Pyrogenesis  13997
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Attributes | List of all members
ICmpTerritoryManager Class Referenceabstract

#include <ICmpTerritoryManager.h>

Inheritance diagram for ICmpTerritoryManager:
IComponent CCmpTerritoryManager

Public Member Functions

virtual bool NeedUpdate (size_t *dirtyID)=0
 
virtual const Grid< u8 > & GetTerritoryGrid ()=0
 For each tile, the TERRITORY_PLAYER_MASK bits are player ID; TERRITORY_CONNECTED_MASK is set if the tile is connected to a root object (civ center etc). More...
 
virtual player_id_t GetOwner (entity_pos_t x, entity_pos_t z)=0
 Get owner of territory at given position. More...
 
virtual bool IsConnected (entity_pos_t x, entity_pos_t z)=0
 Get whether territory at given position is connected to a root object (civ center etc) owned by that territory's player. More...
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
virtual void Init (const CParamNode &paramNode)=0
 
virtual void Deinit ()=0
 
virtual void HandleMessage (const CMessage &msg, bool global)
 
CEntityHandle GetEntityHandle () const
 
void SetEntityHandle (CEntityHandle ent)
 
entity_id_t GetEntityId () const
 
CEntityHandle GetSystemEntity () const
 
const CSimContextGetSimContext () const
 
void SetSimContext (const CSimContext &context)
 
virtual void Serialize (ISerializer &serialize)=0
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0
 
virtual JSClass * GetJSClass () const
 
virtual jsval GetJSInstance () const
 

Static Public Attributes

static const int TERRITORY_PLAYER_MASK = 0x3F
 
static const int TERRITORY_CONNECTED_MASK = 0x40
 
static const int TERRITORY_PROCESSED_MASK = 0x80
 

Additional Inherited Members

- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static u8 GetSerializationVersion ()
 

Detailed Description

Definition at line 27 of file ICmpTerritoryManager.h.

Member Function Documentation

virtual player_id_t ICmpTerritoryManager::GetOwner ( entity_pos_t  x,
entity_pos_t  z 
)
pure virtual

Get owner of territory at given position.

Returns
player ID of owner; 0 if neutral territory

Implemented in CCmpTerritoryManager.

virtual const Grid<u8>& ICmpTerritoryManager::GetTerritoryGrid ( )
pure virtual

For each tile, the TERRITORY_PLAYER_MASK bits are player ID; TERRITORY_CONNECTED_MASK is set if the tile is connected to a root object (civ center etc).

Implemented in CCmpTerritoryManager.

virtual bool ICmpTerritoryManager::IsConnected ( entity_pos_t  x,
entity_pos_t  z 
)
pure virtual

Get whether territory at given position is connected to a root object (civ center etc) owned by that territory's player.

Implemented in CCmpTerritoryManager.

virtual bool ICmpTerritoryManager::NeedUpdate ( size_t *  dirtyID)
pure virtual

Implemented in CCmpTerritoryManager.

Member Data Documentation

const int ICmpTerritoryManager::TERRITORY_CONNECTED_MASK = 0x40
static

Definition at line 33 of file ICmpTerritoryManager.h.

const int ICmpTerritoryManager::TERRITORY_PLAYER_MASK = 0x3F
static

Definition at line 32 of file ICmpTerritoryManager.h.

const int ICmpTerritoryManager::TERRITORY_PROCESSED_MASK = 0x80
static

Definition at line 34 of file ICmpTerritoryManager.h.


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