OpenTTD Source  20241108-master-g80f628063a
ai_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 "../error.h"
12 #include "../company_base.h"
13 #include "../window_func.h"
14 #include "../network/network.h"
15 #include "../settings_func.h"
16 #include "../network/network_content.h"
17 #include "../core/geometry_func.hpp"
18 
19 #include "ai.hpp"
20 #include "ai_gui.hpp"
21 #include "ai_config.hpp"
22 #include "ai_info.hpp"
23 #include "../script/script_gui.h"
24 #include "table/strings.h"
25 
26 #include "../safeguards.h"
27 
28 
30 static constexpr NWidgetPart _nested_ai_config_widgets[] = {
32  NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
33  NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_AI_CONFIG_CAPTION_AI, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
34  EndContainer(),
35  NWidget(WWT_PANEL, COLOUR_MAUVE, WID_AIC_BACKGROUND),
42  EndContainer(),
43  NWidget(WWT_TEXT, COLOUR_MAUVE, WID_AIC_NUMBER), SetDataTip(STR_AI_CONFIG_MAX_COMPETITORS, STR_NULL), SetFill(1, 0),
44  EndContainer(),
49  EndContainer(),
50  NWidget(WWT_TEXT, COLOUR_MAUVE, WID_AIC_INTERVAL), SetDataTip(STR_AI_CONFIG_COMPETITORS_INTERVAL, STR_NULL), SetFill(1, 0),
51  EndContainer(),
53  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_MOVE_UP), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_CONFIG_MOVE_UP, STR_AI_CONFIG_MOVE_UP_TOOLTIP),
54  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_MOVE_DOWN), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_CONFIG_MOVE_DOWN, STR_AI_CONFIG_MOVE_DOWN_TOOLTIP),
55  EndContainer(),
56  EndContainer(),
57  NWidget(WWT_FRAME, COLOUR_MAUVE), SetDataTip(STR_AI_CONFIG_AI, STR_NULL), SetPIP(0, WidgetDimensions::unscaled.vsep_sparse, 0),
59  NWidget(WWT_MATRIX, COLOUR_MAUVE, WID_AIC_LIST), SetMinimalSize(288, 112), SetFill(1, 0), SetMatrixDataTip(1, 8, STR_AI_CONFIG_AILIST_TOOLTIP), SetScrollbar(WID_AIC_SCROLLBAR),
61  EndContainer(),
62  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_CONFIGURE), SetFill(1, 0), SetDataTip(STR_AI_CONFIG_CONFIGURE, STR_AI_CONFIG_CONFIGURE_TOOLTIP),
63  EndContainer(),
66  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_CHANGE), SetFill(1, 1), SetDataTip(STR_AI_CONFIG_CHANGE_AI, STR_AI_CONFIG_CHANGE_TOOLTIP),
67  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_CONTENT_DOWNLOAD), SetFill(1, 1), SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
68  EndContainer(),
71  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_OPEN_URL), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_CONTENT_OPEN_URL, STR_CONTENT_OPEN_URL_TOOLTIP),
72  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_TEXTFILE + TFT_README), SetFill(1, 1), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_TEXTFILE_VIEW_README_TOOLTIP),
73  EndContainer(),
75  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_TEXTFILE + TFT_CHANGELOG), SetFill(1, 1), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_TEXTFILE_VIEW_CHANGELOG_TOOLTIP),
76  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_TEXTFILE + TFT_LICENSE), SetFill(1, 1), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_TEXTFILE_VIEW_LICENCE_TOOLTIP),
77  EndContainer(),
78  EndContainer(),
79  EndContainer(),
80  EndContainer(),
81  EndContainer(),
82 };
83 
86  WDP_CENTER, nullptr, 0, 0,
88  0,
90 );
91 
95 struct AIConfigWindow : public Window {
99 
101  {
102  this->InitNested(WN_GAME_OPTIONS_AI); // Initializes 'this->line_height' as a side effect.
103  this->vscroll = this->GetScrollbar(WID_AIC_SCROLLBAR);
104  this->selected_slot = INVALID_COMPANY;
105  NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_AIC_LIST);
106  this->vscroll->SetCapacity(nwi->current_y / this->line_height);
107  this->vscroll->SetCount(MAX_COMPANIES);
108  this->OnInvalidateData(0);
109  }
110 
111  void Close([[maybe_unused]] int data = 0) override
112  {
115  this->Window::Close();
116  }
117 
118  void SetStringParameters(WidgetID widget) const override
119  {
120  switch (widget) {
121  case WID_AIC_NUMBER:
122  SetDParam(0, GetGameSettings().difficulty.max_no_competitors);
123  break;
124 
125  case WID_AIC_INTERVAL:
126  SetDParam(0, GetGameSettings().difficulty.competitors_interval);
127  break;
128  }
129  }
130 
131  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
132  {
133  switch (widget) {
138  size = maxdim(size, NWidgetScrollbar::GetHorizontalDimension());
139  break;
140 
141  case WID_AIC_LIST:
142  this->line_height = GetCharacterHeight(FS_NORMAL) + padding.height;
143  resize.height = this->line_height;
144  size.height = 8 * this->line_height;
145  break;
146  }
147  }
148 
154  static bool IsEditable(CompanyID slot)
155  {
156  if (_game_mode != GM_NORMAL) {
157  return slot > 0 && slot < MAX_COMPANIES;
158  }
159  return slot < MAX_COMPANIES && !Company::IsValidID(slot);
160  }
161 
162  void DrawWidget(const Rect &r, WidgetID widget) const override
163  {
164  switch (widget) {
165  case WID_AIC_LIST: {
166  Rect tr = r.Shrink(WidgetDimensions::scaled.matrix);
168  if (_game_mode == GM_NORMAL) {
169  for (const Company *c : Company::Iterate()) {
170  if (c->is_ai) max_slot--;
171  }
172  for (CompanyID cid = COMPANY_FIRST; cid < (CompanyID)max_slot && cid < MAX_COMPANIES; cid++) {
173  if (Company::IsValidID(cid)) max_slot++;
174  }
175  } else {
176  max_slot++; // Slot 0 is human
177  }
178  for (int i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < MAX_COMPANIES; i++) {
179  StringID text;
180 
181  if ((_game_mode != GM_NORMAL && i == 0) || (_game_mode == GM_NORMAL && Company::IsValidHumanID(i))) {
182  text = STR_AI_CONFIG_HUMAN_PLAYER;
183  } else if (AIConfig::GetConfig((CompanyID)i)->GetInfo() != nullptr) {
184  SetDParamStr(0, AIConfig::GetConfig((CompanyID)i)->GetInfo()->GetName());
185  text = STR_JUST_RAW_STRING;
186  } else {
187  text = STR_AI_CONFIG_RANDOM_AI;
188  }
189 
190  TextColour tc = TC_SILVER;
191  if (this->selected_slot == i) {
192  tc = TC_WHITE;
193  } else if (IsEditable((CompanyID)i)) {
194  if (i < max_slot) tc = TC_ORANGE;
195  } else if (Company::IsValidAiID(i)) {
196  tc = TC_GREEN;
197  }
198  DrawString(tr, text, tc);
199  tr.top += this->line_height;
200  }
201  break;
202  }
203  }
204  }
205 
206  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
207  {
208  if (widget >= WID_AIC_TEXTFILE && widget < WID_AIC_TEXTFILE + TFT_CONTENT_END) {
209  if (this->selected_slot == INVALID_COMPANY || AIConfig::GetConfig(this->selected_slot) == nullptr) return;
210 
211  ShowScriptTextfileWindow((TextfileType)(widget - WID_AIC_TEXTFILE), this->selected_slot);
212  return;
213  }
214 
215  switch (widget) {
218  int new_value;
219  if (widget == WID_AIC_DECREASE_NUMBER) {
220  new_value = std::max(0, GetGameSettings().difficulty.max_no_competitors - 1);
221  } else {
222  new_value = std::min(MAX_COMPANIES - 1, GetGameSettings().difficulty.max_no_competitors + 1);
223  }
224  IConsoleSetSetting("difficulty.max_no_competitors", new_value);
225  this->InvalidateData();
226  break;
227  }
228 
231  int new_value;
232  if (widget == WID_AIC_DECREASE_INTERVAL) {
233  new_value = std::max(static_cast<int>(MIN_COMPETITORS_INTERVAL), GetGameSettings().difficulty.competitors_interval - 1);
234  } else {
235  new_value = std::min(static_cast<int>(MAX_COMPETITORS_INTERVAL), GetGameSettings().difficulty.competitors_interval + 1);
236  }
237  IConsoleSetSetting("difficulty.competitors_interval", new_value);
238  this->InvalidateData();
239  break;
240  }
241 
242  case WID_AIC_LIST: { // Select a slot
243  this->selected_slot = (CompanyID)this->vscroll->GetScrolledRowFromWidget(pt.y, this, widget);
244  this->InvalidateData();
245  if (click_count > 1 && IsEditable(this->selected_slot)) ShowScriptListWindow((CompanyID)this->selected_slot, _ctrl_pressed);
246  break;
247  }
248 
249  case WID_AIC_MOVE_UP:
250  if (IsEditable(this->selected_slot) && IsEditable((CompanyID)(this->selected_slot - 1))) {
251  Swap(GetGameSettings().ai_config[this->selected_slot], GetGameSettings().ai_config[this->selected_slot - 1]);
252  this->selected_slot--;
253  this->vscroll->ScrollTowards(this->selected_slot);
254  this->InvalidateData();
255  }
256  break;
257 
258  case WID_AIC_MOVE_DOWN:
259  if (IsEditable(this->selected_slot) && IsEditable((CompanyID)(this->selected_slot + 1))) {
260  Swap(GetGameSettings().ai_config[this->selected_slot], GetGameSettings().ai_config[this->selected_slot + 1]);
261  this->selected_slot++;
262  this->vscroll->ScrollTowards(this->selected_slot);
263  this->InvalidateData();
264  }
265  break;
266 
267  case WID_AIC_OPEN_URL: {
268  const AIConfig *config = AIConfig::GetConfig(this->selected_slot);
269  if (this->selected_slot == INVALID_COMPANY || config == nullptr || config->GetInfo() == nullptr) return;
270  OpenBrowser(config->GetInfo()->GetURL());
271  break;
272  }
273 
274  case WID_AIC_CHANGE: // choose other AI
275  if (IsEditable(this->selected_slot)) ShowScriptListWindow((CompanyID)this->selected_slot, _ctrl_pressed);
276  break;
277 
278  case WID_AIC_CONFIGURE: // change the settings for an AI
279  ShowScriptSettingsWindow((CompanyID)this->selected_slot);
280  break;
281 
283  if (!_network_available) {
284  ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
285  } else {
287  }
288  break;
289  }
290  }
291 
297  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
298  {
299  if (!IsEditable(this->selected_slot) && !Company::IsValidAiID(this->selected_slot)) {
300  this->selected_slot = INVALID_COMPANY;
301  }
302 
303  if (!gui_scope) return;
304 
305  AIConfig *config = this->selected_slot == INVALID_COMPANY ? nullptr : AIConfig::GetConfig(this->selected_slot);
306 
307  this->SetWidgetDisabledState(WID_AIC_DECREASE_NUMBER, GetGameSettings().difficulty.max_no_competitors == 0);
308  this->SetWidgetDisabledState(WID_AIC_INCREASE_NUMBER, GetGameSettings().difficulty.max_no_competitors == MAX_COMPANIES - 1);
311  this->SetWidgetDisabledState(WID_AIC_CHANGE, !IsEditable(this->selected_slot));
312  this->SetWidgetDisabledState(WID_AIC_CONFIGURE, this->selected_slot == INVALID_COMPANY || config->GetConfigList()->empty());
313  this->SetWidgetDisabledState(WID_AIC_MOVE_UP, !IsEditable(this->selected_slot) || !IsEditable((CompanyID)(this->selected_slot - 1)));
314  this->SetWidgetDisabledState(WID_AIC_MOVE_DOWN, !IsEditable(this->selected_slot) || !IsEditable((CompanyID)(this->selected_slot + 1)));
315 
316  this->SetWidgetDisabledState(WID_AIC_OPEN_URL, this->selected_slot == INVALID_COMPANY || config->GetInfo() == nullptr || config->GetInfo()->GetURL().empty());
317  for (TextfileType tft = TFT_CONTENT_BEGIN; tft < TFT_CONTENT_END; tft++) {
318  this->SetWidgetDisabledState(WID_AIC_TEXTFILE + tft, this->selected_slot == INVALID_COMPANY || !config->GetTextfile(tft, this->selected_slot).has_value());
319  }
320  }
321 };
322 
325 {
327  new AIConfigWindow();
328 }
329 
Base functions for all AIs.
AIConfig stores the configuration settings of every AI.
static WindowDesc _ai_config_desc(WDP_CENTER, nullptr, 0, 0, WC_GAME_OPTIONS, WC_NONE, 0, _nested_ai_config_widgets)
Window definition for the configure AI window.
void ShowAIConfigWindow()
Open the AI config window.
Definition: ai_gui.cpp:324
static constexpr NWidgetPart _nested_ai_config_widgets[]
Widgets for the configure AI window.
Definition: ai_gui.cpp:30
Window for configuring the AIs
AIInfo keeps track of all information of an AI, like Author, Description, ...
@ WID_AIC_CONFIGURE
Change AI settings button.
Definition: ai_widget.h:29
@ WID_AIC_NUMBER
Number of AIs.
Definition: ai_widget.h:20
@ WID_AIC_INTERVAL
Interval between time AIs start.
Definition: ai_widget.h:23
@ WID_AIC_TEXTFILE
Open AI readme, changelog (+1) or license (+2).
Definition: ai_widget.h:31
@ WID_AIC_MOVE_DOWN
Move down button.
Definition: ai_widget.h:27
@ WID_AIC_BACKGROUND
Window background.
Definition: ai_widget.h:17
@ WID_AIC_LIST
List with currently selected AIs.
Definition: ai_widget.h:24
@ WID_AIC_CONTENT_DOWNLOAD
Download content button.
Definition: ai_widget.h:32
@ WID_AIC_INCREASE_INTERVAL
Increase the interval.
Definition: ai_widget.h:22
@ WID_AIC_OPEN_URL
Open AI URL.
Definition: ai_widget.h:30
@ WID_AIC_DECREASE_INTERVAL
Decrease the interval.
Definition: ai_widget.h:21
@ WID_AIC_SCROLLBAR
Scrollbar to scroll through the selected AIs.
Definition: ai_widget.h:25
@ WID_AIC_DECREASE_NUMBER
Decrease the number of AIs.
Definition: ai_widget.h:18
@ WID_AIC_CHANGE
Select another AI button.
Definition: ai_widget.h:28
@ WID_AIC_INCREASE_NUMBER
Increase the number of AIs.
Definition: ai_widget.h:19
@ WID_AIC_MOVE_UP
Move up button.
Definition: ai_widget.h:26
static AIConfig * GetConfig(CompanyID company, ScriptSettingSource source=SSS_DEFAULT)
Get the config of a company.
Definition: ai_config.cpp:20
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:244
Base class for a 'real' widget.
Definition: widget_type.h:370
std::optional< std::string > GetTextfile(TextfileType type, CompanyID slot) const
Search a textfile file next to this script.
const ScriptConfigItemList * GetConfigList()
Get the config list for this ScriptConfig.
const std::string & GetURL() const
Get the website for this script.
Definition: script_info.hpp:76
Scrollbar data structure.
Definition: widget_type.h:694
bool IsVisible(size_type item) const
Checks whether given current item is visible in the list.
Definition: widget_type.h:750
void SetCount(size_t num)
Sets the number of elements in the list.
Definition: widget_type.h:780
void SetCapacity(size_t capacity)
Set the capacity of visible elements.
Definition: widget_type.h:794
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:2320
void ScrollTowards(size_type position)
Scroll towards the given position; if the item is visible nothing happens, otherwise it will be shown...
Definition: widget_type.h:841
size_type GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:740
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition: window_gui.h:67
static const uint MIN_COMPETITORS_INTERVAL
The minimum interval (in minutes) between competitors.
Definition: company_type.h:45
Owner
Enum for all companies/owners.
Definition: company_type.h:18
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
@ COMPANY_FIRST
First company, same as owner.
Definition: company_type.h:22
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
static const uint MAX_COMPETITORS_INTERVAL
The maximum interval (in minutes) between competitors.
Definition: company_type.h:46
void ShowErrorMessage(StringID summary_msg, int x, int y, CommandCost cc)
Display an error message in a window.
Definition: error_gui.cpp:367
@ WL_ERROR
Errors (eg. saving/loading failed)
Definition: error.h:26
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:77
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
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
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:209
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:260
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1181
constexpr NWidgetPart SetPIP(uint8_t pre, uint8_t inter, uint8_t post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1260
constexpr NWidgetPart SetScrollbar(WidgetID index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1284
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1228
constexpr NWidgetPart SetDataTip(uint32_t data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1202
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1137
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1309
constexpr NWidgetPart SetMatrixDataTip(uint8_t cols, uint8_t rows, StringID tip)
Widget part function for setting the data and tooltip of WWT_MATRIX widgets.
Definition: widget_type.h:1214
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1191
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
Definition: widget_type.h:1126
constexpr void Swap(T &a, T &b)
Type safe swap operation.
Definition: math_func.hpp:283
bool _network_available
is network mode available?
Definition: network.cpp:67
void ShowNetworkContentListWindow(ContentVector *cv=nullptr, ContentType type1=CONTENT_TYPE_END, ContentType type2=CONTENT_TYPE_END)
Show the content list window with a given set of content.
void ShowScriptTextfileWindow(TextfileType file_type, CompanyID slot)
Open the Script version of the textfile window.
Definition: script_gui.cpp:661
void ShowScriptSettingsWindow(CompanyID slot)
Open the Script settings window to change the Script settings for a Script.
Definition: script_gui.cpp:619
void ShowScriptListWindow(CompanyID slot, bool show_all)
Open the Script list window to chose a script for the given company slot.
Definition: script_gui.cpp:277
GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
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:357
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
Window to configure which AIs will start.
Definition: ai_gui.cpp:95
CompanyID selected_slot
The currently selected AI slot or INVALID_COMPANY.
Definition: ai_gui.cpp:96
static bool IsEditable(CompanyID slot)
Can the AI config in the given company slot be edited?
Definition: ai_gui.cpp:154
Scrollbar * vscroll
Cache of the vertical scrollbar.
Definition: ai_gui.cpp:98
void OnInvalidateData([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true) override
Some data on this window has become invalid.
Definition: ai_gui.cpp:297
int line_height
Height of a single AI-name line.
Definition: ai_gui.cpp:97
static bool IsValidAiID(size_t index)
Is this company a valid company, controlled by the computer (a NoAI program)?
Definition: company_base.h:159
static bool IsValidHumanID(size_t index)
Is this company a valid company, not controlled by a NoAI program?
Definition: company_base.h:171
uint8_t max_no_competitors
the number of competitors (AIs)
Definition: settings_type.h:99
Dimensions (a width and height) of a rectangle in 2D.
DifficultySettings difficulty
settings related to the difficulty
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:1075
Coordinates of a point in 2D.
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:328
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:388
Specification of a rectangle with absolute coordinates of all edges.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
High level window description.
Definition: window_gui.h:159
Data structure for an opened window.
Definition: window_gui.h:273
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1047
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3151
ResizeInfo resize
Resize information.
Definition: window_gui.h:314
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1746
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:314
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:387
@ CONTENT_TYPE_AI
The content consists of an AI.
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:14
@ TFT_LICENSE
Content license.
Definition: textfile_type.h:19
@ TFT_README
Content readme.
Definition: textfile_type.h:17
@ TFT_CHANGELOG
Content changelog.
Definition: textfile_type.h:18
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition: widget_type.h:31
@ AWV_INCREASE
Arrow to the right or in case of RTL to the left.
Definition: widget_type.h:32
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:524
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:112
@ WWT_PUSHARROWBTN
Normal push-button (no toggle button) with arrow caption.
Definition: widget_type.h:114
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:75
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:50
@ WWT_MATRIX
Grid of rows and columns.
Definition: widget_type.h:59
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:84
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:77
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:69
@ WWT_FRAME
Frame.
Definition: widget_type.h:60
@ WWT_TEXT
Pure simple text.
Definition: widget_type.h:58
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition: window.cpp:1152
@ WDP_CENTER
Center the window.
Definition: window_gui.h:148
int WidgetID
Widget ID.
Definition: window_type.h:18
@ WN_GAME_OPTIONS_AI
AI settings.
Definition: window_type.h:22
@ WC_SCRIPT_SETTINGS
Script settings; Window numbers:
Definition: window_type.h:175
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:45
@ WC_SCRIPT_LIST
Scripts list; Window numbers:
Definition: window_type.h:284
@ WC_GAME_OPTIONS
Game options window; Window numbers:
Definition: window_type.h:624