File: GameChatHandler.h

package info (click to toggle)
vcmi 1.6.5%2Bdfsg-2
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid, trixie
  • size: 32,060 kB
  • sloc: cpp: 238,971; python: 265; sh: 224; xml: 157; ansic: 78; objc: 61; makefile: 49
file content (47 lines) | stat: -rw-r--r-- 1,678 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/*
 * GameChatHandler.h, part of VCMI engine
 *
 * Authors: listed in file AUTHORS in main folder
 *
 * License: GNU General Public License v2.0 or later
 * Full text of license available in license.txt file, in main folder
 *
 */
#pragma once

#include "../lib/constants/EntityIdentifiers.h"

struct GameChatMessage
{
	std::string senderName;
	std::string messageText;
	std::string dateFormatted;
};

/// Class that manages game chat for current game match
/// Used for all matches - singleplayer, local multiplayer, online multiplayer
class GameChatHandler : boost::noncopyable
{
	std::vector<GameChatMessage> chatHistory;
public:
	/// Returns all message history for current match
	const std::vector<GameChatMessage> & getChatHistory() const;

	/// Erases any local state, must be called when client disconnects from match server
	void resetMatchState();

	/// Must be called when local player sends new message into chat from gameplay mode (adventure map)
	void sendMessageGameplay(const std::string & messageText);

	/// Must be called when local player sends new message into chat from pregame mode (match lobby)
	void sendMessageLobby(const std::string & senderName, const std::string & messageText);

	/// Must be called when client receives new chat message from server
	void onNewLobbyMessageReceived(const std::string & senderName, const std::string & messageText);

	/// Must be called when client receives new chat message from server
	void onNewGameMessageReceived(PlayerColor sender, const std::string & messageText);

	/// Must be called when client receives new message from "system" sender
	void onNewSystemMessageReceived(const std::string & messageText);
};