OpenTTD Source 20250205-master-gfd85ab1e2c
network_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 <http://www.gnu.org/licenses/>.
6 */
7
10#include "../stdafx.h"
11#include "../strings_func.h"
12#include "../fios.h"
13#include "network_client.h"
14#include "network_gui.h"
15#include "network_gamelist.h"
16#include "network.h"
17#include "network_base.h"
18#include "network_content.h"
19#include "network_server.h"
20#include "network_coordinator.h"
21#include "network_survey.h"
22#include "../gui.h"
23#include "network_udp.h"
24#include "../window_func.h"
25#include "../gfx_func.h"
26#include "../dropdown_type.h"
27#include "../dropdown_func.h"
28#include "../querystring_gui.h"
29#include "../sortlist_type.h"
30#include "../company_func.h"
31#include "../command_func.h"
32#include "../core/geometry_func.hpp"
33#include "../genworld.h"
34#include "../map_type.h"
35#include "../zoom_func.h"
36#include "../sprite.h"
37#include "../settings_internal.h"
38#include "../company_cmd.h"
39#include "../timer/timer.h"
40#include "../timer/timer_window.h"
41#include "../timer/timer_game_calendar.h"
42#include "../textfile_gui.h"
43
44#include "../widgets/network_widget.h"
45
46#include "table/strings.h"
47#include "../table/sprites.h"
48
49#include "../stringfilter_type.h"
50
51#ifdef __EMSCRIPTEN__
52# include <emscripten.h>
53#endif
54
55#include "../safeguards.h"
56
57static void ShowNetworkStartServerWindow();
58
61
70
71static DropDownList BuildVisibilityDropDownList()
72{
73 DropDownList list;
74
75 list.push_back(MakeDropDownListStringItem(STR_NETWORK_SERVER_VISIBILITY_LOCAL, SERVER_GAME_TYPE_LOCAL));
76 list.push_back(MakeDropDownListStringItem(STR_NETWORK_SERVER_VISIBILITY_INVITE_ONLY, SERVER_GAME_TYPE_INVITE_ONLY));
77 list.push_back(MakeDropDownListStringItem(STR_NETWORK_SERVER_VISIBILITY_PUBLIC, SERVER_GAME_TYPE_PUBLIC));
78
79 return list;
80}
81
83typedef int ServerListPosition;
84static const ServerListPosition SLP_INVALID = -1;
85
88 static const uint MINIMUM_NAME_WIDTH_BEFORE_NEW_HEADER = 150;
89public:
91 {
92 auto leaf = std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_NAME, WidgetData{.string = STR_NETWORK_SERVER_LIST_GAME_NAME}, STR_NETWORK_SERVER_LIST_GAME_NAME_TOOLTIP);
93 leaf->SetResize(1, 0);
94 leaf->SetFill(1, 0);
95 this->Add(std::move(leaf));
96
97 this->Add(std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_CLIENTS, WidgetData{.string = STR_NETWORK_SERVER_LIST_CLIENTS_CAPTION}, STR_NETWORK_SERVER_LIST_CLIENTS_CAPTION_TOOLTIP));
98 this->Add(std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_MAPSIZE, WidgetData{.string = STR_NETWORK_SERVER_LIST_MAP_SIZE_CAPTION}, STR_NETWORK_SERVER_LIST_MAP_SIZE_CAPTION_TOOLTIP));
99 this->Add(std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_DATE, WidgetData{.string = STR_NETWORK_SERVER_LIST_DATE_CAPTION}, STR_NETWORK_SERVER_LIST_DATE_CAPTION_TOOLTIP));
100 this->Add(std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_YEARS, WidgetData{.string = STR_NETWORK_SERVER_LIST_PLAY_TIME_CAPTION}, STR_NETWORK_SERVER_LIST_PLAY_TIME_CAPTION_TOOLTIP));
101
102 leaf = std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_INFO, WidgetData{.string = STR_EMPTY}, STR_NETWORK_SERVER_LIST_INFO_ICONS_TOOLTIP);
103 leaf->SetFill(0, 1);
104 this->Add(std::move(leaf));
105 }
106
107 void SetupSmallestSize(Window *w) override
108 {
109 this->smallest_y = 0; // Biggest child.
110 this->fill_x = 1;
111 this->fill_y = 0;
112 this->resize_x = 1; // We only resize in this direction
113 this->resize_y = 0; // We never resize in this direction
114
115 /* First initialise some variables... */
116 for (const auto &child_wid : this->children) {
117 child_wid->SetupSmallestSize(w);
118 this->smallest_y = std::max(this->smallest_y, child_wid->smallest_y + child_wid->padding.Vertical());
119 }
120
121 /* ... then in a second pass make sure the 'current' sizes are set. Won't change for most widgets. */
122 for (const auto &child_wid : this->children) {
123 child_wid->current_x = child_wid->smallest_x;
124 child_wid->current_y = this->smallest_y;
125 }
126
127 this->smallest_x = this->children.front()->smallest_x + this->children.back()->smallest_x; // First and last are always shown, rest not
128 this->ApplyAspectRatio();
129 }
130
131 void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
132 {
133 assert(given_width >= this->smallest_x && given_height >= this->smallest_y);
134
135 this->pos_x = x;
136 this->pos_y = y;
137 this->current_x = given_width;
138 this->current_y = given_height;
139
140 given_width -= this->children.back()->smallest_x;
141 /* The first and last widget are always visible, determine which other should be visible */
142 if (this->children.size() > 2) {
143 auto first = std::next(std::begin(this->children));
144 auto last = std::prev(std::end(this->children));
145 for (auto it = first; it != last; ++it) {
146 auto &child_wid = *it;
147 if (given_width > ScaleGUITrad(MINIMUM_NAME_WIDTH_BEFORE_NEW_HEADER) + child_wid->smallest_x && (*std::prev(it))->current_x != 0) {
148 given_width -= child_wid->smallest_x;
149 child_wid->current_x = child_wid->smallest_x; /* Make visible. */
150 } else {
151 child_wid->current_x = 0; /* Make invisible. */
152 }
153 }
154 }
155
156 /* All remaining space goes to the first (name) widget */
157 this->children.front()->current_x = given_width;
158
159 /* Now assign the widgets to their rightful place */
160 uint position = 0; // Place to put next child relative to origin of the container.
161 auto assign_position = [&](const std::unique_ptr<NWidgetBase> &child_wid) {
162 if (child_wid->current_x != 0) {
163 child_wid->AssignSizePosition(sizing, x + position, y, child_wid->current_x, this->current_y, rtl);
164 position += child_wid->current_x;
165 }
166 };
167
168 if (rtl) {
169 std::for_each(std::rbegin(this->children), std::rend(this->children), assign_position);
170 } else {
171 std::for_each(std::begin(this->children), std::end(this->children), assign_position);
172 }
173 }
174};
175
176class NetworkGameWindow : public Window {
177protected:
178 /* Runtime saved values */
179 static Listing last_sorting;
180
181 /* Constants for sorting servers */
182 static const std::initializer_list<GUIGameServerList::SortFunction * const> sorter_funcs;
183 static const std::initializer_list<GUIGameServerList::FilterFunction * const> filter_funcs;
184
188 ServerListPosition list_pos;
192 bool searched_internet = false;
193
194 Dimension lock;
196
203 {
204 if (!this->servers.NeedRebuild()) return;
205
206 /* Create temporary array of games to use for listing */
207 this->servers.clear();
208
209 bool found_current_server = false;
210 bool found_last_joined = false;
211 for (NetworkGameList *ngl = _network_game_list; ngl != nullptr; ngl = ngl->next) {
212 this->servers.push_back(ngl);
213 if (ngl == this->server) {
215 }
216 if (ngl == this->last_joined) {
217 found_last_joined = true;
218 }
219 }
220 /* A refresh can cause the current server to be delete; so unselect. */
221 if (!found_last_joined) {
222 this->last_joined = nullptr;
223 }
225 this->server = nullptr;
226 this->list_pos = SLP_INVALID;
227 }
228
229 /* Apply the filter condition immediately, if a search string has been provided. */
230 StringFilter sf;
231 sf.SetFilterTerm(this->filter_editbox.text.GetText());
232
233 if (!sf.IsEmpty()) {
234 this->servers.SetFilterState(true);
235 this->servers.Filter(sf);
236 } else {
237 this->servers.SetFilterState(false);
238 }
239
240 this->servers.RebuildDone();
241 this->vscroll->SetCount(this->servers.size());
242
243 /* Sort the list of network games as requested. */
244 this->servers.Sort();
245 this->UpdateListPos();
246 }
247
249 static bool NGameNameSorter(NetworkGameList * const &a, NetworkGameList * const &b)
250 {
251 int r = StrNaturalCompare(a->info.server_name, b->info.server_name, true); // Sort by name (natural sorting).
252 if (r == 0) r = a->connection_string.compare(b->connection_string);
253
254 return r < 0;
255 }
256
262 static bool NGameClientSorter(NetworkGameList * const &a, NetworkGameList * const &b)
263 {
264 /* Reverse as per default we are interested in most-clients first */
265 int r = a->info.clients_on - b->info.clients_on;
266
267 if (r == 0) r = a->info.clients_max - b->info.clients_max;
268 if (r == 0) return NGameNameSorter(a, b);
269
270 return r < 0;
271 }
272
274 static bool NGameMapSizeSorter(NetworkGameList * const &a, NetworkGameList * const &b)
275 {
276 /* Sort by the area of the map. */
277 int r = (a->info.map_height) * (a->info.map_width) - (b->info.map_height) * (b->info.map_width);
278
279 if (r == 0) r = a->info.map_width - b->info.map_width;
280 return (r != 0) ? r < 0 : NGameClientSorter(a, b);
281 }
282
284 static bool NGameCalendarDateSorter(NetworkGameList * const &a, NetworkGameList * const &b)
285 {
286 auto r = a->info.calendar_date - b->info.calendar_date;
287 return (r != 0) ? r < 0 : NGameClientSorter(a, b);
288 }
289
291 static bool NGameTicksPlayingSorter(NetworkGameList * const &a, NetworkGameList * const &b)
292 {
293 if (a->info.ticks_playing == b->info.ticks_playing) {
294 return NGameClientSorter(a, b);
295 }
296 return a->info.ticks_playing < b->info.ticks_playing;
297 }
298
303 static bool NGameAllowedSorter(NetworkGameList * const &a, NetworkGameList * const &b)
304 {
305 /* The servers we do not know anything about (the ones that did not reply) should be at the bottom) */
306 int r = a->info.server_revision.empty() - b->info.server_revision.empty();
307
308 /* Reverse default as we are interested in version-compatible clients first */
309 if (r == 0) r = b->info.version_compatible - a->info.version_compatible;
310 /* The version-compatible ones are then sorted with NewGRF compatible first, incompatible last */
311 if (r == 0) r = b->info.compatible - a->info.compatible;
312 /* Passworded servers should be below unpassworded servers */
313 if (r == 0) r = a->info.use_password - b->info.use_password;
314
315 /* Finally sort on the number of clients of the server in reverse order. */
316 return (r != 0) ? r < 0 : NGameClientSorter(b, a);
317 }
318
321 {
322 if (this->servers.Sort()) this->UpdateListPos();
323 }
324
327 {
328 auto it = std::ranges::find(this->servers, this->server);
329 if (it == std::end(this->servers)) {
330 this->list_pos = SLP_INVALID;
331 } else {
332 this->list_pos = static_cast<ServerListPosition>(std::distance(std::begin(this->servers), it));
333 }
334 }
335
336 static bool NGameSearchFilter(NetworkGameList * const *item, StringFilter &sf)
337 {
338 assert(item != nullptr);
339 assert((*item) != nullptr);
340
341 sf.ResetState();
342 sf.AddLine((*item)->info.server_name);
343 return sf.GetState();
344 }
345
352 void DrawServerLine(const NetworkGameList *cur_item, int y, bool highlight) const
353 {
354 Rect name = this->GetWidget<NWidgetBase>(WID_NG_NAME)->GetCurrentRect();
355 Rect info = this->GetWidget<NWidgetBase>(WID_NG_INFO)->GetCurrentRect();
356
357 /* show highlighted item with a different colour */
358 if (highlight) {
359 Rect r = {std::min(name.left, info.left), y, std::max(name.right, info.right), y + (int)this->resize.step_height - 1};
361 }
362
363 /* Offset to vertically position text. */
365
366 info = info.Shrink(WidgetDimensions::scaled.framerect);
367 name = name.Shrink(WidgetDimensions::scaled.framerect);
368 DrawString(name.left, name.right, y + text_y_offset, cur_item->info.server_name, TC_BLACK);
369
370 /* only draw details if the server is online */
371 if (cur_item->status == NGLS_ONLINE) {
373 Rect clients = nwid->GetCurrentRect();
374 SetDParam(0, cur_item->info.clients_on);
375 SetDParam(1, cur_item->info.clients_max);
376 SetDParam(2, cur_item->info.companies_on);
377 SetDParam(3, cur_item->info.companies_max);
378 DrawString(clients.left, clients.right, y + text_y_offset, STR_NETWORK_SERVER_LIST_GENERAL_ONLINE, TC_FROMSTRING, SA_HOR_CENTER);
379 }
380
382 /* map size */
383 Rect mapsize = nwid->GetCurrentRect();
384 SetDParam(0, cur_item->info.map_width);
385 SetDParam(1, cur_item->info.map_height);
387 }
388
390 /* current date */
391 Rect date = nwid->GetCurrentRect();
392 TimerGameCalendar::YearMonthDay ymd = TimerGameCalendar::ConvertDateToYMD(cur_item->info.calendar_date);
393 SetDParam(0, ymd.year);
394 DrawString(date.left, date.right, y + text_y_offset, STR_JUST_INT, TC_BLACK, SA_HOR_CENTER);
395 }
396
398 /* play time */
399 Rect years = nwid->GetCurrentRect();
400 const auto play_time = cur_item->info.ticks_playing / Ticks::TICKS_PER_SECOND;
401 SetDParam(0, play_time / 60 / 60);
402 SetDParam(1, (play_time / 60) % 60);
404 }
405
406 /* Set top and bottom of info rect to current row. */
407 info.top = y;
408 info.bottom = y + this->resize.step_height - 1;
409
410 bool rtl = _current_text_dir == TD_RTL;
411
412 /* draw a lock if the server is password protected */
413 if (cur_item->info.use_password) DrawSpriteIgnorePadding(SPR_LOCK, PAL_NONE, info.WithWidth(this->lock.width, rtl), SA_CENTER);
414
415 /* draw red or green icon, depending on compatibility with server */
416 PaletteID pal = cur_item->info.compatible ? PALETTE_TO_GREEN : (cur_item->info.version_compatible ? PALETTE_TO_YELLOW : PALETTE_TO_RED);
417 DrawSpriteIgnorePadding(SPR_BLOT, pal, info.WithWidth(this->blot.width, !rtl), SA_CENTER);
418 }
419 }
420
429 {
430 if (this->list_pos == SLP_INVALID) return; // no server selected
431 this->vscroll->ScrollTowards(this->list_pos);
432 }
433
434public:
436 {
437 this->list_pos = SLP_INVALID;
438 this->server = nullptr;
439
440 this->CreateNestedTree();
441 this->vscroll = this->GetScrollbar(WID_NG_SCROLLBAR);
443
445 this->name_editbox.text.Assign(_settings_client.network.client_name);
446
448 this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
450
451 /* As the Game Coordinator doesn't support "websocket" servers yet, we
452 * let "os/emscripten/pre.js" hardcode a list of servers people can
453 * join. This means the serverlist is curated for now, but it is the
454 * best we can offer. */
455#ifdef __EMSCRIPTEN__
456 EM_ASM(if (window["openttd_server_list"]) openttd_server_list());
457#endif
458
459 this->last_joined = NetworkAddServer(_settings_client.network.last_joined, false);
460 this->server = this->last_joined;
461
462 this->servers.SetListing(this->last_sorting);
463 this->servers.SetSortFuncs(NetworkGameWindow::sorter_funcs);
464 this->servers.SetFilterFuncs(NetworkGameWindow::filter_funcs);
465 this->servers.ForceRebuild();
466 }
467
469 {
470 this->last_sorting = this->servers.GetListing();
471 }
472
473 void OnInit() override
474 {
475 this->lock = GetScaledSpriteSize(SPR_LOCK);
476 this->blot = GetScaledSpriteSize(SPR_BLOT);
477 }
478
480 {
481 switch (widget) {
482 case WID_NG_MATRIX:
483 resize.height = std::max(GetSpriteSize(SPR_BLOT).height, (uint)GetCharacterHeight(FS_NORMAL)) + padding.height;
484 fill.height = resize.height;
485 size.height = 12 * resize.height;
486 break;
487
489 size.height = std::max(GetSpriteSize(SPR_BLOT).height, (uint)GetCharacterHeight(FS_NORMAL)) + WidgetDimensions::scaled.matrix.Vertical();
490 break;
491
493 size.width = NWidgetScrollbar::GetVerticalDimension().width;
494 break;
495
496 case WID_NG_NAME:
497 size.width += 2 * Window::SortButtonWidth(); // Make space for the arrow
498 break;
499
500 case WID_NG_CLIENTS:
501 size.width += 2 * Window::SortButtonWidth(); // Make space for the arrow
507 break;
508
509 case WID_NG_MAPSIZE:
510 size.width += 2 * Window::SortButtonWidth(); // Make space for the arrow
514 break;
515
516 case WID_NG_DATE:
517 case WID_NG_YEARS:
518 size.width += 2 * Window::SortButtonWidth(); // Make space for the arrow
519 SetDParamMaxValue(0, 5);
521 break;
522
523 case WID_NG_INFO:
524 size.width = this->lock.width + WidgetDimensions::scaled.hsep_normal + this->blot.width + padding.width;
525 size.height = std::max(this->lock.height, this->blot.height) + padding.height;
526 break;
527 }
528 }
529
530 void DrawWidget(const Rect &r, WidgetID widget) const override
531 {
532 switch (widget) {
533 case WID_NG_MATRIX: {
534 uint16_t y = r.top;
535
536 auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->servers);
537 for (auto it = first; it != last; ++it) {
538 const NetworkGameList *ngl = *it;
539 this->DrawServerLine(ngl, y, ngl == this->server);
540 y += this->resize.step_height;
541 }
542 break;
543 }
544
546 /* Draw the last joined server, if any */
547 if (this->last_joined != nullptr) this->DrawServerLine(this->last_joined, r.top, this->last_joined == this->server);
548 break;
549
550 case WID_NG_DETAILS:
551 this->DrawDetails(r);
552 break;
553
554 case WID_NG_NAME:
555 case WID_NG_CLIENTS:
556 case WID_NG_MAPSIZE:
557 case WID_NG_DATE:
558 case WID_NG_YEARS:
559 case WID_NG_INFO:
560 if (widget - WID_NG_NAME == this->servers.SortType()) this->DrawSortButtonState(widget, this->servers.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
561 break;
562 }
563 }
564
565
566 void OnPaint() override
567 {
568 if (this->servers.NeedRebuild()) {
570 }
571 if (this->servers.NeedResort()) {
572 this->SortNetworkGameList();
573 }
574
575 NetworkGameList *sel = this->server;
576 /* 'Refresh' button invisible if no server selected */
577 this->SetWidgetDisabledState(WID_NG_REFRESH, sel == nullptr);
578 /* 'Join' button disabling conditions */
579 this->SetWidgetDisabledState(WID_NG_JOIN, sel == nullptr || // no Selected Server
580 sel->status != NGLS_ONLINE || // Server offline
581 sel->info.clients_on >= sel->info.clients_max || // Server full
582 !sel->info.compatible); // Revision mismatch
583
584 this->SetWidgetLoweredState(WID_NG_REFRESH, sel != nullptr && sel->refreshing);
585
586 /* 'NewGRF Settings' button invisible if no NewGRF is used */
587 bool changed = false;
588 changed |= this->GetWidget<NWidgetStacked>(WID_NG_NEWGRF_SEL)->SetDisplayedPlane(sel == nullptr || sel->status != NGLS_ONLINE || sel->info.grfconfig.empty() ? SZSP_NONE : 0);
589 changed |= this->GetWidget<NWidgetStacked>(WID_NG_NEWGRF_MISSING_SEL)->SetDisplayedPlane(sel == nullptr || sel->status != NGLS_ONLINE || sel->info.grfconfig.empty() || !sel->info.version_compatible || sel->info.compatible ? SZSP_NONE : 0);
590 if (changed) {
591 this->ReInit();
592 return;
593 }
594
595#ifdef __EMSCRIPTEN__
600#endif
601
602 this->DrawWidgets();
603 }
604
605 StringID GetHeaderString() const
606 {
607 if (this->server == nullptr) return STR_NETWORK_SERVER_LIST_GAME_INFO;
608 switch (this->server->status) {
614 default: NOT_REACHED();
615 }
616 }
617
618 void DrawDetails(const Rect &r) const
619 {
620 NetworkGameList *sel = this->server;
621
622 Rect tr = r.Shrink(WidgetDimensions::scaled.frametext);
623 StringID header_msg = this->GetHeaderString();
624 int header_height = GetStringHeight(header_msg, tr.Width()) +
625 (sel == nullptr ? 0 : GetStringHeight(sel->info.server_name, tr.Width())) +
626 WidgetDimensions::scaled.frametext.Vertical();
627
628 /* Height for the title banner */
629 Rect hr = r.WithHeight(header_height).Shrink(WidgetDimensions::scaled.frametext);
630 tr.top += header_height;
631
632 /* Draw the right menu */
633 /* Create the nice grayish rectangle at the details top */
635 hr.top = DrawStringMultiLine(hr, header_msg, TC_FROMSTRING, SA_HOR_CENTER);
636 if (sel == nullptr) return;
637
638 hr.top = DrawStringMultiLine(hr, sel->info.server_name, TC_ORANGE, SA_HOR_CENTER); // game name
639 if (sel->status != NGLS_ONLINE) {
640 tr.top = DrawStringMultiLine(tr, header_msg, TC_FROMSTRING, SA_HOR_CENTER);
641 } else { // show game info
642 SetDParam(0, sel->info.clients_on);
643 SetDParam(1, sel->info.clients_max);
644 SetDParam(2, sel->info.companies_on);
647
650
651 SetDParam(0, sel->info.map_width);
652 SetDParam(1, sel->info.map_height);
654
657
660 tr.top = DrawStringMultiLine(tr, invite_or_address); // server address / invite code
661
664
667
669 SetDParam(0, play_time / 60 / 60);
670 SetDParam(1, (play_time / 60) % 60);
672
673 if (sel->info.gamescript_version != -1) {
676 tr.top = DrawStringMultiLine(tr, STR_NETWORK_SERVER_LIST_GAMESCRIPT); // gamescript name and version
677 }
678
680
681 if (!sel->info.compatible) {
683 } else if (sel->info.clients_on == sel->info.clients_max) {
684 /* Show: server full, when clients_on == max_clients */
686 } else if (sel->info.use_password) {
687 DrawStringMultiLine(tr, STR_NETWORK_SERVER_LIST_PASSWORD, TC_FROMSTRING, SA_HOR_CENTER); // password warning
688 }
689 }
690 }
691
692 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
693 {
694 switch (widget) {
695 case WID_NG_CANCEL: // Cancel button
697 break;
698
699 case WID_NG_NAME: // Sort by name
700 case WID_NG_CLIENTS: // Sort by connected clients
701 case WID_NG_MAPSIZE: // Sort by map size
702 case WID_NG_DATE: // Sort by date
703 case WID_NG_YEARS: // Sort by years
704 case WID_NG_INFO: // Connectivity (green dot)
705 if (this->servers.SortType() == widget - WID_NG_NAME) {
706 this->servers.ToggleSortOrder();
707 if (this->list_pos != SLP_INVALID) this->list_pos = (ServerListPosition)this->servers.size() - this->list_pos - 1;
708 } else {
709 this->servers.SetSortType(widget - WID_NG_NAME);
710 this->servers.ForceResort();
711 this->SortNetworkGameList();
712 }
714 this->SetDirty();
715 break;
716
717 case WID_NG_MATRIX: { // Show available network games
718 auto it = this->vscroll->GetScrolledItemFromWidget(this->servers, pt.y, this, WID_NG_MATRIX);
719 this->server = (it != this->servers.end()) ? *it : nullptr;
720 this->list_pos = (server == nullptr) ? SLP_INVALID : it - this->servers.begin();
721 this->SetDirty();
722
723 /* FIXME the disabling should go into some InvalidateData, which is called instead of the SetDirty */
724 if (click_count > 1 && !this->IsWidgetDisabled(WID_NG_JOIN)) this->OnClick(pt, WID_NG_JOIN, 1);
725 break;
726 }
727
728 case WID_NG_LASTJOINED: {
729 if (this->last_joined != nullptr) {
730 this->server = this->last_joined;
731
732 /* search the position of the newly selected server */
733 this->UpdateListPos();
735 this->SetDirty();
736
737 /* FIXME the disabling should go into some InvalidateData, which is called instead of the SetDirty */
738 if (click_count > 1 && !this->IsWidgetDisabled(WID_NG_JOIN)) this->OnClick(pt, WID_NG_JOIN, 1);
739 }
740 break;
741 }
742
745 this->searched_internet = true;
746 break;
747
750 break;
751
752 case WID_NG_ADD: // Add a server
757 NETWORK_HOSTNAME_PORT_LENGTH, // maximum number of characters including '\0'
759 break;
760
761 case WID_NG_START: // Start server
762 ShowNetworkStartServerWindow();
763 break;
764
765 case WID_NG_JOIN: // Join Game
766 if (this->server != nullptr) {
768 }
769 break;
770
771 case WID_NG_REFRESH: // Refresh
772 if (this->server != nullptr && !this->server->refreshing) NetworkQueryServer(this->server->connection_string);
773 break;
774
775 case WID_NG_NEWGRF: // NewGRF Settings
776 if (this->server != nullptr) ShowNewGRFSettings(false, false, false, this->server->info.grfconfig);
777 break;
778
779 case WID_NG_NEWGRF_MISSING: // Find missing content online
780 if (this->server != nullptr) ShowMissingContentWindow(this->server->info.grfconfig);
781 break;
782 }
783 }
784
790 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
791 {
792 this->servers.ForceRebuild();
793 this->SetDirty();
794 }
795
796 EventState OnKeyPress([[maybe_unused]] char32_t key, uint16_t keycode) override
797 {
799
800 /* handle up, down, pageup, pagedown, home and end */
801 if (this->vscroll->UpdateListPositionOnKeyPress(this->list_pos, keycode) == ES_HANDLED) {
802 if (this->list_pos == SLP_INVALID) return ES_HANDLED;
803
804 this->server = this->servers[this->list_pos];
805
806 /* Scroll to the new server if it is outside the current range. */
808
809 /* redraw window */
810 this->SetDirty();
811 return ES_HANDLED;
812 }
813
814 if (this->server != nullptr) {
815 if (keycode == WKC_DELETE) { // Press 'delete' to remove servers
816 NetworkGameListRemoveItem(this->server);
817 if (this->server == this->last_joined) this->last_joined = nullptr;
818 this->server = nullptr;
819 this->list_pos = SLP_INVALID;
820 }
821 }
822
823 return state;
824 }
825
827 {
828 switch (wid) {
829 case WID_NG_FILTER: {
830 this->servers.ForceRebuild();
833 this->SetDirty();
834 break;
835 }
836
837 case WID_NG_CLIENT:
838 /* Validation of the name will happen once the user tries to join or start a game, as getting
839 * error messages while typing (e.g. when you clear the name) defeats the purpose of the check. */
840 _settings_client.network.client_name = this->name_editbox.text.GetText();
841 break;
842 }
843 }
844
845 void OnQueryTextFinished(std::optional<std::string> str) override
846 {
847 if (!str.has_value() || str->empty()) return;
848
849 _settings_client.network.connect_to_ip = std::move(*str);
851 NetworkRebuildHostList();
852 }
853
854 void OnResize() override
855 {
856 this->vscroll->SetCapacityFromWidget(this, WID_NG_MATRIX);
857 }
858
860 IntervalTimer<TimerWindow> refresh_interval = {std::chrono::seconds(30), [this](uint) {
861 if (!this->searched_internet) return;
862
864 }};
865};
866
867Listing NetworkGameWindow::last_sorting = {false, 5};
868const std::initializer_list<GUIGameServerList::SortFunction * const> NetworkGameWindow::sorter_funcs = {
869 &NGameNameSorter,
870 &NGameClientSorter,
871 &NGameMapSizeSorter,
872 &NGameCalendarDateSorter,
873 &NGameTicksPlayingSorter,
874 &NGameAllowedSorter
875};
876
877const std::initializer_list<GUIGameServerList::FilterFunction * const> NetworkGameWindow::filter_funcs = {
878 &NGameSearchFilter
879};
880
881static std::unique_ptr<NWidgetBase> MakeResizableHeader()
882{
883 return std::make_unique<NWidgetServerListHeader>();
884}
885
886static constexpr NWidgetPart _nested_network_game_widgets[] = {
887 /* TOP */
889 NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE),
890 NWidget(WWT_CAPTION, COLOUR_LIGHT_BLUE), SetStringTip(STR_NETWORK_SERVER_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
891 NWidget(WWT_DEFSIZEBOX, COLOUR_LIGHT_BLUE),
892 EndContainer(),
893 NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE, WID_NG_MAIN),
896 /* LEFT SIDE */
899 NWidget(WWT_TEXT, INVALID_COLOUR, WID_NG_FILTER_LABEL), SetStringTip(STR_LIST_FILTER_TITLE),
900 NWidget(WWT_EDITBOX, COLOUR_LIGHT_BLUE, WID_NG_FILTER), SetMinimalSize(251, 0), SetFill(1, 0), SetResize(1, 0),
901 SetStringTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
902 EndContainer(),
905 NWidgetFunction(MakeResizableHeader),
906 NWidget(WWT_MATRIX, COLOUR_LIGHT_BLUE, WID_NG_MATRIX), SetResize(1, 1), SetFill(1, 0),
907 SetMatrixDataTip(1, 0, STR_NETWORK_SERVER_LIST_CLICK_GAME_TO_SELECT), SetScrollbar(WID_NG_SCROLLBAR),
908 EndContainer(),
909 NWidget(NWID_VSCROLLBAR, COLOUR_LIGHT_BLUE, WID_NG_SCROLLBAR),
910 EndContainer(),
912 NWidget(WWT_TEXT, INVALID_COLOUR, WID_NG_LASTJOINED_LABEL), SetFill(1, 0),
913 SetStringTip(STR_NETWORK_SERVER_LIST_LAST_JOINED_SERVER), SetResize(1, 0),
915 NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE, WID_NG_LASTJOINED), SetFill(1, 0), SetResize(1, 0),
916 SetToolTip(STR_NETWORK_SERVER_LIST_CLICK_TO_SELECT_LAST_TOOLTIP),
917 EndContainer(),
918 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_NG_LASTJOINED_SPACER), SetFill(0, 0),
919 EndContainer(),
920 EndContainer(),
921 EndContainer(),
922 /* RIGHT SIDE */
925 NWidget(WWT_TEXT, INVALID_COLOUR, WID_NG_CLIENT_LABEL), SetStringTip(STR_NETWORK_SERVER_LIST_PLAYER_NAME),
926 NWidget(WWT_EDITBOX, COLOUR_LIGHT_BLUE, WID_NG_CLIENT), SetMinimalSize(151, 0), SetFill(1, 0), SetResize(1, 0),
927 SetStringTip(STR_NETWORK_SERVER_LIST_PLAYER_NAME_OSKTITLE, STR_NETWORK_SERVER_LIST_ENTER_NAME_TOOLTIP),
928 EndContainer(),
930 NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE, WID_NG_DETAILS), SetMinimalSize(140, 0), SetMinimalTextLines(15, 0), SetResize(0, 1),
931 EndContainer(),
934 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_NEWGRF_MISSING), SetFill(1, 0), SetStringTip(STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_BUTTON, STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_TOOLTIP),
935 EndContainer(),
936 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_NG_NEWGRF_SEL),
937 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_NEWGRF), SetFill(1, 0), SetStringTip(STR_INTRO_NEWGRF_SETTINGS),
938 EndContainer(),
940 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_JOIN), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_JOIN_GAME),
941 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_REFRESH), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_REFRESH, STR_NETWORK_SERVER_LIST_REFRESH_TOOLTIP),
942 EndContainer(),
943 EndContainer(),
944 EndContainer(),
945 EndContainer(),
946 EndContainer(),
947 /* BOTTOM */
949 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_SEARCH_INTERNET), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_SEARCH_SERVER_INTERNET, STR_NETWORK_SERVER_LIST_SEARCH_SERVER_INTERNET_TOOLTIP),
950 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_SEARCH_LAN), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_SEARCH_SERVER_LAN, STR_NETWORK_SERVER_LIST_SEARCH_SERVER_LAN_TOOLTIP),
951 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_ADD), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_ADD_SERVER, STR_NETWORK_SERVER_LIST_ADD_SERVER_TOOLTIP),
952 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_START), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_START_SERVER, STR_NETWORK_SERVER_LIST_START_SERVER_TOOLTIP),
953 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NG_CANCEL), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_BUTTON_CANCEL),
954 EndContainer(),
955 EndContainer(),
956 /* Resize button. */
958 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
959 NWidget(WWT_RESIZEBOX, COLOUR_LIGHT_BLUE), SetResizeWidgetTypeTip(RWV_HIDE_BEVEL, STR_TOOLTIP_RESIZE),
960 EndContainer(),
961 EndContainer(),
962};
963
964static WindowDesc _network_game_window_desc(
965 WDP_CENTER, "list_servers", 1000, 730,
967 {},
968 _nested_network_game_widgets
969);
970
971void ShowNetworkGameWindow()
972{
973 static bool first = true;
975
976 /* Only show once */
977 if (first) {
978 first = false;
979 /* Add all servers from the config file to our list. */
980 for (const auto &iter : _network_host_list) {
981 NetworkAddServer(iter);
982 }
983 }
984
985 new NetworkGameWindow(_network_game_window_desc);
986}
987
991
993 {
995
997 this->name_editbox.text.Assign(_settings_client.network.server_name);
998
1000 }
1001
1002 void SetStringParameters(WidgetID widget) const override
1003 {
1004 switch (widget) {
1007 break;
1008
1011 break;
1012
1015 break;
1016 }
1017 }
1018
1020 {
1021 switch (widget) {
1024 size.width += padding.width;
1025 size.height += padding.height;
1026 break;
1027 }
1028 }
1029
1030 void DrawWidget(const Rect &r, WidgetID widget) const override
1031 {
1032 switch (widget) {
1033 case WID_NSS_SETPWD:
1034 /* If password is set, draw red '*' next to 'Set password' button. */
1035 if (!_settings_client.network.server_password.empty()) DrawString(r.right + WidgetDimensions::scaled.framerect.left, this->width - WidgetDimensions::scaled.framerect.right, r.top, "*", TC_RED);
1036 }
1037 }
1038
1039 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1040 {
1041 switch (widget) {
1042 case WID_NSS_CANCEL: // Cancel button
1043 ShowNetworkGameWindow();
1044 break;
1045
1046 case WID_NSS_SETPWD: // Set password button
1047 this->widget_id = WID_NSS_SETPWD;
1050 break;
1051
1052 case WID_NSS_CONNTYPE_BTN: // Connection type
1053 ShowDropDownList(this, BuildVisibilityDropDownList(), _settings_client.network.server_game_type, WID_NSS_CONNTYPE_BTN);
1054 break;
1055
1056 case WID_NSS_CLIENTS_BTND: case WID_NSS_CLIENTS_BTNU: // Click on up/down button for number of clients
1057 case WID_NSS_COMPANIES_BTND: case WID_NSS_COMPANIES_BTNU: // Click on up/down button for number of companies
1058 /* Don't allow too fast scrolling. */
1059 if (!this->flags.Test(WindowFlag::Timeout) || this->timeout_timer <= 1) {
1060 this->HandleButtonClick(widget);
1061 this->SetDirty();
1062 switch (widget) {
1063 default: NOT_REACHED();
1066 break;
1069 break;
1070 }
1071 }
1072 _left_button_clicked = false;
1073 break;
1074
1075 case WID_NSS_CLIENTS_TXT: // Click on number of clients
1076 this->widget_id = WID_NSS_CLIENTS_TXT;
1079 break;
1080
1081 case WID_NSS_COMPANIES_TXT: // Click on number of companies
1082 this->widget_id = WID_NSS_COMPANIES_TXT;
1085 break;
1086
1087 case WID_NSS_GENERATE_GAME: // Start game
1088 if (!CheckServerName()) return;
1089 _is_network_server = true;
1090 if (_ctrl_pressed) {
1092 } else {
1094 }
1095 break;
1096
1097 case WID_NSS_LOAD_GAME:
1098 if (!CheckServerName()) return;
1099 _is_network_server = true;
1101 break;
1102
1104 if (!CheckServerName()) return;
1105 _is_network_server = true;
1107 break;
1108
1110 if (!CheckServerName()) return;
1111 _is_network_server = true;
1113 break;
1114 }
1115 }
1116
1117 void OnDropdownSelect(WidgetID widget, int index) override
1118 {
1119 switch (widget) {
1122 break;
1123 default:
1124 NOT_REACHED();
1125 }
1126
1127 this->SetDirty();
1128 }
1129
1130 bool CheckServerName()
1131 {
1132 std::string str = this->name_editbox.text.GetText();
1133 if (!NetworkValidateServerName(str)) return false;
1134
1135 SetSettingValue(GetSettingFromName("network.server_name")->AsStringSetting(), str);
1136 return true;
1137 }
1138
1143
1144 void OnQueryTextFinished(std::optional<std::string> str) override
1145 {
1146 if (!str.has_value()) return;
1147
1148 if (this->widget_id == WID_NSS_SETPWD) {
1149 _settings_client.network.server_password = std::move(*str);
1150 } else {
1151 int32_t value = atoi(str->c_str());
1152 this->SetWidgetDirty(this->widget_id);
1153 switch (this->widget_id) {
1154 default: NOT_REACHED();
1157 }
1158 }
1159
1160 this->SetDirty();
1161 }
1162};
1163
1164static constexpr NWidgetPart _nested_network_start_server_window_widgets[] = {
1166 NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE),
1167 NWidget(WWT_CAPTION, COLOUR_LIGHT_BLUE), SetStringTip(STR_NETWORK_START_SERVER_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1168 EndContainer(),
1169 NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE, WID_NSS_BACKGROUND),
1173 /* Game name widgets */
1174 NWidget(WWT_TEXT, INVALID_COLOUR, WID_NSS_GAMENAME_LABEL), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_NEW_GAME_NAME),
1175 NWidget(WWT_EDITBOX, COLOUR_LIGHT_BLUE, WID_NSS_GAMENAME), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_NEW_GAME_NAME_OSKTITLE, STR_NETWORK_START_SERVER_NEW_GAME_NAME_TOOLTIP),
1176 EndContainer(),
1177
1180 NWidget(WWT_TEXT, INVALID_COLOUR, WID_NSS_CONNTYPE_LABEL), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_VISIBILITY_LABEL),
1181 NWidget(WWT_DROPDOWN, COLOUR_LIGHT_BLUE, WID_NSS_CONNTYPE_BTN), SetFill(1, 0), SetStringTip(STR_JUST_STRING, STR_NETWORK_START_SERVER_VISIBILITY_TOOLTIP),
1182 EndContainer(),
1184 NWidget(NWID_SPACER), SetFill(1, 1),
1185 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NSS_SETPWD), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_SET_PASSWORD, STR_NETWORK_START_SERVER_PASSWORD_TOOLTIP),
1186 EndContainer(),
1187 EndContainer(),
1188
1191 NWidget(WWT_TEXT, INVALID_COLOUR, WID_NSS_CLIENTS_LABEL), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_NUMBER_OF_CLIENTS),
1193 NWidget(WWT_IMGBTN, COLOUR_LIGHT_BLUE, WID_NSS_CLIENTS_BTND), SetAspect(WidgetDimensions::ASPECT_UP_DOWN_BUTTON), SetFill(0, 1), SetSpriteTip(SPR_ARROW_DOWN, STR_NETWORK_START_SERVER_NUMBER_OF_CLIENTS_TOOLTIP),
1194 NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_NSS_CLIENTS_TXT), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_CLIENTS_SELECT, STR_NETWORK_START_SERVER_NUMBER_OF_CLIENTS_TOOLTIP),
1195 NWidget(WWT_IMGBTN, COLOUR_LIGHT_BLUE, WID_NSS_CLIENTS_BTNU), SetAspect(WidgetDimensions::ASPECT_UP_DOWN_BUTTON), SetFill(0, 1), SetSpriteTip(SPR_ARROW_UP, STR_NETWORK_START_SERVER_NUMBER_OF_CLIENTS_TOOLTIP),
1196 EndContainer(),
1197 EndContainer(),
1198
1200 NWidget(WWT_TEXT, INVALID_COLOUR, WID_NSS_COMPANIES_LABEL), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_NUMBER_OF_COMPANIES),
1202 NWidget(WWT_IMGBTN, COLOUR_LIGHT_BLUE, WID_NSS_COMPANIES_BTND), SetAspect(WidgetDimensions::ASPECT_UP_DOWN_BUTTON), SetFill(0, 1), SetSpriteTip(SPR_ARROW_DOWN, STR_NETWORK_START_SERVER_NUMBER_OF_COMPANIES_TOOLTIP),
1203 NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_NSS_COMPANIES_TXT), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_COMPANIES_SELECT, STR_NETWORK_START_SERVER_NUMBER_OF_COMPANIES_TOOLTIP),
1204 NWidget(WWT_IMGBTN, COLOUR_LIGHT_BLUE, WID_NSS_COMPANIES_BTNU), SetAspect(WidgetDimensions::ASPECT_UP_DOWN_BUTTON), SetFill(0, 1), SetSpriteTip(SPR_ARROW_UP, STR_NETWORK_START_SERVER_NUMBER_OF_COMPANIES_TOOLTIP),
1205 EndContainer(),
1206 EndContainer(),
1207 EndContainer(),
1208 EndContainer(),
1209
1211 /* 'generate game' and 'load game' buttons */
1213 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NSS_GENERATE_GAME), SetStringTip(STR_INTRO_NEW_GAME, STR_INTRO_TOOLTIP_NEW_GAME), SetFill(1, 0),
1214 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NSS_LOAD_GAME), SetStringTip(STR_INTRO_LOAD_GAME, STR_INTRO_TOOLTIP_LOAD_GAME), SetFill(1, 0),
1215 EndContainer(),
1216
1217 /* 'play scenario' and 'play heightmap' buttons */
1219 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NSS_PLAY_SCENARIO), SetStringTip(STR_INTRO_PLAY_SCENARIO, STR_INTRO_TOOLTIP_PLAY_SCENARIO), SetFill(1, 0),
1220 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NSS_PLAY_HEIGHTMAP), SetStringTip(STR_INTRO_PLAY_HEIGHTMAP, STR_INTRO_TOOLTIP_PLAY_HEIGHTMAP), SetFill(1, 0),
1221 EndContainer(),
1222 EndContainer(),
1223
1225 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NSS_CANCEL), SetStringTip(STR_BUTTON_CANCEL), SetMinimalSize(128, 12),
1226 EndContainer(),
1227 EndContainer(),
1228 EndContainer(),
1229};
1230
1231static WindowDesc _network_start_server_window_desc(
1232 WDP_CENTER, nullptr, 0, 0,
1234 {},
1235 _nested_network_start_server_window_widgets
1236);
1237
1238static void ShowNetworkStartServerWindow()
1239{
1240 if (!NetworkValidateOurClientName()) return;
1241
1243
1244 new NetworkStartServerWindow(_network_start_server_window_desc);
1245}
1246
1247/* The window below gives information about the connected clients
1248 * and also makes able to kick them (if server) and stuff like that. */
1249
1250extern void DrawCompanyIcon(CompanyID cid, int x, int y);
1251
1252static constexpr NWidgetPart _nested_client_list_widgets[] = {
1254 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1255 NWidget(WWT_CAPTION, COLOUR_GREY), SetStringTip(STR_NETWORK_CLIENT_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1256 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1257 NWidget(WWT_STICKYBOX, COLOUR_GREY),
1258 EndContainer(),
1259 NWidget(WWT_PANEL, COLOUR_GREY),
1261 NWidget(WWT_FRAME, COLOUR_GREY), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER), SetPIP(0, WidgetDimensions::unscaled.vsep_normal, 0),
1263 NWidget(WWT_TEXT, INVALID_COLOUR), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER_NAME),
1264 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CL_SERVER_NAME), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_JUST_RAW_STRING, STR_NETWORK_CLIENT_LIST_SERVER_NAME_TOOLTIP), SetAlignment(SA_VERT_CENTER | SA_RIGHT),
1265 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_CL_SERVER_NAME_EDIT), SetAspect(WidgetDimensions::ASPECT_RENAME), SetSpriteTip(SPR_RENAME, STR_NETWORK_CLIENT_LIST_SERVER_NAME_EDIT_TOOLTIP),
1266 EndContainer(),
1270 NWidget(WWT_TEXT, INVALID_COLOUR), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER_VISIBILITY),
1271 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_CL_SERVER_VISIBILITY), SetStringTip(STR_JUST_STRING, STR_NETWORK_CLIENT_LIST_SERVER_VISIBILITY_TOOLTIP),
1272 EndContainer(),
1274 NWidget(WWT_TEXT, INVALID_COLOUR), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER_INVITE_CODE),
1275 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CL_SERVER_INVITE_CODE), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_JUST_RAW_STRING, STR_NETWORK_CLIENT_LIST_SERVER_INVITE_CODE_TOOLTIP), SetAlignment(SA_VERT_CENTER | SA_RIGHT),
1276 EndContainer(),
1278 NWidget(WWT_TEXT, INVALID_COLOUR), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER_CONNECTION_TYPE),
1279 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CL_SERVER_CONNECTION_TYPE), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_JUST_STRING, STR_NETWORK_CLIENT_LIST_SERVER_CONNECTION_TYPE_TOOLTIP), SetAlignment(SA_VERT_CENTER | SA_RIGHT),
1280 EndContainer(),
1281 EndContainer(),
1282 EndContainer(),
1283 EndContainer(),
1284 NWidget(WWT_FRAME, COLOUR_GREY), SetStringTip(STR_NETWORK_CLIENT_LIST_PLAYER),
1286 NWidget(WWT_TEXT, INVALID_COLOUR), SetStringTip(STR_NETWORK_CLIENT_LIST_PLAYER_NAME),
1287 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CL_CLIENT_NAME), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_JUST_RAW_STRING, STR_NETWORK_CLIENT_LIST_PLAYER_NAME_TOOLTIP), SetAlignment(SA_VERT_CENTER | SA_RIGHT),
1288 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_CL_CLIENT_NAME_EDIT), SetAspect(WidgetDimensions::ASPECT_RENAME), SetSpriteTip(SPR_RENAME, STR_NETWORK_CLIENT_LIST_PLAYER_NAME_EDIT_TOOLTIP),
1289 EndContainer(),
1290 EndContainer(),
1291 EndContainer(),
1292 EndContainer(),
1296 EndContainer(),
1298 NWidget(WWT_PANEL, COLOUR_GREY),
1299 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CL_CLIENT_COMPANY_COUNT), SetFill(1, 0), SetResize(1, 0), SetPadding(WidgetDimensions::unscaled.framerect), SetAlignment(SA_CENTER), SetStringTip(STR_NETWORK_CLIENT_LIST_CLIENT_COMPANY_COUNT, STR_NETWORK_CLIENT_LIST_CLIENT_COMPANY_COUNT_TOOLTIP),
1300 EndContainer(),
1301 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1302 EndContainer(),
1303};
1304
1305static WindowDesc _client_list_desc(
1306 WDP_AUTO, "list_clients", 220, 300,
1308 {},
1309 _nested_client_list_widgets
1310);
1311
1316enum DropDownAdmin : uint8_t {
1317 DD_CLIENT_ADMIN_KICK,
1318 DD_CLIENT_ADMIN_BAN,
1319 DD_COMPANY_ADMIN_RESET,
1320};
1321
1326static void AdminClientKickCallback(Window *, bool confirmed)
1327{
1328 if (confirmed) NetworkServerKickClient(_admin_client_id, {});
1329}
1330
1335static void AdminClientBanCallback(Window *, bool confirmed)
1336{
1337 if (confirmed) NetworkServerKickOrBanIP(_admin_client_id, true, {});
1338}
1339
1344static void AdminCompanyResetCallback(Window *, bool confirmed)
1345{
1346 if (confirmed) {
1349 }
1350}
1351
1360public:
1363 Colours colour;
1365 uint height;
1366 uint width;
1367
1368 ButtonCommon(SpriteID sprite, StringID tooltip, Colours colour, bool disabled = false) :
1369 sprite(sprite),
1371 colour(colour),
1373 {
1375 this->height = d.height + WidgetDimensions::scaled.framerect.Vertical();
1376 this->width = d.width + WidgetDimensions::scaled.framerect.Horizontal();
1377 }
1378 virtual ~ButtonCommon() = default;
1379
1383 virtual void OnClick(struct NetworkClientListWindow *w, Point pt) = 0;
1384};
1385
1389template <typename T>
1390class Button : public ButtonCommon {
1391private:
1392 typedef void (*ButtonCallback)(struct NetworkClientListWindow *w, Point pt, T id);
1393 T id;
1395
1396public:
1397 Button(SpriteID sprite, StringID tooltip, Colours colour, T id, ButtonCallback proc, bool disabled = false) :
1399 id(id),
1400 proc(proc)
1401 {
1402 assert(proc != nullptr);
1403 }
1404
1405 void OnClick(struct NetworkClientListWindow *w, Point pt) override
1406 {
1407 if (this->disabled) return;
1408
1409 this->proc(w, pt, this->id);
1410 }
1411};
1412
1415
1420private:
1422
1425
1432
1433 std::map<uint, std::vector<std::unique_ptr<ButtonCommon>>> buttons;
1434
1445
1461
1471
1479 {
1480 DropDownList list;
1481 list.push_back(MakeDropDownListStringItem(STR_NETWORK_CLIENT_LIST_ADMIN_CLIENT_KICK, DD_CLIENT_ADMIN_KICK));
1482 list.push_back(MakeDropDownListStringItem(STR_NETWORK_CLIENT_LIST_ADMIN_CLIENT_BAN, DD_CLIENT_ADMIN_BAN));
1483
1484 Rect wi_rect;
1485 wi_rect.left = pt.x;
1486 wi_rect.right = pt.x;
1487 wi_rect.top = pt.y;
1488 wi_rect.bottom = pt.y;
1489
1490 w->dd_client_id = client_id;
1491 ShowDropDownListAt(w, std::move(list), -1, WID_CL_MATRIX, wi_rect, COLOUR_GREY, true);
1492 }
1493
1501 {
1502 DropDownList list;
1503 list.push_back(MakeDropDownListStringItem(STR_NETWORK_CLIENT_LIST_ADMIN_COMPANY_RESET, DD_COMPANY_ADMIN_RESET, NetworkCompanyHasClients(company_id)));
1504
1505 Rect wi_rect;
1506 wi_rect.left = pt.x;
1507 wi_rect.right = pt.x;
1508 wi_rect.top = pt.y;
1509 wi_rect.bottom = pt.y;
1510
1511 w->dd_company_id = company_id;
1512 ShowDropDownListAt(w, std::move(list), -1, WID_CL_MATRIX, wi_rect, COLOUR_GREY, true);
1513 }
1524
1525 static void OnClickClientAuthorize([[maybe_unused]] NetworkClientListWindow *w, [[maybe_unused]] Point pt, ClientID client_id)
1526 {
1529 }
1530
1538 {
1540
1541 if (_network_server) this->buttons[line_count].push_back(std::make_unique<CompanyButton>(SPR_ADMIN, STR_NETWORK_CLIENT_LIST_ADMIN_COMPANY_TOOLTIP, COLOUR_RED, company_id, &NetworkClientListWindow::OnClickCompanyAdmin, company_id == COMPANY_SPECTATOR));
1542 this->buttons[line_count].emplace_back(chat_button);
1543 if (can_join_company) this->buttons[line_count].push_back(std::make_unique<CompanyButton>(SPR_JOIN, STR_NETWORK_CLIENT_LIST_JOIN_TOOLTIP, COLOUR_ORANGE, company_id, &NetworkClientListWindow::OnClickCompanyJoin, company_id != COMPANY_SPECTATOR && Company::Get(company_id)->is_ai));
1544
1545 this->line_count += 1;
1546
1547 bool has_players = false;
1548 for (const NetworkClientInfo *ci : NetworkClientInfo::Iterate()) {
1549 if (ci->client_playas != company_id) continue;
1550 has_players = true;
1551
1552 if (_network_server) this->buttons[line_count].push_back(std::make_unique<ClientButton>(SPR_ADMIN, STR_NETWORK_CLIENT_LIST_ADMIN_CLIENT_TOOLTIP, COLOUR_RED, ci->client_id, &NetworkClientListWindow::OnClickClientAdmin, _network_own_client_id == ci->client_id));
1553 if (_network_own_client_id != ci->client_id) this->buttons[line_count].push_back(std::make_unique<ClientButton>(SPR_CHAT, STR_NETWORK_CLIENT_LIST_CHAT_CLIENT_TOOLTIP, COLOUR_ORANGE, ci->client_id, &NetworkClientListWindow::OnClickClientChat));
1554 if (_network_own_client_id != ci->client_id && client_playas != COMPANY_SPECTATOR && !ci->CanJoinCompany(client_playas)) this->buttons[line_count].push_back(std::make_unique<ClientButton>(SPR_JOIN, STR_NETWORK_CLIENT_LIST_COMPANY_AUTHORIZE_TOOLTIP, COLOUR_GREEN, ci->client_id, &NetworkClientListWindow::OnClickClientAuthorize));
1555
1556 if (ci->client_id == _network_own_client_id) {
1557 this->player_self_index = this->line_count;
1558 } else if (ci->client_id == CLIENT_ID_SERVER) {
1559 this->player_host_index = this->line_count;
1560 }
1561
1562 this->line_count += 1;
1563 }
1564
1565 /* Disable the chat button when there are players in this company. */
1567 }
1568
1573 {
1575 CompanyID client_playas = own_ci == nullptr ? COMPANY_SPECTATOR : own_ci->client_playas;
1576
1577 this->buttons.clear();
1578 this->line_count = 0;
1579 this->player_host_index = -1;
1580 this->player_self_index = -1;
1581
1582 /* As spectator, show a line to create a new company. */
1583 if (client_playas == COMPANY_SPECTATOR && !NetworkMaxCompaniesReached()) {
1584 this->buttons[line_count].push_back(std::make_unique<CompanyButton>(SPR_JOIN, STR_NETWORK_CLIENT_LIST_NEW_COMPANY_TOOLTIP, COLOUR_ORANGE, COMPANY_SPECTATOR, &NetworkClientListWindow::OnClickCompanyNew));
1585 this->line_count += 1;
1586 }
1587
1588 if (client_playas != COMPANY_SPECTATOR) {
1589 this->RebuildListCompany(client_playas, client_playas, false);
1590 }
1591
1592 /* Companies */
1593 for (const Company *c : Company::Iterate()) {
1594 if (c->index == client_playas) continue;
1595
1596 this->RebuildListCompany(c->index, client_playas, (own_ci != nullptr && c->allow_list.Contains(own_ci->public_key)) || _network_server);
1597 }
1598
1599 /* Spectators */
1600 this->RebuildListCompany(COMPANY_SPECTATOR, client_playas, client_playas != COMPANY_SPECTATOR);
1601
1602 this->vscroll->SetCount(this->line_count);
1603 }
1604
1611 {
1612 uint index = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_CL_MATRIX);
1613 Rect matrix = this->GetWidget<NWidgetBase>(WID_CL_MATRIX)->GetCurrentRect().Shrink(WidgetDimensions::scaled.framerect);
1614
1615 bool rtl = _current_text_dir == TD_RTL;
1616 uint x = rtl ? matrix.left : matrix.right;
1617
1618 /* Find the buttons for this row. */
1619 auto button_find = this->buttons.find(index);
1620 if (button_find == this->buttons.end()) return nullptr;
1621
1622 /* Check if we want to display a tooltip for any of the buttons. */
1623 for (auto &button : button_find->second) {
1624 uint left = rtl ? x : x - button->width;
1625 uint right = rtl ? x + button->width : x;
1626
1627 if (IsInsideMM(pt.x, left, right)) {
1628 return button.get();
1629 }
1630
1631 int width = button->width + WidgetDimensions::scaled.framerect.Horizontal();
1632 x += rtl ? width : -width;
1633 }
1634
1635 return nullptr;
1636 }
1637
1638public:
1640 Window(desc),
1641 hover_index(-1),
1644 {
1645 this->CreateNestedTree();
1646 this->vscroll = this->GetScrollbar(WID_CL_SCROLLBAR);
1647 this->OnInvalidateData();
1648 this->FinishInitNested(window_number);
1649 }
1650
1651 void OnInit() override
1652 {
1653 RebuildList();
1654 }
1655
1656 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1657 {
1658 this->RebuildList();
1659
1660 /* Currently server information is not sync'd to clients, so we cannot show it on clients. */
1663 }
1664
1666 {
1667 switch (widget) {
1668 case WID_CL_SERVER_NAME:
1669 case WID_CL_CLIENT_NAME:
1670 if (widget == WID_CL_SERVER_NAME) {
1672 } else {
1674 SetDParamStr(0, own_ci != nullptr ? own_ci->client_name : _settings_client.network.client_name);
1675 }
1677 size.width = std::min(size.width, static_cast<uint>(ScaleGUITrad(200))); // By default, don't open the window too wide.
1678 break;
1679
1682 size.width += padding.width;
1683 size.height += padding.height;
1684 break;
1685
1686 case WID_CL_MATRIX: {
1687 uint height = std::max({GetSpriteSize(SPR_COMPANY_ICON).height, GetSpriteSize(SPR_JOIN).height, GetSpriteSize(SPR_ADMIN).height, GetSpriteSize(SPR_CHAT).height});
1689 this->line_height = std::max(height, (uint)GetCharacterHeight(FS_NORMAL)) + padding.height;
1690
1691 resize.width = 1;
1692 resize.height = this->line_height;
1693 fill.height = this->line_height;
1694 size.height = std::max(size.height, 5 * this->line_height);
1695 break;
1696 }
1697 }
1698 }
1699
1700 void OnResize() override
1701 {
1702 this->vscroll->SetCapacityFromWidget(this, WID_CL_MATRIX);
1703 }
1704
1739
1740 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1741 {
1742 switch (widget) {
1744 if (!_network_server) break;
1745
1746 this->query_widget = WID_CL_SERVER_NAME_EDIT;
1749 break;
1750
1753 this->query_widget = WID_CL_CLIENT_NAME_EDIT;
1754 SetDParamStr(0, own_ci != nullptr ? own_ci->client_name : _settings_client.network.client_name);
1756 break;
1757 }
1759 if (!_network_server) break;
1760
1762 break;
1763
1764 case WID_CL_MATRIX: {
1765 ButtonCommon *button = this->GetButtonAtPoint(pt);
1766 if (button == nullptr) break;
1767
1768 button->OnClick(this, pt);
1769 break;
1770 }
1771 }
1772 }
1773
1774 bool OnTooltip([[maybe_unused]] Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
1775 {
1776 switch (widget) {
1777 case WID_CL_MATRIX: {
1778 int index = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_CL_MATRIX);
1779
1780 bool rtl = _current_text_dir == TD_RTL;
1781 Rect matrix = this->GetWidget<NWidgetBase>(WID_CL_MATRIX)->GetCurrentRect().Shrink(WidgetDimensions::scaled.framerect);
1782
1783 Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
1784 uint text_left = matrix.left + (rtl ? 0 : d.width + WidgetDimensions::scaled.hsep_wide);
1785 uint text_right = matrix.right - (rtl ? d.width + WidgetDimensions::scaled.hsep_wide : 0);
1786
1787 Dimension d2 = GetSpriteSize(SPR_PLAYER_SELF);
1789
1790 uint player_icon_x = rtl ? text_right - offset_x - d2.width : text_left + offset_x;
1791
1792 if (IsInsideMM(pt.x, player_icon_x, player_icon_x + d2.width)) {
1793 if (index == this->player_self_index) {
1795 return true;
1796 } else if (index == this->player_host_index) {
1798 return true;
1799 }
1800 }
1801
1802 ButtonCommon *button = this->GetButtonAtPoint(pt);
1803 if (button == nullptr) return false;
1804
1805 GuiShowTooltips(this, button->tooltip, close_cond);
1806 return true;
1807 };
1808 }
1809
1810 return false;
1811 }
1812
1813 void OnDropdownClose(Point pt, WidgetID widget, int index, bool instant_close) override
1814 {
1815 /* If you close the dropdown outside the list, don't take any action. */
1816 if (widget == WID_CL_MATRIX) return;
1817
1818 Window::OnDropdownClose(pt, widget, index, instant_close);
1819 }
1820
1821 void OnDropdownSelect(WidgetID widget, int index) override
1822 {
1823 switch (widget) {
1825 if (!_network_server) break;
1826
1829 break;
1830
1831 case WID_CL_MATRIX: {
1832 StringID text = STR_NULL;
1833 QueryCallbackProc *callback = nullptr;
1834
1835 switch (index) {
1836 case DD_CLIENT_ADMIN_KICK:
1839 callback = AdminClientKickCallback;
1841 break;
1842
1843 case DD_CLIENT_ADMIN_BAN:
1846 callback = AdminClientBanCallback;
1848 break;
1849
1850 case DD_COMPANY_ADMIN_RESET:
1853 callback = AdminCompanyResetCallback;
1855 break;
1856
1857 default:
1858 NOT_REACHED();
1859 }
1860
1861 assert(text != STR_NULL);
1862 assert(callback != nullptr);
1863
1864 /* Always ask confirmation for all admin actions. */
1865 ShowQuery(STR_NETWORK_CLIENT_LIST_ASK_CAPTION, text, this, callback);
1866
1867 break;
1868 }
1869
1870 default:
1871 NOT_REACHED();
1872 }
1873
1874 this->SetDirty();
1875 }
1876
1877 void OnQueryTextFinished(std::optional<std::string> str) override
1878 {
1879 if (!str.has_value()) return;
1880
1881 switch (this->query_widget) {
1882 default: NOT_REACHED();
1883
1885 if (!_network_server) break;
1886
1887 SetSettingValue(GetSettingFromName("network.server_name")->AsStringSetting(), *str);
1888 this->InvalidateData();
1889 break;
1890 }
1891
1893 SetSettingValue(GetSettingFromName("network.client_name")->AsStringSetting(), *str);
1894 this->InvalidateData();
1895 break;
1896 }
1897 }
1898 }
1899
1910 void DrawButtons(int &x, uint y, const std::vector<std::unique_ptr<ButtonCommon>> &buttons) const
1911 {
1912 Rect r;
1913
1914 for (auto &button : buttons) {
1915 bool rtl = _current_text_dir == TD_RTL;
1916
1917 int offset = (this->line_height - button->height) / 2;
1918 r.left = rtl ? x : x - button->width + 1;
1919 r.right = rtl ? x + button->width - 1 : x;
1920 r.top = y + offset;
1921 r.bottom = r.top + button->height - 1;
1922
1923 DrawFrameRect(r, button->colour, {});
1924 DrawSprite(button->sprite, PAL_NONE, r.left + WidgetDimensions::scaled.framerect.left, r.top + WidgetDimensions::scaled.framerect.top);
1925 if (button->disabled) {
1927 }
1928
1929 int width = button->width + WidgetDimensions::scaled.hsep_normal;
1930 x += rtl ? width : -width;
1931 }
1932 }
1933
1940 void DrawCompany(CompanyID company_id, const Rect &r, uint &line) const
1941 {
1942 bool rtl = _current_text_dir == TD_RTL;
1943 int text_y_offset = CenterBounds(0, this->line_height, GetCharacterHeight(FS_NORMAL));
1944
1945 Dimension d = GetSpriteSize(SPR_COMPANY_ICON);
1946 int offset = CenterBounds(0, this->line_height, d.height);
1947
1948 uint line_start = this->vscroll->GetPosition();
1949 uint line_end = line_start + this->vscroll->GetCapacity();
1950
1951 uint y = r.top + (this->line_height * (line - line_start));
1952
1953 /* Draw the company line (if in range of scrollbar). */
1954 if (IsInsideMM(line, line_start, line_end)) {
1955 int icon_left = r.WithWidth(d.width, rtl).left;
1957 int &x = rtl ? tr.left : tr.right;
1958
1959 /* If there are buttons for this company, draw them. */
1960 auto button_find = this->buttons.find(line);
1961 if (button_find != this->buttons.end()) {
1962 this->DrawButtons(x, y, button_find->second);
1963 }
1964
1966 DrawSprite(SPR_COMPANY_ICON, PALETTE_TO_GREY, icon_left, y + offset);
1967 DrawString(tr.left, tr.right, y + text_y_offset, STR_NETWORK_CLIENT_LIST_SPECTATORS, TC_SILVER);
1968 } else if (company_id == COMPANY_NEW_COMPANY) {
1969 DrawSprite(SPR_COMPANY_ICON, PALETTE_TO_GREY, icon_left, y + offset);
1971 } else {
1972 DrawCompanyIcon(company_id, icon_left, y + offset);
1973
1976 DrawString(tr.left, tr.right, y + text_y_offset, STR_COMPANY_NAME, TC_SILVER);
1977 }
1978 }
1979
1980 y += this->line_height;
1981 line++;
1982
1983 for (const NetworkClientInfo *ci : NetworkClientInfo::Iterate()) {
1984 if (ci->client_playas != company_id) continue;
1985
1986 /* Draw the player line (if in range of scrollbar). */
1987 if (IsInsideMM(line, line_start, line_end)) {
1988 Rect tr = r.Indent(WidgetDimensions::scaled.hsep_indent, rtl);
1989
1990 /* If there are buttons for this client, draw them. */
1991 auto button_find = this->buttons.find(line);
1992 if (button_find != this->buttons.end()) {
1993 int &x = rtl ? tr.left : tr.right;
1994 this->DrawButtons(x, y, button_find->second);
1995 }
1996
1998 if (ci->client_id == _network_own_client_id) {
1999 player_icon = SPR_PLAYER_SELF;
2000 } else if (ci->client_id == CLIENT_ID_SERVER) {
2001 player_icon = SPR_PLAYER_HOST;
2002 }
2003
2004 if (player_icon != 0) {
2006 int offset_y = CenterBounds(0, this->line_height, d2.height);
2007 DrawSprite(player_icon, PALETTE_TO_GREY, rtl ? tr.right - d2.width : tr.left, y + offset_y);
2008 tr = tr.Indent(d2.width + WidgetDimensions::scaled.hsep_normal, rtl);
2009 }
2010
2011 SetDParamStr(0, ci->client_name);
2012 DrawString(tr.left, tr.right, y + text_y_offset, STR_JUST_RAW_STRING, TC_BLACK);
2013 }
2014
2015 y += this->line_height;
2016 line++;
2017 }
2018 }
2019
2020 void DrawWidget(const Rect &r, WidgetID widget) const override
2021 {
2022 switch (widget) {
2023 case WID_CL_MATRIX: {
2024 Rect ir = r.Shrink(WidgetDimensions::scaled.framerect, RectPadding::zero);
2025 uint line = 0;
2026
2027 if (this->hover_index >= 0) {
2028 Rect br = r.WithHeight(this->line_height).Translate(0, this->hover_index * this->line_height);
2030 }
2031
2033 CompanyID client_playas = own_ci == nullptr ? COMPANY_SPECTATOR : own_ci->client_playas;
2034
2035 if (client_playas == COMPANY_SPECTATOR && !NetworkMaxCompaniesReached()) {
2036 this->DrawCompany(COMPANY_NEW_COMPANY, ir, line);
2037 }
2038
2039 if (client_playas != COMPANY_SPECTATOR) {
2040 this->DrawCompany(client_playas, ir, line);
2041 }
2042
2043 for (const Company *c : Company::Iterate()) {
2044 if (client_playas == c->index) continue;
2045 this->DrawCompany(c->index, ir, line);
2046 }
2047
2048 /* Spectators */
2049 this->DrawCompany(COMPANY_SPECTATOR, ir, line);
2050
2051 break;
2052 }
2053 }
2054 }
2055
2056 void OnMouseOver([[maybe_unused]] Point pt, WidgetID widget) override
2057 {
2058 if (widget != WID_CL_MATRIX) {
2059 if (this->hover_index != -1) {
2060 this->hover_index = -1;
2062 }
2063 } else {
2064 int index = this->GetRowFromWidget(pt.y, widget, 0, -1);
2065 if (index != this->hover_index) {
2066 this->hover_index = index;
2068 }
2069 }
2070 }
2071};
2072
2073void ShowClientList()
2074{
2075 AllocateWindowDescFront<NetworkClientListWindow>(_client_list_desc, 0);
2076}
2077
2082
2084 std::shared_ptr<NetworkAuthenticationPasswordRequest> request;
2085
2087 {
2090 }
2091
2092 void DrawWidget(const Rect &r, WidgetID widget) const override
2093 {
2094 switch (widget) {
2095 case WID_NJS_PROGRESS_BAR: {
2096 /* Draw the % complete with a bar and a text */
2099 uint8_t progress; // used for progress bar
2100 switch (_network_join_status) {
2101 case NETWORK_JOIN_STATUS_CONNECTING:
2102 case NETWORK_JOIN_STATUS_AUTHORIZING:
2103 case NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO:
2104 progress = 10; // first two stages 10%
2105 break;
2106 case NETWORK_JOIN_STATUS_WAITING:
2107 progress = 15; // third stage is 15%
2108 break;
2109 case NETWORK_JOIN_STATUS_DOWNLOADING:
2110 if (_network_join_bytes_total == 0) {
2111 progress = 15; // We don't have the final size yet; the server is still compressing!
2112 break;
2113 }
2114 [[fallthrough]];
2115
2116 default: // Waiting is 15%, so the resting receivement of map is maximum 70%
2117 progress = 15 + _network_join_bytes * (100 - 15) / _network_join_bytes_total;
2118 break;
2119 }
2120 DrawFrameRect(ir.WithWidth(ir.Width() * progress / 100, _current_text_dir == TD_RTL), COLOUR_MAUVE, {});
2122 break;
2123 }
2124
2126 switch (_network_join_status) {
2127 case NETWORK_JOIN_STATUS_WAITING:
2130 break;
2131 case NETWORK_JOIN_STATUS_DOWNLOADING:
2135 break;
2136 default:
2137 break;
2138 }
2139 break;
2140 }
2141 }
2142
2144 {
2145 switch (widget) {
2147 /* Account for the statuses */
2148 for (uint i = 0; i < NETWORK_JOIN_STATUS_END; i++) {
2150 }
2151 /* For the number of waiting (other) players */
2154 /* We need some spacing for the 'border' */
2157 break;
2158
2160 /* Account for downloading ~ 10 MiB */
2161 SetDParamMaxDigits(0, 8);
2162 SetDParamMaxDigits(1, 8);
2165 break;
2166 }
2167 }
2168
2169 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2170 {
2171 if (widget == WID_NJS_CANCELOK) { // Disconnect button
2173 SwitchToMode(SM_MENU);
2174 ShowNetworkGameWindow();
2175 }
2176 }
2177
2178 void OnQueryTextFinished(std::optional<std::string> str) override
2179 {
2180 if (!str.has_value() || str->empty() || this->request == nullptr) {
2182 return;
2183 }
2184
2185 this->request->Reply(*str);
2186 }
2187};
2188
2189static constexpr NWidgetPart _nested_network_join_status_window_widgets[] = {
2190 NWidget(WWT_CAPTION, COLOUR_GREY), SetStringTip(STR_NETWORK_CONNECTING_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2191 NWidget(WWT_PANEL, COLOUR_GREY),
2193 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_NJS_PROGRESS_BAR), SetFill(1, 0),
2194 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_NJS_PROGRESS_TEXT), SetFill(1, 0), SetMinimalSize(350, 0),
2195 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NJS_CANCELOK), SetMinimalSize(101, 12), SetStringTip(STR_NETWORK_CONNECTION_DISCONNECT), SetFill(1, 0),
2196 EndContainer(),
2197 EndContainer(),
2198};
2199
2200static WindowDesc _network_join_status_window_desc(
2201 WDP_CENTER, nullptr, 0, 0,
2204 _nested_network_join_status_window_widgets
2205);
2206
2207void ShowJoinStatusWindow()
2208{
2210 new NetworkJoinStatusWindow(_network_join_status_window_desc);
2211}
2212
2213void ShowNetworkNeedPassword(std::shared_ptr<NetworkAuthenticationPasswordRequest> request)
2214{
2216 if (w == nullptr) return;
2217 w->request = request;
2218
2219 ShowQueryString(STR_EMPTY, STR_NETWORK_NEED_GAME_PASSWORD_CAPTION, NETWORK_PASSWORD_LENGTH, w, CS_ALPHANUMERAL, QSF_NONE);
2220}
2221
2228 std::string token;
2229
2230 NetworkAskRelayWindow(WindowDesc &desc, Window *parent, const std::string &server_connection_string, const std::string &relay_connection_string, const std::string &token) :
2231 Window(desc),
2234 token(token)
2235 {
2236 this->parent = parent;
2237 this->InitNested(0);
2238 }
2239
2240 void Close(int data = 0) override
2241 {
2242 if (data == NRWCD_UNHANDLED) _network_coordinator_client.ConnectFailure(this->token, 0);
2243 this->Window::Close();
2244 }
2245
2247 {
2248 if (widget == WID_NAR_TEXT) {
2250 }
2251 }
2252
2253 void DrawWidget(const Rect &r, WidgetID widget) const override
2254 {
2255 if (widget == WID_NAR_TEXT) {
2257 }
2258 }
2259
2261 {
2262 /* Position query window over the calling window, ensuring it's within screen bounds. */
2263 this->left = Clamp(parent->left + (parent->width / 2) - (this->width / 2), 0, _screen.width - this->width);
2264 this->top = Clamp(parent->top + (parent->height / 2) - (this->height / 2), 0, _screen.height - this->height);
2265 this->SetDirty();
2266 }
2267
2268 void SetStringParameters(WidgetID widget) const override
2269 {
2270 switch (widget) {
2271 case WID_NAR_TEXT:
2272 SetDParamStr(0, this->server_connection_string);
2273 SetDParamStr(1, this->relay_connection_string);
2274 break;
2275 }
2276 }
2277
2278 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2279 {
2280 switch (widget) {
2281 case WID_NAR_NO:
2283 this->Close(NRWCD_HANDLED);
2284 break;
2285
2286 case WID_NAR_YES_ONCE:
2287 _network_coordinator_client.StartTurnConnection(this->token);
2288 this->Close(NRWCD_HANDLED);
2289 break;
2290
2291 case WID_NAR_YES_ALWAYS:
2293 _network_coordinator_client.StartTurnConnection(this->token);
2294 this->Close(NRWCD_HANDLED);
2295 break;
2296 }
2297 }
2298};
2299
2300static constexpr NWidgetPart _nested_network_ask_relay_widgets[] = {
2302 NWidget(WWT_CLOSEBOX, COLOUR_RED),
2303 NWidget(WWT_CAPTION, COLOUR_RED, WID_NAR_CAPTION), SetStringTip(STR_NETWORK_ASK_RELAY_CAPTION),
2304 EndContainer(),
2305 NWidget(WWT_PANEL, COLOUR_RED),
2309 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NAR_NO), SetMinimalSize(71, 12), SetFill(1, 1), SetStringTip(STR_NETWORK_ASK_RELAY_NO),
2310 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NAR_YES_ONCE), SetMinimalSize(71, 12), SetFill(1, 1), SetStringTip(STR_NETWORK_ASK_RELAY_YES_ONCE),
2311 NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_NAR_YES_ALWAYS), SetMinimalSize(71, 12), SetFill(1, 1), SetStringTip(STR_NETWORK_ASK_RELAY_YES_ALWAYS),
2312 EndContainer(),
2313 EndContainer(),
2314 EndContainer(),
2315};
2316
2317static WindowDesc _network_ask_relay_desc(
2318 WDP_CENTER, nullptr, 0, 0,
2321 _nested_network_ask_relay_widgets
2322);
2323
2330void ShowNetworkAskRelay(const std::string &server_connection_string, const std::string &relay_connection_string, const std::string &token)
2331{
2333
2334 Window *parent = GetMainWindow();
2335 new NetworkAskRelayWindow(_network_ask_relay_desc, parent, server_connection_string, relay_connection_string, token);
2336}
2337
2343 Window(desc)
2344 {
2345 this->parent = parent;
2346 this->InitNested(0);
2347 }
2348
2350 {
2351 if (widget == WID_NAS_TEXT) {
2353 }
2354 }
2355
2356 void DrawWidget(const Rect &r, WidgetID widget) const override
2357 {
2358 if (widget == WID_NAS_TEXT) {
2360 }
2361 }
2362
2364 {
2365 /* Position query window over the calling window, ensuring it's within screen bounds. */
2366 this->left = Clamp(parent->left + (parent->width / 2) - (this->width / 2), 0, _screen.width - this->width);
2367 this->top = Clamp(parent->top + (parent->height / 2) - (this->height / 2), 0, _screen.height - this->height);
2368 this->SetDirty();
2369 }
2370
2371 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2372 {
2373 switch (widget) {
2374 case WID_NAS_PREVIEW:
2375 ShowSurveyResultTextfileWindow();
2376 break;
2377
2378 case WID_NAS_LINK:
2379 OpenBrowser(NETWORK_SURVEY_DETAILS_LINK);
2380 break;
2381
2382 case WID_NAS_NO:
2384 this->Close();
2385 break;
2386
2387 case WID_NAS_YES:
2389 this->Close();
2390 break;
2391 }
2392 }
2393};
2394
2395static constexpr NWidgetPart _nested_network_ask_survey_widgets[] = {
2397 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
2398 NWidget(WWT_CAPTION, COLOUR_GREY, WID_NAS_CAPTION), SetStringTip(STR_NETWORK_ASK_SURVEY_CAPTION),
2399 EndContainer(),
2400 NWidget(WWT_PANEL, COLOUR_GREY),
2404 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NAS_PREVIEW), SetMinimalSize(71, 12), SetFill(1, 1), SetStringTip(STR_NETWORK_ASK_SURVEY_PREVIEW),
2405 NWidget(WWT_PUSHTXTBTN, COLOUR_WHITE, WID_NAS_LINK), SetMinimalSize(71, 12), SetFill(1, 1), SetStringTip(STR_NETWORK_ASK_SURVEY_LINK),
2406 EndContainer(),
2408 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_NAS_NO), SetMinimalSize(71, 12), SetFill(1, 1), SetStringTip(STR_NETWORK_ASK_SURVEY_NO),
2409 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_NAS_YES), SetMinimalSize(71, 12), SetFill(1, 1), SetStringTip(STR_NETWORK_ASK_SURVEY_YES),
2410 EndContainer(),
2411 EndContainer(),
2412 EndContainer(),
2413};
2414
2415static WindowDesc _network_ask_survey_desc(
2416 WDP_CENTER, nullptr, 0, 0,
2419 _nested_network_ask_survey_widgets
2420);
2421
2426{
2427 /* If we can't send a survey, don't ask the question. */
2428 if constexpr (!NetworkSurveyHandler::IsSurveyPossible()) return;
2429
2431
2432 Window *parent = GetMainWindow();
2433 new NetworkAskSurveyWindow(_network_ask_survey_desc, parent);
2434}
2435
2439
2441 {
2442 this->ConstructWindow();
2443
2444 auto result = _survey.CreatePayload(NetworkSurveyHandler::Reason::PREVIEW, true);
2445 this->LoadText(result);
2446 this->InvalidateData();
2447 }
2448};
2449
2450void ShowSurveyResultTextfileWindow()
2451{
2454}
Button shown for either a company or client in the client-list.
Colours colour
The colour of the button.
bool disabled
Is the button disabled?
uint width
Calculated width of the button.
virtual void OnClick(struct NetworkClientListWindow *w, Point pt)=0
OnClick handler for when the button is pressed.
SpriteID sprite
The sprite to use on the button.
uint height
Calculated height of the button.
StringID tooltip
The tooltip of the button.
Template version of Button, with callback support.
T id
ID this button belongs to.
void OnClick(struct NetworkClientListWindow *w, Point pt) override
OnClick handler for when the button is pressed.
ButtonCallback proc
Callback proc to call when button is pressed.
void(* ButtonCallback)(struct NetworkClientListWindow *w, Point pt, T id)
Callback function to call on click.
void ConnectFailure(const std::string &token, uint8_t tracking_number)
Callback from a Connecter to let the Game Coordinator know the connection failed.
void GetListing()
Request a listing of all public servers.
constexpr bool Test(Tenum value) const
Test if the enum value is set.
List template of 'things' T to sort in a GUI.
bool Filter(FilterFunction *decide, F filter_data)
Filter the list.
void RebuildDone()
Notify the sortlist that the rebuild is done.
void SetListing(Listing l)
Import sort conditions.
void SetFilterState(bool state)
Enable or disable the filter.
bool IsDescSortOrder() const
Check if the sort order is descending.
void ToggleSortOrder()
Toggle the sort order Since that is the worst condition for the sort function reverse the list here.
void SetFilterFuncs(std::span< FilterFunction *const > n_funcs)
Hand the filter function pointers to the GUIList.
bool NeedRebuild() const
Check if a rebuild is needed.
void ForceRebuild()
Force that a rebuild is needed.
bool Sort(Comp compare)
Sort the list.
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
uint8_t SortType() const
Get the sorttype of the list.
Listing GetListing() const
Export current sort conditions.
void SetSortFuncs(std::span< SortFunction *const > n_funcs)
Hand the sort function pointers to the GUIList.
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0.
void SetSortType(uint8_t n_type)
Set the sorttype of the list.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
Baseclass for nested widgets.
uint resize_x
Horizontal resize step (0 means not resizable).
uint fill_x
Horizontal fill stepsize (from initial size, 0 means not resizable).
uint smallest_x
Smallest horizontal size of the widget in a filled window.
uint current_x
Current horizontal size (after resizing).
int pos_y
Vertical position of top-left corner of the widget in the window.
int pos_x
Horizontal position of top-left corner of the widget in the window.
uint smallest_y
Smallest vertical size of the widget in a filled window.
uint fill_y
Vertical fill stepsize (from initial size, 0 means not resizable).
uint resize_y
Vertical resize step (0 means not resizable).
uint current_y
Current vertical size (after resizing).
Baseclass for container widgets.
void Add(std::unique_ptr< NWidgetBase > &&wid)
Append widget wid to container.
Definition widget.cpp:1281
std::vector< std::unique_ptr< NWidgetBase > > children
Child widgets in contaier.
Full blown container to make it behave exactly as we want :)
static const uint MINIMUM_NAME_WIDTH_BEFORE_NEW_HEADER
Minimum width before adding a new header.
void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
Assign size and position to the widget.
void SetupSmallestSize(Window *w) override
Compute smallest size needed by the widget.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
void OnPaint() override
The window must be repainted.
static bool NGameClientSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by the amount of clients online on a server.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
static bool NGameMapSizeSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by map size.
QueryString filter_editbox
Editbox for filter on servers.
Scrollbar * vscroll
Vertical scrollbar of the list of servers.
NetworkGameList * last_joined
The last joined server.
static bool NGameAllowedSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by joinability.
NetworkGameList * server
Selected server.
void BuildGUINetworkGameList()
Dimension of compatibility icon.
void UpdateListPos()
Set this->list_pos to match this->server.
IntervalTimer< TimerWindow > refresh_interval
Refresh the online servers on a regular interval.
void OnInit() override
Notification that the nested widget tree gets initialized.
static bool NGameNameSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by name.
void DrawServerLine(const NetworkGameList *cur_item, int y, bool highlight) const
Draw a single server line.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
static bool NGameCalendarDateSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by calendar date.
void OnResize() override
Called after the window got resized.
void ScrollToSelectedServer()
Scroll the list up or down to the currently selected server.
void OnEditboxChanged(WidgetID wid) override
The text in an editbox has been edited.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
ServerListPosition list_pos
Position of the selected server.
static bool NGameTicksPlayingSorter(NetworkGameList *const &a, NetworkGameList *const &b)
Sort servers by the number of ticks the game is running.
void SortNetworkGameList()
Sort the server list.
Dimension blot
Dimension of lock icon.
GUIGameServerList servers
List with game servers.
bool searched_internet
Did we ever press "Search Internet" button?
QueryString name_editbox
Client name editbox.
EventState OnKeyPress(char32_t key, uint16_t keycode) override
A key has been pressed.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
@ PREVIEW
User is previewing the survey result.
Scrollbar data structure.
size_type GetCapacity() const
Gets the number of visible elements of the scrollbar.
void SetCount(size_t num)
Sets the number of elements in the list.
auto GetScrolledItemFromWidget(Tcontainer &container, int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Return an iterator pointing to the element of a scrolled widget that a user clicked in.
size_type GetScrolledRowFromWidget(int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition widget.cpp:2459
void SetCapacityFromWidget(Window *w, WidgetID widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition widget.cpp:2533
EventState UpdateListPositionOnKeyPress(int &list_position, uint16_t keycode) const
Update the given list position as if it were on this scroll bar when the given keycode was pressed.
Definition widget.cpp:2480
void ScrollTowards(size_type position)
Scroll towards the given position; if the item is visible nothing happens, otherwise it will be shown...
auto GetVisibleRangeIterators(Tcontainer &container) const
Get a pair of iterators for the range of visible elements in a container.
size_type GetPosition() const
Gets the position of the first visible element in the list.
static constexpr TimerGameTick::Ticks TICKS_PER_SECOND
Estimation of how many ticks fit in a single second.
static YearMonthDay ConvertDateToYMD(Date date)
Converts a Date to a Year, Month & Day.
RectPadding framerect
Standard padding inside many panels.
Definition window_gui.h:40
RectPadding frametext
Padding inside frame with text.
Definition window_gui.h:41
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:28
int vsep_wide
Wide vertical spacing.
Definition window_gui.h:60
int hsep_wide
Wide horizontal spacing.
Definition window_gui.h:62
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:94
RectPadding matrix
Padding of WWT_MATRIX items.
Definition window_gui.h:42
int hsep_normal
Normal horizontal spacing.
Definition window_gui.h:61
RectPadding bevel
Bevel thickness, affected by "scaled bevels" game option.
Definition window_gui.h:38
int hsep_indent
Width of identation for tree layouts.
Definition window_gui.h:63
CompanyID _current_company
Company currently doing an action.
@ CCA_DELETE
Delete a company.
@ CCA_NEW
Create a new company.
@ CALCA_ADD
Create a public key.
Owner
Enum for all companies/owners.
@ INVALID_COMPANY
An invalid company.
@ COMPANY_SPECTATOR
The client is spectating.
@ COMPANY_NEW_COMPANY
The client wants a new company.
@ MAX_COMPANIES
Maximum number of companies.
@ CRR_NONE
Dummy reason for actions that don't need one.
@ CRR_MANUAL
The company is manually removed.
static const uint NETWORK_CLIENT_NAME_LENGTH
The maximum length of a client's name, in bytes including '\0'.
Definition config.h:58
static const uint NETWORK_HOSTNAME_PORT_LENGTH
The maximum length of the host name + port, in bytes including '\0'. The extra six is ":" + port numb...
Definition config.h:55
static const uint NETWORK_NAME_LENGTH
The maximum length of the server name and map name, in bytes including '\0'.
Definition config.h:53
static const std::string NETWORK_SURVEY_DETAILS_LINK
Link with more details & privacy statement of the survey.
Definition config.h:30
static const uint NETWORK_PASSWORD_LENGTH
The maximum length of the password, in bytes including '\0'.
Definition config.h:57
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, bool instant_close, bool persist)
Show a drop down list.
Definition dropdown.cpp:404
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, bool instant_close, bool persist)
Show a drop down list.
Definition dropdown.cpp:386
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23)
Definition enum_type.hpp:15
@ SLO_LOAD
File is being loaded.
Definition fileio_type.h:55
@ FT_SCENARIO
old or new scenario
Definition fileio_type.h:19
@ FT_HEIGHTMAP
heightmap file
Definition fileio_type.h:20
@ FT_SAVEGAME
old or new savegame
Definition fileio_type.h:18
void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Launch save/load dialog in the given mode.
Definition fios_gui.cpp:986
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:77
static const uint32_t GENERATE_NEW_SEED
Create a new random seed.
Definition genworld.h:25
void StartNewGameWithoutGUI(uint32_t seed)
Start a normal game without the GUI.
void ShowGenerateLandscape()
Start with a normal game.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition gfx.cpp:704
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition gfx.cpp:922
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:851
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:657
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:38
bool _left_button_clicked
Is left mouse button clicked?
Definition gfx.cpp:42
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition gfx.cpp:114
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition gfx.cpp:988
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:774
Dimension GetScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI.
Definition widget.cpp:54
int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition gfx_func.h:166
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:243
@ SA_RIGHT
Right align the text (must be a single bit).
Definition gfx_type.h:377
@ SA_HOR_CENTER
Horizontally center the text.
Definition gfx_type.h:376
@ SA_CENTER
Center both horizontally and vertically.
Definition gfx_type.h:385
@ SA_VERT_CENTER
Vertically center the text.
Definition gfx_type.h:381
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition gfx_type.h:333
constexpr NWidgetPart SetMatrixDataTip(uint32_t cols, uint32_t rows, StringID tip={})
Widget part function for setting the data and tooltip of WWT_MATRIX widgets.
constexpr NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
constexpr NWidgetPart SetSpriteTip(SpriteID sprite, StringID tip={})
Widget part function for setting the sprite and tooltip.
constexpr NWidgetPart SetPIP(uint8_t pre, uint8_t inter, uint8_t post)
Widget part function for setting a pre/inter/post spaces.
constexpr NWidgetPart SetScrollbar(WidgetID index)
Attach a scrollbar to a widget.
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.
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
constexpr NWidgetPart SetAspect(float ratio, AspectFlags flags=AspectFlag::ResizeX)
Widget part function for setting the aspect ratio.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
constexpr NWidgetPart SetResizeWidgetTypeTip(ResizeWidgetValues widget_type, StringID tip)
Widget part function for setting the resize widget type and tooltip.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetToolTip(StringID tip)
Widget part function for setting tooltip and clearing the widget data.
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
constexpr NWidgetPart SetAlignment(StringAlignment align)
Widget part function for setting the alignment of text/images.
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
constexpr NWidgetPart SetPIPRatio(uint8_t ratio_pre, uint8_t ratio_inter, uint8_t ratio_post)
Widget part function for setting a pre/inter/post ratio.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:937
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1529
static const uint MAX_MAP_SIZE
Maximal map size = 4096.
Definition map_type.h:40
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
void GuiShowTooltips(Window *parent, StringID str, TooltipCloseCondition close_tooltip, uint paramcount)
Shows a tooltip.
Definition misc_gui.cpp:740
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback, bool focus)
Show a confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre o...
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
bool _is_network_server
Does this client wants to be a network-server?
Definition network.cpp:69
StringList _network_host_list
The servers we know.
Definition network.cpp:74
void NetworkQueryServer(const std::string &connection_string)
Query a server to fetch the game-info.
Definition network.cpp:672
NetworkGameList * NetworkAddServer(const std::string &connection_string, bool manually, bool never_expire)
Validates an address entered as a string and adds the server to the list.
Definition network.cpp:694
void NetworkDisconnect(bool close_admins)
We want to disconnect from the host/clients.
Definition network.cpp:1001
bool _network_server
network-server is active
Definition network.cpp:66
ClientID _network_own_client_id
Our client identifier.
Definition network.cpp:70
bool NetworkClientConnectGame(const std::string &connection_string, CompanyID default_company, const std::string &join_server_password)
Join a client to the server at with the given connection string.
Definition network.cpp:787
void NetworkUpdateServerGameType()
The setting server_game_type was updated; possibly we need to take some action.
Definition network.cpp:1029
bool NetworkValidateServerName(std::string &server_name)
Trim the given server name in place, i.e.
Definition network.cpp:860
Basic functions/variables used all over the place.
Base core network types and some helper functions to access them.
void ShowNetworkChatQueryWindow(DestType type, int dest)
Show the chat window.
bool NetworkValidateOurClientName()
Convenience method for NetworkValidateClientName on _settings_client.network.client_name.
bool NetworkMaxCompaniesReached()
Check if max_companies has been reached on the server (local check only).
uint NetworkMaxCompaniesAllowed()
Get the maximum number of companies that are allowed by the server.
std::string _network_server_name
The current name of the server you are on.
void NetworkClientRequestMove(CompanyID company_id)
Notify the server of this client wanting to be moved to another company.
Client part of the network protocol.
Part of the network protocol handling content distribution.
void ShowMissingContentWindow(const GRFConfigList &list)
Show the content list window with all missing grfs from the given list.
ConnectionType _network_server_connection_type
What type of connection the Game Coordinator detected we are on.
ClientNetworkCoordinatorSocketHandler _network_coordinator_client
The connection to the Game Coordinator.
std::string _network_server_invite_code
Our invite code as indicated by the Game Coordinator.
Part of the network protocol handling Game Coordinator requests.
uint NetworkServerKickOrBanIP(ClientID client_id, bool ban, const std::string &reason)
Ban, or kick, everyone joined from the given client's IP.
void NetworkServerKickClient(ClientID client_id, const std::string &reason)
Kick a single client.
void NetworkServerDoMove(ClientID client_id, CompanyID company_id)
Handle the tid-bits of moving a client from one company to another.
bool NetworkCompanyHasClients(CompanyID company)
Check whether a particular company has clients.
void NetworkGameListRemoveItem(NetworkGameList *remove)
Remove an item from the gamelist linked list.
NetworkGameList * _network_game_list
Game list of this client.
Handling of the list of games.
@ NGLS_ONLINE
Server is online.
@ NGLS_FULL
Server is full and cannot be queried.
@ NGLS_TOO_OLD
Server is too old to query.
@ NGLS_OFFLINE
Server is offline (or cannot be queried).
@ NGLS_BANNED
You are banned from this server.
void ShowNetworkAskRelay(const std::string &server_connection_string, const std::string &relay_connection_string, const std::string &token)
Show a modal confirmation window with "no" / "yes, once" / "yes, always" buttons.
static void AdminCompanyResetCallback(Window *, bool confirmed)
Callback function for admin command to reset company.
NetworkJoinStatus _network_join_status
The status of joining.
static void AdminClientKickCallback(Window *, bool confirmed)
Callback function for admin command to kick client.
void UpdateNetworkGameWindow()
Update the network new window because a new server is found on the network.
uint8_t _network_join_waiting
The number of clients waiting in front of us.
DropDownAdmin
The possibly entries in a DropDown for an admin.
static void AdminClientBanCallback(Window *, bool confirmed)
Callback function for admin command to ban client.
void DrawCompanyIcon(CompanyID cid, int x, int y)
Draw the icon of a company.
uint32_t _network_join_bytes_total
The total number of bytes to download.
uint32_t _network_join_bytes
The number of bytes we already downloaded.
void ShowNetworkAskSurvey()
Show a modal confirmation window with "no" / "preview" / "yes" buttons.
static CompanyID _admin_company_id
For what company a confirmation window is open.
static ClientID _admin_client_id
For what client a confirmation window is open.
GUIs related to networking.
@ NRWCD_UNHANDLED
Relay request is unhandled.
Definition network_gui.h:42
@ NRWCD_HANDLED
Relay request is handled, either by user or by timeout.
Definition network_gui.h:43
NetworkJoinStatus
Status of the clients during joining.
Server part of the network protocol.
Part of the network protocol handling opt-in survey.
@ DESTTYPE_CLIENT
Send message/notice to only a certain client (Private)
@ DESTTYPE_TEAM
Send message/notice to everyone playing the same company (Team)
static const uint MAX_CLIENTS
How many clients can we have.
ClientID
'Unique' identifier to be given to clients
@ INVALID_CLIENT_ID
Client is not part of anything.
@ CLIENT_ID_SERVER
Servers always have this ID.
ServerGameType
Game type the server can be using.
void NetworkUDPSearchGame()
Find all servers.
Sending and receiving UDP messages.
@ WID_NJS_PROGRESS_BAR
Simple progress bar.
@ WID_NJS_PROGRESS_TEXT
Text explaining what is happening.
@ WID_NJS_CANCELOK
Cancel / OK button.
@ WID_NG_CLIENT
Panel with editbox to set client name.
@ WID_NG_CLIENTS
'Clients' button.
@ WID_NG_SCROLLBAR
Scrollbar of matrix.
@ WID_NG_YEARS
'Years' button.
@ WID_NG_FILTER_LABEL
Label in front of the filter/search edit box.
@ WID_NG_NEWGRF_MISSING_SEL
Selection widget for the above button.
@ WID_NG_SEARCH_INTERNET
'Search internet server' button.
@ WID_NG_NEWGRF_MISSING
'Find missing NewGRF online' button.
@ WID_NG_LASTJOINED_SPACER
Spacer after last joined server panel.
@ WID_NG_DATE
'Date' button.
@ WID_NG_LASTJOINED
Info about the last joined server.
@ WID_NG_MATRIX
Panel with list of games.
@ WID_NG_CLIENT_LABEL
Label in front of client name edit box.
@ WID_NG_NEWGRF_SEL
Selection 'widget' to hide the NewGRF settings.
@ WID_NG_JOIN
'Join game' button.
@ WID_NG_SEARCH_LAN
'Search LAN server' button.
@ WID_NG_MAPSIZE
'Map size' button.
@ WID_NG_START
'Start server' button.
@ WID_NG_DETAILS
Panel with game details.
@ WID_NG_INFO
Third button in the game list panel.
@ WID_NG_NAME
'Name' button.
@ WID_NG_CANCEL
'Cancel' button.
@ WID_NG_ADD
'Add server' button.
@ WID_NG_MAIN
Main panel.
@ WID_NG_REFRESH
'Refresh server' button.
@ WID_NG_FILTER
Panel with the edit box to enter the search text.
@ WID_NG_LASTJOINED_LABEL
Label "Last joined server:".
@ WID_NG_NEWGRF
'NewGRF Settings' button.
ClientListWidgets
Widgets of the NetworkClientListWindow class.
@ WID_CL_CLIENT_NAME_EDIT
Edit button for client name.
@ WID_CL_SERVER_NAME
Server name.
@ WID_CL_SERVER_INVITE_CODE
Invite code for this server.
@ WID_CL_SERVER_NAME_EDIT
Edit button for server name.
@ WID_CL_CLIENT_NAME
Client name.
@ WID_CL_SERVER_SELECTOR
Selector to hide the server frame.
@ WID_CL_SCROLLBAR
Scrollbar for company/client list.
@ WID_CL_CLIENT_COMPANY_COUNT
Count of clients and companies.
@ WID_CL_SERVER_CONNECTION_TYPE
The type of connection the Game Coordinator detected for this server.
@ WID_CL_SERVER_VISIBILITY
Server visibility.
@ WID_CL_MATRIX
Company/client list.
@ WID_NSS_COMPANIES_BTNU
'Max companies' uparrow.
@ WID_NSS_COMPANIES_LABEL
Label for 'max companies'.
@ WID_NSS_CLIENTS_LABEL
Label for 'max clients'.
@ WID_NSS_CLIENTS_TXT
'Max clients' text.
@ WID_NSS_CLIENTS_BTND
'Max clients' downarrow.
@ WID_NSS_GAMENAME
Background for editbox to set game name.
@ WID_NSS_CANCEL
'Cancel' button.
@ WID_NSS_PLAY_HEIGHTMAP
Play heightmap button.
@ WID_NSS_GAMENAME_LABEL
Label for the game name.
@ WID_NSS_LOAD_GAME
Load game button.
@ WID_NSS_GENERATE_GAME
New game button.
@ WID_NSS_CONNTYPE_LABEL
Label for 'connection type'.
@ WID_NSS_CONNTYPE_BTN
'Connection type' droplist button.
@ WID_NSS_COMPANIES_BTND
'Max companies' downarrow.
@ WID_NSS_SETPWD
'Set password' button.
@ WID_NSS_CLIENTS_BTNU
'Max clients' uparrow.
@ WID_NSS_COMPANIES_TXT
'Max companies' text.
@ WID_NSS_BACKGROUND
Background of the window.
@ WID_NSS_PLAY_SCENARIO
Play scenario button.
@ WID_NAR_YES_ALWAYS
"Yes, always" button.
@ WID_NAR_TEXT
Text in the window.
@ WID_NAR_YES_ONCE
"Yes, once" button.
@ WID_NAR_NO
"No" button.
@ WID_NAR_CAPTION
Caption of the window.
@ WID_NAS_YES
"Yes" button.
@ WID_NAS_LINK
"Details & Privacy" button.
@ WID_NAS_TEXT
Text in the window.
@ WID_NAS_CAPTION
Caption of the window.
@ WID_NAS_NO
"No" button.
@ WID_NAS_PREVIEW
"Preview" button.
void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfigList &config)
Setup the NewGRF gui.
@ SM_MENU
Switch to game intro menu.
Definition openttd.h:33
uint8_t GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition palette.cpp:387
static const uint8_t PC_GREY
Grey palette colour.
static const uint8_t PC_DARK_BLUE
Dark blue palette colour.
#define GREY_SCALE(level)
Return the colour for a particular greyscale level.
bool SetSettingValue(const IntSettingDesc *sd, int32_t value, bool force_newgame)
Top function to save the new value of an element of the Settings struct.
static const SettingDesc * GetSettingFromName(const std::string_view name, const SettingTable &settings)
Given a name of setting, return a setting description from the table.
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:56
int StrNaturalCompare(std::string_view s1, std::string_view s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition string.cpp:589
@ CS_NUMERAL
Only numeric ones.
Definition string_type.h:26
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition string_type.h:25
void SetDParamMaxValue(size_t n, uint64_t max_value, uint min_count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
Definition strings.cpp:127
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition strings.cpp:104
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:56
void SetDParamStr(size_t n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition strings.cpp:370
void SetDParamMaxDigits(size_t n, uint count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
Definition strings.cpp:143
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
@ TD_RTL
Text is written right-to-left by default.
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
NetworkSettings network
settings related to the network
Dimensions (a width and height) of a rectangle in 2D.
Information about GRF, used in the game and (part of it) in savegames.
Data structure describing how to show the list (what sort direction and criteria).
Partial widget specification to allow NWidgets to be written nested.
Window used for asking the user if he is okay using a relay server.
void FindWindowPlacementAndResize(int def_width, int def_height) override
Resize window towards the default size.
void SetStringParameters(WidgetID widget) const override
Initialize string parameters for a widget.
std::string relay_connection_string
The relay server we want to connect to.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
std::string token
The token for this connection.
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
std::string server_connection_string
The game server we want to connect to.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
Window used for asking if the user wants to participate in the automated survey.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void FindWindowPlacementAndResize(int def_width, int def_height) override
Resize window towards the default size.
Container for all information known about a client.
static NetworkClientInfo * GetByClientID(ClientID client_id)
Return the CI given it's client-identifier.
Definition network.cpp:116
Main handle for clientlist.
Scrollbar * vscroll
Vertical scrollbar of this window.
void OnResize() override
Called after the window got resized.
uint line_count
Amount of lines in the matrix.
std::map< uint, std::vector< std::unique_ptr< ButtonCommon > > > buttons
Per line which buttons are available.
void DrawButtons(int &x, uint y, const std::vector< std::unique_ptr< ButtonCommon > > &buttons) const
Draw the buttons for a single line in the matrix.
ClientListWidgets query_widget
During a query this tracks what widget caused the query.
void SetStringParameters(WidgetID widget) const override
Initialize string parameters for a widget.
void OnDropdownSelect(WidgetID widget, int index) override
A dropdown option associated to this window has been selected.
CompanyID dd_company_id
During admin dropdown, track which company this was for.
void OnMouseOver(Point pt, WidgetID widget) override
The mouse is currently moving over the window or has just moved outside of the window.
int hover_index
Index of the current line we are hovering over, or -1 if none.
bool OnTooltip(Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
Event to display a custom tooltip.
static void OnClickCompanyNew(NetworkClientListWindow *w, Point pt, CompanyID)
Crete new company button is clicked.
void OnDropdownClose(Point pt, WidgetID widget, int index, bool instant_close) override
A dropdown window associated to this window has been closed.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
uint line_height
Current lineheight of each entry in the matrix.
void OnInit() override
Notification that the nested widget tree gets initialized.
static void OnClickCompanyAdmin(NetworkClientListWindow *w, Point pt, CompanyID company_id)
Admin button on a Company is clicked.
static void OnClickCompanyChat(NetworkClientListWindow *w, Point pt, CompanyID company_id)
Chat button on a Company is clicked.
ClientID dd_client_id
During admin dropdown, track which client this was for.
static void OnClickClientChat(NetworkClientListWindow *w, Point pt, ClientID client_id)
Chat button on a Client is clicked.
void RebuildListCompany(CompanyID company_id, CompanyID client_playas, bool can_join_company)
Part of RebuildList() to create the information for a single company.
int player_self_index
The line the current player is on.
void DrawCompany(CompanyID company_id, const Rect &r, uint &line) const
Draw a company and its clients on the matrix.
int player_host_index
The line the host is on.
static void OnClickClientAdmin(NetworkClientListWindow *w, Point pt, ClientID client_id)
Admin button on a Client is clicked.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
ButtonCommon * GetButtonAtPoint(Point pt)
Get the button at a specific point on the WID_CL_MATRIX.
static void OnClickCompanyJoin(NetworkClientListWindow *w, Point pt, CompanyID company_id)
Join button on a Company is clicked.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void RebuildList()
Rebuild the list, meaning: calculate the lines needed and what buttons go on which line.
bool version_compatible
Can we connect to this server or not? (based on server_revision)
bool compatible
Can we connect to this server or not? (based on server_revision and grf_match.
Structure with information shown in the game list (GUI)
std::string connection_string
Address of the server.
bool refreshing
Whether this server is being queried.
NetworkGameList * next
Next pointer to make a linked game list.
NetworkGameListStatus status
Stats of the server.
NetworkGameInfo info
The game information of this server.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
TimerGameCalendar::Date calendar_start
When the game started.
std::string server_revision
The version number the server is using (e.g.: 'r304' or 0.5.0)
bool use_password
Is this server passworded?
uint8_t clients_max
Max clients allowed on server.
GRFConfigList grfconfig
List of NewGRF files used.
uint16_t map_height
Map height.
std::string server_name
Server name.
uint16_t map_width
Map width.
TimerGameTick::TickCounter ticks_playing
Amount of ticks the game has been running unpaused.
LandscapeType landscape
The used landscape.
uint8_t companies_max
Max companies allowed on server.
std::string gamescript_name
Name of the gamescript.
TimerGameCalendar::Date calendar_date
Current calendar date.
int gamescript_version
Version of the gamescript.
uint8_t companies_on
How many started companies do we have.
uint8_t clients_on
Current count of clients on server.
uint8_t max_clients
maximum amount of clients
uint8_t max_companies
maximum amount of companies
std::string client_name
name of the player (as client)
ServerGameType server_game_type
Server type: local / public / invite-only.
UseRelayService use_relay_service
Use relay service?
std::string connect_to_ip
default for the "Add server" query
std::string last_joined
Last joined server.
std::string server_name
name of the server
std::string server_password
password for joining this server
ParticipateSurvey participate_survey
Participate in the automated survey.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
WidgetID widget_id
The widget that has the pop-up input menu.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnDropdownSelect(WidgetID widget, int index) override
A dropdown option associated to this window has been selected.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
void SetStringParameters(WidgetID widget) const override
Initialize string parameters for a widget.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
QueryString name_editbox
Server name editbox.
void OnTimeout() override
Called when this window's timeout has been reached.
Coordinates of a point in 2D.
static size_t GetNumItems()
Returns number of valid items in the pool.
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
static Titem * Get(size_t index)
Returns Titem with given index.
Data stored about a string that can be modified in the GUI.
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
static const int ACTION_CLEAR
Clear editbox.
constexpr uint Horizontal() const
Get total horizontal padding of RectPadding.
constexpr uint Vertical() const
Get total vertical padding of RectPadding.
Specification of a rectangle with absolute coordinates of all edges.
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Rect WithHeight(int height, bool end=false) const
Copy Rect and set its height.
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Rect Translate(int x, int y) const
Copy and translate Rect by x,y pixels.
uint step_height
Step-size of height resize changes.
Definition window_gui.h:213
String filter and state.
bool IsEmpty() const
Check whether any filter words were entered.
void SetFilterTerm(const char *str)
Set the term to filter on.
void ResetState()
Reset the matching state to process a new item.
void AddLine(const char *str)
Pass another text line from the current item to the filter.
bool GetState() const
Get the matching state of the current item.
Window for displaying the textfile of a survey result.
const GRFConfig * grf_config
View the textfile of this GRFConfig.
void Assign(StringID string)
Render a string into the textbuffer.
Definition textbuf.cpp:431
const char * GetText() const
Get the current text.
Definition textbuf.cpp:290
Window for displaying a textfile.
void LoadText(std::string_view buf)
Load a text into the textfile viewer.
TextfileType file_type
Type of textfile to view.
Container with the data associated to a single widget.
High level window description.
Definition window_gui.h:168
Number to differentiate different windows of the same class.
Data structure for an opened window.
Definition window_gui.h:272
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:949
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1044
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition widget.cpp:780
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1730
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition window_gui.h:319
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:731
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition window.cpp:3157
Window * parent
Parent window.
Definition window_gui.h:327
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:548
void DrawSortButtonState(WidgetID widget, SortButtonState state) const
Draw a sort button's up or down arrow symbol.
Definition widget.cpp:763
ResizeInfo resize
Resize information.
Definition window_gui.h:313
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1720
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition window.cpp:483
virtual void OnDropdownClose(Point pt, WidgetID widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
Definition window.cpp:284
bool IsWidgetDisabled(WidgetID widget_index) const
Gets the enabled/disabled status of a widget.
Definition window_gui.h:409
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:440
int left
x position of left edge of the window
Definition window_gui.h:308
void RaiseWidgetsWhenLowered(Args... widgets)
Raises the widgets and sets widgets dirty that are lowered.
Definition window_gui.h:535
int top
y position of top edge of the window
Definition window_gui.h:309
int GetRowFromWidget(int clickpos, WidgetID widget, int padding, int line_height=-1) const
Compute the row of a widget that a user clicked in.
Definition window.cpp:210
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:970
void HandleButtonClick(WidgetID widget)
Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
Definition window.cpp:587
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1743
WindowFlags flags
Window flags.
Definition window_gui.h:299
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition window.cpp:311
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:380
int height
Height of the window (number of pixels down in y direction)
Definition window_gui.h:311
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:310
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:301
@ CONNECTION_TYPE_UNKNOWN
The Game Coordinator hasn't informed us yet what type of connection we have.
void QueryCallbackProc(Window *, bool)
Callback procedure for the ShowQuery method.
Definition textbuf_gui.h:28
@ QSF_ACCEPT_UNCHANGED
return success even when the text didn't change
Definition textbuf_gui.h:20
@ QSF_LEN_IN_CHARS
the length of the string is counted in characters
Definition textbuf_gui.h:22
TextfileType
Additional text files accompanying Tar archives.
@ TFT_SURVEY_RESULT
Survey result (preview)
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition widget.cpp:283
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition widget.cpp:35
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
@ WWT_IMGBTN
(Toggle) Button with image
Definition widget_type.h:43
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
@ NWID_SPACER
Invisible widget that takes some space.
Definition widget_type.h:70
@ WWT_EDITBOX
a textbox for typing
Definition widget_type.h:62
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:41
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition widget_type.h:57
@ WWT_MATRIX
Grid of rows and columns.
Definition widget_type.h:50
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition widget_type.h:52
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition widget_type.h:76
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:68
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:60
@ WWT_FRAME
Frame.
Definition widget_type.h:51
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition widget_type.h:39
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition widget_type.h:59
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition widget_type.h:56
@ WWT_DROPDOWN
Drop down list.
Definition widget_type.h:61
@ WWT_TEXT
Pure simple text.
Definition widget_type.h:49
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:71
@ SZSP_HORIZONTAL
Display plane with zero size vertically, and filling and resizing horizontally.
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
SizingType
Different forms of sizing nested widgets, using NWidgetBase::AssignSizePosition()
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
@ RWV_HIDE_BEVEL
Bevel of resize box is hidden.
Definition widget_type.h:31
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1137
Window * GetMainWindow()
Get the main window, i.e.
Definition window.cpp:1124
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1149
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:3217
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1095
@ Modal
The window is a modal child of some other window, meaning the parent is 'inactive'.
@ BorderOnly
Draw border only, no background.
@ Lowered
If set the frame is lowered and the background colour brighter (ie. buttons when pressed)
@ Timeout
Window timeout counter.
@ SBS_DOWN
Sort ascending.
Definition window_gui.h:219
@ SBS_UP
Sort descending.
Definition window_gui.h:220
@ WDP_CENTER
Center the window.
Definition window_gui.h:146
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:145
int WidgetID
Widget ID.
Definition window_type.h:20
@ WN_NETWORK_STATUS_WINDOW_JOIN
Network join status.
Definition window_type.h:41
@ WN_NETWORK_WINDOW_GAME
Network game window.
Definition window_type.h:37
@ WN_NETWORK_WINDOW_START
Network start server.
Definition window_type.h:39
EventState
State of handling an event.
@ ES_HANDLED
The passed event is handled.
@ ES_NOT_HANDLED
The passed event is not handled.
@ WC_NETWORK_ASK_RELAY
Network ask relay window; Window numbers:
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:47
@ WC_CLIENT_LIST
Client list; Window numbers:
@ WC_NETWORK_WINDOW
Network window; Window numbers:
@ WC_TEXTFILE
textfile; Window numbers:
@ WC_NETWORK_STATUS_WINDOW
Network status window; Window numbers:
@ WC_NETWORK_ASK_SURVEY
Network ask survey window; Window numbers: