Emergency 20 Dokumentation  4.2.0
em5::FreeplayGameMode Class Reference

EMERGENCY 5 freeplay game mode. More...

#include <FreeplayGameMode.h>

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

Public Member Functions

 FreeplayGameMode ()
 Default constructor. More...
 
virtual ~FreeplayGameMode ()
 Destructor. More...
 
void toggleWorldEventPhase ()
 Starts or stops the world event. This is used for debug. More...
 
void toggleSeasonalEvent (const std::string &seasonalEventIdentifier, bool show)
 Starts or stops the seasonal event. This activates and deactivate event specific layers. More...
 
virtual std::string getGameModeAsString () const override
 Return the game mode type as string (lowercase) More...
 
virtual void startup () override
 
virtual void shutdown () override
 
virtual void onGameLoaded () override
 
virtual void updateGameMode (qsf::Time timePassed) override
 
virtual void onSendGameModeSignal (const std::string &gameModeSignal) override
 
- Public Member Functions inherited from em5::GameMode
virtual ~GameMode ()
 Destructor. More...
 
virtual bool isSingleInteraction () const
 
- 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

virtual void onEventSucceeded (const qsf::MessageParameters &parameters)
 
virtual void onEventFailed (const qsf::MessageParameters &parameters)
 
virtual void onReceiveObjectivePoints (const qsf::MessageParameters &parameters)
 
virtual void onSetPointGain (const FreeplayEvent::EventResult &eventResult, int32 pointGain)
 
virtual void onEventCompleted (const qsf::MessageParameters &parameters)
 
virtual void onFirstEventCompleted ()
 
virtual std::string getIntroVideo (uint32 index)
 
bool setupEventPool (const std::string &postfix="", bool allowFallback=true)
 
bool setupFixedEventPool ()
 
void setupUnitPool (const Player *player=nullptr)
 
void setupMessageHandler ()
 
void updateEventGenerator (const qsf::Time &timePassed)
 
void setupWorldEvents (const qsf::Map &map, bool showHint)
 
void cleanupWorldEvents (const qsf::Map &map)
 
void setupFreeplay ()
 
bool startIntroVideo (uint32 index)
 
void resetEventLimit ()
 Resets the event limit to the limit specified by the spec. More...
 
- Protected Member Functions inherited from em5::GameMode
 GameMode ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 

Protected Attributes

MapIdentifier mMapIdentifier
 The current map. More...
 
bool mIsPlayingIntro
 
bool mFirstEventCompleted
 
qsf::MessageProxy mCutsceneMessageProxy
 

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 freeplay game mode.

Constructor & Destructor Documentation

em5::FreeplayGameMode::FreeplayGameMode ( )

Default constructor.

virtual em5::FreeplayGameMode::~FreeplayGameMode ( )
virtual

Destructor.

Member Function Documentation

void em5::FreeplayGameMode::cleanupWorldEvents ( const qsf::Map map)
protected
virtual std::string em5::FreeplayGameMode::getGameModeAsString ( ) const
overridevirtual

Return the game mode type as string (lowercase)

Implements em5::GameMode.

Reimplemented in em5::CampaignGameMode, em5::MultiplayPvPGameMode, em5::MultiplayCoopGameMode, and em5::ChallengeGameMode.

virtual std::string em5::FreeplayGameMode::getIntroVideo ( uint32  index)
protectedvirtual

Reimplemented in em5::CampaignGameMode.

virtual void em5::FreeplayGameMode::onEventCompleted ( const qsf::MessageParameters parameters)
protectedvirtual
virtual void em5::FreeplayGameMode::onEventFailed ( const qsf::MessageParameters parameters)
protectedvirtual
virtual void em5::FreeplayGameMode::onEventSucceeded ( const qsf::MessageParameters parameters)
protectedvirtual
virtual void em5::FreeplayGameMode::onFirstEventCompleted ( )
protectedvirtual
virtual void em5::FreeplayGameMode::onGameLoaded ( )
overridevirtual
virtual void em5::FreeplayGameMode::onReceiveObjectivePoints ( const qsf::MessageParameters parameters)
protectedvirtual
virtual void em5::FreeplayGameMode::onSendGameModeSignal ( const std::string &  gameModeSignal)
overridevirtual

Reimplemented from em5::GameMode.

Reimplemented in em5::CampaignGameMode.

virtual void em5::FreeplayGameMode::onSetPointGain ( const FreeplayEvent::EventResult eventResult,
int32  pointGain 
)
protectedvirtual
void em5::FreeplayGameMode::resetEventLimit ( )
protected

Resets the event limit to the limit specified by the spec.

bool em5::FreeplayGameMode::setupEventPool ( const std::string &  postfix = "",
bool  allowFallback = true 
)
protected
bool em5::FreeplayGameMode::setupFixedEventPool ( )
protected
void em5::FreeplayGameMode::setupFreeplay ( )
protected
void em5::FreeplayGameMode::setupMessageHandler ( )
protected
void em5::FreeplayGameMode::setupUnitPool ( const Player player = nullptr)
protected
void em5::FreeplayGameMode::setupWorldEvents ( const qsf::Map map,
bool  showHint 
)
protected
virtual void em5::FreeplayGameMode::shutdown ( )
overridevirtual

Implements em5::GameMode.

Reimplemented in em5::CampaignGameMode, and em5::ChallengeGameMode.

bool em5::FreeplayGameMode::startIntroVideo ( uint32  index)
protected
virtual void em5::FreeplayGameMode::startup ( )
overridevirtual
void em5::FreeplayGameMode::toggleSeasonalEvent ( const std::string &  seasonalEventIdentifier,
bool  show 
)

Starts or stops the seasonal event. This activates and deactivate event specific layers.

void em5::FreeplayGameMode::toggleWorldEventPhase ( )

Starts or stops the world event. This is used for debug.

void em5::FreeplayGameMode::updateEventGenerator ( const qsf::Time timePassed)
protected
virtual void em5::FreeplayGameMode::updateGameMode ( qsf::Time  timePassed)
overridevirtual

Member Data Documentation

qsf::MessageProxy em5::FreeplayGameMode::mCutsceneMessageProxy
protected
bool em5::FreeplayGameMode::mFirstEventCompleted
protected
bool em5::FreeplayGameMode::mIsPlayingIntro
protected
MapIdentifier em5::FreeplayGameMode::mMapIdentifier
protected

The current map.


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