OpenTTD Source: src/network/network_chat_gui.cpp Source File

OpenTTD Source 15.0-RC2

network_chat_gui.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#include "../stdafx.h"
11#include "../strings_func.h"
12#include "../autocompletion.h"
13#include "../blitter/factory.hpp"
14#include "../console_func.h"
15#include "../video/video_driver.hpp"
16#include "../querystring_gui.h"
17#include "../town.h"
18#include "../window_func.h"
19#include "../toolbar_gui.h"
20#include "../zoom_func.h"
21#include "../timer/timer.h"
22#include "../timer/timer_window.h"
23#include "network.h"
24#include "network_client.h"
25#include "network_base.h"
26
27#include "../widgets/network_chat_widget.h"
28
29#include "table/strings.h"
30
31#include "../safeguards.h"
32
34 static const uint NETWORK_CHAT_LINE_SPACING = 3;
35
37 struct ChatMessage {
38 std::string message;
39 TextColour colour;
40 std::chrono::steady_clock::time_point remove_time;
41};
42
43/* used for chat window */
44 static std::deque<ChatMessage> _chatmsg_list;
45 static bool _chatmessage_dirty = false;
46 static bool _chatmessage_visible = false;
47 static uint MAX_CHAT_MESSAGES = 0;
48
53 static std::chrono::steady_clock::time_point _chatmessage_dirty_time;
54
59 static PointDimension _chatmsg_box;
60 static ReusableBuffer<uint8_t> _chatmessage_backup;
61
67 static inline bool HaveChatMessages(bool show_all)
68{
69 if (show_all) return !_chatmsg_list.empty();
70
71 auto now = std::chrono::steady_clock::now();
72 for (auto &cmsg : _chatmsg_list) {
73 if (cmsg.remove_time >= now) return true;
74 }
75
76 return false;
77}
78
85 void CDECL NetworkAddChatMessage(TextColour colour, uint duration, const std::string &message)
86{
87 if (_chatmsg_list.size() == MAX_CHAT_MESSAGES) {
88 _chatmsg_list.pop_back();
89 }
90
91 ChatMessage *cmsg = &_chatmsg_list.emplace_front();
92 cmsg->message = message;
93 cmsg->colour = colour;
94 cmsg->remove_time = std::chrono::steady_clock::now() + std::chrono::seconds(duration);
95
96 _chatmessage_dirty_time = std::chrono::steady_clock::now();
97 _chatmessage_dirty = true;
98}
99
101 void NetworkReInitChatBoxSize()
102{
103 _chatmsg_box.y = 3 * GetCharacterHeight(FS_NORMAL);
104 _chatmsg_box.height = MAX_CHAT_MESSAGES * (GetCharacterHeight(FS_NORMAL) + ScaleGUITrad(NETWORK_CHAT_LINE_SPACING)) + ScaleGUITrad(4);
105}
106
108 void NetworkInitChatMessage()
109{
110 MAX_CHAT_MESSAGES = _settings_client.gui.network_chat_box_height;
111
112 _chatmsg_list.clear();
113 _chatmsg_box.x = ScaleGUITrad(10);
114 _chatmsg_box.width = _settings_client.gui.network_chat_box_width_pct * _screen.width / 100;
115 NetworkReInitChatBoxSize();
116 _chatmessage_visible = false;
117}
118
120 void NetworkUndrawChatMessage()
121{
122 /* Sometimes we also need to hide the cursor
123 * This is because both textmessage and the cursor take a shot of the
124 * screen before drawing.
125 * Now the textmessage takes its shot and paints its data before the cursor
126 * does, so in the shot of the cursor is the screen-data of the textmessage
127 * included when the cursor hangs somewhere over the textmessage. To
128 * avoid wrong repaints, we undraw the cursor in that case, and everything
129 * looks nicely ;)
130 * (and now hope this story above makes sense to you ;))
131 */
132 if (_cursor.visible &&
133 _cursor.draw_pos.x + _cursor.draw_size.x >= _chatmsg_box.x &&
134 _cursor.draw_pos.x <= _chatmsg_box.x + _chatmsg_box.width &&
135 _cursor.draw_pos.y + _cursor.draw_size.y >= _screen.height - _chatmsg_box.y - _chatmsg_box.height &&
136 _cursor.draw_pos.y <= _screen.height - _chatmsg_box.y) {
137 UndrawMouseCursor();
138 }
139
140 if (_chatmessage_visible) {
141 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
142 int x = _chatmsg_box.x;
143 int y = _screen.height - _chatmsg_box.y - _chatmsg_box.height;
144 int width = _chatmsg_box.width;
145 int height = _chatmsg_box.height;
146 if (y < 0) {
147 height = std::max(height + y, std::min(_chatmsg_box.height, _screen.height));
148 y = 0;
149 }
150 if (x + width >= _screen.width) {
151 width = _screen.width - x;
152 }
153 if (width <= 0 || height <= 0) return;
154
155 _chatmessage_visible = false;
156 /* Put our 'shot' back to the screen */
157 blitter->CopyFromBuffer(blitter->MoveTo(_screen.dst_ptr, x, y), _chatmessage_backup.GetBuffer(), width, height);
158 /* And make sure it is updated next time */
159 VideoDriver::GetInstance()->MakeDirty(x, y, width, height);
160
161 _chatmessage_dirty_time = std::chrono::steady_clock::now();
162 _chatmessage_dirty = true;
163 }
164}
165
167 static const IntervalTimer<TimerWindow> network_message_expired_interval(std::chrono::seconds(1), [](auto) {
168 auto now = std::chrono::steady_clock::now();
169 for (auto &cmsg : _chatmsg_list) {
170 /* Message has expired, remove from the list */
171 if (now > cmsg.remove_time && _chatmessage_dirty_time < cmsg.remove_time) {
172 _chatmessage_dirty_time = now;
173 _chatmessage_dirty = true;
174 break;
175 }
176 }
177});
178
180 void NetworkDrawChatMessage()
181{
182 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
183 if (!_chatmessage_dirty) return;
184
185 const Window *w = FindWindowByClass(WC_SEND_NETWORK_MSG);
186 bool show_all = (w != nullptr);
187
188 /* First undraw if needed */
189 NetworkUndrawChatMessage();
190
191 if (_iconsole_mode == ICONSOLE_FULL) return;
192
193 /* Check if we have anything to draw at all */
194 if (!HaveChatMessages(show_all)) return;
195
196 int x = _chatmsg_box.x;
197 int y = _screen.height - _chatmsg_box.y - _chatmsg_box.height;
198 int width = _chatmsg_box.width;
199 int height = _chatmsg_box.height;
200 if (y < 0) {
201 height = std::max(height + y, std::min(_chatmsg_box.height, _screen.height));
202 y = 0;
203 }
204 if (x + width >= _screen.width) {
205 width = _screen.width - x;
206 }
207 if (width <= 0 || height <= 0) return;
208
209 /* Make a copy of the screen as it is before painting (for undraw) */
210 uint8_t *buffer = _chatmessage_backup.Allocate(BlitterFactory::GetCurrentBlitter()->BufferSize(width, height));
211 blitter->CopyToBuffer(blitter->MoveTo(_screen.dst_ptr, x, y), buffer, width, height);
212
213 _cur_dpi = &_screen; // switch to _screen painting
214
215 auto now = std::chrono::steady_clock::now();
216 int string_height = 0;
217 for (auto &cmsg : _chatmsg_list) {
218 if (!show_all && cmsg.remove_time < now) continue;
219 string_height += GetStringLineCount(GetString(STR_JUST_RAW_STRING, cmsg.message), width - 1) * GetCharacterHeight(FS_NORMAL) + NETWORK_CHAT_LINE_SPACING;
220 }
221
222 string_height = std::min<uint>(string_height, MAX_CHAT_MESSAGES * (GetCharacterHeight(FS_NORMAL) + NETWORK_CHAT_LINE_SPACING));
223
224 int top = _screen.height - _chatmsg_box.y - string_height - 2;
225 int bottom = _screen.height - _chatmsg_box.y - 2;
226 /* Paint a half-transparent box behind the chat messages */
227 GfxFillRect(_chatmsg_box.x, top - 2, _chatmsg_box.x + _chatmsg_box.width - 1, bottom,
228 PALETTE_TO_TRANSPARENT, FILLRECT_RECOLOUR // black, but with some alpha for background
229 );
230
231 /* Paint the chat messages starting with the lowest at the bottom */
232 int ypos = bottom - 2;
233
234 for (auto &cmsg : _chatmsg_list) {
235 if (!show_all && cmsg.remove_time < now) continue;
236 ypos = DrawStringMultiLine(_chatmsg_box.x + ScaleGUITrad(3), _chatmsg_box.x + _chatmsg_box.width - 1, top, ypos, cmsg.message, cmsg.colour, SA_LEFT | SA_BOTTOM | SA_FORCE) - NETWORK_CHAT_LINE_SPACING;
237 if (ypos < top) break;
238 }
239
240 /* Make sure the data is updated next flush */
241 VideoDriver::GetInstance()->MakeDirty(x, y, width, height);
242
243 _chatmessage_visible = true;
244 _chatmessage_dirty = false;
245}
246
253 static void SendChat(std::string_view buf, DestType type, int dest)
254{
255 if (buf.empty()) return;
256 if (!_network_server) {
257 MyClient::SendChat((NetworkAction)(NETWORK_ACTION_CHAT + type), type, dest, buf, 0);
258 } else {
259 NetworkServerSendChat((NetworkAction)(NETWORK_ACTION_CHAT + type), type, dest, buf, CLIENT_ID_SERVER);
260 }
261}
262
263 class NetworkChatAutoCompletion final : public AutoCompletion {
264public:
265 using AutoCompletion::AutoCompletion;
266
267private:
268 std::vector<std::string> GetSuggestions([[maybe_unused]] std::string_view prefix, std::string_view query) override
269 {
270 std::vector<std::string> suggestions;
271 for (NetworkClientInfo *ci : NetworkClientInfo::Iterate()) {
272 if (ci->client_name.starts_with(query)) {
273 suggestions.push_back(ci->client_name);
274 }
275 }
276 for (const Town *t : Town::Iterate()) {
277 /* Get the town-name via the string-system */
278 std::string town_name = GetString(STR_TOWN_NAME, t->index);
279 if (town_name.starts_with(query)) {
280 suggestions.push_back(std::move(town_name));
281 }
282 }
283 return suggestions;
284 }
285
286 void ApplySuggestion(std::string_view prefix, std::string_view suggestion) override
287 {
288 /* Add ': ' if we are at the start of the line (pretty) */
289 if (prefix.empty()) {
290 this->textbuf->Assign(fmt::format("{}: ", suggestion));
291 } else {
292 this->textbuf->Assign(fmt::format("{}{} ", prefix, suggestion));
293 }
294 }
295};
296
298 struct NetworkChatWindow : public Window {
299 DestType dtype{};
300 int dest = 0;
301 QueryString message_editbox;
302 NetworkChatAutoCompletion chat_tab_completion;
303
310 NetworkChatWindow(WindowDesc &desc, DestType type, int dest)
311 : Window(desc), dtype(type), dest(dest), message_editbox(NETWORK_CHAT_LENGTH), chat_tab_completion(&message_editbox.text)
312 {
313 this->querystrings[WID_NC_TEXTBOX] = &this->message_editbox;
314 this->message_editbox.cancel_button = WID_NC_CLOSE;
315 this->message_editbox.ok_button = WID_NC_SENDBUTTON;
316
317 this->CreateNestedTree();
318 this->FinishInitNested(type);
319
320 this->SetFocusedWidget(WID_NC_TEXTBOX);
321 InvalidateWindowData(WC_NEWS_WINDOW, 0, this->height);
322
323 PositionNetworkChatWindow(this);
324 }
325
326 void Close([[maybe_unused]] int data = 0) override
327 {
328 InvalidateWindowData(WC_NEWS_WINDOW, 0, 0);
329 this->Window::Close();
330 }
331
332 void FindWindowPlacementAndResize(int, int def_height, bool allow_resize) override
333 {
334 Window::FindWindowPlacementAndResize(_toolbar_width, def_height, allow_resize);
335 }
336
340 void ChatTabCompletion()
341 {
342 if (this->chat_tab_completion.AutoComplete()) {
343 this->SetDirty();
344 }
345 }
346
347 Point OnInitialPosition([[maybe_unused]] int16_t sm_width, [[maybe_unused]] int16_t sm_height, [[maybe_unused]] int window_number) override
348 {
349 Point pt = { 0, _screen.height - sm_height - FindWindowById(WC_STATUS_BAR, 0)->height };
350 return pt;
351 }
352
353 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
354 {
355 if (widget != WID_NC_DESTINATION) return this->Window::GetWidgetString(widget, stringid);
356
357 static const StringID chat_captions[] = {
358 STR_NETWORK_CHAT_ALL_CAPTION,
359 STR_NETWORK_CHAT_COMPANY_CAPTION,
360 STR_NETWORK_CHAT_CLIENT_CAPTION
361 };
362 assert((uint)this->dtype < lengthof(chat_captions));
363
364 if (this->dtype == DESTTYPE_CLIENT) {
365 return GetString(STR_NETWORK_CHAT_CLIENT_CAPTION, NetworkClientInfo::GetByClientID((ClientID)this->dest)->client_name);
366 }
367
368 return GetString(chat_captions[this->dtype]);
369 }
370
371 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
372 {
373 switch (widget) {
374 case WID_NC_SENDBUTTON: /* Send */
375 SendChat(this->message_editbox.text.GetText(), this->dtype, this->dest);
376 [[fallthrough]];
377
378 case WID_NC_CLOSE: /* Cancel */
379 this->Close();
380 break;
381 }
382 }
383
384 EventState OnKeyPress([[maybe_unused]] char32_t key, uint16_t keycode) override
385 {
386 EventState state = ES_NOT_HANDLED;
387 if (keycode == WKC_TAB) {
388 ChatTabCompletion();
389 state = ES_HANDLED;
390 }
391 return state;
392 }
393
394 void OnEditboxChanged(WidgetID widget) override
395 {
396 if (widget == WID_NC_TEXTBOX) {
397 this->chat_tab_completion.Reset();
398 }
399 }
400
406 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
407 {
408 if (data == this->dest) this->Close();
409 }
410};
411
413 static constexpr std::initializer_list<NWidgetPart> _nested_chat_window_widgets = {
414 NWidget(NWID_HORIZONTAL),
415 NWidget(WWT_CLOSEBOX, COLOUR_GREY, WID_NC_CLOSE),
416 NWidget(WWT_PANEL, COLOUR_GREY, WID_NC_BACKGROUND),
417 NWidget(NWID_HORIZONTAL),
418 NWidget(WWT_TEXT, INVALID_COLOUR, WID_NC_DESTINATION), SetMinimalSize(62, 12), SetPadding(1, 0, 1, 0), SetAlignment(SA_VERT_CENTER | SA_RIGHT),
419 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_NC_TEXTBOX), SetMinimalSize(100, 0), SetPadding(1, 0, 1, 0), SetResize(1, 0),
420 SetStringTip(STR_NETWORK_CHAT_OSKTITLE),
421 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_NC_SENDBUTTON), SetMinimalSize(62, 12), SetPadding(1, 0, 1, 0), SetStringTip(STR_NETWORK_CHAT_SEND),
422 EndContainer(),
423 EndContainer(),
424 EndContainer(),
425};
426
428 static WindowDesc _chat_window_desc(
429 WDP_MANUAL, {}, 0, 0,
430 WC_SEND_NETWORK_MSG, WC_NONE,
431 {},
432 _nested_chat_window_widgets
433);
434
435
441 void ShowNetworkChatQueryWindow(DestType type, int dest)
442{
443 CloseWindowByClass(WC_SEND_NETWORK_MSG);
444 new NetworkChatWindow(_chat_window_desc, type, dest);
445}
AutoCompletion
Definition autocompletion.h:15
AutoCompletion::AutoComplete
bool AutoComplete()
Definition autocompletion.cpp:23
AutoCompletion::query
std::string_view query
Last token of the text. This is used to based the suggestions on.
Definition autocompletion.h:23
AutoCompletion::prefix
std::string_view prefix
Prefix of the text before the last space.
Definition autocompletion.h:22
BlitterFactory::GetCurrentBlitter
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition factory.hpp:136
Blitter
How all blitters should look like.
Definition base.hpp:29
Blitter::MoveTo
virtual void * MoveTo(void *video, int x, int y)=0
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
Blitter::CopyToBuffer
virtual void CopyToBuffer(const void *video, void *dst, int width, int height)=0
Copy from the screen to a buffer.
Blitter::CopyFromBuffer
virtual void CopyFromBuffer(void *video, const void *src, int width, int height)=0
Copy from a buffer to the screen.
ClientNetworkGameSocketHandler::SendChat
static NetworkRecvStatus SendChat(NetworkAction action, DestType type, int dest, std::string_view msg, int64_t data)
Send a chat-packet over the network.
Definition network_client.cpp:394
IntervalTimer
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
NetworkChatAutoCompletion
Definition network_chat_gui.cpp:263
ReusableBuffer
A reusable buffer that can be used for places that temporary allocate a bit of memory and do that ver...
Definition alloc_type.hpp:22
ReusableBuffer::GetBuffer
const T * GetBuffer() const
Get the currently allocated buffer.
Definition alloc_type.hpp:58
ReusableBuffer::Allocate
T * Allocate(size_t count)
Get buffer of at least count times T.
Definition alloc_type.hpp:34
VideoDriver::MakeDirty
virtual void MakeDirty(int left, int top, int width, int height)=0
Mark a particular area dirty.
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition video_driver.hpp:192
NETWORK_CHAT_LENGTH
static const uint NETWORK_CHAT_LENGTH
The maximum length of a chat message, in bytes including '\0'.
Definition config.h:61
ICONSOLE_FULL
@ ICONSOLE_FULL
In-game console is opened, whole screen.
Definition console_type.h:17
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:87
GetStringLineCount
int GetStringLineCount(std::string_view str, int maxw)
Calculates number of lines of string.
Definition gfx.cpp:736
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition gfx.cpp:782
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, const std::variant< PixelColour, PaletteID > &colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition gfx.cpp:115
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:249
SA_LEFT
@ SA_LEFT
Left align the text.
Definition gfx_type.h:388
SA_RIGHT
@ SA_RIGHT
Right align the text (must be a single bit).
Definition gfx_type.h:390
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition gfx_type.h:400
SA_BOTTOM
@ SA_BOTTOM
Bottom align the text.
Definition gfx_type.h:395
SA_VERT_CENTER
@ SA_VERT_CENTER
Vertically center the text.
Definition gfx_type.h:394
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:307
FILLRECT_RECOLOUR
@ FILLRECT_RECOLOUR
Apply a recolour sprite to the screen content.
Definition gfx_type.h:347
SetPadding
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
Definition widget_type.h:1332
SetStringTip
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
Definition widget_type.h:1240
SetMinimalSize
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition widget_type.h:1156
EndContainer
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition widget_type.h:1229
NWidget
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
Definition widget_type.h:1424
SetAlignment
constexpr NWidgetPart SetAlignment(StringAlignment align)
Widget part function for setting the alignment of text/images.
Definition widget_type.h:1208
SetResize
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
Definition widget_type.h:1145
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:966
_network_server
bool _network_server
network-server is active
Definition network.cpp:67
network.h
Basic functions/variables used all over the place.
network_base.h
Base core network types and some helper functions to access them.
MAX_CHAT_MESSAGES
static uint MAX_CHAT_MESSAGES
The limit of chat messages to show.
Definition network_chat_gui.cpp:47
NetworkDrawChatMessage
void NetworkDrawChatMessage()
Draw the chat message-box.
Definition network_chat_gui.cpp:180
_chatmessage_backup
static ReusableBuffer< uint8_t > _chatmessage_backup
Backup in case text is moved.
Definition network_chat_gui.cpp:60
ShowNetworkChatQueryWindow
void ShowNetworkChatQueryWindow(DestType type, int dest)
Show the chat window.
Definition network_chat_gui.cpp:441
HaveChatMessages
static bool HaveChatMessages(bool show_all)
Test if there are any chat messages to display.
Definition network_chat_gui.cpp:67
NetworkAddChatMessage
void CDECL NetworkAddChatMessage(TextColour colour, uint duration, const std::string &message)
Add a text message to the 'chat window' to be shown.
Definition network_chat_gui.cpp:85
_nested_chat_window_widgets
static constexpr std::initializer_list< NWidgetPart > _nested_chat_window_widgets
The widgets of the chat window.
Definition network_chat_gui.cpp:413
_chatmessage_dirty_time
static std::chrono::steady_clock::time_point _chatmessage_dirty_time
Time the chat history was marked dirty.
Definition network_chat_gui.cpp:53
NetworkReInitChatBoxSize
void NetworkReInitChatBoxSize()
Initialize all font-dependent chat box sizes.
Definition network_chat_gui.cpp:101
SendChat
static void SendChat(std::string_view buf, DestType type, int dest)
Send an actual chat message.
Definition network_chat_gui.cpp:253
NETWORK_CHAT_LINE_SPACING
static const uint NETWORK_CHAT_LINE_SPACING
Spacing between chat lines.
Definition network_chat_gui.cpp:34
_chat_window_desc
static WindowDesc _chat_window_desc(WDP_MANUAL, {}, 0, 0, WC_SEND_NETWORK_MSG, WC_NONE, {}, _nested_chat_window_widgets)
The description of the chat window.
NetworkInitChatMessage
void NetworkInitChatMessage()
Initialize all buffers of the chat visualisation.
Definition network_chat_gui.cpp:108
network_message_expired_interval
static const IntervalTimer< TimerWindow > network_message_expired_interval(std::chrono::seconds(1), [](auto) { auto now=std::chrono::steady_clock::now();for(auto &cmsg :_chatmsg_list) { if(now > cmsg.remove_time &&_chatmessage_dirty_time< cmsg.remove_time) { _chatmessage_dirty_time=now;_chatmessage_dirty=true;break;} } })
Check if a message is expired on a regular interval.
NetworkUndrawChatMessage
void NetworkUndrawChatMessage()
Hide the chatbox.
Definition network_chat_gui.cpp:120
_chatmsg_box
static PointDimension _chatmsg_box
The chatbox grows from the bottom so the coordinates are pixels from the left and pixels from the bot...
Definition network_chat_gui.cpp:59
_chatmessage_dirty
static bool _chatmessage_dirty
Does the chat message need repainting?
Definition network_chat_gui.cpp:45
_chatmessage_visible
static bool _chatmessage_visible
Is a chat message visible.
Definition network_chat_gui.cpp:46
_chatmsg_list
static std::deque< ChatMessage > _chatmsg_list
The actual chat message list.
Definition network_chat_gui.cpp:44
WID_NC_SENDBUTTON
@ WID_NC_SENDBUTTON
Send button.
Definition network_chat_widget.h:19
WID_NC_BACKGROUND
@ WID_NC_BACKGROUND
Background of the window.
Definition network_chat_widget.h:16
WID_NC_CLOSE
@ WID_NC_CLOSE
Close button.
Definition network_chat_widget.h:15
WID_NC_TEXTBOX
@ WID_NC_TEXTBOX
Textbox.
Definition network_chat_widget.h:18
WID_NC_DESTINATION
@ WID_NC_DESTINATION
Destination.
Definition network_chat_widget.h:17
network_client.h
Client part of the network protocol.
NetworkServerSendChat
void NetworkServerSendChat(NetworkAction action, DestType type, int dest, std::string_view msg, ClientID from_id, int64_t data=0, bool from_admin=false)
Send an actual chat message.
Definition network_server.cpp:1252
DestType
DestType
Destination of our chat messages.
Definition network_type.h:68
DESTTYPE_CLIENT
@ DESTTYPE_CLIENT
Send message/notice to only a certain client (Private)
Definition network_type.h:71
NetworkAction
NetworkAction
Actions that can be used for NetworkTextMessage.
Definition network_type.h:79
ClientID
ClientID
'Unique' identifier to be given to clients
Definition network_type.h:43
CLIENT_ID_SERVER
@ CLIENT_ID_SERVER
Servers always have this ID.
Definition network_type.h:45
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
PALETTE_TO_TRANSPARENT
static const PaletteID PALETTE_TO_TRANSPARENT
This sets the sprite to transparent.
Definition sprites.h:1616
lengthof
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:271
GetString
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:19
ChatMessage
Container for a message.
Definition network_chat_gui.cpp:37
ChatMessage::colour
TextColour colour
The colour of the message.
Definition network_chat_gui.cpp:39
ChatMessage::remove_time
std::chrono::steady_clock::time_point remove_time
The time to remove the message.
Definition network_chat_gui.cpp:40
ChatMessage::message
std::string message
The action message.
Definition network_chat_gui.cpp:38
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition settings_type.h:650
Coord2D< int >
Coord2D::y
T y
Y coordinate.
Definition geometry_type.hpp:35
Coord2D::x
T x
X coordinate.
Definition geometry_type.hpp:34
CursorVars::visible
bool visible
cursor is visible
Definition gfx_type.h:145
CursorVars::draw_size
Point draw_size
position and size bounding-box for drawing
Definition gfx_type.h:139
GUISettings::network_chat_box_height
uint8_t network_chat_box_height
height of the chat box in lines
Definition settings_type.h:246
GUISettings::network_chat_box_width_pct
uint16_t network_chat_box_width_pct
width of the chat box in percent
Definition settings_type.h:245
NetworkChatWindow
Window to enter the chat message in.
Definition network_chat_gui.cpp:298
NetworkChatWindow::FindWindowPlacementAndResize
void FindWindowPlacementAndResize(int, int def_height, bool allow_resize) override
Resize window towards the default size.
Definition network_chat_gui.cpp:332
NetworkChatWindow::chat_tab_completion
NetworkChatAutoCompletion chat_tab_completion
Holds the state and logic of auto-completion of player names and towns on Tab press.
Definition network_chat_gui.cpp:302
NetworkChatWindow::OnKeyPress
EventState OnKeyPress(char32_t key, uint16_t keycode) override
A key has been pressed.
Definition network_chat_gui.cpp:384
NetworkChatWindow::NetworkChatWindow
NetworkChatWindow(WindowDesc &desc, DestType type, int dest)
Create a chat input window.
Definition network_chat_gui.cpp:310
NetworkChatWindow::OnEditboxChanged
void OnEditboxChanged(WidgetID widget) override
The text in an editbox has been edited.
Definition network_chat_gui.cpp:394
NetworkChatWindow::OnClick
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition network_chat_gui.cpp:371
NetworkChatWindow::ChatTabCompletion
void ChatTabCompletion()
See if we can auto-complete the current text of the user.
Definition network_chat_gui.cpp:340
NetworkChatWindow::GetWidgetString
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
Definition network_chat_gui.cpp:353
NetworkChatWindow::dest
int dest
The identifier of the destination.
Definition network_chat_gui.cpp:300
NetworkChatWindow::dtype
DestType dtype
The type of destination.
Definition network_chat_gui.cpp:299
NetworkChatWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition network_chat_gui.cpp:406
NetworkChatWindow::message_editbox
QueryString message_editbox
Message editbox.
Definition network_chat_gui.cpp:301
NetworkChatWindow::OnInitialPosition
Point OnInitialPosition(int16_t sm_width, int16_t sm_height, int window_number) override
Compute the initial position of the window.
Definition network_chat_gui.cpp:347
NetworkChatWindow::Close
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
Definition network_chat_gui.cpp:326
NetworkClientInfo
Container for all information known about a client.
Definition network_base.h:24
NetworkClientInfo::GetByClientID
static NetworkClientInfo * GetByClientID(ClientID client_id)
Return the CI given it's client-identifier.
Definition network.cpp:117
PointDimension
Specification of a rectangle with an absolute top-left coordinate and a (relative) width/height.
Definition geometry_type.hpp:301
Pool::PoolItem<&_networkclientinfo_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition pool_type.hpp:436
QueryString
Data stored about a string that can be modified in the GUI.
Definition querystring_gui.h:20
QueryString::ok_button
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
Definition querystring_gui.h:27
QueryString::cancel_button
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Definition querystring_gui.h:28
Textbuf::GetText
std::string_view GetText() const
Get the current text.
Definition textbuf.cpp:284
Textbuf::Assign
void Assign(std::string_view text)
Copy a string into the textbuffer.
Definition textbuf.cpp:420
Town
Town data structure.
Definition town.h:63
WindowDesc
High level window description.
Definition window_gui.h:168
Window
Data structure for an opened window.
Definition window_gui.h:274
Window::Close
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1102
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1807
Window::querystrings
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition window_gui.h:321
Window::GetWidgetString
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:504
Window::CreateNestedTree
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1797
Window::SetFocusedWidget
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition window.cpp:485
Window::FindWindowPlacementAndResize
virtual void FindWindowPlacementAndResize(int def_width, int def_height, bool allow_resize)
Resize window towards the default size.
Definition window.cpp:1474
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition window_gui.h:313
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:303
_toolbar_width
uint _toolbar_width
Width of the toolbar, shared by statusbar.
Definition toolbar_gui.cpp:78
ScaleGUITrad
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition widget.cpp:49
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition widget_type.h:104
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition widget_type.h:62
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:39
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:60
WWT_TEXT
@ WWT_TEXT
Pure simple text.
Definition widget_type.h:49
PositionNetworkChatWindow
int PositionNetworkChatWindow(Window *w)
(Re)position network chat window at the screen.
Definition window.cpp:3498
FindWindowByClass
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
Definition window.cpp:1166
CloseWindowByClass
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1205
InvalidateWindowData
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition window.cpp:3294
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1151
WDP_MANUAL
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition window_gui.h:143
WidgetID
int WidgetID
Widget ID.
Definition window_type.h:20
EventState
EventState
State of handling an event.
Definition window_type.h:780
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition window_type.h:781
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition window_type.h:782
WC_NEWS_WINDOW
@ WC_NEWS_WINDOW
News window; Window numbers:
Definition window_type.h:253
WC_STATUS_BAR
@ WC_STATUS_BAR
Statusbar (at the bottom of your screen); Window numbers:
Definition window_type.h:69
WC_SEND_NETWORK_MSG
@ WC_SEND_NETWORK_MSG
Chatbox; Window numbers:
Definition window_type.h:514
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:50