OpenTTD Source 20250218-master-g53dd1258a7
script_gui.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#include "../stdafx.h"
11#include "../table/sprites.h"
12#include "../error.h"
13#include "../settings_gui.h"
14#include "../querystring_gui.h"
15#include "../stringfilter_type.h"
16#include "../company_base.h"
17#include "../company_gui.h"
18#include "../dropdown_type.h"
19#include "../dropdown_func.h"
20#include "../window_func.h"
21#include "../network/network.h"
22#include "../hotkeys.h"
23#include "../company_cmd.h"
24#include "../misc_cmd.h"
25#include "../timer/timer.h"
26#include "../timer/timer_window.h"
27
28#include "script_gui.h"
29#include "script_log.hpp"
30#include "script_scanner.hpp"
31#include "script_config.hpp"
32#include "../ai/ai.hpp"
33#include "../ai/ai_config.hpp"
34#include "../ai/ai_info.hpp"
35#include "../ai/ai_instance.hpp"
36#include "../game/game.hpp"
37#include "../game/game_config.hpp"
38#include "../game/game_info.hpp"
39#include "../game/game_instance.hpp"
40#include "table/strings.h"
41
42#include "../safeguards.h"
43
44
45static ScriptConfig *GetConfig(CompanyID slot)
46{
47 if (slot == OWNER_DEITY) return GameConfig::GetConfig();
48 return AIConfig::GetConfig(slot);
49}
50
54struct ScriptListWindow : public Window {
60 bool show_all;
61
70 {
71 if (slot == OWNER_DEITY) {
72 this->info_list = this->show_all ? Game::GetInfoList() : Game::GetUniqueInfoList();
73 } else {
74 this->info_list = this->show_all ? AI::GetInfoList() : AI::GetUniqueInfoList();
75 }
76
77 this->CreateNestedTree();
78 this->vscroll = this->GetScrollbar(WID_SCRL_SCROLLBAR);
79 this->FinishInitNested(); // Initializes 'this->line_height' as side effect.
80
81 this->vscroll->SetCount(this->info_list->size() + 1);
82
83 /* Try if we can find the currently selected AI */
84 this->selected = -1;
85 if (GetConfig(slot)->HasScript()) {
86 ScriptInfo *info = GetConfig(slot)->GetInfo();
87 int i = 0;
88 for (const auto &item : *this->info_list) {
89 if (item.second == info) {
90 this->selected = i;
91 break;
92 }
93
94 i++;
95 }
96 }
97 }
98
99 void SetStringParameters(WidgetID widget) const override
100 {
101 if (widget != WID_SCRL_CAPTION) return;
102
104 }
105
107 {
108 if (widget != WID_SCRL_LIST) return;
109
110 this->line_height = GetCharacterHeight(FS_NORMAL) + padding.height;
111
112 resize.width = 1;
113 resize.height = this->line_height;
114 size.height = 5 * this->line_height;
115 }
116
117 void DrawWidget(const Rect &r, WidgetID widget) const override
118 {
119 switch (widget) {
120 case WID_SCRL_LIST: {
121 /* Draw a list of all available Scripts. */
123 /* First AI in the list is hardcoded to random */
124 if (this->vscroll->IsVisible(0)) {
125 DrawString(tr, this->slot == OWNER_DEITY ? STR_AI_CONFIG_NONE : STR_AI_CONFIG_RANDOM_AI, this->selected == -1 ? TC_WHITE : TC_ORANGE);
126 tr.top += this->line_height;
127 }
129 int i = 0;
130 for (const auto &item : *this->info_list) {
131 i++;
132 if (this->vscroll->IsVisible(i)) {
133 SetDParamStr(0, item.second->GetName());
134 SetDParam(1, item.second->GetVersion());
135 DrawString(tr, str, (this->selected == i - 1) ? TC_WHITE : TC_ORANGE);
136 tr.top += this->line_height;
137 }
138 }
139 break;
140 }
141 case WID_SCRL_INFO_BG: {
142 ScriptInfo *selected_info = nullptr;
143 int i = 0;
144 for (const auto &item : *this->info_list) {
145 i++;
146 if (this->selected == i - 1) selected_info = static_cast<ScriptInfo *>(item.second);
147 }
148 /* Some info about the currently selected Script. */
149 if (selected_info != nullptr) {
151 SetDParamStr(0, selected_info->GetAuthor());
154 SetDParam(0, selected_info->GetVersion());
157 if (!selected_info->GetURL().empty()) {
158 SetDParamStr(0, selected_info->GetURL());
161 }
162 SetDParamStr(0, selected_info->GetDescription());
164 }
165 break;
166 }
167 }
168 }
169
174 {
175 if (this->selected == -1) {
176 GetConfig(slot)->Change(std::nullopt);
177 } else {
178 ScriptInfoList::const_iterator it = this->info_list->cbegin();
179 std::advance(it, this->selected);
180 GetConfig(slot)->Change(it->second->GetName(), it->second->GetVersion());
181 }
186 }
187
188 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
189 {
190 switch (widget) {
191 case WID_SCRL_LIST: { // Select one of the Scripts
192 int sel = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SCRL_LIST) - 1;
193 if (sel < (int)this->info_list->size()) {
194 this->selected = sel;
195 this->SetDirty();
196 if (click_count > 1) {
197 this->ChangeScript();
198 this->Close();
199 }
200 }
201 break;
202 }
203
204 case WID_SCRL_ACCEPT: {
205 this->ChangeScript();
206 this->Close();
207 break;
208 }
209
210 case WID_SCRL_CANCEL:
211 this->Close();
212 break;
213 }
214 }
215
216 void OnResize() override
217 {
218 this->vscroll->SetCapacityFromWidget(this, WID_SCRL_LIST);
219 }
220
226 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
227 {
228 if (_game_mode == GM_NORMAL && Company::IsValidID(this->slot)) {
229 this->Close();
230 return;
231 }
232
233 if (!gui_scope) return;
234
235 this->vscroll->SetCount(this->info_list->size() + 1);
236
237 /* selected goes from -1 .. length of ai list - 1. */
238 this->selected = std::min(this->selected, this->vscroll->GetCount() - 2);
239 }
240};
241
245 NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
246 NWidget(WWT_CAPTION, COLOUR_MAUVE, WID_SCRL_CAPTION), SetStringTip(STR_AI_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
247 NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
248 EndContainer(),
250 NWidget(WWT_MATRIX, COLOUR_MAUVE, WID_SCRL_LIST), SetMinimalSize(188, 112), SetFill(1, 1), SetResize(1, 1), SetMatrixDataTip(1, 0, STR_AI_LIST_TOOLTIP), SetScrollbar(WID_SCRL_SCROLLBAR),
252 EndContainer(),
254 EndContainer(),
257 NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_SCRL_ACCEPT), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_AI_LIST_ACCEPT, STR_AI_LIST_ACCEPT_TOOLTIP),
258 NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_SCRL_CANCEL), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_AI_LIST_CANCEL, STR_AI_LIST_CANCEL_TOOLTIP),
259 EndContainer(),
260 NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
261 EndContainer(),
262};
263
266 WDP_CENTER, "settings_script_list", 200, 234,
268 {},
270);
271
277void ShowScriptListWindow(CompanyID slot, bool show_all)
278{
280 new ScriptListWindow(_script_list_desc, slot, show_all);
281}
282
283
297 typedef std::vector<const ScriptConfigItem *> VisibleSettingsList;
299
306 slot(slot),
307 clicked_button(-1),
310 {
311 this->CreateNestedTree();
312 this->vscroll = this->GetScrollbar(WID_SCRS_SCROLLBAR);
313 this->FinishInitNested(slot); // Initializes 'this->line_height' as side effect.
314
315 this->OnInvalidateData();
316 }
317
324 {
325 visible_settings.clear();
326
327 for (const auto &item : *this->script_config->GetConfigList()) {
328 bool no_hide = (item.flags & SCRIPTCONFIG_DEVELOPER) == 0;
330 visible_settings.push_back(&item);
331 }
332 }
333
334 this->vscroll->SetCount(this->visible_settings.size());
335 }
336
337 void SetStringParameters(WidgetID widget) const override
338 {
339 if (widget != WID_SCRS_CAPTION) return;
340
342 }
343
345 {
346 if (widget != WID_SCRS_BACKGROUND) return;
347
348 this->line_height = std::max(SETTING_BUTTON_HEIGHT, GetCharacterHeight(FS_NORMAL)) + padding.height;
349
350 resize.width = 1;
351 resize.height = this->line_height;
352 size.height = 5 * this->line_height;
353 }
354
355 void DrawWidget(const Rect &r, WidgetID widget) const override
356 {
357 if (widget != WID_SCRS_BACKGROUND) return;
358
359 Rect ir = r.Shrink(WidgetDimensions::scaled.framerect);
360 bool rtl = _current_text_dir == TD_RTL;
363
364 int y = r.top;
365 int button_y_offset = (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
366 int text_y_offset = (this->line_height - GetCharacterHeight(FS_NORMAL)) / 2;
367
368 const auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->visible_settings);
369 for (auto it = first; it != last; ++it) {
370 const ScriptConfigItem &config_item = **it;
371 int current_value = this->script_config->GetSetting(config_item.name);
372 bool editable = this->IsEditableItem(config_item);
373
374 StringID str;
375 TextColour colour;
376 uint idx = 0;
377 if (config_item.description.empty()) {
378 str = STR_JUST_STRING1;
379 colour = TC_ORANGE;
380 } else {
382 colour = TC_LIGHT_BLUE;
383 SetDParamStr(idx++, config_item.description);
384 }
385
386 if ((config_item.flags & SCRIPTCONFIG_BOOLEAN) != 0) {
387 DrawBoolButton(br.left, y + button_y_offset, current_value != 0, editable);
389 } else {
390 int i = static_cast<int>(std::distance(std::begin(this->visible_settings), it));
391 if (config_item.complete_labels) {
392 DrawDropDownButton(br.left, y + button_y_offset, COLOUR_YELLOW, this->clicked_row == i && clicked_dropdown, editable);
393 } else {
394 DrawArrowButtons(br.left, y + button_y_offset, COLOUR_YELLOW, (this->clicked_button == i) ? 1 + (this->clicked_increase != rtl) : 0, editable && current_value > config_item.min_value, editable && current_value < config_item.max_value);
395 }
396
397 auto config_iterator = config_item.labels.find(current_value);
398 if (config_iterator != config_item.labels.end()) {
400 SetDParamStr(idx++, config_iterator->second);
401 } else {
404 }
405 }
406
407 DrawString(tr.left, tr.right, y + text_y_offset, str, colour);
408 y += this->line_height;
409 }
410 }
411
412 void OnPaint() override
413 {
414 if (this->closing_dropdown) {
415 this->closing_dropdown = false;
416 this->clicked_dropdown = false;
417 }
418 this->DrawWidgets();
419 }
420
421 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
422 {
423 switch (widget) {
424 case WID_SCRS_BACKGROUND: {
425 auto it = this->vscroll->GetScrolledItemFromWidget(this->visible_settings, pt.y, this, widget);
426 if (it == this->visible_settings.end()) break;
427
428 const ScriptConfigItem &config_item = **it;
429 if (!this->IsEditableItem(config_item)) return;
430
431 int num = it - this->visible_settings.begin();
432 if (this->clicked_row != num) {
435 this->clicked_row = num;
436 this->clicked_dropdown = false;
437 }
438
439 bool bool_item = (config_item.flags & SCRIPTCONFIG_BOOLEAN) != 0;
440
441 Rect r = this->GetWidget<NWidgetBase>(widget)->GetCurrentRect().Shrink(WidgetDimensions::scaled.matrix, RectPadding::zero);
442 int x = pt.x - r.left;
443 if (_current_text_dir == TD_RTL) x = r.Width() - 1 - x;
444
445 /* One of the arrows is clicked (or green/red rect in case of bool value) */
446 int old_val = this->script_config->GetSetting(config_item.name);
447 if (!bool_item && IsInsideMM(x, 0, SETTING_BUTTON_WIDTH) && config_item.complete_labels) {
448 if (this->clicked_dropdown) {
449 /* unclick the dropdown */
451 this->clicked_dropdown = false;
452 this->closing_dropdown = false;
453 } else {
454 int rel_y = (pt.y - r.top) % this->line_height;
455
456 Rect wi_rect;
457 wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);
458 wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
459 wi_rect.top = pt.y - rel_y + (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
460 wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;
461
462 /* If the mouse is still held but dragged outside of the dropdown list, keep the dropdown open */
463 if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
464 this->clicked_dropdown = true;
465 this->closing_dropdown = false;
466
467 DropDownList list;
468 for (int i = config_item.min_value; i <= config_item.max_value; i++) {
469 list.push_back(MakeDropDownListStringItem(config_item.labels.find(i)->second, i));
470 }
471
472 ShowDropDownListAt(this, std::move(list), old_val, WID_SCRS_SETTING_DROPDOWN, wi_rect, COLOUR_ORANGE);
473 }
474 }
475 } else if (IsInsideMM(x, 0, SETTING_BUTTON_WIDTH)) {
476 int new_val = old_val;
477 if (bool_item) {
478 new_val = !new_val;
479 } else if (x >= SETTING_BUTTON_WIDTH / 2) {
480 /* Increase button clicked */
481 new_val += config_item.step_size;
482 if (new_val > config_item.max_value) new_val = config_item.max_value;
483 this->clicked_increase = true;
484 } else {
485 /* Decrease button clicked */
486 new_val -= config_item.step_size;
487 if (new_val < config_item.min_value) new_val = config_item.min_value;
488 this->clicked_increase = false;
489 }
490
491 if (new_val != old_val) {
492 this->script_config->SetSetting(config_item.name, new_val);
493 this->clicked_button = num;
494 this->unclick_timeout.Reset();
495 }
496 } else if (!bool_item && !config_item.complete_labels) {
497 /* Display a query box so users can enter a custom value. */
499 }
500 this->SetDirty();
501 break;
502 }
503
504 case WID_SCRS_ACCEPT:
505 this->Close();
506 break;
507
508 case WID_SCRS_RESET:
509 this->script_config->ResetEditableSettings(_game_mode == GM_MENU || ((this->slot != OWNER_DEITY) && !Company::IsValidID(this->slot)));
510 this->SetDirty();
511 break;
512 }
513 }
514
515 void OnQueryTextFinished(std::optional<std::string> str) override
516 {
517 if (!str.has_value() || str->empty()) return;
518 int32_t value = atoi(str->c_str());
519
520 SetValue(value);
521 }
522
523 void OnDropdownSelect(WidgetID widget, int index) override
524 {
525 if (widget != WID_SCRS_SETTING_DROPDOWN) return;
526 assert(this->clicked_dropdown);
527 SetValue(index);
528 }
529
530 void OnDropdownClose(Point, WidgetID widget, int, bool) override
531 {
532 if (widget != WID_SCRS_SETTING_DROPDOWN) return;
533 /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
534 * the same dropdown button was clicked again, and then not open the dropdown again.
535 * So, we only remember that it was closed, and process it on the next OnPaint, which is
536 * after OnClick. */
537 assert(this->clicked_dropdown);
538 this->closing_dropdown = true;
539 this->SetDirty();
540 }
541
542 void OnResize() override
543 {
544 this->vscroll->SetCapacityFromWidget(this, WID_SCRS_BACKGROUND);
545 }
546
548 TimeoutTimer<TimerWindow> unclick_timeout = {std::chrono::milliseconds(150), [this]() {
549 this->clicked_button = -1;
550 this->SetDirty();
551 }};
552
558 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
559 {
560 this->script_config = GetConfig(this->slot);
561 if (this->script_config->GetConfigList()->empty()) this->Close();
565 }
566
567private:
568 bool IsEditableItem(const ScriptConfigItem &config_item) const
569 {
570 return _game_mode == GM_MENU
571 || _game_mode == GM_EDITOR
572 || ((this->slot != OWNER_DEITY) && !Company::IsValidID(this->slot))
573 || (config_item.flags & SCRIPTCONFIG_INGAME) != 0
575 }
576
577 void SetValue(int value)
578 {
579 const ScriptConfigItem &config_item = *this->visible_settings[this->clicked_row];
580 if (_game_mode == GM_NORMAL && ((this->slot == OWNER_DEITY) || Company::IsValidID(this->slot)) && (config_item.flags & SCRIPTCONFIG_INGAME) == 0) return;
581 this->script_config->SetSetting(config_item.name, value);
582 this->SetDirty();
583 }
584};
585
589 NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
590 NWidget(WWT_CAPTION, COLOUR_MAUVE, WID_SCRS_CAPTION), SetStringTip(STR_AI_SETTINGS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
591 NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
592 EndContainer(),
596 EndContainer(),
599 NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_SCRS_ACCEPT), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_AI_SETTINGS_CLOSE),
600 NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_SCRS_RESET), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_AI_SETTINGS_RESET),
601 EndContainer(),
602 NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
603 EndContainer(),
604};
605
608 WDP_CENTER, "settings_script", 500, 208,
610 {},
612);
613
624
625
629
631 {
632 this->ConstructWindow();
633 this->OnInvalidateData();
634 }
635
636 void SetStringParameters(WidgetID widget) const override
637 {
638 if (widget == WID_TF_CAPTION) {
640 SetDParamStr(1, GetConfig(slot)->GetInfo()->GetName());
641 }
642 }
643
644 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
645 {
646 auto textfile = GetConfig(slot)->GetTextfile(file_type, slot);
647 if (!textfile.has_value()) {
648 this->Close();
649 } else {
650 this->LoadTextfile(textfile.value(), (slot == OWNER_DEITY) ? GAME_DIR : AI_DIR);
651 }
652 }
653};
654
661{
662 CloseWindowById(WC_TEXTFILE, file_type);
663 new ScriptTextfileWindow(file_type, slot);
664}
665
666
675static bool SetScriptButtonColour(NWidgetCore &button, bool dead, bool paused)
676{
677 /* Dead scripts are indicated with red background and
678 * paused scripts are indicated with yellow background. */
679 Colours colour = dead ? COLOUR_RED :
680 (paused ? COLOUR_YELLOW : COLOUR_GREY);
681 if (button.colour != colour) {
682 button.colour = colour;
683 return true;
684 }
685 return false;
686}
687
691struct ScriptDebugWindow : public Window {
692 static const uint MAX_BREAK_STR_STRING_LENGTH = 256;
693
700
701 static inline FilterState initial_state = {
702 "",
703 CompanyID::Invalid(),
704 true,
705 false,
706 };
707
717 FilterState filter;
718
719 ScriptLogTypes::LogData &GetLogData() const
720 {
721 if (this->filter.script_debug_company == OWNER_DEITY) return Game::GetInstance()->GetLogData();
722 return Company::Get(this->filter.script_debug_company)->ai_instance->GetLogData();
723 }
724
729 bool IsDead() const
730 {
731 if (this->filter.script_debug_company == OWNER_DEITY) {
733 return game == nullptr || game->IsDead();
734 }
735 return !Company::IsValidAiID(this->filter.script_debug_company) || Company::Get(this->filter.script_debug_company)->ai_instance->IsDead();
736 }
737
743 bool IsValidDebugCompany(CompanyID company) const
744 {
745 switch (company.base()) {
746 case CompanyID::Invalid().base(): return false;
747 case OWNER_DEITY.base(): return Game::GetInstance() != nullptr;
748 default: return Company::IsValidAiID(company);
749 }
750 }
751
757 {
758 /* Check if the currently selected company is still active. */
759 if (this->IsValidDebugCompany(this->filter.script_debug_company)) return;
760
761 this->filter.script_debug_company = CompanyID::Invalid();
762
763 for (const Company *c : Company::Iterate()) {
764 if (c->is_ai) {
765 ChangeToScript(c->index);
766 return;
767 }
768 }
769
770 /* If no AI is available, see if there is a game script. */
772 }
773
780 {
781 this->filter = ScriptDebugWindow::initial_state;
782 this->break_string_filter = {&this->filter.case_sensitive_break_check, false};
783
784 this->CreateNestedTree();
785 this->vscroll = this->GetScrollbar(WID_SCRD_VSCROLLBAR);
786 this->hscroll = this->GetScrollbar(WID_SCRD_HSCROLLBAR);
787 this->FinishInitNested(number);
788
789 this->last_vscroll_pos = 0;
790 this->autoscroll = true;
791 this->highlight_row = -1;
792
794
795 this->hscroll->SetStepSize(10); // Speed up horizontal scrollbar
796
797 /* Restore the break string value from static variable, and enable the filter. */
798 this->break_editbox.text.Assign(this->filter.break_string);
799 this->break_string_filter.SetFilterTerm(this->filter.break_string);
800
801 if (show_company == CompanyID::Invalid()) {
803 } else {
804 this->ChangeToScript(show_company);
805 }
806 }
807
808 void OnInit() override
809 {
810 this->show_break_box = _settings_client.gui.ai_developer_tools;
811 this->GetWidget<NWidgetStacked>(WID_SCRD_BREAK_STRING_WIDGETS)->SetDisplayedPlane(this->show_break_box ? 0 : SZSP_HORIZONTAL);
812 if (!this->show_break_box) this->filter.break_check_enabled = false;
814
815 this->InvalidateData(-1);
816 }
817
819 {
820 ScriptDebugWindow::initial_state = this->filter;
821 }
822
824 {
825 if (widget == WID_SCRD_LOG_PANEL) {
827 size.height = 14 * resize.height + WidgetDimensions::scaled.framerect.Vertical();
828 }
829 }
830
831 void OnPaint() override
832 {
834 this->UpdateLogScroll();
835
836 /* Draw standard stuff */
837 this->DrawWidgets();
838 }
839
840 void SetStringParameters(WidgetID widget) const override
841 {
842 if (widget != WID_SCRD_NAME_TEXT) return;
843
844 if (this->filter.script_debug_company == OWNER_DEITY) {
845 const GameInfo *info = Game::GetInfo();
846 assert(info != nullptr);
848 SetDParamStr(1, info->GetName());
849 SetDParam(2, info->GetVersion());
850 } else if (this->filter.script_debug_company == CompanyID::Invalid() || !Company::IsValidAiID(this->filter.script_debug_company)) {
852 } else {
853 const AIInfo *info = Company::Get(this->filter.script_debug_company)->ai_info;
854 assert(info != nullptr);
856 SetDParamStr(1, info->GetName());
857 SetDParam(2, info->GetVersion());
858 }
859 }
860
861 void DrawWidget(const Rect &r, WidgetID widget) const override
862 {
863 switch (widget) {
865 this->DrawWidgetLog(r);
866 break;
867
868 default:
869 if (IsInsideBS(widget, WID_SCRD_COMPANY_BUTTON_START, MAX_COMPANIES)) {
871 }
872 break;
873 }
874 }
875
882 void DrawWidgetCompanyButton(const Rect &r, WidgetID widget, int start) const
883 {
884 if (this->IsWidgetDisabled(widget)) return;
885 CompanyID cid = (CompanyID)(widget - start);
886 Dimension sprite_size = GetSpriteSize(SPR_COMPANY_ICON);
887 DrawCompanyIcon(cid, CenterBounds(r.left, r.right, sprite_size.width), CenterBounds(r.top, r.bottom, sprite_size.height));
888 }
889
894 void DrawWidgetLog(const Rect &r) const
895 {
896 if (this->filter.script_debug_company == CompanyID::Invalid()) return;
897
898 const ScriptLogTypes::LogData &log = this->GetLogData();
899 if (log.empty()) return;
900
901 Rect fr = r.Shrink(WidgetDimensions::scaled.framerect);
902
903 /* Setup a clipping rectangle... */
905 if (!FillDrawPixelInfo(&tmp_dpi, fr)) return;
906 /* ...but keep coordinates relative to the window. */
907 tmp_dpi.left += fr.left;
908 tmp_dpi.top += fr.top;
909
911
912 fr = ScrollRect(fr, *this->hscroll, 1);
913
914 auto [first, last] = this->vscroll->GetVisibleRangeIterators(log);
915 for (auto it = first; it != last; ++it) {
916 const ScriptLogTypes::LogLine &line = *it;
917
918 TextColour colour;
919 switch (line.type) {
920 case ScriptLogTypes::LOG_SQ_INFO: colour = TC_BLACK; break;
921 case ScriptLogTypes::LOG_SQ_ERROR: colour = TC_WHITE; break;
922 case ScriptLogTypes::LOG_INFO: colour = TC_BLACK; break;
923 case ScriptLogTypes::LOG_WARNING: colour = TC_YELLOW; break;
924 case ScriptLogTypes::LOG_ERROR: colour = TC_RED; break;
925 default: colour = TC_BLACK; break;
926 }
927
928 /* Check if the current line should be highlighted */
929 if (std::distance(std::begin(log), it) == this->highlight_row) {
930 fr.bottom = fr.top + this->resize.step_height - 1;
932 if (colour == TC_BLACK) colour = TC_WHITE; // Make black text readable by inverting it to white.
933 }
934
935 DrawString(fr, line.text, colour, SA_LEFT | SA_FORCE);
936 fr.top += this->resize.step_height;
937 }
938 }
939
944 {
945 this->SetWidgetsDisabledState(this->filter.script_debug_company == CompanyID::Invalid(), WID_SCRD_VSCROLLBAR, WID_SCRD_HSCROLLBAR);
946 if (this->filter.script_debug_company == CompanyID::Invalid()) return;
947
948 ScriptLogTypes::LogData &log = this->GetLogData();
949
950 int scroll_count = (int)log.size();
951 if (this->vscroll->GetCount() != scroll_count) {
952 this->vscroll->SetCount(scroll_count);
953
954 /* We need a repaint */
956 }
957
958 if (log.empty()) return;
959
960 /* Detect when the user scrolls the window. Enable autoscroll when the bottom-most line becomes visible. */
961 if (this->last_vscroll_pos != this->vscroll->GetPosition()) {
962 this->autoscroll = this->vscroll->GetPosition() + this->vscroll->GetCapacity() >= (int)log.size();
963 }
964
965 if (this->autoscroll && this->vscroll->SetPosition((int)log.size())) {
966 /* We need a repaint */
969 }
970
971 this->last_vscroll_pos = this->vscroll->GetPosition();
972 }
973
978 {
979 /* Update company buttons */
980 for (CompanyID i = CompanyID::Begin(); i < MAX_COMPANIES; ++i) {
981 /* Mark dead/paused AIs by setting the background colour. */
982 bool valid = Company::IsValidAiID(i);
983 bool dead = valid && Company::Get(i)->ai_instance->IsDead();
984 bool paused = valid && Company::Get(i)->ai_instance->IsPaused();
985
987 button->SetDisabled(!valid);
988 button->SetLowered(this->filter.script_debug_company == i);
990 }
991 }
992
997 {
999 bool valid = game != nullptr;
1000 bool dead = valid && game->IsDead();
1001 bool paused = valid && game->IsPaused();
1002
1004 button->SetDisabled(!valid);
1005 button->SetLowered(this->filter.script_debug_company == OWNER_DEITY);
1007 }
1008
1015 {
1016 if (!this->IsValidDebugCompany(show_script)) return;
1017
1018 if (new_window) {
1019 ScriptDebugWindow::initial_state = this->filter;
1021 return;
1022 }
1023
1024 this->filter.script_debug_company = show_script;
1025
1026 this->highlight_row = -1; // The highlight of one Script make little sense for another Script.
1027
1028 /* Close AI settings window to prevent confusion */
1030
1031 this->InvalidateData(-1);
1032
1033 this->autoscroll = true;
1034 this->last_vscroll_pos = this->vscroll->GetPosition();
1035 }
1036
1037 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1038 {
1039 /* Also called for hotkeys, so check for disabledness */
1040 if (this->IsWidgetDisabled(widget)) return;
1041
1042 /* Check which button is clicked */
1045 }
1046
1047 switch (widget) {
1050 break;
1051
1053 if (this->filter.script_debug_company == OWNER_DEITY) break;
1054 /* First kill the company of the AI, then start a new one. This should start the current AI again */
1057 break;
1058
1059 case WID_SCRD_SETTINGS:
1061 break;
1062
1064 this->filter.break_check_enabled = !this->filter.break_check_enabled;
1065 this->InvalidateData(-1);
1066 break;
1067
1069 this->filter.case_sensitive_break_check = !this->filter.case_sensitive_break_check;
1070 this->InvalidateData(-1);
1071 break;
1072
1074 /* Unpause current AI / game script and mark the corresponding script button dirty. */
1075 if (!this->IsDead()) {
1076 if (this->filter.script_debug_company == OWNER_DEITY) {
1077 Game::Unpause();
1078 } else {
1079 AI::Unpause(this->filter.script_debug_company);
1080 }
1081 }
1082
1083 /* If the last AI/Game Script is unpaused, unpause the game too. */
1085 bool all_unpaused = !Game::IsPaused();
1086 if (all_unpaused) {
1087 for (const Company *c : Company::Iterate()) {
1088 if (c->is_ai && AI::IsPaused(c->index)) {
1089 all_unpaused = false;
1090 break;
1091 }
1092 }
1093 if (all_unpaused) {
1094 /* All scripts have been unpaused => unpause the game. */
1096 }
1097 }
1098 }
1099
1100 this->highlight_row = -1;
1101 this->InvalidateData(-1);
1102 break;
1103 }
1104 }
1105
1107 {
1108 if (wid != WID_SCRD_BREAK_STR_EDIT_BOX) return;
1109
1110 /* Save the current string to static member so it can be restored next time the window is opened. */
1111 this->filter.break_string = this->break_editbox.text.GetText();
1112 this->break_string_filter.SetFilterTerm(this->filter.break_string);
1113 }
1114
1121 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1122 {
1123 if (this->show_break_box != _settings_client.gui.ai_developer_tools) this->ReInit();
1124
1125 /* If the log message is related to the active company tab, check the break string.
1126 * This needs to be done in gameloop-scope, so the AI is suspended immediately. */
1127 if (!gui_scope && data == this->filter.script_debug_company &&
1128 this->IsValidDebugCompany(this->filter.script_debug_company) &&
1129 this->filter.break_check_enabled && !this->break_string_filter.IsEmpty()) {
1130 /* Get the log instance of the active company */
1131 ScriptLogTypes::LogData &log = this->GetLogData();
1132
1133 if (!log.empty()) {
1134 this->break_string_filter.ResetState();
1135 this->break_string_filter.AddLine(log.back().text);
1136 if (this->break_string_filter.GetState()) {
1137 /* Pause execution of script. */
1138 if (!this->IsDead()) {
1139 if (this->filter.script_debug_company == OWNER_DEITY) {
1140 Game::Pause();
1141 } else {
1142 AI::Pause(this->filter.script_debug_company);
1143 }
1144 }
1145
1146 /* Pause the game. */
1149 }
1150
1151 /* Highlight row that matched */
1152 this->highlight_row = (int)(log.size() - 1);
1153 }
1154 }
1155 }
1156
1157 if (!gui_scope) return;
1158
1160
1161 uint max_width = 0;
1162 if (this->filter.script_debug_company != CompanyID::Invalid()) {
1163 for (auto &line : this->GetLogData()) {
1164 if (line.width == 0 || data == -1) line.width = GetStringBoundingBox(line.text).width;
1165 max_width = std::max(max_width, line.width);
1166 }
1167 }
1168
1169 this->vscroll->SetCount(this->filter.script_debug_company != CompanyID::Invalid() ? this->GetLogData().size() : 0);
1170 this->hscroll->SetCount(max_width + WidgetDimensions::scaled.frametext.Horizontal());
1171
1172 this->UpdateAIButtonsState();
1173 this->UpdateGSButtonState();
1174
1177
1178 this->SetWidgetDisabledState(WID_SCRD_SETTINGS, this->filter.script_debug_company == CompanyID::Invalid() ||
1179 GetConfig(this->filter.script_debug_company)->GetConfigList()->empty());
1182 this->filter.script_debug_company == CompanyID::Invalid() ||
1183 this->filter.script_debug_company == OWNER_DEITY ||
1184 this->filter.script_debug_company == _local_company);
1185 this->SetWidgetDisabledState(WID_SCRD_CONTINUE_BTN, this->filter.script_debug_company == CompanyID::Invalid() ||
1186 (this->filter.script_debug_company == OWNER_DEITY ? !Game::IsPaused() : !AI::IsPaused(this->filter.script_debug_company)));
1187 }
1188
1189 void OnResize() override
1190 {
1191 this->vscroll->SetCapacityFromWidget(this, WID_SCRD_LOG_PANEL, WidgetDimensions::scaled.framerect.Vertical());
1192 this->hscroll->SetCapacityFromWidget(this, WID_SCRD_LOG_PANEL, WidgetDimensions::scaled.framerect.Horizontal());
1193 }
1194
1201 {
1202 if (_game_mode != GM_NORMAL) return ES_NOT_HANDLED;
1203 Window *w = ShowScriptDebugWindow(CompanyID::Invalid());
1204 if (w == nullptr) return ES_NOT_HANDLED;
1205 return w->OnHotkey(hotkey);
1206 }
1207
1208 static inline HotkeyList hotkeys{"aidebug", {
1209 Hotkey('1', "company_1", WID_SCRD_COMPANY_BUTTON_START),
1210 Hotkey('2', "company_2", WID_SCRD_COMPANY_BUTTON_START + 1),
1211 Hotkey('3', "company_3", WID_SCRD_COMPANY_BUTTON_START + 2),
1212 Hotkey('4', "company_4", WID_SCRD_COMPANY_BUTTON_START + 3),
1213 Hotkey('5', "company_5", WID_SCRD_COMPANY_BUTTON_START + 4),
1214 Hotkey('6', "company_6", WID_SCRD_COMPANY_BUTTON_START + 5),
1215 Hotkey('7', "company_7", WID_SCRD_COMPANY_BUTTON_START + 6),
1216 Hotkey('8', "company_8", WID_SCRD_COMPANY_BUTTON_START + 7),
1217 Hotkey('9', "company_9", WID_SCRD_COMPANY_BUTTON_START + 8),
1218 Hotkey(0, "company_10", WID_SCRD_COMPANY_BUTTON_START + 9),
1219 Hotkey(0, "company_11", WID_SCRD_COMPANY_BUTTON_START + 10),
1220 Hotkey(0, "company_12", WID_SCRD_COMPANY_BUTTON_START + 11),
1221 Hotkey(0, "company_13", WID_SCRD_COMPANY_BUTTON_START + 12),
1222 Hotkey(0, "company_14", WID_SCRD_COMPANY_BUTTON_START + 13),
1223 Hotkey(0, "company_15", WID_SCRD_COMPANY_BUTTON_START + 14),
1224 Hotkey('S', "settings", WID_SCRD_SETTINGS),
1225 Hotkey('0', "game_script", WID_SCRD_SCRIPT_GAME),
1226 Hotkey(0, "reload", WID_SCRD_RELOAD_TOGGLE),
1227 Hotkey('B', "break_toggle", WID_SCRD_BREAK_STR_ON_OFF_BTN),
1228 Hotkey('F', "break_string", WID_SCRD_BREAK_STR_EDIT_BOX),
1229 Hotkey('C', "match_case", WID_SCRD_MATCH_CASE_BTN),
1230 Hotkey(WKC_RETURN, "continue", WID_SCRD_CONTINUE_BTN),
1232};
1233
1235std::unique_ptr<NWidgetBase> MakeCompanyButtonRowsScriptDebug()
1236{
1237 return MakeCompanyButtonRows(WID_SCRD_COMPANY_BUTTON_START, WID_SCRD_COMPANY_BUTTON_END, COLOUR_GREY, 5, STR_AI_DEBUG_SELECT_AI_TOOLTIP, false);
1238}
1239
1243 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1244 NWidget(WWT_CAPTION, COLOUR_GREY), SetStringTip(STR_AI_DEBUG, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1245 NWidget(WWT_SHADEBOX, COLOUR_GREY),
1246 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1247 NWidget(WWT_STICKYBOX, COLOUR_GREY),
1248 EndContainer(),
1250 NWidget(WWT_PANEL, COLOUR_GREY, WID_SCRD_VIEW),
1252 EndContainer(),
1253 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SCRD_SCRIPT_GAME), SetMinimalSize(100, 20), SetStringTip(STR_AI_GAME_SCRIPT, STR_AI_GAME_SCRIPT_TOOLTIP),
1254 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SCRD_NAME_TEXT), SetResize(1, 0), SetStringTip(STR_JUST_STRING2, STR_AI_DEBUG_NAME_TOOLTIP),
1256 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SCRD_SETTINGS), SetMinimalSize(100, 20), SetFill(0, 1), SetStringTip(STR_AI_DEBUG_SETTINGS, STR_AI_DEBUG_SETTINGS_TOOLTIP),
1257 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SCRD_RELOAD_TOGGLE), SetMinimalSize(100, 20), SetFill(0, 1), SetStringTip(STR_AI_DEBUG_RELOAD, STR_AI_DEBUG_RELOAD_TOOLTIP),
1258 EndContainer(),
1259 EndContainer(),
1262 /* Log panel */
1264 EndContainer(),
1265 /* Break string widgets */
1268 NWidget(WWT_IMGBTN_2, COLOUR_GREY, WID_SCRD_BREAK_STR_ON_OFF_BTN), SetAspect(WidgetDimensions::ASPECT_VEHICLE_FLAG), SetFill(0, 1), SetSpriteTip(SPR_FLAG_VEH_STOPPED, STR_AI_DEBUG_BREAK_STR_ON_OFF_TOOLTIP),
1269 NWidget(WWT_PANEL, COLOUR_GREY),
1271 NWidget(WWT_LABEL, INVALID_COLOUR), SetPadding(2, 2, 2, 4), SetStringTip(STR_AI_DEBUG_BREAK_ON_LABEL),
1272 NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SCRD_BREAK_STR_EDIT_BOX), SetFill(1, 1), SetResize(1, 0), SetPadding(2, 2, 2, 2), SetStringTip(STR_AI_DEBUG_BREAK_STR_OSKTITLE, STR_AI_DEBUG_BREAK_STR_TOOLTIP),
1273 EndContainer(),
1274 EndContainer(),
1275 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_SCRD_MATCH_CASE_BTN), SetMinimalSize(100, 0), SetFill(0, 1), SetStringTip(STR_AI_DEBUG_MATCH_CASE, STR_AI_DEBUG_MATCH_CASE_TOOLTIP),
1276 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SCRD_CONTINUE_BTN), SetMinimalSize(100, 0), SetFill(0, 1), SetStringTip(STR_AI_DEBUG_CONTINUE, STR_AI_DEBUG_CONTINUE_TOOLTIP),
1277 EndContainer(),
1278 EndContainer(),
1280 EndContainer(),
1283 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1284 EndContainer(),
1285EndContainer(),
1286};
1287
1290 WDP_AUTO, "script_debug", 600, 450,
1292 {},
1294 &ScriptDebugWindow::hotkeys
1295);
1296
1302Window *ShowScriptDebugWindow(CompanyID show_company, bool new_window)
1303{
1304 if (!_networking || _network_server) {
1305 int i = 0;
1306 if (new_window) {
1307 /* find next free window number for script debug */
1308 while (FindWindowById(WC_SCRIPT_DEBUG, i) != nullptr) i++;
1309 } else {
1310 /* Find existing window showing show_company. */
1311 for (Window *w : Window::Iterate()) {
1312 if (w->window_class == WC_SCRIPT_DEBUG && static_cast<ScriptDebugWindow *>(w)->filter.script_debug_company == show_company) {
1313 return BringWindowToFrontById(w->window_class, w->window_number);
1314 }
1315 }
1316
1317 /* Maybe there's a window showing a different company which can be switched. */
1319 if (w != nullptr) {
1321 w->ChangeToScript(show_company);
1322 return w;
1323 }
1324 }
1325 return new ScriptDebugWindow(_script_debug_desc, i, show_company);
1326 } else {
1327 ShowErrorMessage(GetEncodedString(STR_ERROR_AI_DEBUG_SERVER_ONLY), {}, WL_INFO);
1328 }
1329
1330 return nullptr;
1331}
1332
1337{
1338 ScriptDebugWindow::initial_state.script_debug_company = CompanyID::Invalid();
1339}
1340
1343{
1344 /* Network clients can't debug AIs. */
1345 if (_networking && !_network_server) return;
1346
1347 for (const Company *c : Company::Iterate()) {
1348 if (c->is_ai && c->ai_instance->IsDead()) {
1349 ShowScriptDebugWindow(c->index);
1350 break;
1351 }
1352 }
1353
1355 if (g != nullptr && g->IsDead()) {
1357 }
1358}
static AIConfig * GetConfig(CompanyID company, ScriptSettingSource source=SSS_DEFAULT)
Get the config of a company.
Definition ai_config.cpp:20
All static information from an AI like name, version, etc.
Definition ai_info.hpp:16
static void Pause(CompanyID company)
Suspend the AI and then pause execution of the script.
Definition ai_core.cpp:124
static const ScriptInfoList * GetUniqueInfoList()
Wrapper function for AIScanner::GetUniqueAIInfoList.
Definition ai_core.cpp:311
static bool IsPaused(CompanyID company)
Checks if the AI is paused.
Definition ai_core.cpp:145
static void Unpause(CompanyID company)
Resume execution of the AI.
Definition ai_core.cpp:137
static const ScriptInfoList * GetInfoList()
Wrapper function for AIScanner::GetAIInfoList.
Definition ai_core.cpp:306
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
static GameConfig * GetConfig(ScriptSettingSource source=SSS_DEFAULT)
Get the config of a company.
All static information from an Game like name, version, etc.
Definition game_info.hpp:16
Runtime information about a game script like a pointer to the squirrel vm and the current state.
static class GameInfo * GetInfo()
Get the current GameInfo.
Definition game.hpp:75
static void Unpause()
Resume execution of the Game Script.
static bool IsPaused()
Checks if the Game Script is paused.
static const ScriptInfoList * GetUniqueInfoList()
Wrapper function for GameScanner::GetUniqueInfoList.
static class GameInstance * GetGameInstance()
Get the current GameScript instance.
Definition game.hpp:70
static void Pause()
Suspends the Game Script and then pause the execution of the script.
static class GameInstance * GetInstance()
Get the current active instance.
Definition game.hpp:101
static const ScriptInfoList * GetInfoList()
Wrapper function for GameScanner::GetInfoList.
Base class for a 'real' widget.
Colours colour
Colour of this widget.
void SetLowered(bool lowered)
Lower or raise the widget.
void SetDisabled(bool disabled)
Disable (grey-out) or enable the widget.
Script settings.
std::optional< std::string > GetTextfile(TextfileType type, CompanyID slot) const
Search a textfile file next to this script.
void Change(std::optional< const std::string > name, int version=-1, bool force_exact_match=false)
Set another Script to be loaded in this slot.
class ScriptInfo * GetInfo() const
Get the ScriptInfo linked to this ScriptConfig.
void SetSetting(const std::string_view name, int value)
Set the value of a setting for this config.
const ScriptConfigItemList * GetConfigList()
Get the config list for this ScriptConfig.
int GetSetting(const std::string &name) const
Get the value of a setting for this config.
void ResetEditableSettings(bool yet_to_start)
Reset only editable and visible settings to their default value.
All static information from an Script like name, version, etc.
const std::string & GetName() const
Get the Name of the script.
int GetVersion() const
Get the version of the script.
bool IsPaused()
Checks if the script is paused.
ScriptLogTypes::LogData & GetLogData()
Get the log pointer of this script.
bool IsDead() const
Return the "this script died" value.
Scrollbar data structure.
bool IsVisible(size_type item) const
Checks whether given current item is visible in the list.
size_type GetCapacity() const
Gets the number of visible elements of the scrollbar.
void SetCount(size_t num)
Sets the number of elements in the list.
auto GetScrolledItemFromWidget(Tcontainer &container, int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Return an iterator pointing to the element of a scrolled widget that a user clicked in.
size_type GetScrolledRowFromWidget(int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition widget.cpp:2459
bool SetPosition(size_type position)
Sets the position of the first visible element.
void SetCapacityFromWidget(Window *w, WidgetID widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition widget.cpp:2533
size_type GetCount() const
Gets the number of elements in the list.
auto GetVisibleRangeIterators(Tcontainer &container) const
Get a pair of iterators for the range of visible elements in a container.
void SetStepSize(size_t stepsize)
Set the distance to scroll when using the buttons or the wheel.
size_type GetPosition() const
Gets the position of the first visible element in the list.
A timeout timer will fire once after the interval.
Definition timer.h:116
void Reset()
Reset the timer, so it will fire again after the timeout.
Definition timer.h:140
RectPadding framerect
Standard padding inside many panels.
Definition window_gui.h:40
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:28
int vsep_normal
Normal vertical spacing.
Definition window_gui.h:58
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:94
void DrawCompanyIcon(CompanyID c, int x, int y)
Draw the icon of a company.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
static constexpr Owner OWNER_DEITY
The object is owned by a superuser / goal script.
@ CCA_NEW_AI
Create a new AI company.
@ CCA_DELETE
Delete a company.
@ CRR_NONE
Dummy reason for actions that don't need one.
@ CRR_MANUAL
The company is manually removed.
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, bool instant_close, bool persist)
Show a drop down list.
Definition dropdown.cpp:386
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition error.h:24
void ShowErrorMessage(EncodedString &&summary_msg, int x, int y, const CommandCost &cc)
Display an error message in a window.
@ AI_DIR
Subdirectory for all AI files.
@ GAME_DIR
Subdirectory for all game scripts.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:77
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition gfx.cpp:922
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:851
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:657
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:38
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition gfx.cpp:114
PauseModes _pause_mode
The current pause mode.
Definition gfx.cpp:50
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition gfx.cpp:774
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition gfx.cpp:1548
int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition gfx_func.h:166
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:243
@ SA_LEFT
Left align the text.
Definition gfx_type.h:375
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition gfx_type.h:387
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:294
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 SetScrollbar(WidgetID index)
Attach a scrollbar to a widget.
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
constexpr NWidgetPart SetAspect(float ratio, AspectFlags flags=AspectFlag::ResizeX)
Widget part function for setting the aspect ratio.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:937
constexpr bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
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.
@ WID_TF_CAPTION
The caption of the window.
Definition misc_widget.h:50
bool _networking
are we in networking mode?
Definition network.cpp:65
bool _network_server
network-server is active
Definition network.cpp:66
@ INVALID_CLIENT_ID
Client is not part of anything.
uint8_t valid
Bits indicating what variable is valid (for each bit, 0 is invalid, 1 is valid).
@ Normal
A game normally paused.
static const uint8_t PC_BLACK
Black palette colour.
ScriptConfig stores the configuration settings of every Script.
@ SCRIPTCONFIG_INGAME
This setting can be changed while the Script is running.
@ SCRIPTCONFIG_BOOLEAN
This value is a boolean (either 0 (false) or 1 (true) ).
@ SCRIPTCONFIG_DEVELOPER
This setting will only be visible when the Script development tools are active.
static const int INT32_DIGITS_WITH_SIGN_AND_TERMINATION
Maximum of 10 digits for MIN / MAX_INT32, 1 for the sign and 1 for '\0'.
void ShowScriptDebugWindowIfScriptError()
Open the AI debug window if one of the AI scripts has crashed.
static constexpr NWidgetPart _nested_script_list_widgets[]
Widgets for the AI list window.
Window * ShowScriptDebugWindow(CompanyID show_company, bool new_window)
Open the Script debug window and select the given company.
static WindowDesc _script_debug_desc(WDP_AUTO, "script_debug", 600, 450, WC_SCRIPT_DEBUG, WC_NONE, {}, _nested_script_debug_widgets, &ScriptDebugWindow::hotkeys)
Window definition for the Script debug window.
std::unique_ptr< NWidgetBase > MakeCompanyButtonRowsScriptDebug()
Make a number of rows with buttons for each company for the Script debug window.
static bool SetScriptButtonColour(NWidgetCore &button, bool dead, bool paused)
Set the widget colour of a button based on the state of the script.
static constexpr NWidgetPart _nested_script_debug_widgets[]
Widgets for the Script debug window.
void ShowScriptTextfileWindow(TextfileType file_type, CompanyID slot)
Open the Script version of the textfile window.
static WindowDesc _script_list_desc(WDP_CENTER, "settings_script_list", 200, 234, WC_SCRIPT_LIST, WC_NONE, {}, _nested_script_list_widgets)
Window definition for the ai list window.
void ShowScriptSettingsWindow(CompanyID slot)
Open the Script settings window to change the Script settings for a Script.
static WindowDesc _script_settings_desc(WDP_CENTER, "settings_script", 500, 208, WC_SCRIPT_SETTINGS, WC_NONE, {}, _nested_script_settings_widgets)
Window definition for the Script settings window.
static constexpr NWidgetPart _nested_script_settings_widgets[]
Widgets for the Script settings window.
void ShowScriptListWindow(CompanyID slot, bool show_all)
Open the Script list window to chose a script for the given company slot.
void InitializeScriptGui()
Reset the Script windows to their initial state.
Declarations of the class for the script scanner.
std::map< std::string, class ScriptInfo *, CaseInsensitiveComparator > ScriptInfoList
Type for the list of scripts.
@ WID_SCRD_NAME_TEXT
Name of the current selected.
@ WID_SCRD_BREAK_STRING_WIDGETS
The panel to handle the breaking on string.
@ WID_SCRD_SCRIPT_GAME
Game Script button.
@ WID_SCRD_RELOAD_TOGGLE
Reload button.
@ WID_SCRD_HSCROLLBAR
Horizontal scrollbar of the log panel.
@ WID_SCRD_SETTINGS
Settings button.
@ WID_SCRD_BREAK_STR_EDIT_BOX
Edit box for the string to break on.
@ WID_SCRD_COMPANY_BUTTON_START
Buttons in the VIEW.
@ WID_SCRD_VIEW
The row of company buttons.
@ WID_SCRD_MATCH_CASE_BTN
Checkbox to use match caching or not.
@ WID_SCRD_BREAK_STR_ON_OFF_BTN
Enable breaking on string.
@ WID_SCRD_VSCROLLBAR
Vertical scrollbar of the log panel.
@ WID_SCRD_LOG_PANEL
Panel where the log is in.
@ WID_SCRD_CONTINUE_BTN
Continue button.
@ WID_SCRD_COMPANY_BUTTON_END
Last possible button in the VIEW.
@ WID_SCRL_ACCEPT
Accept button.
@ WID_SCRL_INFO_BG
Panel to draw some Script information on.
@ WID_SCRL_CAPTION
Caption of the window.
@ WID_SCRL_LIST
The matrix with all available Scripts.
@ WID_SCRL_SCROLLBAR
Scrollbar next to the Script list.
@ WID_SCRL_CANCEL
Cancel button.
@ WID_SCRS_SETTING_DROPDOWN
Dynamically created dropdown for changing setting value.
@ WID_SCRS_BACKGROUND
Panel to draw the settings on.
@ WID_SCRS_ACCEPT
Accept button.
@ WID_SCRS_SCROLLBAR
Scrollbar to scroll through all settings.
@ WID_SCRS_RESET
Reset button.
@ WID_SCRS_CAPTION
Caption of the window.
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:57
void DrawArrowButtons(int x, int y, Colours button_colour, uint8_t state, bool clickable_left, bool clickable_right)
Draw [<][>] boxes.
void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
Draw a dropdown button.
void DrawBoolButton(int x, int y, bool state, bool clickable)
Draw a toggle button.
#define SETTING_BUTTON_WIDTH
Width of setting buttons.
#define SETTING_BUTTON_HEIGHT
Height of setting buttons.
@ CS_NUMERAL_SIGNED
Only numbers and '-' for negative values.
Definition string_type.h:28
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition strings.cpp:163
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:103
std::string GetString(StringID string)
Resolve the given StringID into a std::string with all the associated DParam lookups and formatting.
Definition strings.cpp:420
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:56
void SetDParamStr(size_t n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition strings.cpp:466
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
@ TD_RTL
Text is written right-to-left by default.
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
GUISettings gui
settings related to the GUI
static bool IsValidAiID(auto index)
Is this company a valid company, controlled by the computer (a NoAI program)?
Dimensions (a width and height) of a rectangle in 2D.
Data about how and where to blit pixels.
Definition gfx_type.h:156
bool ai_developer_tools
activate AI/GS developer tools
List of hotkeys for a window.
Definition hotkeys.h:37
All data for a single hotkey.
Definition hotkeys.h:21
Partial widget specification to allow NWidgets to be written nested.
Coordinates of a point in 2D.
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
static Titem * Get(auto index)
Returns Titem with given index.
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Data stored about a string that can be modified in the GUI.
constexpr uint Vertical() const
Get total vertical padding of RectPadding.
Specification of a rectangle with absolute coordinates of all edges.
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
int Width() const
Get width of Rect.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
uint step_height
Step-size of height resize changes.
Definition window_gui.h:213
Info about a single Script setting.
bool break_check_enabled
Stop an AI when it prints a matching string.
bool case_sensitive_break_check
Is the matching done case-sensitive.
std::string break_string
The string to match to the AI output.
CompanyID script_debug_company
The AI that is (was last) being debugged.
Window with everything an AI prints via ScriptLog.
void UpdateAIButtonsState()
Update state of all Company (AI) buttons.
void DrawWidgetLog(const Rect &r) const
Draw the AI/GS log.
void UpdateGSButtonState()
Update state of game script button.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void OnInit() override
Notification that the nested widget tree gets initialized.
int redraw_timer
Timer for redrawing the window, otherwise it'll happen every tick.
static EventState ScriptDebugGlobalHotkeys(int hotkey)
Handler for global hotkeys of the ScriptDebugWindow.
void SelectValidDebugCompany()
Ensure that script_debug_company refers to a valid AI company or GS, or is set to CompanyID::Invalid(...
void OnEditboxChanged(WidgetID wid) override
The text in an editbox has been edited.
int last_vscroll_pos
Last position of the scrolling.
void DrawWidgetCompanyButton(const Rect &r, WidgetID widget, int start) const
Draw a company button icon.
static const uint MAX_BREAK_STR_STRING_LENGTH
Maximum length of the break string.
QueryString break_editbox
Break editbox.
void OnPaint() override
The window must be repainted.
Scrollbar * hscroll
Cache of the horizontal scrollbar.
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 OnResize() override
Called after the window got resized.
int highlight_row
The output row that matches the given string, or -1.
ScriptDebugWindow(WindowDesc &desc, WindowNumber number, Owner show_company)
Constructor for the window.
void UpdateLogScroll()
Update the scrollbar and scroll position of the log panel.
StringFilter break_string_filter
Log filter for break.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
bool autoscroll
Whether automatically scrolling should be enabled or not.
void SetStringParameters(WidgetID widget) const override
Initialize string parameters for a widget.
bool IsDead() const
Check whether the currently selected AI/GS is dead.
bool IsValidDebugCompany(CompanyID company) const
Check whether a company is a valid AI company or GS.
void ChangeToScript(CompanyID show_script, bool new_window=false)
Change all settings to select another Script.
Scrollbar * vscroll
Cache of the vertical scrollbar.
bool show_break_box
Whether the break/debug box is visible.
Window that let you choose an available Script.
int line_height
Height of a row in the matrix widget.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
bool show_all
Whether to show all available versions.
void OnResize() override
Called after the window got resized.
CompanyID slot
The company we're selecting a new Script for.
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.
int selected
The currently selected Script.
Scrollbar * vscroll
Cache of the vertical scrollbar.
ScriptListWindow(WindowDesc &desc, CompanyID slot, bool show_all)
Constructor for the window.
void SetStringParameters(WidgetID widget) const override
Initialize string parameters for a widget.
void ChangeScript()
Changes the Script of the current slot.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
const ScriptInfoList * info_list
The list of Scripts.
Window for settings the parameters of an AI.
int clicked_row
The clicked row of settings.
void OnPaint() override
The window must be repainted.
std::vector< const ScriptConfigItem * > VisibleSettingsList
typdef for a vector of script settings
int clicked_button
The button we clicked.
void OnResize() override
Called after the window got resized.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void OnDropdownClose(Point, WidgetID widget, int, bool) override
A dropdown window associated to this window has been closed.
void SetStringParameters(WidgetID widget) const override
Initialize string parameters for a widget.
void RebuildVisibleSettings()
Rebuilds the list of visible settings.
void OnDropdownSelect(WidgetID widget, int index) override
A dropdown option associated to this window has been selected.
CompanyID slot
The currently show company's setting.
int line_height
Height of a row in the matrix widget.
ScriptSettingsWindow(WindowDesc &desc, CompanyID slot)
Constructor for the window.
bool clicked_dropdown
Whether the dropdown is open.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
TimeoutTimer< TimerWindow > unclick_timeout
When reset, unclick the button after a small timeout.
bool clicked_increase
Whether we clicked the increase or decrease button.
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.
ScriptConfig * script_config
The configuration we're modifying.
VisibleSettingsList visible_settings
List of visible AI settings.
bool closing_dropdown
True, if the dropdown list is currently closing.
Scrollbar * vscroll
Cache of the vertical scrollbar.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
Window for displaying the textfile of a AI.
void SetStringParameters(WidgetID widget) const override
Initialize string parameters for a widget.
CompanyID slot
View the textfile of this CompanyID slot.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
String filter and state.
void SetFilterTerm(std::string_view str)
Set the term to filter on.
void ResetState()
Reset the matching state to process a new item.
void AddLine(const char *str)
Pass another text line from the current item to the filter.
bool GetState() const
Get the matching state of the current item.
void Assign(const std::string_view text)
Copy a string into the textbuffer.
Definition textbuf.cpp:423
const char * GetText() const
Get the current text.
Definition textbuf.cpp:287
Window for displaying a textfile.
TextfileType file_type
Type of textfile to view.
virtual void LoadTextfile(const std::string &textfile, Subdirectory dir)
Loads the textfile text from file and setup lines.
High level window description.
Definition window_gui.h:168
Number to differentiate different windows of the same class.
Data structure for an opened window.
Definition window_gui.h:272
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:949
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1044
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1730
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition window_gui.h:319
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:731
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition window.cpp:3157
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:548
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1032
ResizeInfo resize
Resize information.
Definition window_gui.h:313
void SetWidgetsDisabledState(bool disab_stat, Args... widgets)
Sets the enabled/disabled status of a list of widgets.
Definition window_gui.h:514
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1720
WindowClass window_class
Window class.
Definition window_gui.h:300
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
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:969
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition window.cpp:311
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition window.cpp:562
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:380
AllWindows< false > Iterate
Iterate all windows in whatever order is easiest.
Definition window_gui.h:919
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:301
TextfileType
Additional text files accompanying Tar archives.
Rect ScrollRect(Rect r, const Scrollbar &sb, int resize_step)
Apply 'scroll' to a rect to be drawn in.
Definition widget.cpp:2550
std::unique_ptr< NWidgetBase > MakeCompanyButtonRows(WidgetID widget_first, WidgetID widget_last, Colours button_colour, int max_length, StringID button_tooltip, bool resizable)
Make a number of rows with button-like graphics, for enabling/disabling each company.
Definition widget.cpp:3442
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
@ WWT_IMGBTN_2
(Toggle) Button with diff image when clicked
Definition widget_type.h:44
@ WWT_LABEL
Centered label.
Definition widget_type.h:48
@ WWT_EDITBOX
a textbox for typing
Definition widget_type.h:62
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:46
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:41
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition widget_type.h:57
@ WWT_MATRIX
Grid of rows and columns.
Definition widget_type.h:50
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition widget_type.h:55
@ 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
@ NWID_HSCROLLBAR
Horizontal scrollbar.
Definition widget_type.h:75
@ 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
@ 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.
@ EqualSize
Containers should keep all their (resizing) children equally large.
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1137
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
Definition window.cpp:1110
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1149
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition window.cpp:3217
Window * BringWindowToFrontById(WindowClass cls, WindowNumber number)
Find a window and make it the relative top-window on the screen.
Definition window.cpp:1220
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1095
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition window.cpp:3234
@ WDP_CENTER
Center the window.
Definition window_gui.h:146
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:145
int WidgetID
Widget ID.
Definition window_type.h:20
@ WN_GAME_OPTIONS_GS
GS settings.
Definition window_type.h:25
@ WN_GAME_OPTIONS_AI
AI settings.
Definition window_type.h:24
EventState
State of handling an event.
@ ES_NOT_HANDLED
The passed event is not handled.
@ WC_SCRIPT_SETTINGS
Script settings; Window numbers:
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:47
@ WC_SCRIPT_LIST
Scripts list; Window numbers:
@ WC_GAME_OPTIONS
Game options window; Window numbers:
@ WC_SCRIPT_DEBUG
Script debug window; Window numbers:
@ WC_TEXTFILE
textfile; Window numbers:
@ WC_DROPDOWN_MENU
Drop down menu; Window numbers:
@ WC_QUERY_STRING
Query string window; Window numbers: