Emergency 20 Dokumentation  4.1.0
Public Types | Public Member Functions | List of all members
qsf::game::CommandMode Class Reference

Command mode base class. More...

#include <CommandMode.h>

Inheritance diagram for qsf::game::CommandMode:
Inheritance graph
Collaboration diagram for qsf::game::CommandMode:
Collaboration graph

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(mk) Think about adding this class to reflection system, cause we have different command modes from different projects

Member Typedef Documentation

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

Constructor & Destructor Documentation

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

Default constructor.

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


Member Function Documentation

virtual bool qsf::game::CommandMode::executeCommandContext ( CommandContext commandContext,
const EntityIdSet callerIds 
uint32 qsf::game::CommandMode::getId ( ) const

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

virtual void qsf::game::CommandMode::shutdown ( )
virtual void qsf::game::CommandMode::startup ( )
virtual void qsf::game::CommandMode::updateCommandMode ( const Clock clock)

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