Emergency 2017 Dokumentation  v3.0.1
qsf::game::CommandMode Class Reference

Command mode base class. More...

#include <CommandMode.h>

Public Types

typedef boost::container::flat_set< uint64EntityIdSet
 

Public Member Functions

 CommandMode (uint32 commandId)
 Default constructor. More...
 
virtual ~CommandMode ()
 Destructor. More...
 
uint32 getId () const
 Get command mode ID, which is the command mode's PLUGINABLE_ID. More...
 
virtual void startup ()
 Startup. More...
 
virtual void shutdown ()
 Shutdown. More...
 
virtual bool executeCommandContext (CommandContext &commandContext, const EntityIdSet &callerIds)
 Process command execution. More...
 
virtual void updateCommandMode (const Clock &clock)
 Regular update. More...
 

Detailed Description

Command mode base class.

Todo:
  • TODO(mk) Think about adding this class to reflection system, cause we have different commandmodes from different projects

Definition at line 52 of file CommandMode.h.

Member Typedef Documentation

typedef boost::container::flat_set<uint64> qsf::game::CommandMode::EntityIdSet

Definition at line 60 of file CommandMode.h.

Constructor & Destructor Documentation

qsf::game::CommandMode::CommandMode ( uint32  commandId)

Default constructor.

virtual qsf::game::CommandMode::~CommandMode ( )
virtual

Destructor.

Member Function Documentation

uint32 qsf::game::CommandMode::getId ( ) const

Get command mode ID, which is the command mode's PLUGINABLE_ID.


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