Emergency 20 Dokumentation  4.2.0
HintMessage.h
Go to the documentation of this file.
1 // Copyright (C) 2012-2018 Promotion Software GmbH
2 
3 
4 //[-------------------------------------------------------]
5 //[ Header guard ]
6 //[-------------------------------------------------------]
7 #pragma once
8 
9 
10 //[-------------------------------------------------------]
11 //[ Includes ]
12 //[-------------------------------------------------------]
13 #include "em5/Export.h"
14 
15 #include <string>
16 
17 
18 //[-------------------------------------------------------]
19 //[ Namespace ]
20 //[-------------------------------------------------------]
21 namespace em5
22 {
23 
24 
25  //[-------------------------------------------------------]
26  //[ Classes ]
27  //[-------------------------------------------------------]
33  {
34 
35 
36  //[-------------------------------------------------------]
37  //[ Public definitions ]
38  //[-------------------------------------------------------]
39  public:
41  {
48  MESSAGETYPE_SUPERVISOR_PURE_AUDIO
49  };
50 
51 
52  //[-------------------------------------------------------]
53  //[ Public methods ]
54  //[-------------------------------------------------------]
55  public:
60  inline HintMessage();
61  inline HintMessage(MessageType messageType, const std::string& messageText, const std::string& audioFile, uint32 playerIndex);
62 
67  inline virtual ~HintMessage();
68 
69  inline MessageType getMessageType() const;
70  inline const std::string& getMessageText() const;
71  inline const std::string& getAudioFile() const;
72  inline uint32 getPlayerIndex() const;
73 
74 
75  //[-------------------------------------------------------]
76  //[ Private data ]
77  //[-------------------------------------------------------]
78  private:
79  MessageType mMessageType;
80  std::string mMessageText;
81  std::string mAudioFile;
82  uint32 mPlayerIndex;
83 
84 
85  };
86 
87 
88 //[-------------------------------------------------------]
89 //[ Namespace ]
90 //[-------------------------------------------------------]
91 } // em5
92 
93 
94 //[-------------------------------------------------------]
95 //[ Implementation ]
96 //[-------------------------------------------------------]
Definition: ActionPriority.h:13
Supervisor message with text and video + audio output, attention! We don't use videos anymore...
Definition: HintMessage.h:46
unsigned int uint32
Definition: PlatformTypes.h:181
Unit hint with audio output only.
Definition: HintMessage.h:45
#define EM5_API_EXPORT
Definition: Export.h:28
Unknown message type.
Definition: HintMessage.h:42
Hint with text message and audio output.
Definition: HintMessage.h:43
MessageType
Definition: MultiplayerProxyTypes.h:32
Supervisor message with text and audio output.
Definition: HintMessage.h:47
Hint message contains information about the text, sound file, video file the hint system needs...
Definition: HintMessage.h:32
MessageType
Definition: HintMessage.h:40
Hint with text message, but no audio output.
Definition: HintMessage.h:44