Emergency 2017 Dokumentation  v3.0.1
em5::HelicopterFollowCommand Class Reference

EMERGENCY 5 evacuate building command. More...

#include <HelicopterFollowCommand.h>

Public Member Functions

 HelicopterFollowCommand (qsf::game::CommandManager *commandManager)
 Constructor. More...
 
virtual bool checkAvailable () override
 Check whether the command is currently available at all. More...
 
virtual bool checkCaller (qsf::Entity &caller) override
 Check whether the command can be executed by the given caller entity. More...
 
virtual bool checkContext (const qsf::game::CommandContext &context) override
 Check whether the command can be executed with the given context. More...
 
virtual void execute (const qsf::game::CommandContext &context) override
 Execute command for given context. More...
 
- Public Member Functions inherited from em5::Command
virtual const IconSettingsgetIconSettings () const
 
virtual bool highlightTarget () const
 Indicates if target highlighting for this command is enabled/disabled. More...
 
const std::string & getHelpPageName () const
 Returns the help page name. More...
 
int32 getButtonPriority () const
 Returns the priority of the command buttons (Bigger priority comes first) More...
 
- Public Member Functions inherited from qsf::game::Command
 Command (CommandManager *commandManager, uint32 commandId)
 Constructor. More...
 
uint32 getId () const
 Get command ID, which is the command class's PLUGINABLE_ID. More...
 
uint32 getPriority () const
 Get command priority. More...
 
bool getIsScriptCommand () const
 Returns true if command is created via script. More...
 
virtual std::string getName () const
 Returns the name of the command. More...
 
- Public Member Functions inherited from qsf::Pluginable< CommandManager >
virtual ~Pluginable ()
 Destructor. More...
 
CommandManager & getManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::PluginableBase
virtual ~PluginableBase ()
 Destructor. More...
 
template<typename T >
T & getPluginableManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::Object
virtual ~Object ()
 Destructor. More...
 
const camp::Class & getCampClass () const
 Return the CAMP class. More...
 
int getPropertyIndexById (const StringHash &propertyId) const
 Return the CAMP property index by using the unique class property ID. More...
 
uint32 getPropertyIdByIndex (int index) const
 Return the unique class property ID with the given index. More...
 
std::string getPropertyNameById (const StringHash &propertyId) const
 Return the CAMP property name by using the unique class property ID. More...
 
const camp::Property * getCampPropertyById (const StringHash &propertyId) const
 Return the CAMP property by using the unique class property ID. More...
 
void setPropertyValuesByString (const std::string &values)
 Set CAMP reflection property values by using a given string. More...
 
void setPropertiesToDefaultValues ()
 Set all CAMP reflection system properties to their default values. More...
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
void serializeToBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void deserializeFromBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL, bool setOverrideState=true)
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState)
 
virtual void onPreDeserialize ()
 Called right before the object is deserialized using any of the above methods. Default implementation is empty. More...
 
virtual void onPostDeserialize ()
 Called right after the object was deserialized using any of the above methods. Default implementation is empty. More...
 
virtual ScriptgetAssociatedScript () const
 Return the script instance associated with this object instance. More...
 

Static Public Attributes

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

Additional Inherited Members

- Public Types inherited from qsf::Object
enum  PropertyOverrideState { PROPERTY_INVALID, PROPERTY_DEFAULT, PROPERTY_OVERRIDE, PROPERTY_REMOVED }
 
enum  SerializationMethod { SERIALIZE_FLAT, SERIALIZE_COMPLETE, SERIALIZE_DIFFERENTIAL, SERIALIZE_IGNORE_UNKNOWN }
 
enum  SerializationMode { MODE_MINIMAL, MODE_COMPATIBLE }
 
- Protected Member Functions inherited from em5::Command
 Command (qsf::game::CommandManager *commandManager, uint32 commandId)
 Constructor. More...
 
bool checkCallerActionPriorityNoBlocking (qsf::Entity &caller, uint32 maximumPriority) const
 Modification of the "checkCallerActionPriority" but return "false" if callers action is with blocking priority. More...
 
- Protected Member Functions inherited from qsf::game::Command
bool checkCallerActionPriority (Entity &caller, uint32 maximumPriority) const
 
ActionComponentgetActionComponent (Entity &caller) const
 
- Protected Member Functions inherited from qsf::Pluginable< CommandManager >
 Pluginable (CommandManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::PluginableBase
 PluginableBase (PluginableManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 
- Protected Attributes inherited from em5::Command
IconSettings mIconSettings
 The command's icon settings structure. More...
 
std::string mHelpPageName
 Holds the corresponding help page name. More...
 
int32 mButtonPriority
 Priority of command buttons on screen (Bigger priority comes first) More...
 
- Protected Attributes inherited from qsf::game::Command
uint32 mPriority
 Commands with higher priority get evaluated first; default value is 100. More...
 
bool mIsScriptCommand
 True if command is loaded via script. More...
 

Detailed Description

EMERGENCY 5 evacuate building command.

Todo:
  • TODO(fw): This is a pure dummy right now to define the command ID

Definition at line 33 of file HelicopterFollowCommand.h.

Constructor & Destructor Documentation

em5::HelicopterFollowCommand::HelicopterFollowCommand ( qsf::game::CommandManager commandManager)
explicit

Constructor.

Member Function Documentation

virtual bool em5::HelicopterFollowCommand::checkAvailable ( )
overridevirtual

Check whether the command is currently available at all.

Returns
"true" if command can be executed, "false" if it is blocked or makes no sense in the current game state

Implements qsf::game::Command.

virtual bool em5::HelicopterFollowCommand::checkCaller ( qsf::Entity caller)
overridevirtual

Check whether the command can be executed by the given caller entity.

Parameters
[in]callerThe caller entity to check
Returns
"true" if command can be executed by this entity, "false" if the entity is not able to execute the command (at all or in the current situation)
Remarks
This only gets called in case checkAvailable() returned "true", so don't repeat checks from checkAvailable() in checkCaller().

Implements qsf::game::Command.

virtual bool em5::HelicopterFollowCommand::checkContext ( const qsf::game::CommandContext context)
overridevirtual

Check whether the command can be executed with the given context.

Parameters
[in]contextThe command context, including caller and target information
Returns
"true" if command can be executed for this context, "false" if the target is not valid for the command
Remarks
This only gets called if both checkAvailable() and checkCaller() returned "true", so don't repeat their checks in checkContext().

Implements qsf::game::Command.

virtual void em5::HelicopterFollowCommand::execute ( const qsf::game::CommandContext context)
overridevirtual

Execute command for given context.

Parameters
[in]contextThe command context, including caller and target information
Remarks
This only gets called if all three checks returned "true". Command execution usually consists of pushing new actions to the caller entity's action component.

Implements qsf::game::Command.

Member Data Documentation

const uint32 em5::HelicopterFollowCommand::PLUGINABLE_ID
static

"em5::HelicopterFollowCommand" unique command pluginable ID

Definition at line 41 of file HelicopterFollowCommand.h.


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