Pyrogenesis  trunk
Public Member Functions | Private Member Functions | Private Attributes | List of all members
CWorld Class Reference

CWorld is a general data class containing whatever is needed to accurately represent the world. More...

#include <World.h>

Collaboration diagram for CWorld:
Collaboration graph
[legend]

Public Member Functions

 CWorld (CGame *pGame)
 Constructor. More...
 
 ~CWorld ()
 Destructor. More...
 
void RegisterInit (const CStrW &mapFile, JSRuntime *rt, JS::HandleValue settings, int playerID)
 Initializes the game world with the attributes provided. More...
 
void RegisterInitRMS (const CStrW &scriptFile, JSRuntime *rt, JS::HandleValue settings, int playerID)
 
CTerrainGetTerrain ()
 Get the pointer to the terrain object. More...
 
CUnitManagerGetUnitManager ()
 Get a reference to the unit manager object. More...
 
CTerritoryManager * GetTerritoryManager ()
 Get the pointer to the territory manager object. More...
 

Private Member Functions

 NONCOPYABLE (CWorld)
 

Private Attributes

CGamem_pGame
 pointer to the CGame object representing the game. More...
 
CTerrainm_Terrain
 pointer to the CTerrain object representing the height map. More...
 
CUnitManagerm_UnitManager
 pointer to the CUnitManager that holds all the units in the world. More...
 
CTerritoryManager * m_TerritoryManager
 pointer to the CTerritoryManager that holds territory matrix for the world. More...
 

Detailed Description

CWorld is a general data class containing whatever is needed to accurately represent the world.

This includes the map, entities, influence maps, tiles, heightmap, etc.

Constructor & Destructor Documentation

CWorld::CWorld ( CGame pGame)

Constructor.

Parameters
pGameCGame * pGame pointer to the container game object.
CWorld::~CWorld ( )

Destructor.

Member Function Documentation

CTerrain* CWorld::GetTerrain ( )
inline

Get the pointer to the terrain object.

Returns
CTerrain * the value of m_Terrain.
CTerritoryManager* CWorld::GetTerritoryManager ( )
inline

Get the pointer to the territory manager object.

Returns
CTerritoryManager * the value of m_TerritoryManager.
CUnitManager& CWorld::GetUnitManager ( )
inline

Get a reference to the unit manager object.

Returns
CUnitManager & dereferenced m_UnitManager.
CWorld::NONCOPYABLE ( CWorld  )
private
void CWorld::RegisterInit ( const CStrW &  mapFile,
JSRuntime *  rt,
JS::HandleValue  settings,
int  playerID 
)

Initializes the game world with the attributes provided.

void CWorld::RegisterInitRMS ( const CStrW &  scriptFile,
JSRuntime *  rt,
JS::HandleValue  settings,
int  playerID 
)

Member Data Documentation

CGame* CWorld::m_pGame
private

pointer to the CGame object representing the game.

CTerrain* CWorld::m_Terrain
private

pointer to the CTerrain object representing the height map.

CTerritoryManager* CWorld::m_TerritoryManager
private

pointer to the CTerritoryManager that holds territory matrix for the world.

CUnitManager* CWorld::m_UnitManager
private

pointer to the CUnitManager that holds all the units in the world.


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