Emergency 20 Dokumentation  4.2.0
em5::CampaignGameMode Class Reference

EMERGENCY 5 campaign game mode. More...

#include <CampaignGameMode.h>

Inheritance diagram for em5::CampaignGameMode:
em5::FreeplayGameMode em5::GameMode qsf::Object

Public Member Functions

 CampaignGameMode ()
 Default constructor. More...
 
virtual ~CampaignGameMode ()
 Destructor. More...
 
void initNextMap (bool triggerStartGame)
 Go to next map in campaign progress. More...
 
bool isMainEvent () const
 Are we in a main-event phase right now? More...
 
bool isMiniEvent () const
 Are we in a mini-event phase right now? More...
 
bool getReceivedRepeatSignal () const
 Received repeat signal? 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::FreeplayGameMode
 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...
 
- 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) override
 
virtual void onEventFailed (const qsf::MessageParameters &parameters) override
 
virtual void onReceiveObjectivePoints (const qsf::MessageParameters &parameters) override
 
virtual void onSetPointGain (const FreeplayEvent::EventResult &eventResult, int32 pointGain) override
 
virtual std::string getIntroVideo (uint32 index) override
 
- Protected Member Functions inherited from em5::FreeplayGameMode
virtual void onEventCompleted (const qsf::MessageParameters &parameters)
 
virtual void onFirstEventCompleted ()
 
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...
 

Friends

class FreeplaySystem
 

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 Attributes inherited from em5::FreeplayGameMode
MapIdentifier mMapIdentifier
 The current map. More...
 
bool mIsPlayingIntro
 
bool mFirstEventCompleted
 
qsf::MessageProxy mCutsceneMessageProxy
 

Detailed Description

EMERGENCY 5 campaign game mode.

Constructor & Destructor Documentation

em5::CampaignGameMode::CampaignGameMode ( )

Default constructor.

virtual em5::CampaignGameMode::~CampaignGameMode ( )
virtual

Destructor.

Member Function Documentation

virtual std::string em5::CampaignGameMode::getGameModeAsString ( ) const
overridevirtual

Return the game mode type as string (lowercase)

Reimplemented from em5::FreeplayGameMode.

virtual std::string em5::CampaignGameMode::getIntroVideo ( uint32  index)
overrideprotectedvirtual

Reimplemented from em5::FreeplayGameMode.

bool em5::CampaignGameMode::getReceivedRepeatSignal ( ) const

Received repeat signal?

void em5::CampaignGameMode::initNextMap ( bool  triggerStartGame)

Go to next map in campaign progress.

bool em5::CampaignGameMode::isMainEvent ( ) const

Are we in a main-event phase right now?

bool em5::CampaignGameMode::isMiniEvent ( ) const

Are we in a mini-event phase right now?

virtual void em5::CampaignGameMode::onEventFailed ( const qsf::MessageParameters parameters)
overrideprotectedvirtual

Reimplemented from em5::FreeplayGameMode.

virtual void em5::CampaignGameMode::onEventSucceeded ( const qsf::MessageParameters parameters)
overrideprotectedvirtual

Reimplemented from em5::FreeplayGameMode.

virtual void em5::CampaignGameMode::onGameLoaded ( )
overridevirtual

Reimplemented from em5::FreeplayGameMode.

virtual void em5::CampaignGameMode::onReceiveObjectivePoints ( const qsf::MessageParameters parameters)
overrideprotectedvirtual

Reimplemented from em5::FreeplayGameMode.

virtual void em5::CampaignGameMode::onSendGameModeSignal ( const std::string &  gameModeSignal)
overridevirtual

Reimplemented from em5::FreeplayGameMode.

virtual void em5::CampaignGameMode::onSetPointGain ( const FreeplayEvent::EventResult eventResult,
int32  pointGain 
)
overrideprotectedvirtual

Reimplemented from em5::FreeplayGameMode.

virtual void em5::CampaignGameMode::shutdown ( )
overridevirtual

Reimplemented from em5::FreeplayGameMode.

virtual void em5::CampaignGameMode::startup ( )
overridevirtual

Reimplemented from em5::FreeplayGameMode.

virtual void em5::CampaignGameMode::updateGameMode ( qsf::Time  timePassed)
overridevirtual

Reimplemented from em5::FreeplayGameMode.

Friends And Related Function Documentation

friend class FreeplaySystem
friend

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