Emergency 20 Dokumentation  4.2.0
em5::GameMode Class Referenceabstract

EMERGENCY 5 game mode base class. More...

#include <GameMode.h>

Inheritance diagram for em5::GameMode:
qsf::Object em5::BenchmarkGameMode em5::FreeplayGameMode em5::CampaignGameMode em5::ChallengeGameMode em5::MultiplayCoopGameMode em5::MultiplayPvPGameMode

Public Member Functions

virtual ~GameMode ()
 Destructor. More...
 
virtual std::string getGameModeAsString () const =0
 Return the game mode type as string (lowercase) More...
 
virtual void startup ()=0
 
virtual void shutdown ()=0
 
virtual void onGameLoaded ()
 
virtual bool isSingleInteraction () const
 
virtual void updateGameMode (qsf::Time timePassed)=0
 
virtual void onSendGameModeSignal (const std::string &gameModeSignal)
 
- 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...
 

Protected Member Functions

 GameMode ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. 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 }
 

Detailed Description

EMERGENCY 5 game mode base class.

Constructor & Destructor Documentation

virtual em5::GameMode::~GameMode ( )
virtual

Destructor.

em5::GameMode::GameMode ( )
protected

Default constructor.

Member Function Documentation

virtual std::string em5::GameMode::getGameModeAsString ( ) const
pure virtual
virtual bool em5::GameMode::isSingleInteraction ( ) const
virtual

Reimplemented in em5::MultiplayPvPGameMode.

virtual void em5::GameMode::onGameLoaded ( )
virtual
virtual void em5::GameMode::onSendGameModeSignal ( const std::string &  gameModeSignal)
virtual
virtual void em5::GameMode::shutdown ( )
pure virtual
virtual void em5::GameMode::updateGameMode ( qsf::Time  timePassed)
pure virtual

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