Emergency 20 Dokumentation  4.2.0
em5::AreaExtinguishCommandMode Class Reference

Extinguish an area command mode. More...

#include <AreaExtinguishCommandMode.h>

Inheritance diagram for em5::AreaExtinguishCommandMode:
qsf::game::CommandMode

Public Member Functions

 AreaExtinguishCommandMode ()
 Default constructor. More...
 
virtual ~AreaExtinguishCommandMode ()
 Destructor. More...
 
void initialize (qsf::Entity *callerEntity)
 Fill class with all necessary variables. More...
 
virtual void startup () override
 Startup. More...
 
virtual void shutdown () override
 Shutdown. More...
 
virtual bool executeCommandContext (qsf::game::CommandContext &commandContext, const EntityIdSet &callerIds) override
 Process command execution. More...
 
virtual void updateCommandMode (const qsf::Clock &clock) override
 Regular update. More...
 
- Public Member Functions inherited from qsf::game::CommandMode
 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...
 

Static Public Attributes

static const uint32 PLUGINABLE_ID
 "em5::AreaExtinguishCommandMode" unique command pluginable ID More...
 

Additional Inherited Members

- Public Types inherited from qsf::game::CommandMode
typedef boost::container::flat_set< uint64EntityIdSet
 

Detailed Description

Extinguish an area command mode.

Remarks
This command mode lets the user select a position where to place a fire plane and extinguish the area

Constructor & Destructor Documentation

em5::AreaExtinguishCommandMode::AreaExtinguishCommandMode ( )

Default constructor.

virtual em5::AreaExtinguishCommandMode::~AreaExtinguishCommandMode ( )
virtual

Destructor.

Member Function Documentation

virtual bool em5::AreaExtinguishCommandMode::executeCommandContext ( qsf::game::CommandContext commandContext,
const EntityIdSet callerIds 
)
overridevirtual

Process command execution.

Reimplemented from qsf::game::CommandMode.

void em5::AreaExtinguishCommandMode::initialize ( qsf::Entity callerEntity)

Fill class with all necessary variables.

virtual void em5::AreaExtinguishCommandMode::shutdown ( )
overridevirtual

Shutdown.

Note
  • The default implementation is empty

Reimplemented from qsf::game::CommandMode.

virtual void em5::AreaExtinguishCommandMode::startup ( )
overridevirtual

Startup.

Note
  • The default implementation is empty

Reimplemented from qsf::game::CommandMode.

virtual void em5::AreaExtinguishCommandMode::updateCommandMode ( const qsf::Clock clock)
overridevirtual

Regular update.

Note
  • The default implementation is empty

Reimplemented from qsf::game::CommandMode.

Member Data Documentation

const uint32 em5::AreaExtinguishCommandMode::PLUGINABLE_ID
static

"em5::AreaExtinguishCommandMode" unique command pluginable ID


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