Emergency 20 Dokumentation  4.2.0
em5::GameDebugGroup Class Reference

Game debug group implementation. More...

#include <GameDebugGroup.h>

Inheritance diagram for em5::GameDebugGroup:
qsf::DebugGroup qsf::UniqueInstance< GameDebugGroup > qsf::ParameterGroup qsf::Pluginable< ParameterGroupManager > qsf::PluginableBase qsf::Object

Public Member Functions

 GameDebugGroup (qsf::DebugGroupManager *debugGroupManager)
 Constructor. More...
 
virtual ~GameDebugGroup ()
 Destructor. More...
 
bool getShowHealthState () const
 Get the current show health state. More...
 
void setShowHealthState (bool showHealthState)
 Set show health state. More...
 
bool getShowEventDebug () const
 Get the current show event debug. More...
 
void setActiveFreeplay (bool activeFreeplay)
 Set the freeplay system active or not. More...
 
bool getShowEventDensity () const
 Get if the event density debug is shown. More...
 
void setShowEventDensity (bool showEventDensity)
 Set if the event density debug is shown. More...
 
bool getShowEventFailConditions () const
 Get if the event fail conditions debug is shown. More...
 
void setShowEventFailConditions (bool showEventFailConditions)
 Set if the event fail conditions debug is shown. More...
 
void setShowEventDebug (bool showEventDebug)
 Set show event debug. More...
 
bool getShowContaminationRadius () const
 Get the fire debug display of contamination components. More...
 
void setShowContaminationRadius (bool showContaminationRadius)
 Set show contamination debug display. More...
 
bool getShowDebugTextComponent () const
 Get show debug text component display. More...
 
void setShowDebugTextComponent (bool showDebugTextComponent)
 Set show debug text component display. More...
 
bool getShowFireDebug () const
 Get the fire debug display of fire components. More...
 
void setShowFireDebug (bool showFireDebug)
 Set show fire debug display. More...
 
bool getShowFireRadius () const
 Get the fire radius display of fire components. More...
 
void setShowFireRadius (bool showFireRadius)
 Set show fire radius. More...
 
bool getShowFireReceiver () const
 Get the fire receiver display of fire components. More...
 
void setShowFireReceiver (bool showFireReceiver)
 Set show fire receiver display. More...
 
bool getHideUserInterface () const
 Return "true" if the user interface is hidden. More...
 
void setHideUserInterface (bool hideUserInterface)
 Hide or show the user interface. More...
 
const qsf::AssetProxygetStartupMap () const
 Get the current startup map asset. More...
 
void setStartupMap (const qsf::AssetProxy &startupMap)
 Set startup map asset. More...
 
bool getActiveFreeplay () const
 Get if the freeplay system is active or not. More...
 
bool getShowAutomatismDebug () const
 Get if the automatism debug is shown. More...
 
void setShowAutomatismDebug (bool showAutomatismDebug)
 Set if the automatism debug is shown. More...
 
bool getShowActivitiesDebug () const
 Get if the activities debug is shown. More...
 
void setShowActivitiesDebug (bool showActivitiesDebug)
 Set if the activities debug is shown. More...
 
bool getShowDebugSelectionMarker () const
 Get if the debug selection marker is shown. More...
 
void setShowDebugSelectionMarker (bool showDebugSelectionMarker)
 Set if the debug selection marker is shown. More...
 
qsf::LogMessage::SeverityLevel getShowLogSeverityLevel () const
 Get the show log severity level. More...
 
void setShowLogSeverityLevel (qsf::LogMessage::SeverityLevel showLogSeverityLevel)
 Set the show log severity level. More...
 
- Public Member Functions inherited from qsf::DebugGroup
virtual ~DebugGroup ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::ParameterGroup
virtual ~ParameterGroup ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::Pluginable< ParameterGroupManager >
virtual ~Pluginable ()
 Destructor. More...
 
ParameterGroupManagergetManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::PluginableBase
virtual ~PluginableBase ()
 Destructor. More...
 
template<typename T >
T & getPluginableManager () const
 Return the pluginable manager this pluginable is in. 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 uint32 PLUGINABLE_ID
 "em5::GameDebugGroup" unique pluginable debug group ID More...
 
static const uint32 SHOW_FREEPLAY_EVENT_OBJECTIVES
 "ShowEventDebug" unique class property ID inside the class More...
 
static const uint32 SHOW_HEALTH_STATE
 "ShowHealthState" unique class property ID inside the class More...
 
static const uint32 SHOW_CONTAMINATION_RADIUS
 "ShowContaminationRadius" unique class property ID inside the class More...
 
static const uint32 SHOW_DEBUG_TEXT_COMPONENT
 "ShowDebugTextComponent" unique class property ID inside the class More...
 
static const uint32 SHOW_FIRE_DEBUG
 "ShowFireDebug" unique class property ID inside the class More...
 
