Emergency 20 Dokumentation  4.2.0
em5::RescueDogLocateVictimAction Class Reference

EMERGENCY 5 rescue dog locate victim action. More...

#include <RescueDogLocateVictimAction.h>

Inheritance diagram for em5::RescueDogLocateVictimAction:
qsf::Action qsf::Object em5::PoliceDogLocateObjectAction

Public Types

enum  State { STATE_INIT, STATE_PANT, STATE_FOUND_VICTIM, STATE_LOOPACTION }
 
- 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 }
 

Public Member Functions

 RescueDogLocateVictimAction ()
 Default constructor. More...
 
virtual ~RescueDogLocateVictimAction ()
 Destructor. More...
 
void init (qsf::Entity &targetEntity, qsf::Entity &rescueDogLeaderEntity)
 
virtual void serialize (qsf::BinarySerializer &serializer) override
 Serialize or deserialize the action using a binary serializer. More...
 
- Public Member Functions inherited from qsf::Action
virtual ~Action ()
 Destructor. More...
 
uint32 getTypeId () const
 Return the action's type ID. More...
 
ActionComponentgetComponent () const
 Return the owning action component. More...
 
EntitygetEntity () const
 Return the owning entity. More...
 
uint64 getEntityId () const
 Return the owning entity's ID. More...
 
MapgetMap () const
 Return the map the action's owning entity is in. More...
 
process::State getState () const
 Return the action's process state. More...
 
action::Result update (const Clock &clock)
 Update the action. More...
 
void shutdown ()
 Called before the action gets removed. More...
 
void pause ()
 Called when the action gets interrupted by another action, but not removed. More...
 
action::Priority getPriority () const
 Get action priority. More...
 
void setPriority (action::Priority priority)
 Set action priority. 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 qsf::NamedIdentifier ACTION_ID
 "em5::RescueDogLocateVictim" unique action identifier More...
 

Protected Member Functions

virtual bool onStartup () override
 Called when the action gets active (i.e. switches to the "running" state) for the first time. More...
 
virtual void onShutdown () override
 Called before the action gets removed, in case it was active at least once since its creation. More...
 
virtual qsf::action::Result updateAction (const qsf::Clock &clock) override
 Update the action. More...
 
 RescueDogLocateVictimAction (uint32 actionId)
 Constructor for sub-classes. More...
 
virtual uint32 getFoundMessageId () const
 
- Protected Member Functions inherited from qsf::Action
 Action (uint32 actionTypeId)
 Constructor. More...
 
virtual void onAbort ()
 Called before the action gets removed, in case it was never active. More...
 
virtual void onPause ()
 Called when the action gets interrupted by another action, but not removed. More...
 
virtual void onResume ()
 Called when the action gets active again after it was paused. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 

Protected Attributes

qsf::WeakPtr< qsf::EntitymTargetEntity
 
qsf::WeakPtr< qsf::EntitymRescueDogLeaderEntity
 
bool mTurnToTarget
 
qsf::Time mTimeForAutoAbort
 
qsf::WeakPtr< qsf::MeshAnimationChannelmMeshAnimationChannel
 
State mState
 
AudioProxy mAudioProxy
 
- Protected Attributes inherited from qsf::Action
action::Priority mPriority
 Action with higher priority get evaluated first; default value is 100. More...
 
bool mIsScriptAction
 True if action is loaded via script. More...
 

Detailed Description

EMERGENCY 5 rescue dog locate victim action.

Member Enumeration Documentation

Enumerator
STATE_INIT 
STATE_PANT 
STATE_FOUND_VICTIM 
STATE_LOOPACTION 

Constructor & Destructor Documentation

em5::RescueDogLocateVictimAction::RescueDogLocateVictimAction ( )

Default constructor.

virtual em5::RescueDogLocateVictimAction::~RescueDogLocateVictimAction ( )
virtual

Destructor.

em5::RescueDogLocateVictimAction::RescueDogLocateVictimAction ( uint32  actionId)
protected

Constructor for sub-classes.

Member Function Documentation

virtual uint32 em5::RescueDogLocateVictimAction::getFoundMessageId ( ) const
protectedvirtual
void em5::RescueDogLocateVictimAction::init ( qsf::Entity targetEntity,
qsf::Entity rescueDogLeaderEntity 
)
virtual void em5::RescueDogLocateVictimAction::onShutdown ( )
overrideprotectedvirtual

Called before the action gets removed, in case it was active at least once since its creation.

Remarks
This method is called only if the action to be removed got an onStartup() call before; if this was not the case, onAbort() gets called instead

Reimplemented from qsf::Action.

virtual bool em5::RescueDogLocateVictimAction::onStartup ( )
overrideprotectedvirtual

Called when the action gets active (i.e. switches to the "running" state) for the first time.

Returns
true if startup succeeded, false otherwise

Reimplemented from qsf::Action.

virtual void em5::RescueDogLocateVictimAction::serialize ( qsf::BinarySerializer serializer)
overridevirtual

Serialize or deserialize the action using a binary serializer.

Parameters
[in]serializerThe serializer, which can be either in read or write mode

Reimplemented from qsf::Action.

virtual qsf::action::Result em5::RescueDogLocateVictimAction::updateAction ( const qsf::Clock clock)
overrideprotectedvirtual

Update the action.

Parameters
clockThe clock used for timing the action updates; holds e.g. time passed since last update
Returns
The result of the action update

Implements qsf::Action.

Member Data Documentation

const qsf::NamedIdentifier em5::RescueDogLocateVictimAction::ACTION_ID
static

"em5::RescueDogLocateVictim" unique action identifier

AudioProxy em5::RescueDogLocateVictimAction::mAudioProxy
protected
qsf::WeakPtr<qsf::MeshAnimationChannel> em5::RescueDogLocateVictimAction::mMeshAnimationChannel
protected
qsf::WeakPtr<qsf::Entity> em5::RescueDogLocateVictimAction::mRescueDogLeaderEntity
protected
State em5::RescueDogLocateVictimAction::mState
protected
qsf::WeakPtr<qsf::Entity> em5::RescueDogLocateVictimAction::mTargetEntity
protected
qsf::Time em5::RescueDogLocateVictimAction::mTimeForAutoAbort
protected
bool em5::RescueDogLocateVictimAction::mTurnToTarget
protected

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