CWorld Class Reference

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

#include <World.h>

Public Member Functions
	CWorld (CGame *pGame)
	Constructor. More...
	~CWorld ()
	Destructor. More...
void	RegisterInit (const CStrW &mapFile, const CScriptValRooted &settings, int playerID)
	Initializes the game world with the attributes provided. More...
void	RegisterInitRMS (const CStrW &scriptFile, const CScriptValRooted &settings, int playerID)
CTerrain *	GetTerrain ()
	Get the pointer to the terrain object. More...
CUnitManager &	GetUnitManager ()
	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
CGame *	m_pGame
	pointer to the CGame object representing the game. More...
CTerrain *	m_Terrain
	pointer to the CTerrain object representing the height map. More...
CUnitManager *	m_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.

Definition at line 47 of file World.h.

Constructor & Destructor Documentation

CWorld::CWorld

(

CGame *

pGame

)

Constructor.

Parameters

pGame

CGame * pGame pointer to the container game object.

Definition at line 57 of file World.cpp.

CWorld::~CWorld

(

)

Destructor.

Definition at line 120 of file World.cpp.

Member Function Documentation

CTerrain* CWorld::GetTerrain ( )

inline

Get the pointer to the terrain object.

Returns

CTerrain * the value of m_Terrain.

Definition at line 88 of file World.h.

CTerritoryManager* CWorld::GetTerritoryManager ( )

inline

Get the pointer to the territory manager object.

Returns

CTerritoryManager * the value of m_TerritoryManager.

Definition at line 103 of file World.h.

CUnitManager& CWorld::GetUnitManager ( )

inline

Get a reference to the unit manager object.

Returns

CUnitManager & dereferenced m_UnitManager.

Definition at line 96 of file World.h.

CWorld::NONCOPYABLE ( CWorld  )

private

void CWorld::RegisterInit	(	const CStrW &	mapFile,
		const CScriptValRooted &	settings,
		int	playerID
	)

Initializes the game world with the attributes provided.

Definition at line 68 of file World.cpp.

void CWorld::RegisterInitRMS	(	const CStrW &	scriptFile,
		const CScriptValRooted &	settings,
		int	playerID
	)

Definition at line 98 of file World.cpp.

Member Data Documentation

CGame* CWorld::m_pGame

private

pointer to the CGame object representing the game.

Definition at line 53 of file World.h.

CTerrain* CWorld::m_Terrain

private

pointer to the CTerrain object representing the height map.

Definition at line 58 of file World.h.

CTerritoryManager* CWorld::m_TerritoryManager

private

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

Definition at line 67 of file World.h.

CUnitManager* CWorld::m_UnitManager

private

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

Definition at line 63 of file World.h.

---

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

• /home/sathyam/0ad.svn/source/ps/World.h
• /home/sathyam/0ad.svn/source/ps/World.cpp