OpenTTD Source 20261112-master-gbcbec5e63f
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "../stdafx.h"
11#include "../string_func.h"
12#include "../strings_func.h"
13#include "../fios.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_coordinator.h"
20#include "network_internal.h"
21#include "network_func.h"
22#include "network_survey.h"
23#include "../gui.h"
24#include "network_udp.h"
25#include "../window_func.h"
26#include "../gfx_func.h"
27#include "../dropdown_type.h"
28#include "../dropdown_func.h"
29#include "../querystring_gui.h"
30#include "../sortlist_type.h"
31#include "../company_func.h"
32#include "../command_func.h"
34#include "../genworld.h"
35#include "../map_type.h"
36#include "../zoom_func.h"
38#include "../company_cmd.h"
39#include "../timer/timer.h"
42#include "../textbuf_gui.h"
43#include "../textfile_gui.h"
46
48
49#include "table/strings.h"
50#include "../table/sprites.h"
51
52#ifdef __EMSCRIPTEN__
53# include <emscripten.h>
54#endif
55
56#include "../safeguards.h"
57
59
61static CompanyID _admin_company_id = CompanyID::Invalid();
62
68{
69 InvalidateWindowData(WindowClass::Network, NetworkWindowNumber::Game, 0);
70}
71
77{
78 DropDownList list;
79
80 list.push_back(MakeDropDownListStringItem(STR_NETWORK_SERVER_VISIBILITY_LOCAL, to_underlying(ServerGameType::Local)));
81 list.push_back(MakeDropDownListStringItem(STR_NETWORK_SERVER_VISIBILITY_INVITE_ONLY, to_underlying(ServerGameType::InviteOnly)));
82 list.push_back(MakeDropDownListStringItem(STR_NETWORK_SERVER_VISIBILITY_PUBLIC, to_underlying(ServerGameType::Public)));
83
84 return list;
85}
86
88using ServerListPosition = int;
90
92class NWidgetServerListHeader : public NWidgetContainer {
93 static const uint MINIMUM_NAME_WIDTH_BEFORE_NEW_HEADER = 150;
94public:
97 {
98 auto leaf = std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, Colours::White, WID_NG_NAME, WidgetData{.string = STR_NETWORK_SERVER_LIST_GAME_NAME}, STR_NETWORK_SERVER_LIST_GAME_NAME_TOOLTIP);
99 leaf->SetResize(1, 0);
100 leaf->SetFill(1, 0);
101 this->Add(std::move(leaf));
102
103 this->Add(std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, Colours::White, WID_NG_CLIENTS, WidgetData{.string = STR_NETWORK_SERVER_LIST_CLIENTS_CAPTION}, STR_NETWORK_SERVER_LIST_CLIENTS_CAPTION_TOOLTIP));
104 this->Add(std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, Colours::White, WID_NG_MAPSIZE, WidgetData{.string = STR_NETWORK_SERVER_LIST_MAP_SIZE_CAPTION}, STR_NETWORK_SERVER_LIST_MAP_SIZE_CAPTION_TOOLTIP));
105 this->Add(std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, Colours::White, WID_NG_DATE, WidgetData{.string = STR_NETWORK_SERVER_LIST_DATE_CAPTION}, STR_NETWORK_SERVER_LIST_DATE_CAPTION_TOOLTIP));
106 this->Add(std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, Colours::White, WID_NG_YEARS, WidgetData{.string = STR_NETWORK_SERVER_LIST_PLAY_TIME_CAPTION}, STR_NETWORK_SERVER_LIST_PLAY_TIME_CAPTION_TOOLTIP));
107
108 leaf = std::make_unique<NWidgetLeaf>(WWT_PUSHTXTBTN, Colours::White, WID_NG_INFO, WidgetData{.string = STR_EMPTY}, STR_NETWORK_SERVER_LIST_INFO_ICONS_TOOLTIP);
109 leaf->SetFill(0, 1);
110 this->Add(std::move(leaf));
111 }
112
113 void SetupSmallestSize(Window *w) override
114 {
115 this->smallest_y = 0; // Biggest child.
116 this->fill_x = 1;
117 this->fill_y = 0;
118 this->resize_x = 1; // We only resize in this direction
119 this->resize_y = 0; // We never resize in this direction
120
121 /* First initialise some variables... */
122 for (const auto &child_wid : this->children) {
123 child_wid->SetupSmallestSize(w);
124 this->smallest_y = std::max(this->smallest_y, child_wid->smallest_y + child_wid->padding.Vertical());
125 }
126
127 /* ... then in a second pass make sure the 'current' sizes are set. Won't change for most widgets. */
128 for (const auto &child_wid : this->children) {
129 child_wid->current_x = child_wid->smallest_x;
130 child_wid->current_y = this->smallest_y;
131 }
132
133 this->smallest_x = this->children.front()->smallest_x + this->children.back()->smallest_x; // First and last are always shown, rest not
134 this->ApplyAspectRatio();
135 }
136
137 void AssignSizePosition(SizingType sizing, int x, int y, uint given_width, uint given_height, bool rtl) override
138 {
139 assert(given_width >= this->smallest_x && given_height >= this->smallest_y);
140
141 this->pos_x = x;
142 this->pos_y = y;
143 this->current_x = given_width;
144 this->current_y = given_height;
145
146 given_width -= this->children.back()->smallest_x;
147 /* The first and last widget are always visible, determine which other should be visible */
148 if (this->children.size() > 2) {
149 auto first = std::next(std::begin(this->children));
150 auto last = std::prev(std::end(this->children));
151 for (auto it = first; it != last; ++it) {
152 auto &child_wid = *it;
153 if (given_width > ScaleGUITrad(MINIMUM_NAME_WIDTH_BEFORE_NEW_HEADER) + child_wid->smallest_x && (*std::prev(it))->current_x != 0) {
154 given_width -= child_wid->smallest_x;
155 child_wid->current_x = child_wid->smallest_x; /* Make visible. */
156 } else {
157 child_wid->current_x = 0; /* Make invisible. */
158 }
159 }
160 }
161
162 /* All remaining space goes to the first (name) widget */
163 this->children.front()->current_x = given_width;
164
165 /* Now assign the widgets to their rightful place */
166 uint position = 0; // Place to put next child relative to origin of the container.
167 auto assign_position = [&](const std::unique_ptr<NWidgetBase> &child_wid) {
168 if (child_wid->current_x != 0) {
169 child_wid->AssignSizePosition(sizing, x + position, y, child_wid->current_x, this->current_y, rtl);
170 position += child_wid->current_x;
171 }
172 };
173
174 if (rtl) {
175 std::for_each(std::rbegin(this->children), std::rend(this->children), assign_position);
176 } else {
177 std::for_each(std::begin(this->children), std::end(this->children), assign_position);
178 }
179 }
180};
181
183class NetworkGameWindow : public Window {
184protected:
186 static Listing last_sorting;
187
189 static const std::initializer_list<GUIGameServerList::SortFunction * const> sorter_funcs;
191 static const std::initializer_list<GUIGameServerList::FilterFunction * const> filter_funcs;
192
193 NetworkGame *server = nullptr;
197 Scrollbar *vscroll = nullptr;
200 bool searched_internet = false;
201
204
211 {
212 if (!this->servers.NeedRebuild()) return;
213
214 /* Create temporary array of games to use for listing */
215 this->servers.clear();
216
217 bool found_current_server = false;
218 bool found_last_joined = false;
219 for (const auto &ngl : _network_game_list) {
220 this->servers.push_back(ngl.get());
221 if (ngl.get() == this->server) {
222 found_current_server = true;
223 }
224 if (ngl.get() == this->last_joined) {
225 found_last_joined = true;
226 }
227 }
228 /* A refresh can cause the current server to be delete; so unselect. */
229 if (!found_last_joined) {
230 this->last_joined = nullptr;
231 }
232 if (!found_current_server) {
233 this->server = nullptr;
234 this->list_pos = SLP_INVALID;
235 }
236
237 /* Apply the filter condition immediately, if a search string has been provided. */
238 StringFilter sf;
239 sf.SetFilterTerm(this->filter_editbox.text.GetText());
240
241 if (!sf.IsEmpty()) {
242 this->servers.SetFilterState(true);
243 this->servers.Filter(sf);
244 } else {
245 this->servers.SetFilterState(false);
246 }
247
248 this->servers.RebuildDone();
249 this->vscroll->SetCount(this->servers.size());
250
251 /* Sort the list of network games as requested. */
252 this->servers.Sort();
253 this->UpdateListPos();
254 }
255
257 static bool NGameNameSorter(NetworkGame * const &a, NetworkGame * const &b)
258 {
259 int r = StrNaturalCompare(a->info.server_name, b->info.server_name, true); // Sort by name (natural sorting).
260 if (r == 0) r = a->connection_string.compare(b->connection_string);
261
262 return r < 0;
263 }
264
271 static bool NGameClientSorter(NetworkGame * const &a, NetworkGame * const &b)
272 {
273 /* Reverse as per default we are interested in most-clients first */
274 int r = a->info.clients_on - b->info.clients_on;
275
276 if (r == 0) r = a->info.clients_max - b->info.clients_max;
277 if (r == 0) return NGameNameSorter(a, b);
278
279 return r < 0;
280 }
281
283 static bool NGameMapSizeSorter(NetworkGame * const &a, NetworkGame * const &b)
284 {
285 /* Sort by the area of the map. */
286 int r = (a->info.map_height) * (a->info.map_width) - (b->info.map_height) * (b->info.map_width);
287
288 if (r == 0) r = a->info.map_width - b->info.map_width;
289 return (r != 0) ? r < 0 : NGameClientSorter(a, b);
290 }
291
293 static bool NGameCalendarDateSorter(NetworkGame * const &a, NetworkGame * const &b)
294 {
295 auto r = a->info.calendar_date - b->info.calendar_date;
296 return (r != 0) ? r < 0 : NGameClientSorter(a, b);
297 }
298
300 static bool NGameTicksPlayingSorter(NetworkGame * const &a, NetworkGame * const &b)
301 {
302 if (a->info.ticks_playing == b->info.ticks_playing) {
303 return NGameClientSorter(a, b);
304 }
305 return a->info.ticks_playing < b->info.ticks_playing;
306 }
307
313 static bool NGameAllowedSorter(NetworkGame * const &a, NetworkGame * const &b)
314 {
315 /* The servers we do not know anything about (the ones that did not reply) should be at the bottom) */
316 int r = a->info.server_revision.empty() - b->info.server_revision.empty();
317
318 /* Reverse default as we are interested in version-compatible clients first */
319 if (r == 0) r = b->info.version_compatible - a->info.version_compatible;
320 /* The version-compatible ones are then sorted with NewGRF compatible first, incompatible last */
321 if (r == 0) r = b->info.compatible - a->info.compatible;
322 /* Passworded servers should be below unpassworded servers */
323 if (r == 0) r = a->info.use_password - b->info.use_password;
324
325 /* Finally sort on the number of clients of the server in reverse order. */
326 return (r != 0) ? r < 0 : NGameClientSorter(b, a);
327 }
328
331 {
332 if (this->servers.Sort()) this->UpdateListPos();
333 }
334
337 {
338 auto it = std::ranges::find(this->servers, this->server);
339 if (it == std::end(this->servers)) {
340 this->list_pos = SLP_INVALID;
341 } else {
342 this->list_pos = static_cast<ServerListPosition>(std::distance(std::begin(this->servers), it));
343 }
344 }
345
347 static bool NGameSearchFilter(NetworkGame * const *item, StringFilter &filter)
348 {
349 assert(item != nullptr);
350 assert((*item) != nullptr);
351
352 filter.ResetState();
353 filter.AddLine((*item)->info.server_name);
354 return filter.GetState();
355 }
356
363 void DrawServerLine(const NetworkGame *cur_item, int y, bool highlight) const
364 {
365 Rect name = this->GetWidget<NWidgetBase>(WID_NG_NAME)->GetCurrentRect();
366 Rect info = this->GetWidget<NWidgetBase>(WID_NG_INFO)->GetCurrentRect();
367
368 /* show highlighted item with a different colour */
369 if (highlight) {
370 Rect r = {std::min(name.left, info.left), y, std::max(name.right, info.right), y + (int)this->resize.step_height - 1};
372 }
373
374 /* Offset to vertically position text. */
375 int text_y_offset = WidgetDimensions::scaled.matrix.top + (this->resize.step_height - WidgetDimensions::scaled.matrix.Vertical() - GetCharacterHeight(FontSize::Normal)) / 2;
376
377 info = info.Shrink(WidgetDimensions::scaled.framerect);
378 name = name.Shrink(WidgetDimensions::scaled.framerect);
379 DrawString(name.left, name.right, y + text_y_offset, cur_item->info.server_name, TextColour::Black);
380
381 /* only draw details if the server is online */
382 if (cur_item->status == NetworkGameStatus::Online) {
383 if (const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(WID_NG_CLIENTS); nwid->current_x != 0) {
384 Rect clients = nwid->GetCurrentRect();
385 DrawString(clients.left, clients.right, y + text_y_offset,
386 GetString(STR_NETWORK_SERVER_LIST_GENERAL_ONLINE, cur_item->info.clients_on, cur_item->info.clients_max, cur_item->info.companies_on, cur_item->info.companies_max),
388 }
389
390 if (const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(WID_NG_MAPSIZE); nwid->current_x != 0) {
391 /* map size */
392 Rect mapsize = nwid->GetCurrentRect();
393 DrawString(mapsize.left, mapsize.right, y + text_y_offset,
394 GetString(STR_NETWORK_SERVER_LIST_MAP_SIZE_SHORT, cur_item->info.map_width, cur_item->info.map_height),
396 }
397
398 if (const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(WID_NG_DATE); nwid->current_x != 0) {
399 /* current date */
400 Rect date = nwid->GetCurrentRect();
401 TimerGameCalendar::YearMonthDay ymd = TimerGameCalendar::ConvertDateToYMD(cur_item->info.calendar_date);
402 DrawString(date.left, date.right, y + text_y_offset,
403 GetString(STR_JUST_INT, ymd.year),
405 }
406
407 if (const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(WID_NG_YEARS); nwid->current_x != 0) {
408 /* play time */
409 Rect years = nwid->GetCurrentRect();
410 const auto play_time = cur_item->info.ticks_playing / Ticks::TICKS_PER_SECOND;
411 DrawString(years.left, years.right, y + text_y_offset,
412 GetString(STR_NETWORK_SERVER_LIST_PLAY_TIME_SHORT, play_time / 60 / 60, (play_time / 60) % 60),
414 }
415
416 /* Set top and bottom of info rect to current row. */
417 info.top = y;
418 info.bottom = y + this->resize.step_height - 1;
419
420 bool rtl = _current_text_dir == TD_RTL;
421
422 /* draw a lock if the server is password protected */
423 if (cur_item->info.use_password) DrawSpriteIgnorePadding(SPR_LOCK, PAL_NONE, info.WithWidth(this->lock.width, rtl), {AlignmentH::Centre, AlignmentV::Middle});
424
425 /* draw red or green icon, depending on compatibility with server */
427 DrawSpriteIgnorePadding(SPR_BLOT, pal, info.WithWidth(this->blot.width, !rtl), {AlignmentH::Centre, AlignmentV::Middle});
428 }
429 }
430
439 {
440 if (this->list_pos == SLP_INVALID) return; // no server selected
441 this->vscroll->ScrollTowards(this->list_pos);
442 }
443
444public:
450 {
451 this->CreateNestedTree();
452 this->vscroll = this->GetScrollbar(WID_NG_SCROLLBAR);
454
455 this->querystrings[WID_NG_CLIENT] = &this->name_editbox;
456 this->name_editbox.text.Assign(_settings_client.network.client_name);
457
458 this->querystrings[WID_NG_FILTER] = &this->filter_editbox;
459 this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
461
462 /* As the Game Coordinator doesn't support "websocket" servers yet, we
463 * let "os/emscripten/pre.js" hardcode a list of servers people can
464 * join. This means the serverlist is curated for now, but it is the
465 * best we can offer. */
466#ifdef __EMSCRIPTEN__
467 EM_ASM(if (window["openttd_server_list"]) openttd_server_list());
468#endif
469
470 this->last_joined = NetworkAddServer(_settings_client.network.last_joined, false);
471 this->server = this->last_joined;
472
473 this->servers.SetListing(this->last_sorting);
476 this->servers.ForceRebuild();
477 }
478
481 {
482 this->last_sorting = this->servers.GetListing();
483 }
484
485 void OnInit() override
486 {
487 this->lock = GetScaledSpriteSize(SPR_LOCK);
488 this->blot = GetScaledSpriteSize(SPR_BLOT);
489 }
490
491 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
492 {
493 switch (widget) {
494 case WID_NG_MATRIX:
495 fill.height = resize.height = std::max<uint>(this->blot.height, GetCharacterHeight(FontSize::Normal)) + padding.height;
496 size.height = 12 * resize.height;
497 break;
498
500 size.height = std::max<uint>(this->blot.height, GetCharacterHeight(FontSize::Normal)) + WidgetDimensions::scaled.matrix.Vertical();
501 break;
502
504 size.width = NWidgetScrollbar::GetVerticalDimension().width;
505 break;
506
507 case WID_NG_NAME:
508 size.width += 2 * Window::SortButtonWidth(); // Make space for the arrow
509 break;
510
511 case WID_NG_CLIENTS: {
512 size.width += 2 * Window::SortButtonWidth(); // Make space for the arrow
513 auto max_clients = GetParamMaxValue(MAX_CLIENTS);
514 auto max_companies = GetParamMaxValue(MAX_COMPANIES);
515 size = maxdim(size, GetStringBoundingBox(GetString(STR_NETWORK_SERVER_LIST_GENERAL_ONLINE, max_clients, max_clients, max_companies, max_companies)));
516 break;
517 }
518
519 case WID_NG_MAPSIZE: {
520 size.width += 2 * Window::SortButtonWidth(); // Make space for the arrow
521 auto max_map_size = GetParamMaxValue(MAX_MAP_SIZE);
522 size = maxdim(size, GetStringBoundingBox(GetString(STR_NETWORK_SERVER_LIST_MAP_SIZE_SHORT, max_map_size, max_map_size)));
523 break;
524 }
525
526 case WID_NG_DATE:
527 case WID_NG_YEARS:
528 size.width += 2 * Window::SortButtonWidth(); // Make space for the arrow
529 size = maxdim(size, GetStringBoundingBox(GetString(STR_JUST_INT, GetParamMaxValue(5))));
530 break;
531
532 case WID_NG_INFO:
533 size.width = this->lock.width + WidgetDimensions::scaled.hsep_normal + this->blot.width + padding.width;
534 size.height = std::max(this->lock.height, this->blot.height) + padding.height;
535 break;
536 }
537 }
538
539 void DrawWidget(const Rect &r, WidgetID widget) const override
540 {
541 switch (widget) {
542 case WID_NG_MATRIX: {
543 uint16_t y = r.top;
544
545 auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->servers);
546 for (auto it = first; it != last; ++it) {
547 const NetworkGame *ngl = *it;
548 this->DrawServerLine(ngl, y, ngl == this->server);
549 y += this->resize.step_height;
550 }
551 break;
552 }
553
555 /* Draw the last joined server, if any */
556 if (this->last_joined != nullptr) this->DrawServerLine(this->last_joined, r.top, this->last_joined == this->server);
557 break;
558
559 case WID_NG_DETAILS:
560 this->DrawDetails(r);
561 break;
562
563 case WID_NG_NAME:
564 case WID_NG_CLIENTS:
565 case WID_NG_MAPSIZE:
566 case WID_NG_DATE:
567 case WID_NG_YEARS:
568 case WID_NG_INFO:
569 if (widget - WID_NG_NAME == this->servers.SortType()) this->DrawSortButton(widget, this->servers.IsDescSortOrder());
570 break;
571 }
572 }
573
574
575 void OnPaint() override
576 {
577 if (this->servers.NeedRebuild()) {
579 }
580 if (this->servers.NeedResort()) {
581 this->SortNetworkGameList();
582 }
583
584 NetworkGame *sel = this->server;
585 /* 'Refresh' button invisible if no server selected */
586 this->SetWidgetDisabledState(WID_NG_REFRESH, sel == nullptr);
587 /* 'Join' button disabling conditions */
588 this->SetWidgetDisabledState(WID_NG_JOIN, sel == nullptr || // no Selected Server
589 sel->status != NetworkGameStatus::Online || // Server offline
590 sel->info.clients_on >= sel->info.clients_max || // Server full
591 !sel->info.compatible); // Revision mismatch
592
593 this->SetWidgetLoweredState(WID_NG_REFRESH, sel != nullptr && sel->refreshing);
594
595 /* 'NewGRF Settings' button invisible if no NewGRF is used */
596 bool changed = false;
597 changed |= this->GetWidget<NWidgetStacked>(WID_NG_NEWGRF_SEL)->SetDisplayedPlane(sel == nullptr || sel->status != NetworkGameStatus::Online || sel->info.grfconfig.empty() ? SZSP_NONE : 0);
598 changed |= this->GetWidget<NWidgetStacked>(WID_NG_NEWGRF_MISSING_SEL)->SetDisplayedPlane(sel == nullptr || sel->status != NetworkGameStatus::Online || sel->info.grfconfig.empty() || !sel->info.version_compatible || sel->info.compatible ? SZSP_NONE : 0);
599 if (changed) {
600 this->ReInit();
601 return;
602 }
603
604#ifdef __EMSCRIPTEN__
609#endif
610
611 this->DrawWidgets();
612 }
613
619 {
620 if (this->server == nullptr) return STR_NETWORK_SERVER_LIST_GAME_INFO;
621 switch (this->server->status) {
622 case NetworkGameStatus::Offline: return STR_NETWORK_SERVER_LIST_SERVER_OFFLINE;
623 case NetworkGameStatus::Online: return STR_NETWORK_SERVER_LIST_GAME_INFO;
624 case NetworkGameStatus::Full: return STR_NETWORK_SERVER_LIST_SERVER_FULL;
625 case NetworkGameStatus::Banned: return STR_NETWORK_SERVER_LIST_SERVER_BANNED;
626 case NetworkGameStatus::TooOld: return STR_NETWORK_SERVER_LIST_SERVER_TOO_OLD;
627 default: NOT_REACHED();
628 }
629 }
630
635 void DrawDetails(const Rect &r) const
636 {
637 NetworkGame *sel = this->server;
638
639 Rect tr = r.Shrink(WidgetDimensions::scaled.frametext);
640 StringID header_msg = this->GetHeaderString();
641 int header_height = GetStringHeight(header_msg, tr.Width()) +
642 (sel == nullptr ? 0 : GetStringHeight(sel->info.server_name, tr.Width())) +
643 WidgetDimensions::scaled.frametext.Vertical();
644
645 /* Height for the title banner */
646 Rect hr = r.WithHeight(header_height).Shrink(WidgetDimensions::scaled.frametext);
647 tr.top += header_height;
648
649 /* Draw the right menu */
650 /* Create the nice darker rectangle at the details top */
653 if (sel == nullptr) return;
654
656 if (sel->status != NetworkGameStatus::Online) {
658 } else { // show game info
659 tr.top = DrawStringMultiLine(tr, GetString(STR_NETWORK_SERVER_LIST_CLIENTS, sel->info.clients_on, sel->info.clients_max, sel->info.companies_on, sel->info.companies_max));
660
661 tr.top = DrawStringMultiLine(tr, GetString(STR_NETWORK_SERVER_LIST_LANDSCAPE, STR_CLIMATE_TEMPERATE_LANDSCAPE + to_underlying(sel->info.landscape))); // landscape
662
663 tr.top = DrawStringMultiLine(tr, GetString(STR_NETWORK_SERVER_LIST_MAP_SIZE, sel->info.map_width, sel->info.map_height)); // map size
664
665 tr.top = DrawStringMultiLine(tr, GetString(STR_NETWORK_SERVER_LIST_SERVER_VERSION, sel->info.server_revision)); // server version
666
667 StringID invite_or_address = sel->connection_string.starts_with("+") ? STR_NETWORK_SERVER_LIST_INVITE_CODE : STR_NETWORK_SERVER_LIST_SERVER_ADDRESS;
668 tr.top = DrawStringMultiLine(tr, GetString(invite_or_address, sel->connection_string)); // server address / invite code
669
670 tr.top = DrawStringMultiLine(tr, GetString(STR_NETWORK_SERVER_LIST_START_DATE, sel->info.calendar_start)); // start date
671
672 tr.top = DrawStringMultiLine(tr, GetString(STR_NETWORK_SERVER_LIST_CURRENT_DATE, sel->info.calendar_date)); // current date
673
674 const auto play_time = sel->info.ticks_playing / Ticks::TICKS_PER_SECOND;
675 tr.top = DrawStringMultiLine(tr, GetString(STR_NETWORK_SERVER_LIST_PLAY_TIME, play_time / 60 / 60, (play_time / 60) % 60)); // play time
676
677 if (sel->info.gamescript_version != -1) {
678 tr.top = DrawStringMultiLine(tr, GetString(STR_NETWORK_SERVER_LIST_GAMESCRIPT, sel->info.gamescript_name, sel->info.gamescript_version)); // gamescript name and version
679 }
680
681 tr.top += WidgetDimensions::scaled.vsep_wide;
682
683 if (!sel->info.compatible) {
684 DrawStringMultiLine(tr, sel->info.version_compatible ? STR_NETWORK_SERVER_LIST_GRF_MISMATCH : STR_NETWORK_SERVER_LIST_VERSION_MISMATCH, TextColour::FromString, AlignmentH::Centre); // server mismatch
685 } else if (sel->info.clients_on == sel->info.clients_max) {
686 /* Show: server full, when clients_on == max_clients */
687 DrawStringMultiLine(tr, STR_NETWORK_SERVER_LIST_SERVER_FULL, TextColour::FromString, AlignmentH::Centre); // server full
688 } else if (sel->info.use_password) {
689 DrawStringMultiLine(tr, STR_NETWORK_SERVER_LIST_PASSWORD, TextColour::FromString, AlignmentH::Centre); // password warning
690 }
691 }
692 }
693
694 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
695 {
696 switch (widget) {
697 case WID_NG_NAME: // Sort by name
698 case WID_NG_CLIENTS: // Sort by connected clients
699 case WID_NG_MAPSIZE: // Sort by map size
700 case WID_NG_DATE: // Sort by date
701 case WID_NG_YEARS: // Sort by years
702 case WID_NG_INFO: // Connectivity (green dot)
703 if (this->servers.SortType() == widget - WID_NG_NAME) {
704 this->servers.ToggleSortOrder();
705 if (this->list_pos != SLP_INVALID) this->list_pos = (ServerListPosition)this->servers.size() - this->list_pos - 1;
706 } else {
707 this->servers.SetSortType(widget - WID_NG_NAME);
708 this->servers.ForceResort();
709 this->SortNetworkGameList();
710 }
712 this->SetDirty();
713 break;
714
715 case WID_NG_MATRIX: { // Show available network games
716 auto it = this->vscroll->GetScrolledItemFromWidget(this->servers, pt.y, this, WID_NG_MATRIX);
717 this->server = (it != this->servers.end()) ? *it : nullptr;
718 this->list_pos = (server == nullptr) ? SLP_INVALID : it - this->servers.begin();
719 this->SetDirty();
720
721 if (click_count > 1 && !this->IsWidgetDisabled(WID_NG_JOIN)) this->OnClick(pt, WID_NG_JOIN, 1);
722 break;
723 }
724
725 case WID_NG_LASTJOINED: {
726 if (this->last_joined != nullptr) {
727 this->server = this->last_joined;
728
729 /* search the position of the newly selected server */
730 this->UpdateListPos();
732 this->SetDirty();
733
734 if (click_count > 1 && !this->IsWidgetDisabled(WID_NG_JOIN)) this->OnClick(pt, WID_NG_JOIN, 1);
735 }
736 break;
737 }
738
740 _network_coordinator_client.GetListing();
741 this->searched_internet = true;
742 break;
743
746 break;
747
748 case WID_NG_ADD: // Add a server
750 _settings_client.network.connect_to_ip,
751 STR_NETWORK_SERVER_LIST_ENTER_SERVER_ADDRESS,
752 NETWORK_HOSTNAME_PORT_LENGTH, // maximum number of characters including '\0'
754 break;
755
756 case WID_NG_START: // Start server
758 break;
759
760 case WID_NG_JOIN: // Join Game
761 if (this->server != nullptr) {
763 }
764 break;
765
766 case WID_NG_REFRESH: // Refresh
767 if (this->server != nullptr && !this->server->refreshing) NetworkQueryServer(this->server->connection_string);
768 break;
769
770 case WID_NG_NEWGRF: // NewGRF Settings
771 if (this->server != nullptr) ShowNewGRFSettings(false, false, false, this->server->info.grfconfig);
772 break;
773
774 case WID_NG_NEWGRF_MISSING: // Find missing content online
775 if (this->server != nullptr) ShowMissingContentWindow(this->server->info.grfconfig);
776 break;
777 }
778 }
779
785 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
786 {
787 this->servers.ForceRebuild();
788 this->SetDirty();
789 }
790
791 EventState OnKeyPress([[maybe_unused]] char32_t key, uint16_t keycode) override
792 {
794
795 /* handle up, down, pageup, pagedown, home and end */
796 if (this->vscroll->UpdateListPositionOnKeyPress(this->list_pos, keycode) == EventState::Handled) {
797 if (this->list_pos == SLP_INVALID) return EventState::Handled;
798
799 this->server = this->servers[this->list_pos];
800
801 /* Scroll to the new server if it is outside the current range. */
803
804 /* redraw window */
805 this->SetDirty();
806 return EventState::Handled;
807 }
808
809 if (this->server != nullptr) {
810 if (keycode == WKC_DELETE) { // Press 'delete' to remove servers
811 NetworkGameListRemoveItem(this->server);
812 if (this->server == this->last_joined) this->last_joined = nullptr;
813 this->server = nullptr;
814 this->list_pos = SLP_INVALID;
815 }
816 }
817
818 return state;
819 }
820
821 void OnEditboxChanged(WidgetID wid) override
822 {
823 switch (wid) {
824 case WID_NG_FILTER: {
825 this->servers.ForceRebuild();
828 this->SetDirty();
829 break;
830 }
831
832 case WID_NG_CLIENT:
833 /* Validation of the name will happen once the user tries to join or start a game, as getting
834 * error messages while typing (e.g. when you clear the name) defeats the purpose of the check. */
835 _settings_client.network.client_name = this->name_editbox.text.GetText();
836 break;
837 }
838 }
839
840 void OnQueryTextFinished(std::optional<std::string> str) override
841 {
842 if (!str.has_value() || str->empty()) return;
843
844 _settings_client.network.connect_to_ip = std::move(*str);
845 NetworkAddServer(_settings_client.network.connect_to_ip);
847 }
848
849 void OnResize() override
850 {
851 this->vscroll->SetCapacityFromWidget(this, WID_NG_MATRIX);
852 }
853
855 const IntervalTimer<TimerWindow> refresh_interval = {std::chrono::seconds(30), [this](uint) {
856 if (!this->searched_internet) return;
857
858 _network_coordinator_client.GetListing();
859 }};
860};
861
863const std::initializer_list<GUIGameServerList::SortFunction * const> NetworkGameWindow::sorter_funcs = {
870};
871
872const std::initializer_list<GUIGameServerList::FilterFunction * const> NetworkGameWindow::filter_funcs = {
874};
875
877static constexpr std::initializer_list<NWidgetPart> _nested_network_game_widgets = {
878 /* TOP */
881 NWidget(WWT_CAPTION, Colours::LightBlue), SetStringTip(STR_NETWORK_SERVER_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
883 EndContainer(),
887 /* LEFT SIDE */
892 SetStringTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
893 EndContainer(),
896 NWidgetFunction([]() -> std::unique_ptr<NWidgetBase> { return std::make_unique<NWidgetServerListHeader>(); }),
898 SetMatrixDataTip(1, 0, STR_NETWORK_SERVER_LIST_CLICK_GAME_TO_SELECT), SetScrollbar(WID_NG_SCROLLBAR),
899 EndContainer(),
901 EndContainer(),
904 SetStringTip(STR_NETWORK_SERVER_LIST_LAST_JOINED_SERVER), SetResize(1, 0),
907 SetToolTip(STR_NETWORK_SERVER_LIST_CLICK_TO_SELECT_LAST_TOOLTIP),
908 EndContainer(),
910 EndContainer(),
911 EndContainer(),
912 EndContainer(),
913 /* RIGHT SIDE */
916 NWidget(WWT_TEXT, Colours::Invalid, WID_NG_CLIENT_LABEL), SetStringTip(STR_NETWORK_SERVER_LIST_PLAYER_NAME),
918 SetStringTip(STR_NETWORK_SERVER_LIST_PLAYER_NAME_OSKTITLE, STR_NETWORK_SERVER_LIST_ENTER_NAME_TOOLTIP),
919 EndContainer(),
922 EndContainer(),
925 NWidget(WWT_PUSHTXTBTN, Colours::White, WID_NG_NEWGRF_MISSING), SetFill(1, 0), SetStringTip(STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_BUTTON, STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_TOOLTIP),
926 EndContainer(),
928 NWidget(WWT_PUSHTXTBTN, Colours::White, WID_NG_NEWGRF), SetFill(1, 0), SetStringTip(STR_MAPGEN_NEWGRF_SETTINGS, STR_MAPGEN_NEWGRF_SETTINGS_TOOLTIP),
929 EndContainer(),
931 NWidget(WWT_PUSHTXTBTN, Colours::White, WID_NG_JOIN), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_JOIN_GAME),
932 NWidget(WWT_PUSHTXTBTN, Colours::White, WID_NG_REFRESH), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_REFRESH, STR_NETWORK_SERVER_LIST_REFRESH_TOOLTIP),
933 EndContainer(),
934 EndContainer(),
935 EndContainer(),
936 EndContainer(),
937 EndContainer(),
938 /* BOTTOM */
940 NWidget(WWT_PUSHTXTBTN, Colours::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),
941 NWidget(WWT_PUSHTXTBTN, Colours::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),
942 NWidget(WWT_PUSHTXTBTN, Colours::White, WID_NG_ADD), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_ADD_SERVER, STR_NETWORK_SERVER_LIST_ADD_SERVER_TOOLTIP),
943 NWidget(WWT_PUSHTXTBTN, Colours::White, WID_NG_START), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_NETWORK_SERVER_LIST_START_SERVER, STR_NETWORK_SERVER_LIST_START_SERVER_TOOLTIP),
944 EndContainer(),
945 EndContainer(),
946 /* Resize button. */
948 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
950 EndContainer(),
951 EndContainer(),
952};
953
956 WindowPosition::Center, "list_servers", 1000, 730,
957 WindowClass::Network, WindowClass::None,
958 {},
960);
961
964{
965 static bool first = true;
967
968 /* Only show once */
969 if (first) {
970 first = false;
971 /* Add all servers from the config file to our list. */
972 for (const auto &iter : _network_host_list) {
973 NetworkAddServer(iter);
974 }
975 }
976
978}
979
984
990 {
992
993 this->querystrings[WID_NSS_GAMENAME] = &this->name_editbox;
994 this->name_editbox.text.Assign(_settings_client.network.server_name);
995
997 }
998
999 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1000 {
1001 switch (widget) {
1003 return GetString(STR_NETWORK_SERVER_VISIBILITY_LOCAL + to_underlying(_settings_client.network.server_game_type));
1004
1006 return GetString(STR_NETWORK_START_SERVER_CLIENTS_SELECT, _settings_client.network.max_clients);
1007
1009 return GetString(STR_NETWORK_START_SERVER_COMPANIES_SELECT, _settings_client.network.max_companies);
1010
1011 default:
1012 return this->Window::GetWidgetString(widget, stringid);
1013 }
1014 }
1015
1016 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1017 {
1018 switch (widget) {
1020 size = maxdim(maxdim(GetStringBoundingBox(STR_NETWORK_SERVER_VISIBILITY_LOCAL), GetStringBoundingBox(STR_NETWORK_SERVER_VISIBILITY_PUBLIC)), GetStringBoundingBox(STR_NETWORK_SERVER_VISIBILITY_INVITE_ONLY));
1021 size.width += padding.width;
1022 size.height += padding.height;
1023 break;
1024 }
1025 }
1026
1027 void DrawWidget(const Rect &r, WidgetID widget) const override
1028 {
1029 switch (widget) {
1030 case WID_NSS_SETPWD:
1031 /* If password is set, draw red '*' next to 'Set password' button. */
1032 if (!_settings_client.network.server_password.empty()) DrawString(r.right + WidgetDimensions::scaled.framerect.left, this->width - WidgetDimensions::scaled.framerect.right, r.top, "*", TextColour::Red);
1033 }
1034 }
1035
1036 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1037 {
1038 switch (widget) {
1039 case WID_NSS_CANCEL: // Cancel button
1041 break;
1042
1043 case WID_NSS_SETPWD: // Set password button
1044 this->widget_id = WID_NSS_SETPWD;
1045 ShowQueryString(_settings_client.network.server_password, STR_NETWORK_START_SERVER_SET_PASSWORD, NETWORK_PASSWORD_LENGTH, this, CS_ALPHANUMERAL, {});
1046 break;
1047
1048 case WID_NSS_CONNTYPE_BTN: // Connection type
1050 break;
1051
1052 case WID_NSS_CLIENTS_BTND: case WID_NSS_CLIENTS_BTNU: // Click on up/down button for number of clients
1053 case WID_NSS_COMPANIES_BTND: case WID_NSS_COMPANIES_BTNU: // Click on up/down button for number of companies
1054 /* Don't allow too fast scrolling. */
1055 if (!this->flags.Test(WindowFlag::Timeout) || this->timeout_timer <= 1) {
1056 this->HandleButtonClick(widget);
1057 this->SetDirty();
1058 switch (widget) {
1059 default: NOT_REACHED();
1061 _settings_client.network.max_clients = Clamp(_settings_client.network.max_clients + widget - WID_NSS_CLIENTS_TXT, 2, MAX_CLIENTS);
1062 break;
1064 _settings_client.network.max_companies = Clamp(_settings_client.network.max_companies + widget - WID_NSS_COMPANIES_TXT, 1, MAX_COMPANIES);
1065 break;
1066 }
1067 }
1069 break;
1070
1071 case WID_NSS_CLIENTS_TXT: // Click on number of clients
1072 this->widget_id = WID_NSS_CLIENTS_TXT;
1073 ShowQueryString(GetString(STR_JUST_INT, _settings_client.network.max_clients), STR_NETWORK_START_SERVER_NUMBER_OF_CLIENTS, 4, this, CS_NUMERAL, {});
1074 break;
1075
1076 case WID_NSS_COMPANIES_TXT: // Click on number of companies
1077 this->widget_id = WID_NSS_COMPANIES_TXT;
1078 ShowQueryString(GetString(STR_JUST_INT, _settings_client.network.max_companies), STR_NETWORK_START_SERVER_NUMBER_OF_COMPANIES, 3, this, CS_NUMERAL, {});
1079 break;
1080
1081 case WID_NSS_GENERATE_GAME: // Start game
1082 if (!CheckServerName()) return;
1083 _is_network_server = true;
1084 if (IsCtrlPressed()) {
1086 } else {
1088 }
1089 break;
1090
1091 case WID_NSS_LOAD_GAME:
1092 if (!CheckServerName()) return;
1093 _is_network_server = true;
1095 break;
1096
1098 if (!CheckServerName()) return;
1099 _is_network_server = true;
1101 break;
1102
1104 if (!CheckServerName()) return;
1105 _is_network_server = true;
1107 break;
1108 }
1109 }
1110
1111 void OnDropdownSelect(WidgetID widget, int index, int) override
1112 {
1113 switch (widget) {
1115 _settings_client.network.server_game_type = (ServerGameType)index;
1116 break;
1117 default:
1118 NOT_REACHED();
1119 }
1120
1121 this->SetDirty();
1122 }
1123
1129 {
1130 std::string str{this->name_editbox.text.GetText()};
1131 if (!NetworkValidateServerName(str)) return false;
1132
1133 SetSettingValue(GetSettingFromName("network.server_name")->AsStringSetting(), std::move(str));
1134 return true;
1135 }
1136
1141
1142 void OnQueryTextFinished(std::optional<std::string> str) override
1143 {
1144 if (!str.has_value()) return;
1145
1146 if (this->widget_id == WID_NSS_SETPWD) {
1147 _settings_client.network.server_password = std::move(*str);
1148 } else {
1149 auto value = ParseInteger<int32_t>(*str, 10, true);
1150 if (!value.has_value()) return;
1151 this->SetWidgetDirty(this->widget_id);
1152 switch (this->widget_id) {
1153 default: NOT_REACHED();
1154 case WID_NSS_CLIENTS_TXT: _settings_client.network.max_clients = Clamp(*value, 2, MAX_CLIENTS); break;
1155 case WID_NSS_COMPANIES_TXT: _settings_client.network.max_companies = Clamp(*value, 1, MAX_COMPANIES); break;
1156 }
1157 }
1158
1159 this->SetDirty();
1160 }
1161};
1162
1164static constexpr std::initializer_list<NWidgetPart> _nested_network_start_server_window_widgets = {
1167 NWidget(WWT_CAPTION, Colours::LightBlue), SetStringTip(STR_NETWORK_START_SERVER_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1168 EndContainer(),
1173 /* Game name widgets */
1174 NWidget(WWT_TEXT, Colours::Invalid, WID_NSS_GAMENAME_LABEL), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_NEW_GAME_NAME),
1175 NWidget(WWT_EDITBOX, Colours::LightBlue, 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, Colours::Invalid, WID_NSS_CONNTYPE_LABEL), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_VISIBILITY_LABEL),
1181 NWidget(WWT_DROPDOWN, Colours::LightBlue, WID_NSS_CONNTYPE_BTN), SetFill(1, 0), SetToolTip(STR_NETWORK_START_SERVER_VISIBILITY_TOOLTIP),
1182 EndContainer(),
1184 NWidget(NWID_SPACER), SetFill(1, 1),
1185 NWidget(WWT_PUSHTXTBTN, Colours::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, Colours::Invalid, WID_NSS_CLIENTS_LABEL), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_NUMBER_OF_CLIENTS),
1193 NWidget(WWT_IMGBTN, Colours::LightBlue, 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, Colours::LightBlue, WID_NSS_CLIENTS_TXT), SetFill(1, 0), SetToolTip(STR_NETWORK_START_SERVER_NUMBER_OF_CLIENTS_TOOLTIP),
1195 NWidget(WWT_IMGBTN, Colours::LightBlue, 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, Colours::Invalid, WID_NSS_COMPANIES_LABEL), SetFill(1, 0), SetStringTip(STR_NETWORK_START_SERVER_NUMBER_OF_COMPANIES),
1202 NWidget(WWT_IMGBTN, Colours::LightBlue, 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, Colours::LightBlue, WID_NSS_COMPANIES_TXT), SetFill(1, 0), SetToolTip(STR_NETWORK_START_SERVER_NUMBER_OF_COMPANIES_TOOLTIP),
1204 NWidget(WWT_IMGBTN, Colours::LightBlue, 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, Colours::White, WID_NSS_GENERATE_GAME), SetStringTip(STR_INTRO_NEW_GAME, STR_INTRO_TOOLTIP_NEW_GAME), SetFill(1, 0),
1214 NWidget(WWT_PUSHTXTBTN, Colours::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, Colours::White, WID_NSS_PLAY_SCENARIO), SetStringTip(STR_INTRO_PLAY_SCENARIO, STR_INTRO_TOOLTIP_PLAY_SCENARIO), SetFill(1, 0),
1220 NWidget(WWT_PUSHTXTBTN, Colours::White, WID_NSS_PLAY_HEIGHTMAP), SetStringTip(STR_INTRO_PLAY_HEIGHTMAP, STR_INTRO_TOOLTIP_PLAY_HEIGHTMAP), SetFill(1, 0),
1221 EndContainer(),
1222 EndContainer(),
1223
1226 EndContainer(),
1227 EndContainer(),
1228 EndContainer(),
1229};
1230
1233 WindowPosition::Center, {}, 0, 0,
1234 WindowClass::Network, WindowClass::None,
1235 {},
1237);
1238
1248
1249/* The window below gives information about the connected clients
1250 * and also makes able to kick them (if server) and stuff like that. */
1251
1252extern void DrawCompanyIcon(CompanyID cid, int x, int y);
1253
1255static constexpr std::initializer_list<NWidgetPart> _nested_client_list_widgets = {
1258 NWidget(WWT_CAPTION, Colours::Grey), SetStringTip(STR_NETWORK_CLIENT_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1261 EndContainer(),
1264 NWidget(WWT_FRAME, Colours::Grey), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER), SetPIP(0, WidgetDimensions::unscaled.vsep_normal, 0),
1266 NWidget(WWT_TEXT, Colours::Invalid), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER_NAME),
1267 NWidget(WWT_TEXT, Colours::Invalid, WID_CL_SERVER_NAME), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_NETWORK_CLIENT_LIST_SERVER_NAME_TOOLTIP), SetAlignment({AlignmentH::End, AlignmentV::Middle}),
1268 NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_CL_SERVER_NAME_EDIT), SetAspect(WidgetDimensions::ASPECT_RENAME), SetSpriteTip(SPR_RENAME, STR_NETWORK_CLIENT_LIST_SERVER_NAME_EDIT_TOOLTIP),
1269 EndContainer(),
1273 NWidget(WWT_TEXT, Colours::Invalid), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER_VISIBILITY),
1274 NWidget(WWT_DROPDOWN, Colours::Grey, WID_CL_SERVER_VISIBILITY), SetToolTip(STR_NETWORK_CLIENT_LIST_SERVER_VISIBILITY_TOOLTIP),
1275 EndContainer(),
1277 NWidget(WWT_TEXT, Colours::Invalid), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER_INVITE_CODE),
1278 NWidget(WWT_TEXT, Colours::Invalid, WID_CL_SERVER_INVITE_CODE), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_NETWORK_CLIENT_LIST_SERVER_INVITE_CODE_TOOLTIP), SetAlignment({AlignmentH::End, AlignmentV::Middle}),
1279 EndContainer(),
1281 NWidget(WWT_TEXT, Colours::Invalid), SetStringTip(STR_NETWORK_CLIENT_LIST_SERVER_CONNECTION_TYPE),
1282 NWidget(WWT_TEXT, Colours::Invalid, WID_CL_SERVER_CONNECTION_TYPE), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_NETWORK_CLIENT_LIST_SERVER_CONNECTION_TYPE_TOOLTIP), SetAlignment({AlignmentH::End, AlignmentV::Middle}),
1283 EndContainer(),
1284 EndContainer(),
1285 EndContainer(),
1286 EndContainer(),
1287 NWidget(WWT_FRAME, Colours::Grey), SetStringTip(STR_NETWORK_CLIENT_LIST_PLAYER),
1289 NWidget(WWT_TEXT, Colours::Invalid), SetStringTip(STR_NETWORK_CLIENT_LIST_PLAYER_NAME),
1290 NWidget(WWT_TEXT, Colours::Invalid, WID_CL_CLIENT_NAME), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_NETWORK_CLIENT_LIST_PLAYER_NAME_TOOLTIP), SetAlignment({AlignmentH::End, AlignmentV::Middle}),
1291 NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_CL_CLIENT_NAME_EDIT), SetAspect(WidgetDimensions::ASPECT_RENAME), SetSpriteTip(SPR_RENAME, STR_NETWORK_CLIENT_LIST_PLAYER_NAME_EDIT_TOOLTIP),
1292 EndContainer(),
1293 EndContainer(),
1294 EndContainer(),
1295 EndContainer(),
1299 EndContainer(),
1303 EndContainer(),
1305 EndContainer(),
1306};
1307
1310 WindowPosition::Automatic, "list_clients", 220, 300,
1311 WindowClass::NetworkClientList, WindowClass::None,
1312 {},
1314);
1315
1320static void AdminClientKickCallback(Window *, bool confirmed)
1321{
1322 if (confirmed) NetworkServerKickClient(_admin_client_id, {});
1323}
1324
1329static void AdminClientBanCallback(Window *, bool confirmed)
1330{
1331 if (confirmed) NetworkServerKickOrBanIP(_admin_client_id, true, {});
1332}
1333
1338static void AdminCompanyResetCallback(Window *, bool confirmed)
1339{
1340 if (confirmed) {
1343 }
1344}
1345
1354public:
1359 uint height;
1360 uint width;
1361
1370 sprite(sprite),
1372 colour(colour),
1374 {
1376 this->height = d.height + WidgetDimensions::scaled.framerect.Vertical();
1377 this->width = d.width + WidgetDimensions::scaled.framerect.Horizontal();
1378 }
1379
1380 virtual ~ButtonCommon() = default;
1381
1387 virtual void OnClick(struct NetworkClientListWindow *w, Point pt) = 0;
1388};
1389
1393template <typename T>
1394class Button : public ButtonCommon {
1395private:
1396 typedef void (*ButtonCallback)(struct NetworkClientListWindow *w, Point pt, T id);
1399
1400public:
1412 id(id),
1413 proc(proc)
1414 {
1415 assert(proc != nullptr);
1416 }
1417
1418 void OnClick(struct NetworkClientListWindow *w, Point pt) override
1419 {
1420 if (this->disabled) return;
1421
1422 this->proc(w, pt, this->id);
1423 }
1424};
1425
1428
1433public:
1434 std::vector<std::unique_ptr<ButtonCommon>> buttons{};
1435
1437 virtual ~ButtonLine() = default;
1438
1443 virtual void Draw(Rect r) const = 0;
1444
1450 template <typename T, typename...TArgs>
1451 T &AddButton(TArgs &&... args)
1452 {
1453 auto &button = this->buttons.emplace_back(std::make_unique<T>(std::forward<TArgs &&>(args)...));
1454 return static_cast<T &>(*button);
1455 }
1456
1463 ButtonCommon *GetButton(Rect r, const Point &pt) const
1464 {
1465 bool rtl = _current_text_dir == TD_RTL;
1466 for (auto &button : this->buttons) {
1467 if (r.WithWidth(button->width, !rtl).Contains(pt)) return button.get();
1468 r = r.Indent(button->width + WidgetDimensions::scaled.hsep_normal, !rtl);
1469 }
1470 return nullptr;
1471 }
1472
1479 virtual std::optional<EncodedString> GetTooltip(Rect r, const Point &pt) const
1480 {
1481 ButtonCommon *button = this->GetButton(r, pt);
1482 if (button == nullptr) return {};
1483 return GetEncodedString(button->tooltip);
1484 }
1485
1486protected:
1493 {
1494 bool rtl = _current_text_dir == TD_RTL;
1495 for (auto &button : buttons) {
1496 Rect br = r.CentreToHeight(button->height).WithWidth(button->width, !rtl);
1497 DrawFrameRect(br, button->colour, {});
1498 DrawSpriteIgnorePadding(button->sprite, PAL_NONE, br, {AlignmentH::Centre, AlignmentV::Middle});
1499 if (button->disabled) {
1501 }
1502 r = r.Indent(button->width + WidgetDimensions::scaled.hsep_normal, !rtl);
1503 }
1504 return r;
1505 }
1506};
1507
1510public:
1516
1517 void Draw(Rect r) const override
1518 {
1519 bool rtl = _current_text_dir == TD_RTL;
1520 r = this->DrawButtons(r);
1521
1524 DrawSpriteIgnorePadding(SPR_COMPANY_ICON, pal, r.WithWidth(d.width, rtl), {AlignmentH::Centre, AlignmentV::Middle});
1525
1527 if (this->company_id == COMPANY_SPECTATOR) {
1528 DrawString(tr, STR_NETWORK_CLIENT_LIST_SPECTATORS, TextColour::Silver);
1529 } else if (this->company_id == COMPANY_NEW_COMPANY) {
1530 DrawString(tr, STR_NETWORK_CLIENT_LIST_NEW_COMPANY, TextColour::White);
1531 } else {
1532 DrawString(tr, GetString(STR_COMPANY_NAME, this->company_id, this->company_id), TextColour::Silver);
1533 }
1534 };
1535
1536private:
1537 CompanyID company_id;
1538};
1539
1542public:
1548
1549 void Draw(Rect r) const override
1550 {
1552 if (ci == nullptr) return;
1553
1554 bool rtl = _current_text_dir == TD_RTL;
1555 r = this->DrawButtons(r);
1556
1558
1559 SpriteID player_icon = 0;
1560 if (ci->client_id == _network_own_client_id) {
1561 player_icon = SPR_PLAYER_SELF;
1562 } else if (ci->client_id == ClientID::Server) {
1563 player_icon = SPR_PLAYER_HOST;
1564 }
1565
1566 if (player_icon != 0) {
1567 Dimension d = GetScaledSpriteSize(player_icon);
1568 DrawSpriteIgnorePadding(player_icon, PALETTE_TO_GREY, r.WithWidth(d.width, rtl), {AlignmentH::Centre, AlignmentV::Middle});
1569 tr = tr.Indent(d.width + WidgetDimensions::scaled.hsep_normal, rtl);
1570 }
1571
1572 DrawString(tr, GetString(STR_JUST_RAW_STRING, ci->client_name), TextColour::Black);
1573 }
1574
1575 std::optional<EncodedString> GetTooltip(Rect r, const Point &pt) const override
1576 {
1577 bool rtl = _current_text_dir == TD_RTL;
1578 Dimension d = GetScaledSpriteSize(SPR_PLAYER_SELF);
1579
1580 if (r.WithWidth(d.width, rtl).Contains(pt)) {
1582 if (ci != nullptr) {
1583 if (ci->client_id == _network_own_client_id) {
1584 return GetEncodedString(STR_NETWORK_CLIENT_LIST_PLAYER_ICON_SELF_TOOLTIP);
1585 } else if (ci->client_id == ClientID::Server) {
1586 return GetEncodedString(STR_NETWORK_CLIENT_LIST_PLAYER_ICON_HOST_TOOLTIP);
1587 }
1588 }
1589 }
1590
1591 return this->ButtonLine::GetTooltip(r, pt);
1592 }
1593
1594private:
1596};
1597
1602private:
1614
1616
1618 CompanyID dd_company_id = CompanyID::Invalid();
1619
1620 Scrollbar *vscroll = nullptr;
1621 uint line_height = 0;
1622 int hover_index = -1;
1623
1624 std::vector<std::unique_ptr<ButtonLine>> buttons{};
1625
1630 static void OnClickCompanyChat(NetworkClientListWindow *, Point, CompanyID company_id)
1631 {
1633 }
1634
1639 static void OnClickCompanyJoin(NetworkClientListWindow *, Point, CompanyID company_id)
1640 {
1641 if (_network_server) {
1644 } else {
1645 NetworkClientRequestMove(company_id);
1646 }
1647 }
1648
1653 {
1654 Command<Commands::CompanyControl>::Post(CompanyCtrlAction::New, CompanyID::Invalid(), CompanyRemoveReason::None, _network_own_client_id);
1655 }
1656
1664 {
1665 DropDownList list;
1666 list.push_back(MakeDropDownListStringItem(STR_NETWORK_CLIENT_LIST_ADMIN_CLIENT_KICK, to_underlying(DropDownAction::AdminKickClient)));
1667 list.push_back(MakeDropDownListStringItem(STR_NETWORK_CLIENT_LIST_ADMIN_CLIENT_BAN, to_underlying(DropDownAction::AdminBanClient)));
1668
1669 Rect wi_rect;
1670 wi_rect.left = pt.x;
1671 wi_rect.right = pt.x;
1672 wi_rect.top = pt.y;
1673 wi_rect.bottom = pt.y;
1674
1675 w->dd_client_id = client_id;
1677 }
1678
1685 static void OnClickCompanyAdmin(NetworkClientListWindow *w, Point pt, CompanyID company_id)
1686 {
1687 DropDownList list;
1688 if (_network_server) list.push_back(MakeDropDownListStringItem(STR_NETWORK_CLIENT_LIST_ADMIN_COMPANY_RESET, to_underlying(DropDownAction::AdminResetCompany), NetworkCompanyHasClients(company_id)));
1689 if (const Company *c = Company::GetIfValid(company_id); c != nullptr && !c->is_ai) {
1690 list.push_back(MakeDropDownListStringItem(STR_NETWORK_CLIENT_LIST_ADMIN_COMPANY_ALLOW_ANY, to_underlying(DropDownAction::CompanyAllowAny), c->allow_any));
1691 list.push_back(MakeDropDownListStringItem(STR_NETWORK_CLIENT_LIST_ADMIN_COMPANY_ALLOW_LISTED, to_underlying(DropDownAction::CompanyAllowListed), !c->allow_any));
1692 }
1693
1694 Rect wi_rect;
1695 wi_rect.left = pt.x;
1696 wi_rect.right = pt.x;
1697 wi_rect.top = pt.y;
1698 wi_rect.bottom = pt.y;
1699
1700 w->dd_company_id = company_id;
1702 }
1703
1712
1718 {
1720 Command<Commands::CompanyAllowListControl>::Post(CompanyAllowListCtrlAction::AddKey, NetworkClientInfo::GetByClientID(client_id)->public_key);
1721 }
1722
1729 void RebuildListCompany(CompanyID company_id, CompanyID client_playas, bool can_join_company)
1730 {
1731 ButtonLine &company_line = *this->buttons.emplace_back(std::make_unique<CompanyButtonLine>(company_id));
1732 if (_network_server || company_id == _local_company) {
1733 company_line.AddButton<CompanyButton>(SPR_ADMIN, STR_NETWORK_CLIENT_LIST_ADMIN_COMPANY_TOOLTIP, Colours::Red, company_id, &NetworkClientListWindow::OnClickCompanyAdmin, company_id == COMPANY_SPECTATOR);
1734 }
1735 ButtonCommon &chat_button = company_line.AddButton<CompanyButton>(SPR_CHAT, company_id == COMPANY_SPECTATOR ? STR_NETWORK_CLIENT_LIST_CHAT_SPECTATOR_TOOLTIP : STR_NETWORK_CLIENT_LIST_CHAT_COMPANY_TOOLTIP, Colours::Orange, company_id, &NetworkClientListWindow::OnClickCompanyChat);
1736 if (can_join_company) company_line.AddButton<CompanyButton>(SPR_JOIN, STR_NETWORK_CLIENT_LIST_JOIN_TOOLTIP, Colours::Orange, company_id, &NetworkClientListWindow::OnClickCompanyJoin, company_id != COMPANY_SPECTATOR && Company::Get(company_id)->is_ai);
1737
1738 bool has_players = false;
1739 for (const NetworkClientInfo *ci : NetworkClientInfo::Iterate()) {
1740 if (ci->client_playas != company_id) continue;
1741 has_players = true;
1742
1743 ButtonLine &line = *this->buttons.emplace_back(std::make_unique<ClientButtonLine>(ci->index));
1744 if (_network_server) line.AddButton<ClientButton>(SPR_ADMIN, STR_NETWORK_CLIENT_LIST_ADMIN_CLIENT_TOOLTIP, Colours::Red, ci->client_id, &NetworkClientListWindow::OnClickClientAdmin, _network_own_client_id == ci->client_id);
1745 if (_network_own_client_id != ci->client_id) line.AddButton<ClientButton>(SPR_CHAT, STR_NETWORK_CLIENT_LIST_CHAT_CLIENT_TOOLTIP, Colours::Orange, ci->client_id, &NetworkClientListWindow::OnClickClientChat);
1746 if (_network_own_client_id != ci->client_id && client_playas != COMPANY_SPECTATOR && !ci->CanJoinCompany(client_playas)) line.AddButton<ClientButton>(SPR_JOIN, STR_NETWORK_CLIENT_LIST_COMPANY_AUTHORIZE_TOOLTIP, Colours::Green, ci->client_id, &NetworkClientListWindow::OnClickClientAuthorize);
1747 }
1748
1749 /* Disable the chat button when there are no players in this company. */
1750 chat_button.disabled = !has_players;
1751 }
1752
1757 {
1759 CompanyID client_playas = own_ci == nullptr ? COMPANY_SPECTATOR : own_ci->client_playas;
1760
1761 this->buttons.clear();
1762
1763 /* As spectator, show a line to create a new company. */
1764 if (client_playas == COMPANY_SPECTATOR && !NetworkMaxCompaniesReached()) {
1765 ButtonLine &line = *this->buttons.emplace_back(std::make_unique<CompanyButtonLine>(COMPANY_NEW_COMPANY));
1766 line.AddButton<CompanyButton>(SPR_JOIN, STR_NETWORK_CLIENT_LIST_NEW_COMPANY_TOOLTIP, Colours::Orange, COMPANY_SPECTATOR, &NetworkClientListWindow::OnClickCompanyNew);
1767 }
1768
1769 if (client_playas != COMPANY_SPECTATOR) {
1770 this->RebuildListCompany(client_playas, client_playas, false);
1771 }
1772
1773 /* Companies */
1774 for (const Company *c : Company::Iterate()) {
1775 if (c->index == client_playas) continue;
1776
1777 this->RebuildListCompany(c->index, client_playas, own_ci != nullptr && own_ci->CanJoinCompany(c->index));
1778 }
1779
1780 /* Spectators */
1781 this->RebuildListCompany(COMPANY_SPECTATOR, client_playas, client_playas != COMPANY_SPECTATOR);
1782
1783 this->vscroll->SetCount(this->buttons.size());
1784 }
1785
1786public:
1793 {
1794 this->CreateNestedTree();
1795 this->vscroll = this->GetScrollbar(WID_CL_SCROLLBAR);
1796 this->OnInvalidateData();
1797 this->FinishInitNested(window_number);
1798 }
1799
1800 void OnInit() override
1801 {
1802 this->RebuildList();
1803 }
1804
1805 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1806 {
1807 this->RebuildList();
1808
1809 /* Currently server information is not synced to clients, so we cannot show it on clients. */
1812 }
1813
1814 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1815 {
1816 switch (widget) {
1817 case WID_CL_SERVER_NAME:
1818 case WID_CL_CLIENT_NAME: {
1819 std::string str;
1820 if (widget == WID_CL_SERVER_NAME) {
1821 str = GetString(STR_JUST_RAW_STRING, _network_server ? _settings_client.network.server_name : _network_server_name);
1822 } else {
1824 str = GetString(STR_JUST_RAW_STRING, own_ci != nullptr ? own_ci->client_name : _settings_client.network.client_name);
1825 }
1826 size = GetStringBoundingBox(str);
1827 size.width = std::min(size.width, static_cast<uint>(ScaleGUITrad(200))); // By default, don't open the window too wide.
1828 break;
1829 }
1830
1832 size = maxdim(maxdim(GetStringBoundingBox(STR_NETWORK_SERVER_VISIBILITY_LOCAL), GetStringBoundingBox(STR_NETWORK_SERVER_VISIBILITY_PUBLIC)), GetStringBoundingBox(STR_NETWORK_SERVER_VISIBILITY_INVITE_ONLY));
1833 size.width += padding.width;
1834 size.height += padding.height;
1835 break;
1836
1837 case WID_CL_MATRIX: {
1839 height += WidgetDimensions::scaled.framerect.Vertical();
1840 this->line_height = std::max(height, (uint)GetCharacterHeight(FontSize::Normal)) + padding.height;
1841
1842 resize.width = 1;
1843 fill.height = resize.height = this->line_height;
1844 size.height = std::max(size.height, 5 * this->line_height);
1845 break;
1846 }
1847 }
1848 }
1849
1850 void OnResize() override
1851 {
1852 this->vscroll->SetCapacityFromWidget(this, WID_CL_MATRIX);
1853 }
1854
1855 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1856 {
1857 switch (widget) {
1858 case WID_CL_SERVER_NAME:
1859 return _network_server ? _settings_client.network.server_name : _network_server_name;
1860
1862 return GetString(STR_NETWORK_SERVER_VISIBILITY_LOCAL + to_underlying(_settings_client.network.server_game_type));
1863
1866
1868 return GetString(STR_NETWORK_CLIENT_LIST_SERVER_CONNECTION_TYPE_UNKNOWN + to_underlying(_network_server_connection_type));
1869
1870 case WID_CL_CLIENT_NAME: {
1872 return own_ci != nullptr ? own_ci->client_name : _settings_client.network.client_name;
1873 }
1874
1876 return GetString(STR_NETWORK_CLIENT_LIST_CLIENT_COMPANY_COUNT, NetworkClientInfo::GetNumItems(), Company::GetNumItems(), NetworkMaxCompaniesAllowed());
1877
1878 default:
1879 return this->Window::GetWidgetString(widget, stringid);
1880 }
1881 }
1882
1883 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1884 {
1885 switch (widget) {
1887 if (!_network_server) break;
1888
1889 this->query_widget = WID_CL_SERVER_NAME_EDIT;
1890 ShowQueryString(_settings_client.network.server_name, STR_NETWORK_CLIENT_LIST_SERVER_NAME_QUERY_CAPTION, NETWORK_NAME_LENGTH, this, CS_ALPHANUMERAL, QueryStringFlag::LengthIsInChars);
1891 break;
1892
1895 this->query_widget = WID_CL_CLIENT_NAME_EDIT;
1896 ShowQueryString(own_ci != nullptr ? own_ci->client_name : _settings_client.network.client_name, STR_NETWORK_CLIENT_LIST_PLAYER_NAME_QUERY_CAPTION, NETWORK_CLIENT_NAME_LENGTH, this, CS_ALPHANUMERAL, QueryStringFlag::LengthIsInChars);
1897 break;
1898 }
1900 if (!_network_server) break;
1901
1903 break;
1904
1905 case WID_CL_MATRIX: {
1906 auto it = this->vscroll->GetScrolledItemFromWidget(this->buttons, pt.y, this, WID_CL_MATRIX);
1907 if (it == std::end(this->buttons)) break;
1908
1909 Rect r = this->GetWidget<NWidgetBase>(WID_CL_MATRIX)->GetCurrentRect().Shrink(WidgetDimensions::scaled.framerect);
1910 ButtonCommon *button = (*it)->GetButton(r, pt);
1911 if (button == nullptr) break;
1912
1913 button->OnClick(this, pt);
1914 break;
1915 }
1916 }
1917 }
1918
1919 bool OnTooltip([[maybe_unused]] Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
1920 {
1921 switch (widget) {
1922 case WID_CL_MATRIX: {
1923 auto it = this->vscroll->GetScrolledItemFromWidget(this->buttons, pt.y, this, WID_CL_MATRIX);
1924 if (it == std::end(this->buttons)) break;
1925
1926 Rect r = this->GetWidget<NWidgetBase>(WID_CL_MATRIX)->GetCurrentRect().Shrink(WidgetDimensions::scaled.framerect);
1927 auto tooltip = (*it)->GetTooltip(r, pt);
1928 if (!tooltip.has_value()) break;
1929
1930 GuiShowTooltips(this, std::move(*tooltip), close_cond);
1931 return true;
1932 };
1933 }
1934
1935 return false;
1936 }
1937
1938 void OnDropdownClose(Point pt, WidgetID widget, int index, int click_result, bool instant_close) override
1939 {
1940 /* If you close the dropdown outside the list, don't take any action. */
1941 if (widget == WID_CL_MATRIX) return;
1942
1943 Window::OnDropdownClose(pt, widget, index, click_result, instant_close);
1944 }
1945
1946 void OnDropdownSelect(WidgetID widget, int index, int) override
1947 {
1948 switch (widget) {
1950 if (!_network_server) break;
1951
1952 _settings_client.network.server_game_type = (ServerGameType)index;
1954 break;
1955
1956 case WID_CL_MATRIX: {
1957 QueryCallbackProc *callback = nullptr;
1958
1959 EncodedString text;
1960 switch (static_cast<DropDownAction>(index)) {
1962 _admin_client_id = this->dd_client_id;
1963 callback = AdminClientKickCallback;
1964 text = GetEncodedString(STR_NETWORK_CLIENT_LIST_ASK_CLIENT_KICK, NetworkClientInfo::GetByClientID(_admin_client_id)->client_name);
1965 break;
1966
1968 _admin_client_id = this->dd_client_id;
1969 callback = AdminClientBanCallback;
1970 text = GetEncodedString(STR_NETWORK_CLIENT_LIST_ASK_CLIENT_BAN, NetworkClientInfo::GetByClientID(_admin_client_id)->client_name);
1971 break;
1972
1974 _admin_company_id = this->dd_company_id;
1975 callback = AdminCompanyResetCallback;
1976 text = GetEncodedString(STR_NETWORK_CLIENT_LIST_ASK_COMPANY_RESET, _admin_company_id);
1977 break;
1978
1980 AutoRestoreBackup cur_company(_current_company, this->dd_company_id);
1981 Command<Commands::CompanyAllowListControl>::Post(CompanyAllowListCtrlAction::AllowAny, {});
1982 return;
1983 }
1984
1986 AutoRestoreBackup cur_company(_current_company, this->dd_company_id);
1987 Command<Commands::CompanyAllowListControl>::Post(CompanyAllowListCtrlAction::AllowListed, {});
1988 return;
1989 }
1990
1991 default:
1992 NOT_REACHED();
1993 }
1994
1995 assert(callback != nullptr);
1996
1997 /* Always ask confirmation for all admin actions. */
1998 ShowQuery(
1999 GetEncodedString(STR_NETWORK_CLIENT_LIST_ASK_CAPTION),
2000 std::move(text),
2001 this, callback);
2002
2003 break;
2004 }
2005
2006 default:
2007 NOT_REACHED();
2008 }
2009
2010 this->SetDirty();
2011 }
2012
2013 void OnQueryTextFinished(std::optional<std::string> str) override
2014 {
2015 if (!str.has_value()) return;
2016
2017 switch (this->query_widget) {
2018 default: NOT_REACHED();
2019
2021 if (!_network_server) break;
2022
2023 SetSettingValue(GetSettingFromName("network.server_name")->AsStringSetting(), *str);
2024 this->InvalidateData();
2025 break;
2026 }
2027
2029 SetSettingValue(GetSettingFromName("network.client_name")->AsStringSetting(), *str);
2030 this->InvalidateData();
2031 break;
2032 }
2033 }
2034 }
2035
2036 void DrawWidget(const Rect &r, WidgetID widget) const override
2037 {
2038 switch (widget) {
2039 case WID_CL_MATRIX: {
2040 Rect ir = r.WithHeight(this->line_height).Shrink(WidgetDimensions::scaled.framerect, RectPadding::zero);
2041
2042 if (this->hover_index >= 0) {
2043 Rect br = r.WithHeight(this->line_height).Translate(0, this->hover_index * this->line_height);
2045 }
2046
2047 auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->buttons);
2048 for (auto it = first; it != last; ++it) {
2049 (*it)->Draw(ir);
2050 ir = ir.Translate(0, this->line_height);
2051 }
2052
2053 break;
2054 }
2055 }
2056 }
2057
2058 void OnMouseOver([[maybe_unused]] Point pt, WidgetID widget) override
2059 {
2060 if (widget != WID_CL_MATRIX) {
2061 if (this->hover_index != -1) {
2062 this->hover_index = -1;
2064 }
2065 } else {
2066 int index = this->GetRowFromWidget(pt.y, widget, 0, -1);
2067 if (index != this->hover_index) {
2068 this->hover_index = index;
2070 }
2071 }
2072 }
2073};
2074
2080
2085
2088 std::shared_ptr<NetworkAuthenticationPasswordRequest> request{};
2089
2095 {
2096 this->parent = FindWindowById(WindowClass::Network, NetworkWindowNumber::Game);
2098 }
2099
2100 void DrawWidget(const Rect &r, WidgetID widget) const override
2101 {
2102 switch (widget) {
2103 case WID_NJS_PROGRESS_BAR: {
2104 /* Draw the % complete with a bar and a text */
2106 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
2107 uint8_t progress; // used for progress bar
2108 switch (_network_join_status) {
2111 progress = 10; // first two stages 10%
2112 break;
2114 progress = 15; // third stage is 15%
2115 break;
2117 if (_network_join_bytes_total == 0) {
2118 progress = 15; // We don't have the final size yet; the server is still compressing!
2119 break;
2120 }
2121 [[fallthrough]];
2122
2123 default: // Waiting is 15%, so the remaining downloading of the map is maximum 70%
2124 progress = 15 + _network_join_bytes * (100 - 15) / _network_join_bytes_total;
2125 break;
2126 }
2127 DrawFrameRect(ir.WithWidth(ir.Width() * progress / 100, _current_text_dir == TD_RTL), Colours::Mauve, {});
2128 DrawString(ir.left, ir.right, CentreBounds(ir.top, ir.bottom, GetCharacterHeight(FontSize::Normal)), STR_NETWORK_CONNECTING_1 + to_underlying(_network_join_status), TextColour::FromString, AlignmentH::Centre);
2129 break;
2130 }
2131
2133 switch (_network_join_status) {
2136 break;
2137
2139 if (_network_join_bytes_total == 0) {
2141 } else {
2143 }
2144 break;
2145
2146 default:
2147 break;
2148 }
2149 break;
2150 }
2151 }
2152
2153 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
2154 {
2155 switch (widget) {
2157 /* Account for the statuses */
2159 size = maxdim(size, GetStringBoundingBox(STR_NETWORK_CONNECTING_1 + to_underlying(i)));
2160 }
2161 /* For the number of waiting (other) players */
2162 size = maxdim(size, GetStringBoundingBox(GetString(STR_NETWORK_CONNECTING_WAITING, GetParamMaxValue(MAX_CLIENTS))));
2163 /* We need some spacing for the 'border' */
2164 size.height += WidgetDimensions::scaled.frametext.Horizontal();
2165 size.width += WidgetDimensions::scaled.frametext.Vertical();
2166 break;
2167
2168 case WID_NJS_PROGRESS_TEXT: {
2169 /* Account for downloading ~ 10 MiB */
2170 uint64_t max_digits = GetParamMaxDigits(8);
2171 size = maxdim(size, GetStringBoundingBox(GetString(STR_NETWORK_CONNECTING_DOWNLOADING_1, max_digits, max_digits)));
2172 size = maxdim(size, GetStringBoundingBox(GetString(STR_NETWORK_CONNECTING_DOWNLOADING_1, max_digits, max_digits)));
2173 break;
2174 }
2175 }
2176 }
2177
2178 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2179 {
2180 if (widget == WID_NJS_CANCELOK) { // Disconnect button
2182 SwitchToMode(SwitchMode::Menu);
2184 }
2185 }
2186
2187 void OnQueryTextFinished(std::optional<std::string> str) override
2188 {
2189 if (!str.has_value() || str->empty() || this->request == nullptr) {
2191 return;
2192 }
2193
2194 this->request->Reply(*str);
2195 }
2196};
2197
2199static constexpr std::initializer_list<NWidgetPart> _nested_network_join_status_window_widgets = {
2200 NWidget(WWT_CAPTION, Colours::Grey), SetStringTip(STR_NETWORK_CONNECTING_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2205 NWidget(WWT_PUSHTXTBTN, Colours::White, WID_NJS_CANCELOK), SetMinimalSize(101, 12), SetStringTip(STR_NETWORK_CONNECTION_DISCONNECT), SetFill(1, 0),
2206 EndContainer(),
2207 EndContainer(),
2208};
2209
2212 WindowPosition::Center, {}, 0, 0,
2213 WindowClass::NetworkStatus, WindowClass::None,
2216);
2217
2224
2229void ShowNetworkNeedPassword(std::shared_ptr<NetworkAuthenticationPasswordRequest> request)
2230{
2231 NetworkJoinStatusWindow *w = dynamic_cast<NetworkJoinStatusWindow *>(FindWindowById(WindowClass::NetworkStatus, NetworkStatusWindowNumber::Join));
2232 if (w == nullptr) return;
2233 w->request = std::move(request);
2234
2235 ShowQueryString({}, STR_NETWORK_NEED_GAME_PASSWORD_CAPTION, NETWORK_PASSWORD_LENGTH, w, CS_ALPHANUMERAL, {});
2236}
2237
2244 std::string token{};
2245
2255 Window(desc),
2258 token(std::move(token))
2259 {
2260 this->parent = parent;
2261 this->InitNested(0);
2262 }
2263
2264 void Close(int data = 0) override
2265 {
2266 if (data == NRWCD_UNHANDLED) _network_coordinator_client.ConnectFailure(this->token, 0);
2267 this->Window::Close();
2268 }
2269
2270 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
2271 {
2272 if (widget == WID_NAR_TEXT) {
2273 size = GetStringBoundingBox(GetString(STR_NETWORK_ASK_RELAY_TEXT, this->server_connection_string, this->relay_connection_string));
2274 }
2275 }
2276
2277 void DrawWidget(const Rect &r, WidgetID widget) const override
2278 {
2279 if (widget == WID_NAR_TEXT) {
2280 DrawStringMultiLine(r, GetString(STR_NETWORK_ASK_RELAY_TEXT, this->server_connection_string, this->relay_connection_string), TextColour::FromString, {AlignmentH::Centre, AlignmentV::Middle});
2281 }
2282 }
2283
2284 void FindWindowPlacementAndResize(int, int, bool) override
2285 {
2286 /* Position query window over the calling window, ensuring it's within screen bounds. */
2287 this->left = Clamp(parent->left + (parent->width / 2) - (this->width / 2), 0, _screen.width - this->width);
2288 this->top = Clamp(parent->top + (parent->height / 2) - (this->height / 2), 0, _screen.height - this->height);
2289 this->SetDirty();
2290 }
2291
2292 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2293 {
2294 switch (widget) {
2295 case WID_NAR_NO:
2296 _network_coordinator_client.ConnectFailure(this->token, 0);
2297 this->Close(NRWCD_HANDLED);
2298 break;
2299
2300 case WID_NAR_YES_ONCE:
2301 _network_coordinator_client.StartTurnConnection(this->token);
2302 this->Close(NRWCD_HANDLED);
2303 break;
2304
2305 case WID_NAR_YES_ALWAYS:
2306 _settings_client.network.use_relay_service = UseRelayService::Allow;
2307 _network_coordinator_client.StartTurnConnection(this->token);
2308 this->Close(NRWCD_HANDLED);
2309 break;
2310 }
2311 }
2312};
2313
2331
2334 WindowPosition::Center, {}, 0, 0,
2335 WindowClass::NetworkAskRelay, WindowClass::None,
2338);
2339
2346void ShowNetworkAskRelay(std::string_view server_connection_string, std::string &&relay_connection_string, std::string &&token)
2347{
2348 CloseWindowByClass(WindowClass::NetworkAskRelay, NRWCD_HANDLED);
2349
2350 Window *parent = GetMainWindow();
2351 new NetworkAskRelayWindow(_network_ask_relay_desc, parent, server_connection_string, std::move(relay_connection_string), std::move(token));
2352}
2353
2364 Window(desc)
2365 {
2366 this->parent = parent;
2367 this->InitNested(0);
2368 }
2369
2370 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
2371 {
2372 if (widget == WID_NAS_TEXT) {
2373 size = GetStringBoundingBox(STR_NETWORK_ASK_SURVEY_TEXT);
2374 }
2375 }
2376
2377 void DrawWidget(const Rect &r, WidgetID widget) const override
2378 {
2379 if (widget == WID_NAS_TEXT) {
2381 }
2382 }
2383
2384 void FindWindowPlacementAndResize(int, int, bool) override
2385 {
2386 /* Position query window over the calling window, ensuring it's within screen bounds. */
2387 this->left = Clamp(parent->left + (parent->width / 2) - (this->width / 2), 0, _screen.width - this->width);
2388 this->top = Clamp(parent->top + (parent->height / 2) - (this->height / 2), 0, _screen.height - this->height);
2389 this->SetDirty();
2390 }
2391
2392 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2393 {
2394 switch (widget) {
2395 case WID_NAS_PREVIEW:
2397 break;
2398
2399 case WID_NAS_LINK:
2400 OpenBrowser(NETWORK_SURVEY_DETAILS_LINK);
2401 break;
2402
2403 case WID_NAS_NO:
2404 _settings_client.network.participate_survey = ParticipateSurvey::No;
2405 this->Close();
2406 break;
2407
2408 case WID_NAS_YES:
2409 _settings_client.network.participate_survey = ParticipateSurvey::Yes;
2410 this->Close();
2411 break;
2412 }
2413 }
2414};
2415
2436
2439 WindowPosition::Center, {}, 0, 0,
2440 WindowClass::NetworkAskSurvey, WindowClass::None,
2443);
2444
2449{
2450 /* If we can't send a survey, don't ask the question. */
2451 if constexpr (!NetworkSurveyHandler::IsSurveyPossible()) return;
2452
2453 CloseWindowByClass(WindowClass::NetworkAskSurvey);
2454
2455 Window *parent = GetMainWindow();
2457}
2458
2460struct SurveyResultTextfileWindow : public TextfileWindow {
2462
2469 {
2470 this->ConstructWindow();
2471
2472 auto result = _survey.CreatePayload(NetworkSurveyHandler::Reason::Preview, true);
2473 this->LoadText(result);
2474 this->InvalidateData();
2475 }
2476};
2477
Button shown for either a company or client in the client-list.
Colours colour
The colour of the button.
virtual ~ButtonCommon()=default
Ensure the destructor of the sub classes are called as well.
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.
ButtonCommon(SpriteID sprite, StringID tooltip, Colours colour, bool disabled=false)
Create the button.
StringID tooltip
The tooltip of the button.
Base interface for a network client list line.
virtual std::optional< EncodedString > GetTooltip(Rect r, const Point &pt) const
Get tooptip for a given point on the line.
Rect DrawButtons(Rect r) const
Draw the buttons for this line.
std::vector< std::unique_ptr< ButtonCommon > > buttons
Buttons for this line.
T & AddButton(TArgs &&... args)
Construct a button and add it.
virtual ~ButtonLine()=default
Ensure the destructor of the sub classes are called as well.
ButtonCommon * GetButton(Rect r, const Point &pt) const
Get the button at a given point on the line.
virtual void Draw(Rect r) const =0
Draw the button line.
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
Button(SpriteID sprite, StringID tooltip, Colours colour, T id, ButtonCallback proc, bool disabled=false)
Create the button.
void(* ButtonCallback)(struct NetworkClientListWindow *w, Point pt, T id)
Callback function to call on click.
ClientPoolID client_pool_id
The client to show on this line.
ClientButtonLine(ClientPoolID client_pool_id)
Create the line.
void Draw(Rect r) const override
Draw the button line.
std::optional< EncodedString > GetTooltip(Rect r, const Point &pt) const override
Get tooptip for a given point on the line.
void Draw(Rect r) const override
Draw the button line.
CompanyButtonLine(CompanyID company_id)
Create the line.
CompanyID company_id
The company to show on the line.
Container for an encoded string, created by GetEncodedString.
Iterate a range of enum values.
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).
void Add(std::unique_ptr< NWidgetBase > &&wid)
Append widget wid to container.
Definition widget.cpp:1328
std::vector< std::unique_ptr< NWidgetBase > > children
Child widgets in container.
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.
NWidgetServerListHeader()
Create the header.
Window with the list of game servers.
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.
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 DrawDetails(const Rect &r) const
Draw the details about the selected server.
QueryString filter_editbox
Editbox for filter on servers.
Scrollbar * vscroll
Vertical scrollbar of the list of servers.
StringID GetHeaderString() const
Get the string for the header of the 'selected server' subpanel.
void BuildGUINetworkGameList()
(Re)build the GUI network game list (a.k.a.
static bool NGameNameSorter(NetworkGame *const &a, NetworkGame *const &b)
Sort servers by name.
static bool NGameTicksPlayingSorter(NetworkGame *const &a, NetworkGame *const &b)
Sort servers by the number of ticks the game is running.
void UpdateListPos()
Set this->list_pos to match this->server.
void OnInit() override
Notification that the nested widget tree gets initialized.
const IntervalTimer< TimerWindow > refresh_interval
Refresh the online servers on a regular interval.
static bool NGameAllowedSorter(NetworkGame *const &a, NetworkGame *const &b)
Sort servers by joinability.
NetworkGame * server
Selected server.
NetworkGame * last_joined
The last joined server.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void DrawServerLine(const NetworkGame *cur_item, int y, bool highlight) const
Draw a single server line.
void OnResize() override
Called after the window got resized.
static bool NGameCalendarDateSorter(NetworkGame *const &a, NetworkGame *const &b)
Sort servers by calendar date.
void ScrollToSelectedServer()
Scroll the list up or down to the currently selected server.
~NetworkGameWindow() override
Save the last sorting state.
static const std::initializer_list< GUIGameServerList::SortFunction *const > sorter_funcs
Functions for sorting servers.
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 NGameClientSorter(NetworkGame *const &a, NetworkGame *const &b)
Sort servers by the amount of clients online on a server.
void SortNetworkGameList()
Sort the server list.
Dimension blot
Dimension of compatibility icon.
static bool NGameSearchFilter(NetworkGame *const *item, StringFilter &filter)
Filter the servers by the server name.
static Listing last_sorting
Runtime saved values.
static bool NGameMapSizeSorter(NetworkGame *const &a, NetworkGame *const &b)
Sort servers by map size.
static const std::initializer_list< GUIGameServerList::FilterFunction *const > filter_funcs
Functions for filtering servers.
GUIGameServerList servers
List with game servers.
bool searched_internet
Did we ever press "Search Internet" button?
Dimension lock
Dimension of lock icon.
QueryString name_editbox
Client name editbox.
NetworkGameWindow(WindowDesc &desc)
Create the window.
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.
static constexpr bool IsSurveyPossible()
Check whether a survey is possible.
@ Preview
User is previewing the survey result.
Scrollbar data structure.
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.
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:2548
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:2495
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.
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.
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:94
Functions related to commands.
PaletteID GetCompanyPalette(CompanyID company)
Get the palette for recolouring with a company colour.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
CompanyID _current_company
Company currently doing an action.
Command definitions related to companies.
Functions related to companies.
@ New
Create a new company.
@ Delete
Delete a company.
static constexpr CompanyID COMPANY_SPECTATOR
The client is spectating.
@ AddKey
Create a public key.
@ AllowListed
Allow only listed keys to join the company.
@ AllowAny
Allow joining the company without a key.
static constexpr CompanyID COMPANY_NEW_COMPANY
The client wants a new company.
@ None
Dummy reason for actions that don't need one.
@ 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:56
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:53
static const uint NETWORK_NAME_LENGTH
The maximum length of the server name and map name, in bytes including '\0'.
Definition config.h:51
static const std::string NETWORK_SURVEY_DETAILS_LINK
Link with more details & privacy statement of the survey.
Definition config.h:28
static const uint NETWORK_PASSWORD_LENGTH
The maximum length of the password, in bytes including '\0'.
Definition config.h:55
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, DropDownOptions options, std::string *const persistent_filter_text)
Show a drop down list.
Definition dropdown.cpp:574
std::unique_ptr< DropDownListItem > MakeDropDownListStringItem(StringID str, int value, bool masked, bool shaded)
Creates new DropDownListStringItem.
Definition dropdown.cpp:49
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, DropDownOptions options, std::string *const persistent_filter_text)
Show a drop down list.
Definition dropdown.cpp:591
Functions related to the drop down widget.
Types related to the drop down widget.
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
@ InstantClose
Set if releasing mouse button should close the list regardless of where the cursor is.
#define T
Climate temperate.
Definition engines.h:91
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23).
Definition enum_type.hpp:21
@ Load
File is being loaded.
Definition fileio_type.h:53
@ Savegame
old or new savegame
Definition fileio_type.h:18
@ Scenario
old or new scenario
Definition fileio_type.h:19
@ Heightmap
heightmap file
Definition fileio_type.h:20
Declarations for savegames operations.
void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Launch save/load dialog in the given mode.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:88
Functions related to world/map generation.
static const uint32_t GENERATE_NEW_SEED
Create a new random seed.
Definition genworld.h:23
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.
Geometry functions.
@ Centre
Align to the centre.
@ End
Align to the end, LTR/RTL aware.
int CentreBounds(int min, int max, int size)
Determine where to position a centred object.
@ Middle
Align to the middle.
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition gfx.cpp:711
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:894
ControlInputs _input_clicked
Control inputs that have been actioned.
Definition gfx.cpp:35
void GfxFillRect(int left, int top, int right, int bottom, const std::variant< PixelColour, PaletteID > &colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition gfx.cpp:111
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, ExtendedTextColour colour, Alignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition gfx.cpp:782
int DrawString(int left, int right, int top, std::string_view str, ExtendedTextColour colour, Alignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:663
Functions related to the gfx engine.
Dimension GetScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI.
Definition widget.cpp:70
bool IsCtrlPressed()
Test if the ctrl key is pressed.
Definition gfx_func.h:82
void DrawSpriteIgnorePadding(SpriteID img, PaletteID pal, const Rect &r, Alignment align)
Draw a sprite within a Rect, ignoring the sprite's padding.
Definition widget.cpp:350
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ Normal
Index of the normal font in the font tables.
Definition gfx_type.h:249
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
Colours
One of 16 base colours used for companies and windows/widgets.
Definition gfx_type.h:283
@ White
White.
Definition gfx_type.h:300
@ Mauve
Mauve.
Definition gfx_type.h:295
@ Invalid
Invalid marker.
Definition gfx_type.h:302
@ LightBlue
Light blue.
Definition gfx_type.h:290
@ Yellow
Yellow.
Definition gfx_type.h:288
@ Orange
Orange.
Definition gfx_type.h:297
@ Grey
Grey.
Definition gfx_type.h:299
@ Green
Green.
Definition gfx_type.h:291
@ Red
Red.
Definition gfx_type.h:289
@ White
White colour.
Definition gfx_type.h:330
@ FromString
Marker for telling to use the colour from the string.
Definition gfx_type.h:317
@ Orange
Orange colour.
Definition gfx_type.h:324
@ Black
Black colour.
Definition gfx_type.h:334
@ Red
Red colour.
Definition gfx_type.h:321
@ Silver
Silver colour.
Definition gfx_type.h:319
@ Checker
Draw only every second pixel, used for greying-out.
Definition gfx_type.h:393
@ Left
Left mouse button is pressed.
Definition gfx_type.h:444
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 SetResizeWidgetTypeTip(ResizeWidgetType widget_type, StringID tip)
Widget part function for setting the resize widget type 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 SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FontSize::Normal)
Widget part function for setting the minimal text lines.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
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 NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetAlignment(Alignment 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:1013
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1548
GUI functions that shouldn't be here.
#define Point
Macro that prevents name conflicts between included headers.
Types related to maps.
static const uint MAX_MAP_SIZE
Maximal map size = 4096.
Definition map_type.h:40
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, EncodedString &&text, TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition misc_gui.cpp:690
void ShowQuery(EncodedString &&caption, EncodedString &&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(std::string_view 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:67
StringList _network_host_list
The servers we know.
Definition network.cpp:72
void NetworkQueryServer(std::string_view connection_string)
Query a server to fetch the game-info.
Definition network.cpp:685
void NetworkDisconnect(bool close_admins)
We want to disconnect from the host/clients.
Definition network.cpp:1031
bool _network_server
network-server is active
Definition network.cpp:64
NetworkGame * NetworkAddServer(std::string_view connection_string, bool manually, bool never_expire)
Validates an address entered as a string and adds the server to the list.
Definition network.cpp:707
bool NetworkClientConnectGame(std::string_view 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:805
void NetworkRebuildHostList()
Generates the list of manually added hosts from NetworkGame and dumps them into the array _network_ho...
Definition network.cpp:749
ClientID _network_own_client_id
Our client identifier.
Definition network.cpp:68
void NetworkUpdateServerGameType()
The setting server_game_type was updated; possibly we need to take some action.
Definition network.cpp:1059
bool NetworkValidateServerName(std::string &server_name)
Trim the given server name in place, i.e.
Definition network.cpp:883
Basic functions/variables used all over the place.
Base core network types and some helper functions to access them.
void ShowNetworkChatQueryWindow(NetworkChatDestinationType 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.
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.
Network functions used by other parts of OpenTTD.
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 NetworkServerKickClient(ClientID client_id, std::string_view reason)
Kick a single client.
uint NetworkServerKickOrBanIP(ClientID client_id, bool ban, std::string_view reason)
Ban, or kick, everyone joined from the given client's IP.
void NetworkGameListRemoveItem(NetworkGame *remove)
Remove an item from the gamelist linked list.
std::vector< std::unique_ptr< NetworkGame > > _network_game_list
Game list of this client.
Handling of the list of games.
@ Online
Server is online.
@ Offline
Server is offline (or cannot be queried).
@ TooOld
Server is too old to query.
@ Banned
You are banned from this server.
@ Full
Server is full and cannot be queried.
int ServerListPosition
A location within the server list.
static void AdminCompanyResetCallback(Window *, bool confirmed)
Callback function for admin command to reset company.
void ShowNetworkGameWindow()
Show the server list window.
static constexpr std::initializer_list< NWidgetPart > _nested_network_start_server_window_widgets
Widgets and the structure of the NetworkStartServerWindow.
static WindowDesc _network_game_window_desc(WindowPosition::Center, "list_servers", 1000, 730, WindowClass::Network, WindowClass::None, {}, _nested_network_game_widgets)
Description of the NetworkGameWindow.
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.
void ShowJoinStatusWindow()
Open the window showing the status of joining the server.
static constexpr std::initializer_list< NWidgetPart > _nested_network_join_status_window_widgets
Widgets and the structure of the NetworkJoinStatusWindow.
Button< CompanyID > CompanyButton
Button linked to a company.
static const ServerListPosition SLP_INVALID
Sentinel for an invalid location in the server list.
void ShowSurveyResultTextfileWindow(Window *parent)
Show the surver results as a text file.
static constexpr std::initializer_list< NWidgetPart > _nested_network_ask_relay_widgets
Widgets and the structure of the NetworkAskRelayWindow.
static WindowDesc _network_start_server_window_desc(WindowPosition::Center, {}, 0, 0, WindowClass::Network, WindowClass::None, {}, _nested_network_start_server_window_widgets)
Description of the NetworkStartServerWindow.
static void AdminClientBanCallback(Window *, bool confirmed)
Callback function for admin command to ban client.
static WindowDesc _network_ask_relay_desc(WindowPosition::Center, {}, 0, 0, WindowClass::NetworkAskRelay, WindowClass::None, WindowDefaultFlag::Modal, _nested_network_ask_relay_widgets)
Description of the NetworkAskRelayWindow.
static WindowDesc _network_join_status_window_desc(WindowPosition::Center, {}, 0, 0, WindowClass::NetworkStatus, WindowClass::None, WindowDefaultFlag::Modal, _nested_network_join_status_window_widgets)
Description of the NetworkJoinStatusWindow.
void DrawCompanyIcon(CompanyID cid, int x, int y)
Draw the icon of a company.
static WindowDesc _client_list_desc(WindowPosition::Automatic, "list_clients", 220, 300, WindowClass::NetworkClientList, WindowClass::None, {}, _nested_client_list_widgets)
Description of the NetworkClientListWindow.
static constexpr std::initializer_list< NWidgetPart > _nested_client_list_widgets
Widgets and the structure of the NetworkClientListWindow.
static DropDownList BuildVisibilityDropDownList()
Create the dropdown with visibility options for the server.
GUIList< NetworkGame *, std::nullptr_t, StringFilter & > GUIGameServerList
The list of servers with sorting/filtering.
static constexpr std::initializer_list< NWidgetPart > _nested_network_ask_survey_widgets
Widgets and the structure of the NetworkAskSurveyWindow.
void ShowClientList()
Open the client list window.
static constexpr std::initializer_list< NWidgetPart > _nested_network_game_widgets
Widgets and the structure of the NetworkGameWindow.
uint32_t _network_join_bytes_total
The total number of bytes to download.
void ShowNetworkAskRelay(std::string_view server_connection_string, std::string &&relay_connection_string, std::string &&token)
Show a modal confirmation window with "no" / "yes, once" / "yes, always" buttons.
uint32_t _network_join_bytes
The number of bytes we already downloaded.
Button< ClientID > ClientButton
Button linked to a client.
void ShowNetworkAskSurvey()
Show a modal confirmation window with "no" / "preview" / "yes" buttons.
void ShowNetworkNeedPassword(std::shared_ptr< NetworkAuthenticationPasswordRequest > request)
Update the NetworkJoinStatusWindow to start requesting the server password.
static CompanyID _admin_company_id
For what company a confirmation window is open.
static WindowDesc _network_ask_survey_desc(WindowPosition::Center, {}, 0, 0, WindowClass::NetworkAskSurvey, WindowClass::None, WindowDefaultFlag::Modal, _nested_network_ask_survey_widgets)
Description of the NetworkAskSurveyWindow.
static ClientID _admin_client_id
For what client a confirmation window is open.
static void ShowNetworkStartServerWindow()
Show the window to configure and start your server with.
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
Variables and function used internally.
NetworkJoinStatus
Status of the clients during joining.
@ Waiting
Waiting for other clients to finish downloading the map.
@ End
Sentinel for end-of-enumeration.
@ Authorizing
Starting authorizing the client to join the game and optionally company.
@ Downloading
Downloading the map from the server.
@ Connecting
Opening the connection to the server.
NetworkSurveyHandler _survey
The handler for sending surveys for statistics.
Part of the network protocol handling opt-in survey.
static const uint MAX_CLIENTS
How many clients can we have.
@ Client
Send message/notice to only a certain client (Private).
@ Team
Send message/notice to everyone playing the same company (Team).
ClientID
'Unique' identifier to be given to clients
@ Invalid
Client is not part of anything.
@ Server
Servers always have this ID.
ServerGameType
Game type the server can be using.
@ Public
The game is publicly accessible.
@ Local
Do not communicate with the game coordinator.
@ InviteOnly
The game can be accessed if you know the invite code.
PoolID< uint16_t, struct ClientPoolIDTag, MAX_CLIENTS+1, 0xFFFF > ClientPoolID
Indices into the client related pools.
void NetworkUDPSearchGame()
Find all servers.
Sending and receiving UDP messages.
Types related to the network widgets.
@ 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_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.
@ Menu
Switch to game intro menu.
Definition openttd.h:33
PixelColour GetColourGradient(Colours colour, Shade shade)
Get colour gradient palette index.
Definition palette.cpp:393
@ Darker
Darker colour shade.
@ Normal
Normal colour shade.
constexpr PixelColour GREY_SCALE(uint8_t level)
Return the colour for a particular greyscale level.
static constexpr PixelColour PC_GREY
Grey palette colour.
Base for the GUIs that have an edit box in them.
A number of safeguards to prevent using unsafe methods.
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(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:60
Functions and types used internally for the settings configurations.
Base types for having sorted lists in GUIs.
This file contains all sprite-related enums and defines.
static const SpriteID SPR_COMPANY_ICON
Icon showing company colour.
Definition sprites.h:386
static const SpriteID SPR_LOCK
Lock icon (for password protected servers).
Definition sprites.h:73
static const PaletteID PALETTE_TO_GREEN
Definition sprites.h:1769
static const PaletteID PALETTE_TO_RED
Definition sprites.h:1767
static const PaletteID PALETTE_TO_GREY
Definition sprites.h:1778
static const SpriteID SPR_BLOT
Coloured circle (used for server compatibility and installed content).
Definition sprites.h:72
static const SpriteID SPR_ARROW_DOWN
Definition sprites.h:85
static const SpriteID SPR_ARROW_UP
Definition sprites.h:86
static const PaletteID PALETTE_TO_YELLOW
Definition sprites.h:1766
Definition of base types and functions in a cross-platform compatible way.
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:428
Parse strings.
static std::optional< T > ParseInteger(std::string_view arg, int base=10, bool clamp=false)
Change a string into its number representation.
Functions related to low-level strings.
@ 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
Searching and filtering using a stringterm.
uint64_t GetParamMaxValue(uint64_t max_value, uint min_count, FontSize size)
Get some number that is suitable for string size computations.
Definition strings.cpp:235
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:89
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:423
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:55
uint64_t GetParamMaxDigits(uint count, FontSize size)
Get some number that is suitable for string size computations.
Definition strings.cpp:217
Functions related to OTTD's strings.
StrongType::Typedef< uint32_t, struct StringIDTag, StrongType::Compare, StrongType::Integer > 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...
T y
Y coordinate.
T x
X coordinate.
Dimensions (a width and height) of a rectangle in 2D.
value_type height
The height of the rectangle.
value_type width
The width of the rectangle.
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).
Window used for asking the user if he is okay using a relay server.
void FindWindowPlacementAndResize(int, int, bool) override
Resize window towards the default size.
std::string relay_connection_string
The relay server we want to connect to.
NetworkAskRelayWindow(WindowDesc &desc, Window *parent, std::string_view server_connection_string, std::string &&relay_connection_string, std::string &&token)
Create 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.
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, int, bool) override
Resize window towards the default size.
NetworkAskSurveyWindow(WindowDesc &desc, Window *parent)
Create the window.
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:114
bool CanJoinCompany(CompanyID company_id) const
Returns whether the given company can be joined by this client.
Definition network.cpp:128
CompanyID client_playas
As which company is this client playing (CompanyID).
ClientID client_id
Client identifier (same as ClientState->client_id).
std::string client_name
Name of the client.
Main handle for clientlist.
Scrollbar * vscroll
Vertical scrollbar of this window.
void OnResize() override
Called after the window got resized.
static void OnClickCompanyNew(NetworkClientListWindow *, Point, CompanyID)
Create new company button is clicked.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
ClientListWidgets query_widget
During a query this tracks what widget caused the query.
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.
std::vector< std::unique_ptr< ButtonLine > > buttons
Per line which buttons are available.
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 OnClickClientChat(NetworkClientListWindow *, Point, ClientID client_id)
Chat button on a Client is clicked.
ClientID dd_client_id
During admin dropdown, track which client this was for.
void RebuildListCompany(CompanyID company_id, CompanyID client_playas, bool can_join_company)
Part of RebuildList() to create the information for a single company.
static void OnClickClientAuthorize(NetworkClientListWindow *, Point, ClientID client_id)
Authorize button on a Client is clicked.
static void OnClickClientAdmin(NetworkClientListWindow *w, Point pt, ClientID client_id)
Admin button on a Client is clicked.
static void OnClickCompanyChat(NetworkClientListWindow *, Point, CompanyID company_id)
Chat button on a Company 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.
DropDownAction
The possible entries in a DropDown for an admin action.
@ CompanyAllowListed
Allow only listed clients.
static void OnClickCompanyJoin(NetworkClientListWindow *, Point, CompanyID company_id)
Join button on a Company is clicked.
void OnDropdownClose(Point pt, WidgetID widget, int index, int click_result, bool instant_close) override
A dropdown window associated to this window has been closed.
NetworkClientListWindow(WindowDesc &desc, WindowNumber window_number)
Create the window.
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.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
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).
bool refreshing
Whether this server is being queried.
std::string connection_string
Address of the server.
NetworkGameInfo info
The game information of this server.
NetworkGameStatus status
Stats of the server.
Window showing the progress during joining.
NetworkJoinStatusWindow(WindowDesc &desc)
Create the window.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
std::shared_ptr< NetworkAuthenticationPasswordRequest > request
Callback to send the password request result to.
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.
Window to configure and start your server with.
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.
NetworkStartServerWindow(WindowDesc &desc)
Create the window.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
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 OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
bool CheckServerName()
Check whether the currently entered server name is valid, and if so update the server_name setting.
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.
static Pool::IterateWrapper< NetworkClientInfo > Iterate(size_t from=0)
static Company * Get(auto 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.
Specification of a rectangle with absolute coordinates of all edges.
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
int Width() const
Get width of Rect.
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 CentreToHeight(int height) const
Centre a vertical dimension within this Rect.
Rect Translate(int x, int y) const
Copy and translate Rect by x,y pixels.
bool Contains(const Point &pt) const
Test if a point falls inside this Rect.
String filter and state.
bool IsEmpty() const
Check whether any filter words were entered.
void SetFilterTerm(std::string_view str)
Set the term to filter on.
void ResetState()
Reset the matching state to process a new item.
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.
SurveyResultTextfileWindow(Window *parent, TextfileType file_type)
Create the window.
std::string_view GetText() const
Get the current text.
Definition textbuf.cpp:283
void Assign(std::string_view text)
Copy a string into the textbuffer.
Definition textbuf.cpp:419
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:171
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:1025
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1150
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition widget.cpp:839
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1855
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:792
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing).
Definition window.cpp:3317
Window * parent
Parent window.
Definition window_gui.h:327
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:565
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:513
ResizeInfo resize
Resize information.
Definition window_gui.h:313
void DrawSortButton(WidgetID widget, bool descending) const
Draw a sort button's up or down arrow symbol.
Definition widget.cpp:824
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1845
void CloseChildWindowById(WindowClass wc, WindowNumber number) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1137
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition window.cpp:494
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
virtual void OnDropdownClose(Point pt, WidgetID widget, int index, int click_result, bool instant_close)
A dropdown window associated to this window has been closed.
Definition window.cpp:293
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
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition window.cpp:1879
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:218
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
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:604
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1869
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:322
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
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:301
@ Unknown
The Game Coordinator hasn't informed us yet what type of connection we have.
Stuff related to the text buffer GUI.
@ AcceptUnchanged
return success even when the text didn't change
Definition textbuf_gui.h:19
@ LengthIsInChars
the length of the string is counted in characters
Definition textbuf_gui.h:21
void QueryCallbackProc(Window *, bool)
Callback procedure for the ShowQuery method.
Definition textbuf_gui.h:29
GUI functions related to textfiles.
TextfileType
Additional text files accompanying Tar archives.
@ SurveyResult
Survey result (preview).
Definition of Interval and OneShot timers.
Definition of the game-calendar-timer.
Definition of the Window system.
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition widget.cpp:308
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition widget.cpp:49
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
@ WWT_IMGBTN
(Toggle) Button with image
Definition widget_type.h:41
@ 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:39
@ 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:37
@ 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).
@ EqualSize
Containers should keep all their (resizing) children equally large.
SizingType
Different forms of sizing nested widgets, using NWidgetBase::AssignSizePosition().
@ HideBevel
Bevel of resize box is hidden.
Definition widget_type.h:29
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:1242
Window * GetMainWindow()
Get the main window, i.e.
Definition window.cpp:1228
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1255
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:3377
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1199
Window functions not directly related to making/drawing windows.
@ Modal
The window is a modal child of some other window, meaning the parent is 'inactive'.
Definition window_gui.h:155
TooltipCloseCondition
Definition window_gui.h:262
@ BorderOnly
Draw border only, no background.
Definition window_gui.h:25
@ Lowered
If set the frame is lowered and the background colour brighter (ie. buttons when pressed).
Definition window_gui.h:26
Twindow * AllocateWindowDescFront(WindowDesc &desc, WindowNumber window_number, Targs... extra_arguments)
Open a new window.
@ Timeout
Window timeout counter.
Definition window_gui.h:223
@ Automatic
Find a place automatically.
Definition window_gui.h:145
@ Center
Center the window.
Definition window_gui.h:146
int WidgetID
Widget ID.
Definition window_type.h:21
EventState
State of handling an event.
@ Handled
The passed event is handled.
@ NotHandled
The passed event is not handled.
@ Join
Network join status.
Definition window_type.h:56
@ Game
Network game window.
Definition window_type.h:49
@ StartServer
Network start server.
Definition window_type.h:51
Functions related to zooming.