Emergency 20 Dokumentation  4.2.0
em5::TrapPersonsCommandMode Class Reference

Trap persons in building or vehicles (there only when the vehicle contains persons) command mode. More...

#include <TrapPersonsCommandMode.h>

Inheritance diagram for em5::TrapPersonsCommandMode:
em5::DebugCommandMode qsf::game::CommandMode

Public Member Functions

 TrapPersonsCommandMode ()
 Default constructor. More...
 
virtual ~TrapPersonsCommandMode ()
 Destructor. More...
 
void spawnGangster (bool spawnGangster, bool spawnHostage)
 
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::TrapPersonsCommandMode" unique command pluginable ID More...
 

Additional Inherited Members

- Public Types inherited from qsf::game::CommandMode
typedef boost::container::flat_set< uint64EntityIdSet
 
- Protected Member Functions inherited from em5::DebugCommandMode
 DebugCommandMode (uint32 commandId)
 Default constructor. More...
 
virtual ~DebugCommandMode ()
 Destructor. More...
 
FreeplayEventgetCurrentFreeplayEvent () const
 Get the (first) currently running freeplay event, or a null pointer if there is none. More...
 
glm::vec2 getMousePosition () const
 Get the current mouse position. More...
 
glm::vec2 getNormalizedMousePosition () const
 Get the current normalized mouse position. More...
 

Detailed Description

Trap persons in building or vehicles (there only when the vehicle contains persons) command mode.

Remarks
This command mode lets the user select a building entity and trap persons in it. Used for debugging and testing.

Constructor & Destructor Documentation

em5::TrapPersonsCommandMode::TrapPersonsCommandMode ( )

Default constructor.

virtual em5::TrapPersonsCommandMode::~TrapPersonsCommandMode ( )
virtual

Destructor.

Member Function Documentation

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

Process command execution.

Reimplemented from qsf::game::CommandMode.

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

Shutdown.

Note
  • The default implementation is empty

Reimplemented from qsf::game::CommandMode.

void em5::TrapPersonsCommandMode::spawnGangster ( bool  spawnGangster,
bool  spawnHostage 
)
virtual void em5::TrapPersonsCommandMode::startup ( )
overridevirtual

Startup.

Note
  • The default implementation is empty

Reimplemented from qsf::game::CommandMode.

virtual void em5::TrapPersonsCommandMode::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::TrapPersonsCommandMode::PLUGINABLE_ID
static

"em5::TrapPersonsCommandMode" unique command pluginable ID


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