Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CCmpCommandQueue Class Referencefinal
Inheritance diagram for CCmpCommandQueue:
Inheritance graph
[legend]
Collaboration diagram for CCmpCommandQueue:
Collaboration graph
[legend]

Public Member Functions

int GetComponentTypeId () const override
 
void Init (const CParamNode &paramNode) override
 
void Deinit () override
 
void Serialize (ISerializer &serialize) override
 
void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize) override
 
void PushLocalCommand (player_id_t player, JS::HandleValue cmd) override
 Pushes a new command onto the local queue. More...
 
void PostNetworkCommand (JS::HandleValue cmd1) override
 Send a command associated with the current player to the networking system. More...
 
void FlushTurn (const std::vector< SimulationCommand > &commands) override
 Calls the ProcessCommand(player, cmd) global script function for each command in the local queue and in commands, and empties the local queue. More...
 
virtual void PushLocalCommand (player_id_t player, JS::HandleValue cmd)=0
 Pushes a new command onto the local queue. More...
 
virtual void PostNetworkCommand (JS::HandleValue cmd)=0
 Send a command associated with the current player to the networking system. More...
 
virtual void FlushTurn (const std::vector< SimulationCommand > &commands)=0
 Calls the ProcessCommand(player, cmd) global script function for each command in the local queue and in commands, and empties the local queue. 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 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 (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
 

Static Public Member Functions

static void ClassInit (CComponentManager &componentManager)
 
static IComponent * Allocate (const ScriptInterface &, JS::HandleValue)
 
static void Deallocate (IComponent *cmp)
 
static std::string GetSchema ()
 
- 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 ()
 

Public Attributes

std::vector< SimulationCommand > m_LocalQueue
 

Additional Inherited Members

- Public Types inherited from IComponent
using AllocFunc = IComponent *(*)(const ScriptInterface &scriptInterface, JS::HandleValue ctor)
 
using DeallocFunc = void(*)(IComponent *)
 

Member Function Documentation

◆ Allocate()

static IComponent * CCmpCommandQueue::Allocate ( const ScriptInterface &  ,
JS::HandleValue   
)
inlinestatic

◆ ClassInit()

static void CCmpCommandQueue::ClassInit ( CComponentManager &  componentManager)
inlinestatic

◆ Deallocate()

static void CCmpCommandQueue::Deallocate ( IComponent *  cmp)
inlinestatic

◆ Deinit()

void CCmpCommandQueue::Deinit ( )
inlineoverridevirtual

Implements IComponent.

◆ Deserialize()

void CCmpCommandQueue::Deserialize ( const CParamNode &  paramNode,
IDeserializer &  deserialize 
)
inlineoverridevirtual

Implements IComponent.

◆ FlushTurn()

void CCmpCommandQueue::FlushTurn ( const std::vector< SimulationCommand > &  commands)
inlineoverridevirtual

Calls the ProcessCommand(player, cmd) global script function for each command in the local queue and in commands, and empties the local queue.

Implements ICmpCommandQueue.

◆ GetComponentTypeId()

int CCmpCommandQueue::GetComponentTypeId ( ) const
inlineoverridevirtual

Implements IComponent.

◆ GetSchema()

static std::string CCmpCommandQueue::GetSchema ( )
inlinestatic

◆ Init()

void CCmpCommandQueue::Init ( const CParamNode &  paramNode)
inlineoverridevirtual

Implements IComponent.

◆ PostNetworkCommand()

void CCmpCommandQueue::PostNetworkCommand ( JS::HandleValue  cmd)
inlineoverridevirtual

Send a command associated with the current player to the networking system.

Implements ICmpCommandQueue.

◆ PushLocalCommand()

void CCmpCommandQueue::PushLocalCommand ( player_id_t  player,
JS::HandleValue  cmd 
)
inlineoverridevirtual

Pushes a new command onto the local queue.

cmd does not need to be rooted.

Implements ICmpCommandQueue.

◆ Serialize()

void CCmpCommandQueue::Serialize ( ISerializer &  serialize)
inlineoverridevirtual

Implements IComponent.

Member Data Documentation

◆ m_LocalQueue

std::vector<SimulationCommand> CCmpCommandQueue::m_LocalQueue
The documentation for this class was generated from the following file: