Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
ICmpTurretHolder Class Referenceabstract

#include <ICmpTurretHolder.h>

Inheritance diagram for ICmpTurretHolder:
Collaboration diagram for ICmpTurretHolder:

Public Member Functions

virtual std::vector< std::pair< std::string, entity_id_t > > GetTurrets () const =0
 Returns the correlation between garrisoned turrets (their ID) and which turret point they occupy (name). More...
 
virtual void SetInitEntities (std::vector< std::pair< std::string, entity_id_t > > &&entities)=0
 Correlation between entities (ID) and the turret point they ought to occupy (name). 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 bool NewJSObject (const 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
 

Additional Inherited Members

- Public Types inherited from IComponent
using AllocFunc = IComponent *(*)(const ScriptInterface &scriptInterface, JS::HandleValue ctor)
 
using DeallocFunc = void(*)(IComponent *)
 
- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static void RegisterComponentType (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
 
static void RegisterComponentTypeScriptWrapper (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
 
static u8 GetSerializationVersion ()
 

Member Function Documentation

◆ GetTurrets()

virtual std::vector< std::pair< std::string, entity_id_t > > ICmpTurretHolder::GetTurrets ( ) const
pure virtual

Returns the correlation between garrisoned turrets (their ID) and which turret point they occupy (name).

Implemented in CCmpTurretHolderScripted.

◆ SetInitEntities()

virtual void ICmpTurretHolder::SetInitEntities ( std::vector< std::pair< std::string, entity_id_t > > &&  entities)
pure virtual

Correlation between entities (ID) and the turret point they ought to occupy (name).

Implemented in CCmpTurretHolderScripted.


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