Emergency 20 Dokumentation  4.2.0
em5::EventHintParameters Class Reference

Freeplay event hint parameters class. More...

#include <EventHintParameters.h>

Inheritance diagram for em5::EventHintParameters:
qsf::Object

Public Member Functions

 EventHintParameters ()
 Default constructor. More...
 
virtual ~EventHintParameters ()
 Destructor. 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...
 

Public Attributes

std::string mSupervisorMessageIds
 ID of the supervisor message that is displayed to the player as supervisor message. More...
 
std::string mHintAtFailedIds
 ID of the hint that is shown if the event fails. More...
 
std::string mHintsAtLowHealthEnergy
 Pool of hints at low health energy. More...
 
std::string mHintsAtLowHealthEnergy_SecondPerson
 Pool of hints at low life energy if there a multiple perons injured. More...
 
float mHintsAtLowHealthEnergy_Threshold
 Threshold of low health hints. More...
 
std::string mHintsAtLowLifeEnergy
 Pool of hints at low life energy. More...
 
std::string mHintsAtLowLifeEnergy_SecondPerson
 Pool of hints at low life energy if there a multiple perons injured. More...
 
float mHintsAtLowLifeEnergy_Threshold
 Threshold of low life hints. More...
 
std::string mHintsAtInjured
 Pool of hints if a person is injured. More...
 
std::string mHintsAtInjured_SecondPerson
 Pool of hints if a second person is injured. More...
 
std::string mHintsAtVehicleDamaged
 Pool of hints if the first vehicle damaged. More...
 
std::string mHintsAfterInfectionIds
 ´Hints that apply after a person got infected and shows his state to the player More...
 
std::string mHintsAtTimer
 Hint at timer. More...
 
float mHintsAtTimer_Delay
 Delay of timer. More...
 
std::string mHintAtHintFireAtBuildingWithPersonIds
 ID of the hint that is shown if an building with persons inside catches fire. More...
 
std::string mHintAtHintFireAtBuildingWithWaverIds
 ID of the hint that is shown if an building with a waving person inside catches fire. 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 qsf::Object
 Object ()
 Default constructor. More...
 

Detailed Description

Freeplay event hint parameters class.

Constructor & Destructor Documentation

em5::EventHintParameters::EventHintParameters ( )
inline

Default constructor.

Note
: Nothing to do here
virtual em5::EventHintParameters::~EventHintParameters ( )
inlinevirtual

Destructor.

Note
: Nothing to do here

Member Data Documentation

std::string em5::EventHintParameters::mHintAtFailedIds

ID of the hint that is shown if the event fails.

std::string em5::EventHintParameters::mHintAtHintFireAtBuildingWithPersonIds

ID of the hint that is shown if an building with persons inside catches fire.

std::string em5::EventHintParameters::mHintAtHintFireAtBuildingWithWaverIds

ID of the hint that is shown if an building with a waving person inside catches fire.

std::string em5::EventHintParameters::mHintsAfterInfectionIds

´Hints that apply after a person got infected and shows his state to the player

std::string em5::EventHintParameters::mHintsAtInjured

Pool of hints if a person is injured.

std::string em5::EventHintParameters::mHintsAtInjured_SecondPerson

Pool of hints if a second person is injured.

std::string em5::EventHintParameters::mHintsAtLowHealthEnergy

Pool of hints at low health energy.

std::string em5::EventHintParameters::mHintsAtLowHealthEnergy_SecondPerson

Pool of hints at low life energy if there a multiple perons injured.

float em5::EventHintParameters::mHintsAtLowHealthEnergy_Threshold

Threshold of low health hints.

std::string em5::EventHintParameters::mHintsAtLowLifeEnergy

Pool of hints at low life energy.

std::string em5::EventHintParameters::mHintsAtLowLifeEnergy_SecondPerson

Pool of hints at low life energy if there a multiple perons injured.

float em5::EventHintParameters::mHintsAtLowLifeEnergy_Threshold

Threshold of low life hints.

std::string em5::EventHintParameters::mHintsAtTimer

Hint at timer.

float em5::EventHintParameters::mHintsAtTimer_Delay

Delay of timer.

std::string em5::EventHintParameters::mHintsAtVehicleDamaged

Pool of hints if the first vehicle damaged.

std::string em5::EventHintParameters::mSupervisorMessageIds

ID of the supervisor message that is displayed to the player as supervisor message.


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