Emergency 20 Dokumentation  4.2.0
em5::HintMessage Class Reference

Hint message contains information about the text, sound file, video file the hint system needs. More...

#include <HintMessage.h>

Public Types

enum  MessageType {
  MESSAGETYPE_UNKNOWN, MESSAGETYPE_HINT, MESSAGETYPE_TEXTHINT, MESSAGETYPE_UNITHINT,
  MESSAGETYPE_SUPERVISOR_VIDEO, MESSAGETYPE_SUPERVISOR_AUDIO, MESSAGETYPE_SUPERVISOR_PURE_AUDIO
}
 

Public Member Functions

 HintMessage ()
 Constructor. More...
 
 HintMessage (MessageType messageType, const std::string &messageText, const std::string &audioFile, uint32 playerIndex)
 
virtual ~HintMessage ()
 Destructor. More...
 
MessageType getMessageType () const
 
const std::string & getMessageText () const
 
const std::string & getAudioFile () const
 
uint32 getPlayerIndex () const
 

Detailed Description

Hint message contains information about the text, sound file, video file the hint system needs.

Member Enumeration Documentation

Enumerator
MESSAGETYPE_UNKNOWN 

Unknown message type.

MESSAGETYPE_HINT 

Hint with text message and audio output.

MESSAGETYPE_TEXTHINT 

Hint with text message, but no audio output.

MESSAGETYPE_UNITHINT 

Unit hint with audio output only.

MESSAGETYPE_SUPERVISOR_VIDEO 

Supervisor message with text and video + audio output, attention! We don't use videos anymore. Now we use RTT.

MESSAGETYPE_SUPERVISOR_AUDIO 

Supervisor message with text and audio output.

MESSAGETYPE_SUPERVISOR_PURE_AUDIO 

Supervisor message with audio output only, no text.

Constructor & Destructor Documentation

em5::HintMessage::HintMessage ( )
inline

Constructor.

em5::HintMessage::HintMessage ( MessageType  messageType,
const std::string &  messageText,
const std::string &  audioFile,
uint32  playerIndex 
)
inline
em5::HintMessage::~HintMessage ( )
inlinevirtual

Destructor.

Member Function Documentation

const std::string & em5::HintMessage::getAudioFile ( ) const
inline
const std::string & em5::HintMessage::getMessageText ( ) const
inline
HintMessage::MessageType em5::HintMessage::getMessageType ( ) const
inline
uint32 em5::HintMessage::getPlayerIndex ( ) const
inline

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