Emergency 20 Dokumentation  4.2.0
em5::HintHelper Class Reference

Hint helper can create hint observers. More...

#include <HintHelper.h>

Public Types

typedef std::vector< std::string > StringArray
 

Public Member Functions

 HintHelper (FreeplayEvent &freeplayEvent)
 Constructor. More...
 
 ~HintHelper ()
 Destructor. More...
 
EventHintParametersgetHintParameters () const
 Get the hint parameters of the event. More...
 
void createAndInitializeHintsAtLowHealth (const qsf::Entity &targetEntity) const
 
void createAndInitializeHintsAtLowLife (const qsf::Entity &targetEntity) const
 
void createAndInitializeHintsAtInjured (const qsf::Entity &targetEntity) const
 
void createAndInitializeGeneralHintAtDamagedVehicle () const
 
void createAndInitializeGeneralHintAtInfectedObserver () const
 
void createAndInitializeGeneralHintsAtInjured () const
 
void createAndInitializeGeneralHintsForMessageObserver (const qsf::MessageConfiguration &messageConfiguration, const qsf::Time &timeFrame, const bool messageCreated) const
 

Static Public Member Functions

static std::string getRandomStringOfStringArray (StringArray &stringArray)
 Get random string of string array. More...
 
static std::string getRandomStringOfIdString (const std::string &idString)
 Get random hint ID out of string of hint IDs. More...
 
static void showHint (const std::string &hintId, uint32 playerIndex=qsf::getUninitialized< uint32 >(0), qsf::Time blockedTime=qsf::Time::ZERO)
 
static void showTextHint (const std::string &hintId, uint32 playerIndex=qsf::getUninitialized< uint32 >(0), qsf::Time blockedTime=qsf::Time::ZERO)
 
static void showUnitHint (const std::string &unitHintId, uint32 playerIndex=qsf::getUninitialized< uint32 >(0), qsf::Time blockedTime=qsf::Time::ZERO)
 
static void showSupervisorMessage (const std::string &messageId, bool audioOnly=false)
 
static void clearHints ()
 Clears the hint system from any hint not yet played, stops the current running hint and clears the "hint" window. More...
 

Detailed Description

Hint helper can create hint observers.

Member Typedef Documentation

typedef std::vector<std::string> em5::HintHelper::StringArray

Constructor & Destructor Documentation

em5::HintHelper::HintHelper ( FreeplayEvent freeplayEvent)
explicit

Constructor.

em5::HintHelper::~HintHelper ( )

Destructor.

Member Function Documentation

static void em5::HintHelper::clearHints ( )
static

Clears the hint system from any hint not yet played, stops the current running hint and clears the "hint" window.

void em5::HintHelper::createAndInitializeGeneralHintAtDamagedVehicle ( ) const
void em5::HintHelper::createAndInitializeGeneralHintAtInfectedObserver ( ) const
void em5::HintHelper::createAndInitializeGeneralHintsAtInjured ( ) const
void em5::HintHelper::createAndInitializeGeneralHintsForMessageObserver ( const qsf::MessageConfiguration messageConfiguration,
const qsf::Time timeFrame,
const bool  messageCreated 
) const
void em5::HintHelper::createAndInitializeHintsAtInjured ( const qsf::Entity targetEntity) const
void em5::HintHelper::createAndInitializeHintsAtLowHealth ( const qsf::Entity targetEntity) const
void em5::HintHelper::createAndInitializeHintsAtLowLife ( const qsf::Entity targetEntity) const
EventHintParameters& em5::HintHelper::getHintParameters ( ) const

Get the hint parameters of the event.

static std::string em5::HintHelper::getRandomStringOfIdString ( const std::string &  idString)
static

Get random hint ID out of string of hint IDs.

static std::string em5::HintHelper::getRandomStringOfStringArray ( StringArray stringArray)
static

Get random string of string array.

Returns
If the string array is filled, return a random string of this array, or "off" string otherwise
static void em5::HintHelper::showHint ( const std::string &  hintId,
uint32  playerIndex = qsf::getUninitializeduint32 >(0),
qsf::Time  blockedTime = qsf::Time::ZERO 
)
static
static void em5::HintHelper::showSupervisorMessage ( const std::string &  messageId,
bool  audioOnly = false 
)
static
static void em5::HintHelper::showTextHint ( const std::string &  hintId,
uint32  playerIndex = qsf::getUninitializeduint32 >(0),
qsf::Time  blockedTime = qsf::Time::ZERO 
)
static
static void em5::HintHelper::showUnitHint ( const std::string &  unitHintId,
uint32  playerIndex = qsf::getUninitializeduint32 >(0),
qsf::Time  blockedTime = qsf::Time::ZERO 
)
static

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