static const uint32 SHOW_FIRE_RADIUS
 "ShowFireRadius" unique class property ID inside the class More...
 
static const uint32 SHOW_FIRE_RECEIVER
 "ShowFireReceiver" unique class property ID inside the class More...
 
static const uint32 HIDE_USER_INTERFACE
 "HideUserInterface" unique class property ID inside the class More...
 
static const uint32 STARTUP_MAP
 "StartupMap" unique class property ID inside the class More...
 
static const uint32 ACTIVE_FREEPLAY
 "ActiveFreeplay" unique class property ID inside the class More...
 
static const uint32 ACTIVE_CIVILSPAWN
 "ActiveCivilSpawn" unique class property ID inside the class More...
 
static const uint32 SHOW_EVENT_DENSITY
 "ShowEventDensity" unique class property ID inside the class More...
 
static const uint32 SHOW_EVENT_FAILCONDITIONS
 "ShowEventFailConditions" unique class property ID inside the class More...
 
static const uint32 SHOW_AUTOMATISM_DEBUG
 "ShowAutomatismDebug" unique class property ID inside the class More...
 
static const uint32 SHOW_ACTIVITIES_DEBUG
 "ShowActivitiesDebug" unique class property ID inside the class More...
 
static const uint32 SHOW_DEBUG_SELECTION_MARKER
 "ShowDebugSelectionMarker" unique class property ID inside the class More...
 
static const uint32 SHOW_LOG_SEVERITY_LEVEL
 "ShowLogSeverityLevel" unique class property ID inside the class More...
 
static const uint32 ENABLE_DEBUG_INPUT_HANDLER
 "EnableDebugInputHandler" unique class property ID inside the class More...
 

Additional Inherited Members

- Public Types inherited from qsf::DebugGroup
enum  DrawMode { SHOW_NONE = 0, SHOW_DEBUG = 1, SHOW_ALL = 2 }
 Draw mode. More...
 
- 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 }
 
- Static Public Member Functions inherited from qsf::UniqueInstance< GameDebugGroup >
static GameDebugGroup * getInstance ()
 Return the global unique instance. More...
 
static GameDebugGroup & getInstanceSafe ()
 Return the global unique instance. More...
 
