Emergency 20 Dokumentation  4.2.0
em5::GetEquipmentAction Class Reference

EMERGENCY 5 get equipment action. More...

#include <GetEquipmentAction.h>

Inheritance diagram for em5::GetEquipmentAction:
qsf::Action qsf::Object em5::GetDogFromVehicleAction

Public Types

enum  State {
  STATE_INIT, STATE_TURN_TO_DOOR, STATE_OPEN_EQUIPMENT_DOOR, STATE_GET_EQUIPMENT,
  STATE_PLAY_USEANIMATION, STATE_CLOSE_EQUIPMENT_DOOR, STATE_DONE
}
 
- 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

 GetEquipmentAction ()
 Default constructor. More...
 
 GetEquipmentAction (uint32 identifier)
 
virtual ~GetEquipmentAction ()
 Destructor. More...
 
void init (const qsf::Entity &targetEntity, const std::string &equipmentName)
 Initialize action with values. More...
 
void init (const std::string &equipmentName, int forceTintColorIndex=-1)
 Initialize action with values. More...
 
State getState ()
 
const std::string & getEquipmentName () const
 
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::GetEquipmentAction" 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 qsf::action::Result updateAction (const qsf::Clock &clock) override
 Update the action. More...
 
void getAndTurnToClosestEquipmentDoor ()
 
void getAndTurnToClosestEquipmentDoor (bool faceAway, qsf::action::Priority actionPriority)
 
DoorComponentgetNearestDoorFromList (const std::vector< DoorComponent * > &doorComponents) const
 
bool checkForNextUserInArea ()
 
void playUseAnimation ()
 
virtual std::vector< DoorComponent * > getEquipmentDoorsFromTarget () const
 
- Protected Member Functions inherited from qsf::Action
 Action (uint32 actionTypeId)
 Constructor. More...
 
virtual void onShutdown ()
 Called before the action gets removed, in case it was active at least once since its creation. 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

uint64 mTargetEntityId
 ID of the target entity. More...
 
std::string mEquipmentName
 Name of the equipment. More...
 
DoorComponent::DoorType mUsedDoorType
 Type of the used door. More...
 
State mCurrentState
 Current action progress state. More...
 
bool mNeedsTarget
 If "true" a target vehicle is needed to get the equipment from, otherwise the equipment may be switched directly. More...
 
qsf::WeakPtr< qsf::MeshAnimationChannelmUseAnimationChannel
 
bool mDoctorUsesBackDoor
 "true" if the owner is "doctor", "engineer" and "rescuedogleader" and working with the backdoor of the vehicle More...
 
int mForceTintColorIndex
 
- 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 get equipment action.

Note
  • This action is used for both getting an equipment from a vehicle and directly switching to an equipment

Member Enumeration Documentation

Enumerator
STATE_INIT 
STATE_TURN_TO_DOOR 
STATE_OPEN_EQUIPMENT_DOOR 
STATE_GET_EQUIPMENT 
STATE_PLAY_USEANIMATION 
STATE_CLOSE_EQUIPMENT_DOOR 
STATE_DONE 

Constructor & Destructor Documentation

em5::GetEquipmentAction::GetEquipmentAction ( )

Default constructor.

em5::GetEquipmentAction::GetEquipmentAction ( uint32  identifier)
explicit
virtual em5::GetEquipmentAction::~GetEquipmentAction ( )
virtual

Destructor.

Member Function Documentation

bool em5::GetEquipmentAction::checkForNextUserInArea ( )
protected
void em5::GetEquipmentAction::getAndTurnToClosestEquipmentDoor ( )
protected
void em5::GetEquipmentAction::getAndTurnToClosestEquipmentDoor ( bool  faceAway,
qsf::action::Priority  actionPriority 
)
protected
virtual std::vector<DoorComponent*> em5::GetEquipmentAction::getEquipmentDoorsFromTarget ( ) const
protectedvirtual

Reimplemented in em5::GetDogFromVehicleAction.

const std::string& em5::GetEquipmentAction::getEquipmentName ( ) const
DoorComponent* em5::GetEquipmentAction::getNearestDoorFromList ( const std::vector< DoorComponent * > &  doorComponents) const
protected
State em5::GetEquipmentAction::getState ( )
void em5::GetEquipmentAction::init ( const qsf::Entity targetEntity,
const std::string &  equipmentName 
)

Initialize action with values.

void em5::GetEquipmentAction::init ( const std::string &  equipmentName,
int  forceTintColorIndex = -1 
)

Initialize action with values.

virtual bool em5::GetEquipmentAction::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.

void em5::GetEquipmentAction::playUseAnimation ( )
protected
virtual void em5::GetEquipmentAction::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.

Reimplemented in em5::GetDogFromVehicleAction.

virtual qsf::action::Result em5::GetEquipmentAction::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.

Reimplemented in em5::GetDogFromVehicleAction.

Member Data Documentation

const qsf::NamedIdentifier em5::GetEquipmentAction::ACTION_ID
static

"em5::GetEquipmentAction" unique action identifier

State em5::GetEquipmentAction::mCurrentState
protected

Current action progress state.

bool em5::GetEquipmentAction::mDoctorUsesBackDoor
protected

"true" if the owner is "doctor", "engineer" and "rescuedogleader" and working with the backdoor of the vehicle

std::string em5::GetEquipmentAction::mEquipmentName
protected

Name of the equipment.

int em5::GetEquipmentAction::mForceTintColorIndex
protected
bool em5::GetEquipmentAction::mNeedsTarget
protected

If "true" a target vehicle is needed to get the equipment from, otherwise the equipment may be switched directly.

uint64 em5::GetEquipmentAction::mTargetEntityId
protected

ID of the target entity.

qsf::WeakPtr<qsf::MeshAnimationChannel> em5::GetEquipmentAction::mUseAnimationChannel
protected
DoorComponent::DoorType em5::GetEquipmentAction::mUsedDoorType
protected

Type of the used door.


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