Pyrogenesis  trunk
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
IComponent Class Referenceabstract

#include <IComponent.h>

Inheritance diagram for IComponent:
Inheritance graph
[legend]
Collaboration diagram for IComponent:
Collaboration graph
[legend]

Public Member Functions

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 CSimContext & GetSimContext () const
 
void SetSimContext (const CSimContext &context)
 
virtual void Serialize (ISerializer &serialize)=0
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0
 
virtual bool NewJSObject (ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
 Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...
 
virtual JS::Value GetJSInstance () const
 
virtual int GetComponentTypeId () const =0
 

Static Public Member Functions

static std::string GetSchema ()
 
static u8 GetSerializationVersion ()
 

Private Attributes

CEntityHandle m_EntityHandle
 
const CSimContext * m_SimContext
 

Constructor & Destructor Documentation

IComponent::~IComponent ( )
virtual

Member Function Documentation

virtual void IComponent::Deinit ( )
pure virtual

Implemented in CCmpAIManager, CCmpRangeManager, CCmpUnitMotion, CCmpObstruction, CCmpTest2Scripted, CCmpTest1Scripted, CCmpVisualActor, CCmpRallyPointRenderer, CCmpPathfinder, CCmpTest2A, CCmpObstructionManager, CCmpPosition, CCmpSelectable, CCmpUnitRenderer, CCmpTerritoryManager, CCmpTest1B, CCmpDecay, CCmpMinimap, CCmpFootprint, CCmpVision, CCmpProjectileManager, CCmpCinemaManager, CCmpTerritoryInfluence, CCmpOverlayRenderer, CCmpTemplateManager, CCmpWaterManager, CCmpTest1A, CCmpOwnership, CCmpTerrain, CCmpMotionBall, CCmpParticleManager, CCmpCommandQueue, CCmpSoundManager, CCmpUnitMotionScripted, CCmpPlayerScripted, CCmpExample, CCmpIdentityScripted, CCmpSettlementScripted, CCmpAIInterfaceScripted, CCmpDataTemplateManagerScripted, CCmpFoggingScripted, CCmpGuiInterfaceScripted, CCmpMirageScripted, CCmpMotionScripted, CCmpPlayerManagerScripted, CCmpUnknownScript, CCmpValueModificationManagerScripted, and CCmpVisibilityScripted.

virtual void IComponent::Deserialize ( const CParamNode &  paramNode,
IDeserializer &  deserialize 
)
pure virtual

Implemented in CCmpAIManager, CCmpRangeManager, CCmpUnitMotion, CCmpObstruction, CCmpVisualActor, CCmpTest2Scripted, CCmpPosition, CCmpTest1Scripted, CCmpRallyPointRenderer, CCmpObstructionManager, CCmpPathfinder, CCmpTest2A, CCmpSelectable, CCmpTerritoryManager, CCmpUnitRenderer, CCmpMinimap, CCmpTest1B, CCmpDecay, CCmpFootprint, CCmpCinemaManager, CCmpProjectileManager, CCmpVision, CCmpOverlayRenderer, CCmpTemplateManager, CCmpTerritoryInfluence, CCmpCommandQueue, CCmpWaterManager, CCmpTest1A, CCmpMotionBall, CCmpOwnership, CCmpTerrain, CCmpParticleManager, CCmpSoundManager, CCmpUnitMotionScripted, CCmpExample, CCmpPlayerScripted, CCmpIdentityScripted, CCmpSettlementScripted, CCmpAIInterfaceScripted, CCmpDataTemplateManagerScripted, CCmpFoggingScripted, CCmpGuiInterfaceScripted, CCmpMirageScripted, CCmpMotionScripted, CCmpPlayerManagerScripted, CCmpUnknownScript, CCmpValueModificationManagerScripted, and CCmpVisibilityScripted.

virtual int IComponent::GetComponentTypeId ( ) const
pure virtual

Implemented in CCmpAIManager, CCmpRangeManager, CCmpTest2Scripted, CCmpTest1Scripted, CCmpTest2A, CCmpPathfinder, CCmpUnitRenderer, CCmpUnitMotion, CCmpObstructionManager, CCmpTest1B, CCmpRallyPointRenderer, CCmpTerritoryManager, CCmpVisualActor, CCmpSelectable, CCmpPosition, CCmpDecay, CCmpProjectileManager, CCmpCinemaManager, CCmpUnitMotionScripted, CCmpObstruction, CCmpWaterManager, CCmpMinimap, CCmpOverlayRenderer, CCmpTemplateManager, CCmpFootprint, CCmpTerrain, CCmpTest1A, CCmpVision, CCmpSoundManager, CCmpMotionBall, CCmpOwnership, CCmpParticleManager, CCmpCommandQueue, CCmpTerritoryInfluence, CCmpPlayerScripted, CCmpIdentityScripted, CCmpSettlementScripted, CCmpAIInterfaceScripted, CCmpDataTemplateManagerScripted, CCmpFoggingScripted, CCmpGuiInterfaceScripted, CCmpMirageScripted, CCmpMotionScripted, CCmpPlayerManagerScripted, CCmpUnknownScript, CCmpValueModificationManagerScripted, CCmpVisibilityScripted, and CCmpExample.

CEntityHandle IComponent::GetEntityHandle ( ) const
inline
entity_id_t IComponent::GetEntityId ( ) const
inline
JS::Value IComponent::GetJSInstance ( ) const
virtual

Reimplemented in CCmpTest2Scripted, CCmpTest1Scripted, CCmpUnitMotionScripted, CCmpPlayerScripted, CCmpIdentityScripted, CCmpSettlementScripted, CCmpAIInterfaceScripted, CCmpDataTemplateManagerScripted, CCmpFoggingScripted, CCmpGuiInterfaceScripted, CCmpMirageScripted, CCmpMotionScripted, CCmpPlayerManagerScripted, CCmpUnknownScript, CCmpValueModificationManagerScripted, and CCmpVisibilityScripted.

std::string IComponent::GetSchema ( )
static
static u8 IComponent::GetSerializationVersion ( )
inlinestatic
const CSimContext& IComponent::GetSimContext ( ) const
inline
CEntityHandle IComponent::GetSystemEntity ( ) const
inline
void IComponent::HandleMessage ( const CMessage &  msg,
bool  global 
)
virtual

Reimplemented in CCmpAIManager, CCmpPosition, CCmpRangeManager, CCmpUnitMotion, CCmpObstruction, CCmpVisualActor, CCmpTest2Scripted, CCmpTest1Scripted, CCmpObstructionManager, CCmpRallyPointRenderer, CCmpPathfinder, CCmpTest2A, CCmpSelectable, CCmpTerritoryManager, CCmpUnitRenderer, CCmpMinimap, CCmpTest1B, CCmpDecay, CCmpCinemaManager, CCmpProjectileManager, CCmpVision, CCmpTemplateManager, CCmpOverlayRenderer, CCmpTest1A, CCmpWaterManager, CCmpMotionBall, CCmpOwnership, CCmpParticleManager, CCmpExample, CCmpUnitMotionScripted, CCmpPlayerScripted, CCmpIdentityScripted, CCmpSettlementScripted, CCmpAIInterfaceScripted, CCmpDataTemplateManagerScripted, CCmpFoggingScripted, CCmpGuiInterfaceScripted, CCmpMirageScripted, CCmpMotionScripted, CCmpPlayerManagerScripted, CCmpUnknownScript, CCmpValueModificationManagerScripted, and CCmpVisibilityScripted.

virtual void IComponent::Init ( const CParamNode &  paramNode)
pure virtual

Implemented in CCmpAIManager, CCmpRangeManager, CCmpUnitMotion, CCmpTest2Scripted, CCmpTest1Scripted, CCmpRallyPointRenderer, CCmpPathfinder, CCmpVisualActor, CCmpObstruction, CCmpTest2A, CCmpObstructionManager, CCmpUnitRenderer, CCmpPosition, CCmpTerritoryManager, CCmpTest1B, CCmpSelectable, CCmpDecay, CCmpMinimap, CCmpFootprint, CCmpVision, CCmpProjectileManager, CCmpOverlayRenderer, CCmpTerritoryInfluence, CCmpCinemaManager, CCmpWaterManager, CCmpOwnership, CCmpTerrain, CCmpTemplateManager, CCmpTest1A, CCmpUnitMotionScripted, CCmpMotionBall, CCmpParticleManager, CCmpCommandQueue, CCmpSoundManager, CCmpPlayerScripted, CCmpIdentityScripted, CCmpSettlementScripted, CCmpAIInterfaceScripted, CCmpDataTemplateManagerScripted, CCmpFoggingScripted, CCmpGuiInterfaceScripted, CCmpMirageScripted, CCmpMotionScripted, CCmpPlayerManagerScripted, CCmpUnknownScript, CCmpValueModificationManagerScripted, CCmpVisibilityScripted, and CCmpExample.

bool IComponent::NewJSObject ( ScriptInterface &  scriptInterface,
JS::MutableHandleObject  out 
) const
virtual

Returns false by default, indicating that a scripted wrapper of this IComponent is not supported.

Derrived classes should return true if they implement such a wrapper.

virtual void IComponent::Serialize ( ISerializer &  serialize)
pure virtual

Implemented in CCmpAIManager, CCmpRangeManager, CCmpUnitMotion, CCmpObstruction, CCmpVisualActor, CCmpTest2Scripted, CCmpTest1Scripted, CCmpRallyPointRenderer, CCmpObstructionManager, CCmpPathfinder, CCmpTest2A, CCmpPosition, CCmpSelectable, CCmpTerritoryManager, CCmpUnitRenderer, CCmpMinimap, CCmpTest1B, CCmpDecay, CCmpFootprint, CCmpVision, CCmpProjectileManager, CCmpCinemaManager, CCmpTerritoryInfluence, CCmpOverlayRenderer, CCmpTemplateManager, CCmpWaterManager, CCmpTest1A, CCmpOwnership, CCmpTerrain, CCmpMotionBall, CCmpParticleManager, CCmpCommandQueue, CCmpSoundManager, CCmpUnitMotionScripted, CCmpExample, CCmpPlayerScripted, CCmpIdentityScripted, CCmpSettlementScripted, CCmpAIInterfaceScripted, CCmpDataTemplateManagerScripted, CCmpFoggingScripted, CCmpGuiInterfaceScripted, CCmpMirageScripted, CCmpMotionScripted, CCmpPlayerManagerScripted, CCmpUnknownScript, CCmpValueModificationManagerScripted, and CCmpVisibilityScripted.

void IComponent::SetEntityHandle ( CEntityHandle  ent)
inline
void IComponent::SetSimContext ( const CSimContext &  context)
inline

Member Data Documentation

CEntityHandle IComponent::m_EntityHandle
private
const CSimContext* IComponent::m_SimContext
private
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11