- Protected Member Functions inherited from qsf::DebugGroup
 DebugGroup (DebugGroupManager *debugGroupManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::ParameterGroup
 ParameterGroup (ParameterGroupManager *parameterGroupManager)
 Constructor. More...
 
void promotePropertyChange (uint32 propertyId)
 A component property value was changed. More...
 
template<typename T >
bool assignAndPromoteChange (T &variable, const T &newValue, uint32 propertyId)
 Comfort function for updating an exported member variable and promoting any change that happened. More...
 
- Protected Member Functions inherited from qsf::Pluginable< ParameterGroupManager >
 Pluginable (ParameterGroupManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::PluginableBase
 PluginableBase (PluginableManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::UniqueInstance< GameDebugGroup >
 UniqueInstance ()
 Default constructor. More...
 
virtual ~UniqueInstance ()
 Destructor. More...
 

Detailed Description

Game debug group implementation.

Constructor & Destructor Documentation

em5::GameDebugGroup::GameDebugGroup ( qsf::DebugGroupManager debugGroupManager)
explicit

Constructor.

Parameters
[in]debugGroupManagerOptional pointer to the debug group manager this debug group should be registered to, can be a null pointer
virtual em5::GameDebugGroup::~GameDebugGroup ( )
virtual

Destructor.

Member Function Documentation

bool em5::GameDebugGroup::getActiveFreeplay ( ) const
inline

Get if the freeplay system is active or not.

bool em5::GameDebugGroup::getHideUserInterface ( ) const
inline

Return "true" if the user interface is hidden.

bool em5::GameDebugGroup::getShowActivitiesDebug ( ) const
inline

Get if the activities debug is shown.

bool em5::GameDebugGroup::getShowAutomatismDebug ( ) const
inline

Get if the automatism debug is shown.

bool em5::GameDebugGroup::getShowContaminationRadius ( ) const
inline

Get the fire debug display of contamination components.

bool em5::GameDebugGroup::getShowDebugSelectionMarker ( ) const
inline

Get if the debug selection marker is shown.

bool em5::GameDebugGroup::getShowDebugTextComponent ( ) const
inline

Get show debug text component display.

bool em5::GameDebugGroup::getShowEventDebug ( ) const
inline

Get the current show event debug.

Returns
The show event debug
bool em5::GameDebugGroup::getShowEventDensity ( ) const
inline

Get if the event density debug is shown.

bool em5::GameDebugGroup::getShowEventFailConditions ( ) const
inline

Get if the event fail conditions debug is shown.

bool em5::GameDebugGroup::getShowFireDebug ( ) const
inline

Get the fire debug display of fire components.

Returns
The fire debug display
bool em5::GameDebugGroup::getShowFireRadius ( ) const
inline

Get the fire radius display of fire components.

Returns
The fire radius value
bool em5::GameDebugGroup::getShowFireReceiver ( ) const
inline

Get the fire receiver display of fire components.

Returns
The fire receiver value
bool em5::GameDebugGroup::getShowHealthState ( ) const
inline

Get the current show health state.

Returns
The show health state
qsf::LogMessage::SeverityLevel em5::GameDebugGroup::getShowLogSeverityLevel ( ) const
inline

Get the show log severity level.

const qsf::AssetProxy & em5::GameDebugGroup::getStartupMap ( ) const
inline

Get the current startup map asset.

Returns
The startup map asset
void em5::GameDebugGroup::setActiveFreeplay ( bool  activeFreeplay)

Set the freeplay system active or not.

void em5::GameDebugGroup::setHideUserInterface ( bool  hideUserInterface)

Hide or show the user interface.

void em5::GameDebugGroup::setShowActivitiesDebug ( bool  showActivitiesDebug)

Set if the activities debug is shown.

void em5::GameDebugGroup::setShowAutomatismDebug ( bool  showAutomatismDebug)

Set if the automatism debug is shown.

void em5::GameDebugGroup::setShowContaminationRadius ( bool  showContaminationRadius)

Set show contamination debug display.

void em5::GameDebugGroup::setShowDebugSelectionMarker ( bool  showDebugSelectionMarker)

Set if the debug selection marker is shown.

void em5::GameDebugGroup::setShowDebugTextComponent ( bool  showDebugTextComponent)

Set show debug text component display.

void em5::GameDebugGroup::setShowEventDebug ( bool  showEventDebug)

Set show event debug.

Parameters
[in]Showevent debug text
void em5::GameDebugGroup::setShowEventDensity ( bool  showEventDensity)

Set if the event density debug is shown.

void em5::GameDebugGroup::setShowEventFailConditions ( bool  showEventFailConditions)

Set if the event fail conditions debug is shown.

void em5::GameDebugGroup::setShowFireDebug ( bool  showFireDebug)

Set show fire debug display.

Parameters
[in]showFireDebugShow fire debug display
void em5::GameDebugGroup::setShowFireRadius ( bool  showFireRadius)

Set show fire radius.

Parameters
[in]showFireRadiusShow fire radius values
void em5::GameDebugGroup::setShowFireReceiver ( bool  showFireReceiver)

Set show fire receiver display.

Parameters
[in]showFireReceiverShow fire receiver display
void em5::GameDebugGroup::setShowHealthState ( bool  showHealthState)

Set show health state.

Parameters
[in]showHealthStateShow health state
void em5::GameDebugGroup::setShowLogSeverityLevel ( qsf::LogMessage::SeverityLevel  showLogSeverityLevel)
inline

Set the show log severity level.

void em5::GameDebugGroup::setStartupMap ( const qsf::AssetProxy startupMap)

Set startup map asset.

Parameters
[in]startupMapStartup map asset

Member Data Documentation

const uint32 em5::GameDebugGroup::ACTIVE_CIVILSPAWN
static

"ActiveCivilSpawn" unique class property ID inside the class

const uint32 em5::GameDebugGroup::ACTIVE_FREEPLAY
static

"ActiveFreeplay" unique class property ID inside the class

const uint32 em5::GameDebugGroup::ENABLE_DEBUG_INPUT_HANDLER
static

"EnableDebugInputHandler" unique class property ID inside the class

const uint32 em5::GameDebugGroup::HIDE_USER_INTERFACE
static

"HideUserInterface" unique class property ID inside the class

const uint32 em5::GameDebugGroup::PLUGINABLE_ID
static

"em5::GameDebugGroup" unique pluginable debug group ID

const uint32 em5::GameDebugGroup::SHOW_ACTIVITIES_DEBUG
static

"ShowActivitiesDebug" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_AUTOMATISM_DEBUG
static

"ShowAutomatismDebug" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_CONTAMINATION_RADIUS
static

"ShowContaminationRadius" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_DEBUG_SELECTION_MARKER
static

"ShowDebugSelectionMarker" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_DEBUG_TEXT_COMPONENT
static

"ShowDebugTextComponent" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_EVENT_DENSITY
static

"ShowEventDensity" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_EVENT_FAILCONDITIONS
static

"ShowEventFailConditions" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_FIRE_DEBUG
static

"ShowFireDebug" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_FIRE_RADIUS
static

"ShowFireRadius" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_FIRE_RECEIVER
static

"ShowFireReceiver" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_FREEPLAY_EVENT_OBJECTIVES
static

"ShowEventDebug" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_HEALTH_STATE
static

"ShowHealthState" unique class property ID inside the class

const uint32 em5::GameDebugGroup::SHOW_LOG_SEVERITY_LEVEL
static

"ShowLogSeverityLevel" unique class property ID inside the class

const uint32 em5::GameDebugGroup::STARTUP_MAP
static

"StartupMap" unique class property ID inside the class


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