Emergency 20 Dokumentation  4.2.0
em5::HintSystem Class Reference

Hint system knows how to trigger hints and delegates hint calls from gameplay to GUI. More...

#include <HintSystem.h>

Inheritance diagram for em5::HintSystem:

Public Member Functions

 HintSystem ()
 Default constructor. More...
 
virtual ~HintSystem ()
 Destructor. More...
 
void addMessage (const std::string &messageId, HintMessage::MessageType messageType, uint32 playerIndex=qsf::getUninitialized< uint32 >(0), qsf::Time blockedTime=qsf::Time::ZERO)
 Enqueue a message in the hint system. More...
 
void update (const qsf::JobArguments &jobArguments)
 Update other windows and detects starting new hints. More...
 
void repeatLastHint ()
 Show the last hint again. More...
 
void stopCurrentHint ()
 Stop the current hint. More...
 
void clear ()
 Remove any not played hint from the list. More...
 
bool isSupervisorWindowOpen () const
 

Detailed Description

Hint system knows how to trigger hints and delegates hint calls from gameplay to GUI.

Constructor & Destructor Documentation

em5::HintSystem::HintSystem ( )

Default constructor.

virtual em5::HintSystem::~HintSystem ( )
virtual

Destructor.

Member Function Documentation

void em5::HintSystem::addMessage ( const std::string &  messageId,
HintMessage::MessageType  messageType,
uint32  playerIndex = qsf::getUninitializeduint32 >(0),
qsf::Time  blockedTime = qsf::Time::ZERO 
)

Enqueue a message in the hint system.

void em5::HintSystem::clear ( )

Remove any not played hint from the list.

bool em5::HintSystem::isSupervisorWindowOpen ( ) const
void em5::HintSystem::repeatLastHint ( )

Show the last hint again.

void em5::HintSystem::stopCurrentHint ( )

Stop the current hint.

void em5::HintSystem::update ( const qsf::JobArguments jobArguments)

Update other windows and detects starting new hints.


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