Planeshift
Recipe Class Reference

This object represents recipes for the tribe AI. More...

#include <recipe.h>

Classes

struct  Requirement
 Data structure to keep information about requirements. More...
 

Public Types

enum  RequirementType {
  REQ_TYPE_BUILDING, REQ_TYPE_ITEM, REQ_TYPE_KNOWLEDGE, REQ_TYPE_MEMORY,
  REQ_TYPE_RECIPE, REQ_TYPE_RESOURCE, REQ_TYPE_TRADER, REQ_TYPE_TRIBESMAN
}
 Types of requirements. More...
 

Public Member Functions

void Dump ()
 Dump all details about the recipe. More...
 
void DumpAlgorithm ()
 Dumps algorithm to console. More...
 
void DumpRequirements ()
 Dumps requirements to console. More...
 
csStringArray GetAlgorithm ()
 Getter for Recipe's Algorithm. More...
 
int GetID ()
 Getter for Recipe's ID. More...
 
csString GetName ()
 Getter for Recipe's Name. More...
 
csArray< RequirementGetRequirements ()
 Getter for Requirements. More...
 
bool IsPersistent ()
 Getter for Persistance. More...
 
bool Load (iResultRow &row)
 Load a recipe. More...
 
 Recipe ()
 Construct a Recipe object. More...
 
virtual ~Recipe ()
 Destruct a Recipe object. More...
 

Static Public Attributes

static const char * RequirementTypeString []
 

Detailed Description

This object represents recipes for the tribe AI.

Definition at line 55 of file recipe.h.

Member Enumeration Documentation

Types of requirements.

Enumerator
REQ_TYPE_BUILDING 
REQ_TYPE_ITEM 
REQ_TYPE_KNOWLEDGE 
REQ_TYPE_MEMORY 
REQ_TYPE_RECIPE 
REQ_TYPE_RESOURCE 
REQ_TYPE_TRADER 
REQ_TYPE_TRIBESMAN 

Definition at line 60 of file recipe.h.

Constructor & Destructor Documentation

Recipe::Recipe ( )

Construct a Recipe object.

virtual Recipe::~Recipe ( )
inlinevirtual

Destruct a Recipe object.

Definition at line 88 of file recipe.h.

Member Function Documentation

void Recipe::Dump ( )

Dump all details about the recipe.

void Recipe::DumpAlgorithm ( )

Dumps algorithm to console.

void Recipe::DumpRequirements ( )

Dumps requirements to console.

csStringArray Recipe::GetAlgorithm ( )
inline

Getter for Recipe's Algorithm.

Definition at line 115 of file recipe.h.

int Recipe::GetID ( )
inline

Getter for Recipe's ID.

Definition at line 103 of file recipe.h.

csString Recipe::GetName ( )
inline

Getter for Recipe's Name.

Definition at line 109 of file recipe.h.

csArray<Requirement> Recipe::GetRequirements ( )
inline

Getter for Requirements.

Definition at line 127 of file recipe.h.

bool Recipe::IsPersistent ( )
inline

Getter for Persistance.

Definition at line 121 of file recipe.h.

bool Recipe::Load ( iResultRow &  row)

Load a recipe.

Member Data Documentation

const char* Recipe::RequirementTypeString[]
static

Definition at line 71 of file recipe.h.


The documentation for this class was generated from the following file: