Emergency 20 Dokumentation  4.2.0
em5::DebugCommandMode Class Reference

Debug command mode abstract base class. More...

#include <DebugCommandMode.h>

Inheritance diagram for em5::DebugCommandMode:
qsf::game::CommandMode em5::ChangeHealthCommandMode em5::CloseBuildingDoorCommandMode em5::CollisionSensorCommandMode em5::MoveEntityCommandMode em5::RemoveEntityCommandMode em5::StartBurningCommandMode em5::StopBurningCommandMode em5::TrapPersonsCommandMode em5::UseEquipmentCommandMode

Protected Member Functions

 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...
 

Additional Inherited Members

- Public Types inherited from qsf::game::CommandMode
typedef boost::container::flat_set< uint64EntityIdSet
 
- 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...
 
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

Debug command mode abstract base class.

Note
  • This class is only a structure element, plus some protected helper methods

Constructor & Destructor Documentation

em5::DebugCommandMode::DebugCommandMode ( uint32  commandId)
protected

Default constructor.

virtual em5::DebugCommandMode::~DebugCommandMode ( )
protectedvirtual

Destructor.

Member Function Documentation

FreeplayEvent* em5::DebugCommandMode::getCurrentFreeplayEvent ( ) const
protected

Get the (first) currently running freeplay event, or a null pointer if there is none.

glm::vec2 em5::DebugCommandMode::getMousePosition ( ) const
protected

Get the current mouse position.

glm::vec2 em5::DebugCommandMode::getNormalizedMousePosition ( ) const
protected

Get the current normalized mouse position.


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