OpenTTD
ai_gui.cpp
Go to the documentation of this file.
1 /* $Id: ai_gui.cpp 27787 2017-03-12 18:19:01Z peter1138 $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "../stdafx.h"
13 #include "../table/sprites.h"
14 #include "../error.h"
15 #include "../settings_gui.h"
16 #include "../querystring_gui.h"
17 #include "../stringfilter_type.h"
18 #include "../company_base.h"
19 #include "../company_gui.h"
20 #include "../strings_func.h"
21 #include "../window_func.h"
22 #include "../gfx_func.h"
23 #include "../command_func.h"
24 #include "../network/network.h"
25 #include "../settings_func.h"
26 #include "../network/network_content.h"
27 #include "../textfile_gui.h"
28 #include "../widgets/dropdown_type.h"
29 #include "../widgets/dropdown_func.h"
30 #include "../hotkeys.h"
31 #include "../core/geometry_func.hpp"
32 
33 #include "ai.hpp"
34 #include "ai_gui.hpp"
35 #include "../script/api/script_log.hpp"
36 #include "ai_config.hpp"
37 #include "ai_info.hpp"
38 #include "ai_instance.hpp"
39 #include "../game/game.hpp"
40 #include "../game/game_config.hpp"
41 #include "../game/game_info.hpp"
42 #include "../game/game_instance.hpp"
43 
44 #include "table/strings.h"
45 
46 #include <vector>
47 
48 #include "../safeguards.h"
49 
50 static ScriptConfig *GetConfig(CompanyID slot)
51 {
52  if (slot == OWNER_DEITY) return GameConfig::GetConfig();
53  return AIConfig::GetConfig(slot);
54 }
55 
59 struct AIListWindow : public Window {
61  int selected;
65 
71  AIListWindow(WindowDesc *desc, CompanyID slot) : Window(desc),
72  slot(slot)
73  {
74  if (slot == OWNER_DEITY) {
75  this->info_list = Game::GetUniqueInfoList();
76  } else {
77  this->info_list = AI::GetUniqueInfoList();
78  }
79 
80  this->CreateNestedTree();
81  this->vscroll = this->GetScrollbar(WID_AIL_SCROLLBAR);
82  this->FinishInitNested(); // Initializes 'this->line_height' as side effect.
83 
84  this->vscroll->SetCount((int)this->info_list->size() + 1);
85 
86  /* Try if we can find the currently selected AI */
87  this->selected = -1;
88  if (GetConfig(slot)->HasScript()) {
89  ScriptInfo *info = GetConfig(slot)->GetInfo();
90  int i = 0;
91  for (ScriptInfoList::const_iterator it = this->info_list->begin(); it != this->info_list->end(); it++, i++) {
92  if ((*it).second == info) {
93  this->selected = i;
94  break;
95  }
96  }
97  }
98  }
99 
100  virtual void SetStringParameters(int widget) const
101  {
102  switch (widget) {
103  case WID_AIL_CAPTION:
104  SetDParam(0, (this->slot == OWNER_DEITY) ? STR_AI_LIST_CAPTION_GAMESCRIPT : STR_AI_LIST_CAPTION_AI);
105  break;
106  }
107  }
108 
109  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
110  {
111  if (widget == WID_AIL_LIST) {
112  this->line_height = FONT_HEIGHT_NORMAL + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
113 
114  resize->width = 1;
115  resize->height = this->line_height;
116  size->height = 5 * this->line_height;
117  }
118  }
119 
120  virtual void DrawWidget(const Rect &r, int widget) const
121  {
122  switch (widget) {
123  case WID_AIL_LIST: {
124  /* Draw a list of all available AIs. */
125  int y = this->GetWidget<NWidgetBase>(WID_AIL_LIST)->pos_y;
126  /* First AI in the list is hardcoded to random */
127  if (this->vscroll->IsVisible(0)) {
128  DrawString(r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_LEFT, y + WD_MATRIX_TOP, this->slot == OWNER_DEITY ? STR_AI_CONFIG_NONE : STR_AI_CONFIG_RANDOM_AI, this->selected == -1 ? TC_WHITE : TC_ORANGE);
129  y += this->line_height;
130  }
131  ScriptInfoList::const_iterator it = this->info_list->begin();
132  for (int i = 1; it != this->info_list->end(); i++, it++) {
133  if (this->vscroll->IsVisible(i)) {
134  DrawString(r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, y + WD_MATRIX_TOP, (*it).second->GetName(), (this->selected == i - 1) ? TC_WHITE : TC_ORANGE);
135  y += this->line_height;
136  }
137  }
138  break;
139  }
140  case WID_AIL_INFO_BG: {
141  AIInfo *selected_info = NULL;
142  ScriptInfoList::const_iterator it = this->info_list->begin();
143  for (int i = 1; selected_info == NULL && it != this->info_list->end(); i++, it++) {
144  if (this->selected == i - 1) selected_info = static_cast<AIInfo *>((*it).second);
145  }
146  /* Some info about the currently selected AI. */
147  if (selected_info != NULL) {
148  int y = r.top + WD_FRAMERECT_TOP;
149  SetDParamStr(0, selected_info->GetAuthor());
150  DrawString(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, y, STR_AI_LIST_AUTHOR);
152  SetDParam(0, selected_info->GetVersion());
153  DrawString(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, y, STR_AI_LIST_VERSION);
155  if (selected_info->GetURL() != NULL) {
156  SetDParamStr(0, selected_info->GetURL());
157  DrawString(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, y, STR_AI_LIST_URL);
159  }
160  SetDParamStr(0, selected_info->GetDescription());
161  DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, y, r.bottom - WD_FRAMERECT_BOTTOM, STR_JUST_RAW_STRING, TC_WHITE);
162  }
163  break;
164  }
165  }
166  }
167 
171  void ChangeAI()
172  {
173  if (this->selected == -1) {
174  GetConfig(slot)->Change(NULL);
175  } else {
176  ScriptInfoList::const_iterator it = this->info_list->begin();
177  for (int i = 0; i < this->selected; i++) it++;
178  GetConfig(slot)->Change((*it).second->GetName(), (*it).second->GetVersion());
179  }
183  }
184 
185  virtual void OnClick(Point pt, int widget, int click_count)
186  {
187  switch (widget) {
188  case WID_AIL_LIST: { // Select one of the AIs
189  int sel = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_AIL_LIST, 0, this->line_height) - 1;
190  if (sel < (int)this->info_list->size()) {
191  this->selected = sel;
192  this->SetDirty();
193  if (click_count > 1) {
194  this->ChangeAI();
195  delete this;
196  }
197  }
198  break;
199  }
200 
201  case WID_AIL_ACCEPT: {
202  this->ChangeAI();
203  delete this;
204  break;
205  }
206 
207  case WID_AIL_CANCEL:
208  delete this;
209  break;
210  }
211  }
212 
213  virtual void OnResize()
214  {
215  this->vscroll->SetCapacityFromWidget(this, WID_AIL_LIST);
216  }
217 
223  virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
224  {
225  if (_game_mode == GM_NORMAL && Company::IsValidID(this->slot)) {
226  delete this;
227  return;
228  }
229 
230  if (!gui_scope) return;
231 
232  this->vscroll->SetCount((int)this->info_list->size() + 1);
233 
234  /* selected goes from -1 .. length of ai list - 1. */
235  this->selected = min(this->selected, this->vscroll->GetCount() - 2);
236  }
237 };
238 
242  NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
243  NWidget(WWT_CAPTION, COLOUR_MAUVE, WID_AIL_CAPTION), SetDataTip(STR_AI_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
244  NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
245  EndContainer(),
247  NWidget(WWT_MATRIX, COLOUR_MAUVE, WID_AIL_LIST), SetMinimalSize(188, 112), SetFill(1, 1), SetResize(1, 1), SetMatrixDataTip(1, 0, STR_AI_LIST_TOOLTIP), SetScrollbar(WID_AIL_SCROLLBAR),
248  NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_AIL_SCROLLBAR),
249  EndContainer(),
251  EndContainer(),
254  NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_AIL_ACCEPT), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_LIST_ACCEPT, STR_AI_LIST_ACCEPT_TOOLTIP),
255  NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_AIL_CANCEL), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_LIST_CANCEL, STR_AI_LIST_CANCEL_TOOLTIP),
256  EndContainer(),
257  NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
258  EndContainer(),
259 };
260 
263  WDP_CENTER, "settings_script_list", 200, 234,
265  0,
266  _nested_ai_list_widgets, lengthof(_nested_ai_list_widgets)
267 );
268 
273 static void ShowAIListWindow(CompanyID slot)
274 {
276  new AIListWindow(&_ai_list_desc, slot);
277 }
278 
282 struct AISettingsWindow : public Window {
289  int timeout;
293  typedef std::vector<const ScriptConfigItem *> VisibleSettingsList;
294  VisibleSettingsList visible_settings;
295 
302  slot(slot),
303  clicked_button(-1),
304  clicked_dropdown(false),
305  closing_dropdown(false),
306  timeout(0)
307  {
308  this->ai_config = GetConfig(slot);
309 
310  this->CreateNestedTree();
311  this->vscroll = this->GetScrollbar(WID_AIS_SCROLLBAR);
312  this->FinishInitNested(slot); // Initializes 'this->line_height' as side effect.
313 
314  this->SetWidgetDisabledState(WID_AIS_RESET, _game_mode != GM_MENU && Company::IsValidID(this->slot));
315 
316  this->RebuildVisibleSettings();
317  }
318 
319  virtual void SetStringParameters(int widget) const
320  {
321  switch (widget) {
322  case WID_AIS_CAPTION:
323  SetDParam(0, (this->slot == OWNER_DEITY) ? STR_AI_SETTINGS_CAPTION_GAMESCRIPT : STR_AI_SETTINGS_CAPTION_AI);
324  break;
325  }
326  }
327 
334  {
335  visible_settings.clear();
336 
337  ScriptConfigItemList::const_iterator it = this->ai_config->GetConfigList()->begin();
338  for (; it != this->ai_config->GetConfigList()->end(); it++) {
339  bool no_hide = (it->flags & SCRIPTCONFIG_DEVELOPER) == 0;
340  if (no_hide || _settings_client.gui.ai_developer_tools) {
341  visible_settings.push_back(&(*it));
342  }
343  }
344 
345  this->vscroll->SetCount((int)this->visible_settings.size());
346  }
347 
348  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
349  {
350  if (widget == WID_AIS_BACKGROUND) {
352 
353  resize->width = 1;
354  resize->height = this->line_height;
355  size->height = 5 * this->line_height;
356  }
357  }
358 
359  virtual void DrawWidget(const Rect &r, int widget) const
360  {
361  if (widget != WID_AIS_BACKGROUND) return;
362 
363  ScriptConfig *config = this->ai_config;
364  VisibleSettingsList::const_iterator it = this->visible_settings.begin();
365  int i = 0;
366  for (; !this->vscroll->IsVisible(i); i++) it++;
367 
368  bool rtl = _current_text_dir == TD_RTL;
369  uint buttons_left = rtl ? r.right - SETTING_BUTTON_WIDTH - 3 : r.left + 4;
370  uint text_left = r.left + (rtl ? WD_FRAMERECT_LEFT : SETTING_BUTTON_WIDTH + 8);
371  uint text_right = r.right - (rtl ? SETTING_BUTTON_WIDTH + 8 : WD_FRAMERECT_RIGHT);
372 
373 
374  int y = r.top;
375  int button_y_offset = (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
376  int text_y_offset = (this->line_height - FONT_HEIGHT_NORMAL) / 2;
377  for (; this->vscroll->IsVisible(i) && it != visible_settings.end(); i++, it++) {
378  const ScriptConfigItem &config_item = **it;
379  int current_value = config->GetSetting((config_item).name);
380  bool editable = _game_mode == GM_MENU || ((this->slot != OWNER_DEITY) && !Company::IsValidID(this->slot)) || (config_item.flags & SCRIPTCONFIG_INGAME) != 0;
381 
382  StringID str;
383  TextColour colour;
384  uint idx = 0;
385  if (StrEmpty(config_item.description)) {
386  if (!strcmp(config_item.name, "start_date")) {
387  /* Build-in translation */
388  str = STR_AI_SETTINGS_START_DELAY;
389  colour = TC_LIGHT_BLUE;
390  } else {
391  str = STR_JUST_STRING;
392  colour = TC_ORANGE;
393  }
394  } else {
395  str = STR_AI_SETTINGS_SETTING;
396  colour = TC_LIGHT_BLUE;
397  SetDParamStr(idx++, config_item.description);
398  }
399 
400  if ((config_item.flags & SCRIPTCONFIG_BOOLEAN) != 0) {
401  DrawBoolButton(buttons_left, y + button_y_offset, current_value != 0, editable);
402  SetDParam(idx++, current_value == 0 ? STR_CONFIG_SETTING_OFF : STR_CONFIG_SETTING_ON);
403  } else {
404  if (config_item.complete_labels) {
405  DrawDropDownButton(buttons_left, y + button_y_offset, COLOUR_YELLOW, this->clicked_row == i && clicked_dropdown, editable);
406  } else {
407  DrawArrowButtons(buttons_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);
408  }
409  if (config_item.labels != NULL && config_item.labels->Contains(current_value)) {
410  SetDParam(idx++, STR_JUST_RAW_STRING);
411  SetDParamStr(idx++, config_item.labels->Find(current_value)->second);
412  } else {
413  SetDParam(idx++, STR_JUST_INT);
414  SetDParam(idx++, current_value);
415  }
416  }
417 
418  DrawString(text_left, text_right, y + text_y_offset, str, colour);
419  y += this->line_height;
420  }
421  }
422 
423  virtual void OnPaint()
424  {
425  if (this->closing_dropdown) {
426  this->closing_dropdown = false;
427  this->clicked_dropdown = false;
428  }
429  this->DrawWidgets();
430  }
431 
432  virtual void OnClick(Point pt, int widget, int click_count)
433  {
434  switch (widget) {
435  case WID_AIS_BACKGROUND: {
436  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_AIS_BACKGROUND);
437  int num = (pt.y - wid->pos_y) / this->line_height + this->vscroll->GetPosition();
438  if (num >= (int)this->visible_settings.size()) break;
439 
440  VisibleSettingsList::const_iterator it = this->visible_settings.begin();
441  for (int i = 0; i < num; i++) it++;
442  const ScriptConfigItem config_item = **it;
443  if (_game_mode == GM_NORMAL && ((this->slot == OWNER_DEITY) || Company::IsValidID(this->slot)) && (config_item.flags & SCRIPTCONFIG_INGAME) == 0) return;
444 
445  if (this->clicked_row != num) {
447  HideDropDownMenu(this);
448  this->clicked_row = num;
449  this->clicked_dropdown = false;
450  }
451 
452  bool bool_item = (config_item.flags & SCRIPTCONFIG_BOOLEAN) != 0;
453 
454  int x = pt.x - wid->pos_x;
455  if (_current_text_dir == TD_RTL) x = wid->current_x - 1 - x;
456  x -= 4;
457 
458  /* One of the arrows is clicked (or green/red rect in case of bool value) */
459  int old_val = this->ai_config->GetSetting(config_item.name);
460  if (!bool_item && IsInsideMM(x, 0, SETTING_BUTTON_WIDTH) && config_item.complete_labels) {
461  if (this->clicked_dropdown) {
462  /* unclick the dropdown */
463  HideDropDownMenu(this);
464  this->clicked_dropdown = false;
465  this->closing_dropdown = false;
466  } else {
467  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_AIS_BACKGROUND);
468  int rel_y = (pt.y - (int)wid->pos_y) % this->line_height;
469 
470  Rect wi_rect;
471  wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);
472  wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
473  wi_rect.top = pt.y - rel_y + (this->line_height - SETTING_BUTTON_HEIGHT) / 2;
474  wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;
475 
476  /* For dropdowns we also have to check the y position thoroughly, the mouse may not above the just opening dropdown */
477  if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
478  this->clicked_dropdown = true;
479  this->closing_dropdown = false;
480 
481  DropDownList *list = new DropDownList();
482  for (int i = config_item.min_value; i <= config_item.max_value; i++) {
483  *list->Append() = new DropDownListCharStringItem(config_item.labels->Find(i)->second, i, false);
484  }
485 
486  ShowDropDownListAt(this, list, old_val, -1, wi_rect, COLOUR_ORANGE, true);
487  }
488  }
489  } else if (IsInsideMM(x, 0, SETTING_BUTTON_WIDTH)) {
490  int new_val = old_val;
491  if (bool_item) {
492  new_val = !new_val;
493  } else if (x >= SETTING_BUTTON_WIDTH / 2) {
494  /* Increase button clicked */
495  new_val += config_item.step_size;
496  if (new_val > config_item.max_value) new_val = config_item.max_value;
497  this->clicked_increase = true;
498  } else {
499  /* Decrease button clicked */
500  new_val -= config_item.step_size;
501  if (new_val < config_item.min_value) new_val = config_item.min_value;
502  this->clicked_increase = false;
503  }
504 
505  if (new_val != old_val) {
506  this->ai_config->SetSetting(config_item.name, new_val);
507  this->clicked_button = num;
508  this->timeout = 5;
509  }
510  } else if (!bool_item && !config_item.complete_labels) {
511  /* Display a query box so users can enter a custom value. */
512  SetDParam(0, old_val);
513  ShowQueryString(STR_JUST_INT, STR_CONFIG_SETTING_QUERY_CAPTION, 10, this, CS_NUMERAL, QSF_NONE);
514  }
515  this->SetDirty();
516  break;
517  }
518 
519  case WID_AIS_ACCEPT:
520  delete this;
521  break;
522 
523  case WID_AIS_RESET:
524  if (_game_mode == GM_MENU || !Company::IsValidID(this->slot)) {
525  this->ai_config->ResetSettings();
526  this->SetDirty();
527  }
528  break;
529  }
530  }
531 
532  virtual void OnQueryTextFinished(char *str)
533  {
534  if (StrEmpty(str)) return;
535  VisibleSettingsList::const_iterator it = this->visible_settings.begin();
536  for (int i = 0; i < this->clicked_row; i++) it++;
537  const ScriptConfigItem config_item = **it;
538  if (_game_mode == GM_NORMAL && ((this->slot == OWNER_DEITY) || Company::IsValidID(this->slot)) && (config_item.flags & SCRIPTCONFIG_INGAME) == 0) return;
539  int32 value = atoi(str);
540  this->ai_config->SetSetting(config_item.name, value);
541  this->SetDirty();
542  }
543 
544  virtual void OnDropdownSelect(int widget, int index)
545  {
546  assert(this->clicked_dropdown);
547  VisibleSettingsList::const_iterator it = this->visible_settings.begin();
548  for (int i = 0; i < this->clicked_row; i++) it++;
549  const ScriptConfigItem config_item = **it;
550  if (_game_mode == GM_NORMAL && ((this->slot == OWNER_DEITY) || Company::IsValidID(this->slot)) && (config_item.flags & SCRIPTCONFIG_INGAME) == 0) return;
551  this->ai_config->SetSetting(config_item.name, index);
552  this->SetDirty();
553  }
554 
555  virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
556  {
557  /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
558  * the same dropdown button was clicked again, and then not open the dropdown again.
559  * So, we only remember that it was closed, and process it on the next OnPaint, which is
560  * after OnClick. */
561  assert(this->clicked_dropdown);
562  this->closing_dropdown = true;
563  this->SetDirty();
564  }
565 
566  virtual void OnResize()
567  {
568  this->vscroll->SetCapacityFromWidget(this, WID_AIS_BACKGROUND);
569  }
570 
571  virtual void OnTick()
572  {
573  if (--this->timeout == 0) {
574  this->clicked_button = -1;
575  this->SetDirty();
576  }
577  }
578 
584  virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
585  {
586  this->RebuildVisibleSettings();
587  }
588 };
589 
593  NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
594  NWidget(WWT_CAPTION, COLOUR_MAUVE, WID_AIS_CAPTION), SetDataTip(STR_AI_SETTINGS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
595  NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
596  EndContainer(),
598  NWidget(WWT_MATRIX, COLOUR_MAUVE, WID_AIS_BACKGROUND), SetMinimalSize(188, 182), SetResize(1, 1), SetFill(1, 0), SetMatrixDataTip(1, 0, STR_NULL), SetScrollbar(WID_AIS_SCROLLBAR),
599  NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_AIS_SCROLLBAR),
600  EndContainer(),
603  NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_AIS_ACCEPT), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_SETTINGS_CLOSE, STR_NULL),
604  NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_AIS_RESET), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_SETTINGS_RESET, STR_NULL),
605  EndContainer(),
606  NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
607  EndContainer(),
608 };
609 
612  WDP_CENTER, "settings_script", 500, 208,
614  0,
615  _nested_ai_settings_widgets, lengthof(_nested_ai_settings_widgets)
616 );
617 
623 {
626  new AISettingsWindow(&_ai_settings_desc, slot);
627 }
628 
629 
633 
634  ScriptTextfileWindow(TextfileType file_type, CompanyID slot) : TextfileWindow(file_type), slot(slot)
635  {
636  const char *textfile = GetConfig(slot)->GetTextfile(file_type, slot);
637  this->LoadTextfile(textfile, (slot == OWNER_DEITY) ? GAME_DIR : AI_DIR);
638  }
639 
640  /* virtual */ void SetStringParameters(int widget) const
641  {
642  if (widget == WID_TF_CAPTION) {
643  SetDParam(0, (slot == OWNER_DEITY) ? STR_CONTENT_TYPE_GAME_SCRIPT : STR_CONTENT_TYPE_AI);
644  SetDParamStr(1, GetConfig(slot)->GetName());
645  }
646  }
647 };
648 
655 {
657  new ScriptTextfileWindow(file_type, slot);
658 }
659 
660 
664  NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
665  NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_AI_CONFIG_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
666  EndContainer(),
667  NWidget(WWT_PANEL, COLOUR_MAUVE, WID_AIC_BACKGROUND),
668  NWidget(NWID_VERTICAL), SetPIP(4, 4, 4),
669  NWidget(NWID_HORIZONTAL), SetPIP(7, 0, 7),
670  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_AIC_DECREASE), SetFill(0, 1), SetDataTip(AWV_DECREASE, STR_NULL),
671  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_AIC_INCREASE), SetFill(0, 1), SetDataTip(AWV_INCREASE, STR_NULL),
673  NWidget(WWT_TEXT, COLOUR_MAUVE, WID_AIC_NUMBER), SetDataTip(STR_DIFFICULTY_LEVEL_SETTING_MAXIMUM_NO_COMPETITORS, STR_NULL), SetFill(1, 0), SetPadding(1, 0, 0, 0),
674  EndContainer(),
676  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),
677  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),
678  EndContainer(),
679  EndContainer(),
680  NWidget(WWT_FRAME, COLOUR_MAUVE), SetDataTip(STR_AI_CONFIG_AI, STR_NULL), SetPadding(0, 5, 0, 5),
682  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),
683  NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_AIC_SCROLLBAR),
684  EndContainer(),
685  EndContainer(),
687  NWidget(WWT_FRAME, COLOUR_MAUVE), SetDataTip(STR_AI_CONFIG_GAMESCRIPT, STR_NULL), SetPadding(0, 5, 4, 5),
688  NWidget(WWT_MATRIX, COLOUR_MAUVE, WID_AIC_GAMELIST), SetMinimalSize(288, 14), SetFill(1, 0), SetMatrixDataTip(1, 1, STR_AI_CONFIG_GAMELIST_TOOLTIP),
689  EndContainer(),
691  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_CHANGE), SetFill(1, 0), SetMinimalSize(93, 12), SetDataTip(STR_AI_CONFIG_CHANGE, STR_AI_CONFIG_CHANGE_TOOLTIP),
692  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_CONFIGURE), SetFill(1, 0), SetMinimalSize(93, 12), SetDataTip(STR_AI_CONFIG_CONFIGURE, STR_AI_CONFIG_CONFIGURE_TOOLTIP),
693  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_CLOSE), SetFill(1, 0), SetMinimalSize(93, 12), SetDataTip(STR_AI_SETTINGS_CLOSE, STR_NULL),
694  EndContainer(),
696  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
697  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
698  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
699  EndContainer(),
700  NWidget(WWT_PUSHTXTBTN, COLOUR_YELLOW, WID_AIC_CONTENT_DOWNLOAD), SetFill(1, 0), SetMinimalSize(279, 12), SetPadding(0, 7, 9, 7), SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
701  EndContainer(),
702 };
703 
706  WDP_CENTER, "settings_script_config", 0, 0,
708  0,
709  _nested_ai_config_widgets, lengthof(_nested_ai_config_widgets)
710 );
711 
715 struct AIConfigWindow : public Window {
719 
720  AIConfigWindow() : Window(&_ai_config_desc)
721  {
722  this->InitNested(WN_GAME_OPTIONS_AI); // Initializes 'this->line_height' as a side effect.
723  this->vscroll = this->GetScrollbar(WID_AIC_SCROLLBAR);
724  this->selected_slot = INVALID_COMPANY;
725  NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_AIC_LIST);
726  this->vscroll->SetCapacity(nwi->current_y / this->line_height);
727  this->vscroll->SetCount(MAX_COMPANIES);
728  this->OnInvalidateData(0);
729  }
730 
731  ~AIConfigWindow()
732  {
735  }
736 
737  virtual void SetStringParameters(int widget) const
738  {
739  switch (widget) {
740  case WID_AIC_NUMBER:
741  SetDParam(0, GetGameSettings().difficulty.max_no_competitors);
742  break;
743  case WID_AIC_CHANGE:
744  switch (selected_slot) {
745  case OWNER_DEITY:
746  SetDParam(0, STR_AI_CONFIG_CHANGE_GAMESCRIPT);
747  break;
748 
749  case INVALID_COMPANY:
750  SetDParam(0, STR_AI_CONFIG_CHANGE_NONE);
751  break;
752 
753  default:
754  SetDParam(0, STR_AI_CONFIG_CHANGE_AI);
755  break;
756  }
757  break;
758  }
759  }
760 
761  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
762  {
763  switch (widget) {
764  case WID_AIC_GAMELIST:
765  this->line_height = FONT_HEIGHT_NORMAL + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
766  size->height = 1 * this->line_height;
767  break;
768 
769  case WID_AIC_LIST:
770  this->line_height = FONT_HEIGHT_NORMAL + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
771  size->height = 8 * this->line_height;
772  break;
773 
774  case WID_AIC_CHANGE: {
775  SetDParam(0, STR_AI_CONFIG_CHANGE_GAMESCRIPT);
776  Dimension dim = GetStringBoundingBox(STR_AI_CONFIG_CHANGE);
777 
778  SetDParam(0, STR_AI_CONFIG_CHANGE_NONE);
779  dim = maxdim(dim, GetStringBoundingBox(STR_AI_CONFIG_CHANGE));
780 
781  SetDParam(0, STR_AI_CONFIG_CHANGE_AI);
782  dim = maxdim(dim, GetStringBoundingBox(STR_AI_CONFIG_CHANGE));
783 
784  dim.width += padding.width;
785  dim.height += padding.height;
786  *size = maxdim(*size, dim);
787  break;
788  }
789  }
790  }
791 
797  static bool IsEditable(CompanyID slot)
798  {
799  if (slot == OWNER_DEITY) return _game_mode != GM_NORMAL || Game::GetInstance() != NULL;
800 
801  if (_game_mode != GM_NORMAL) {
802  return slot > 0 && slot <= GetGameSettings().difficulty.max_no_competitors;
803  }
804  if (Company::IsValidID(slot) || slot < 0) return false;
805 
807  for (CompanyID cid = COMPANY_FIRST; cid < (CompanyID)max_slot && cid < MAX_COMPANIES; cid++) {
808  if (Company::IsValidHumanID(cid)) max_slot++;
809  }
810  return slot < max_slot;
811  }
812 
813  virtual void DrawWidget(const Rect &r, int widget) const
814  {
815  switch (widget) {
816  case WID_AIC_GAMELIST: {
817  StringID text = STR_AI_CONFIG_NONE;
818 
819  if (GameConfig::GetConfig()->GetInfo() != NULL) {
820  SetDParamStr(0, GameConfig::GetConfig()->GetInfo()->GetName());
821  text = STR_JUST_RAW_STRING;
822  }
823 
824  DrawString(r.left + 10, r.right - 10, r.top + WD_MATRIX_TOP, text,
825  (this->selected_slot == OWNER_DEITY) ? TC_WHITE : (IsEditable(OWNER_DEITY) ? TC_ORANGE : TC_SILVER));
826 
827  break;
828  }
829 
830  case WID_AIC_LIST: {
831  int y = r.top;
832  for (int i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < MAX_COMPANIES; i++) {
833  StringID text;
834 
835  if ((_game_mode != GM_NORMAL && i == 0) || (_game_mode == GM_NORMAL && Company::IsValidHumanID(i))) {
836  text = STR_AI_CONFIG_HUMAN_PLAYER;
837  } else if (AIConfig::GetConfig((CompanyID)i)->GetInfo() != NULL) {
838  SetDParamStr(0, AIConfig::GetConfig((CompanyID)i)->GetInfo()->GetName());
839  text = STR_JUST_RAW_STRING;
840  } else {
841  text = STR_AI_CONFIG_RANDOM_AI;
842  }
843  DrawString(r.left + 10, r.right - 10, y + WD_MATRIX_TOP, text,
844  (this->selected_slot == i) ? TC_WHITE : (IsEditable((CompanyID)i) ? TC_ORANGE : TC_SILVER));
845  y += this->line_height;
846  }
847  break;
848  }
849  }
850  }
851 
852  virtual void OnClick(Point pt, int widget, int click_count)
853  {
854  if (widget >= WID_AIC_TEXTFILE && widget < WID_AIC_TEXTFILE + TFT_END) {
855  if (this->selected_slot == INVALID_COMPANY || GetConfig(this->selected_slot) == NULL) return;
856 
857  ShowScriptTextfileWindow((TextfileType)(widget - WID_AIC_TEXTFILE), this->selected_slot);
858  return;
859  }
860 
861  switch (widget) {
862  case WID_AIC_DECREASE:
863  case WID_AIC_INCREASE: {
864  int new_value;
865  if (widget == WID_AIC_DECREASE) {
866  new_value = max(0, GetGameSettings().difficulty.max_no_competitors - 1);
867  } else {
868  new_value = min(MAX_COMPANIES - 1, GetGameSettings().difficulty.max_no_competitors + 1);
869  }
870  IConsoleSetSetting("difficulty.max_no_competitors", new_value);
871  this->InvalidateData();
872  break;
873  }
874 
875  case WID_AIC_GAMELIST: {
876  this->selected_slot = OWNER_DEITY;
877  this->InvalidateData();
878  if (click_count > 1 && this->selected_slot != INVALID_COMPANY && _game_mode != GM_NORMAL) ShowAIListWindow((CompanyID)this->selected_slot);
879  break;
880  }
881 
882  case WID_AIC_LIST: { // Select a slot
883  this->selected_slot = (CompanyID)this->vscroll->GetScrolledRowFromWidget(pt.y, this, widget, 0, this->line_height);
884  this->InvalidateData();
885  if (click_count > 1 && this->selected_slot != INVALID_COMPANY) ShowAIListWindow((CompanyID)this->selected_slot);
886  break;
887  }
888 
889  case WID_AIC_MOVE_UP:
890  if (IsEditable(this->selected_slot) && IsEditable((CompanyID)(this->selected_slot - 1))) {
891  Swap(GetGameSettings().ai_config[this->selected_slot], GetGameSettings().ai_config[this->selected_slot - 1]);
892  this->selected_slot--;
893  this->vscroll->ScrollTowards(this->selected_slot);
894  this->InvalidateData();
895  }
896  break;
897 
898  case WID_AIC_MOVE_DOWN:
899  if (IsEditable(this->selected_slot) && IsEditable((CompanyID)(this->selected_slot + 1))) {
900  Swap(GetGameSettings().ai_config[this->selected_slot], GetGameSettings().ai_config[this->selected_slot + 1]);
901  this->selected_slot++;
902  this->vscroll->ScrollTowards(this->selected_slot);
903  this->InvalidateData();
904  }
905  break;
906 
907  case WID_AIC_CHANGE: // choose other AI
908  ShowAIListWindow((CompanyID)this->selected_slot);
909  break;
910 
911  case WID_AIC_CONFIGURE: // change the settings for an AI
912  ShowAISettingsWindow((CompanyID)this->selected_slot);
913  break;
914 
915  case WID_AIC_CLOSE:
916  delete this;
917  break;
918 
920  if (!_network_available) {
921  ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
922  } else {
923 #if defined(ENABLE_NETWORK)
925 #endif
926  }
927  break;
928  }
929  }
930 
936  virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
937  {
938  if (!IsEditable(this->selected_slot)) {
939  this->selected_slot = INVALID_COMPANY;
940  }
941 
942  if (!gui_scope) return;
943 
944  this->SetWidgetDisabledState(WID_AIC_DECREASE, GetGameSettings().difficulty.max_no_competitors == 0);
945  this->SetWidgetDisabledState(WID_AIC_INCREASE, GetGameSettings().difficulty.max_no_competitors == MAX_COMPANIES - 1);
946  this->SetWidgetDisabledState(WID_AIC_CHANGE, (this->selected_slot == OWNER_DEITY && _game_mode == GM_NORMAL) || this->selected_slot == INVALID_COMPANY);
947  this->SetWidgetDisabledState(WID_AIC_CONFIGURE, this->selected_slot == INVALID_COMPANY || GetConfig(this->selected_slot)->GetConfigList()->size() == 0);
948  this->SetWidgetDisabledState(WID_AIC_MOVE_UP, this->selected_slot == OWNER_DEITY || this->selected_slot == INVALID_COMPANY || !IsEditable((CompanyID)(this->selected_slot - 1)));
949  this->SetWidgetDisabledState(WID_AIC_MOVE_DOWN, this->selected_slot == OWNER_DEITY || this->selected_slot == INVALID_COMPANY || !IsEditable((CompanyID)(this->selected_slot + 1)));
950 
951  for (TextfileType tft = TFT_BEGIN; tft < TFT_END; tft++) {
952  this->SetWidgetDisabledState(WID_AIC_TEXTFILE + tft, this->selected_slot == INVALID_COMPANY || (GetConfig(this->selected_slot)->GetTextfile(tft, this->selected_slot) == NULL));
953  }
954  }
955 };
956 
959 {
961  new AIConfigWindow();
962 }
963 
972 static bool SetScriptButtonColour(NWidgetCore &button, bool dead, bool paused)
973 {
974  /* Dead scripts are indicated with red background and
975  * paused scripts are indicated with yellow background. */
976  Colours colour = dead ? COLOUR_RED :
977  (paused ? COLOUR_YELLOW : COLOUR_GREY);
978  if (button.colour != colour) {
979  button.colour = colour;
980  return true;
981  }
982  return false;
983 }
984 
988 struct AIDebugWindow : public Window {
989  static const int top_offset;
990  static const int bottom_offset;
991 
992  static const uint MAX_BREAK_STR_STRING_LENGTH = 256;
993 
997  bool autoscroll;
999  static bool break_check_enabled;
1000  static char break_string[MAX_BREAK_STR_STRING_LENGTH];
1006 
1007  ScriptLog::LogData *GetLogPointer() const
1008  {
1009  if (ai_debug_company == OWNER_DEITY) return (ScriptLog::LogData *)Game::GetInstance()->GetLogPointer();
1010  return (ScriptLog::LogData *)Company::Get(ai_debug_company)->ai_instance->GetLogPointer();
1011  }
1012 
1017  bool IsDead() const
1018  {
1019  if (ai_debug_company == OWNER_DEITY) {
1020  GameInstance *game = Game::GetInstance();
1021  return game == NULL || game->IsDead();
1022  }
1023  return !Company::IsValidAiID(ai_debug_company) || Company::Get(ai_debug_company)->ai_instance->IsDead();
1024  }
1025 
1031  bool IsValidDebugCompany(CompanyID company) const
1032  {
1033  switch (company) {
1034  case INVALID_COMPANY: return false;
1035  case OWNER_DEITY: return Game::GetInstance() != NULL;
1036  default: return Company::IsValidAiID(company);
1037  }
1038  }
1039 
1045  {
1046  /* Check if the currently selected company is still active. */
1047  if (this->IsValidDebugCompany(ai_debug_company)) return;
1048 
1049  ai_debug_company = INVALID_COMPANY;
1050 
1051  const Company *c;
1052  FOR_ALL_COMPANIES(c) {
1053  if (c->is_ai) {
1054  ChangeToAI(c->index);
1055  return;
1056  }
1057  }
1058 
1059  /* If no AI is available, see if there is a game script. */
1060  if (Game::GetInstance() != NULL) ChangeToAI(OWNER_DEITY);
1061  }
1062 
1068  AIDebugWindow(WindowDesc *desc, WindowNumber number) : Window(desc), break_editbox(MAX_BREAK_STR_STRING_LENGTH)
1069  {
1070  this->CreateNestedTree();
1071  this->vscroll = this->GetScrollbar(WID_AID_SCROLLBAR);
1072  this->show_break_box = _settings_client.gui.ai_developer_tools;
1073  this->GetWidget<NWidgetStacked>(WID_AID_BREAK_STRING_WIDGETS)->SetDisplayedPlane(this->show_break_box ? 0 : SZSP_HORIZONTAL);
1074  this->FinishInitNested(number);
1075 
1076  if (!this->show_break_box) break_check_enabled = false;
1077 
1078  this->last_vscroll_pos = 0;
1079  this->autoscroll = true;
1080  this->highlight_row = -1;
1081 
1082  this->querystrings[WID_AID_BREAK_STR_EDIT_BOX] = &this->break_editbox;
1083 
1085 
1086  /* Restore the break string value from static variable */
1087  this->break_editbox.text.Assign(this->break_string);
1088 
1089  this->SelectValidDebugCompany();
1090  this->InvalidateData(-1);
1091  }
1092 
1093  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
1094  {
1095  if (widget == WID_AID_LOG_PANEL) {
1096  resize->height = FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
1097  size->height = 14 * resize->height + this->top_offset + this->bottom_offset;
1098  }
1099  }
1100 
1101  virtual void OnPaint()
1102  {
1103  this->SelectValidDebugCompany();
1104 
1105  /* Draw standard stuff */
1106  this->DrawWidgets();
1107 
1108  if (this->IsShaded()) return; // Don't draw anything when the window is shaded.
1109 
1110  bool dirty = false;
1111 
1112  /* Paint the company icons */
1113  for (CompanyID i = COMPANY_FIRST; i < MAX_COMPANIES; i++) {
1114  NWidgetCore *button = this->GetWidget<NWidgetCore>(i + WID_AID_COMPANY_BUTTON_START);
1115 
1116  bool valid = Company::IsValidAiID(i);
1117 
1118  /* Check whether the validity of the company changed */
1119  dirty |= (button->IsDisabled() == valid);
1120 
1121  /* Mark dead/paused AIs by setting the background colour. */
1122  bool dead = valid && Company::Get(i)->ai_instance->IsDead();
1123  bool paused = valid && Company::Get(i)->ai_instance->IsPaused();
1124  /* Re-paint if the button was updated.
1125  * (note that it is intentional that SetScriptButtonColour is always called) */
1126  dirty |= SetScriptButtonColour(*button, dead, paused);
1127 
1128  /* Draw company icon only for valid AI companies */
1129  if (!valid) continue;
1130 
1131  byte offset = (i == ai_debug_company) ? 1 : 0;
1132  DrawCompanyIcon(i, button->pos_x + button->current_x / 2 - 7 + offset, this->GetWidget<NWidgetBase>(WID_AID_COMPANY_BUTTON_START + i)->pos_y + 2 + offset);
1133  }
1134 
1135  /* Set button colour for Game Script. */
1136  GameInstance *game = Game::GetInstance();
1137  bool valid = game != NULL;
1138  bool dead = valid && game->IsDead();
1139  bool paused = valid && game->IsPaused();
1140 
1141  NWidgetCore *button = this->GetWidget<NWidgetCore>(WID_AID_SCRIPT_GAME);
1142  dirty |= (button->IsDisabled() == valid) || SetScriptButtonColour(*button, dead, paused);
1143 
1144  if (dirty) this->InvalidateData(-1);
1145 
1146  /* If there are no active companies, don't display anything else. */
1147  if (ai_debug_company == INVALID_COMPANY) return;
1148 
1149  ScriptLog::LogData *log = this->GetLogPointer();
1150 
1151  int scroll_count = (log == NULL) ? 0 : log->used;
1152  if (this->vscroll->GetCount() != scroll_count) {
1153  this->vscroll->SetCount(scroll_count);
1154 
1155  /* We need a repaint */
1157  }
1158 
1159  if (log == NULL) return;
1160 
1161  /* Detect when the user scrolls the window. Enable autoscroll when the
1162  * bottom-most line becomes visible. */
1163  if (this->last_vscroll_pos != this->vscroll->GetPosition()) {
1164  this->autoscroll = this->vscroll->GetPosition() >= log->used - this->vscroll->GetCapacity();
1165  }
1166  if (this->autoscroll) {
1167  int scroll_pos = max(0, log->used - this->vscroll->GetCapacity());
1168  if (scroll_pos != this->vscroll->GetPosition()) {
1169  this->vscroll->SetPosition(scroll_pos);
1170 
1171  /* We need a repaint */
1174  }
1175  }
1176  this->last_vscroll_pos = this->vscroll->GetPosition();
1177  }
1178 
1179  virtual void SetStringParameters(int widget) const
1180  {
1181  switch (widget) {
1182  case WID_AID_NAME_TEXT:
1183  if (ai_debug_company == OWNER_DEITY) {
1184  const GameInfo *info = Game::GetInfo();
1185  assert(info != NULL);
1186  SetDParam(0, STR_AI_DEBUG_NAME_AND_VERSION);
1187  SetDParamStr(1, info->GetName());
1188  SetDParam(2, info->GetVersion());
1189  } else if (ai_debug_company == INVALID_COMPANY || !Company::IsValidAiID(ai_debug_company)) {
1190  SetDParam(0, STR_EMPTY);
1191  } else {
1192  const AIInfo *info = Company::Get(ai_debug_company)->ai_info;
1193  assert(info != NULL);
1194  SetDParam(0, STR_AI_DEBUG_NAME_AND_VERSION);
1195  SetDParamStr(1, info->GetName());
1196  SetDParam(2, info->GetVersion());
1197  }
1198  break;
1199  }
1200  }
1201 
1202  virtual void DrawWidget(const Rect &r, int widget) const
1203  {
1204  if (ai_debug_company == INVALID_COMPANY) return;
1205 
1206  switch (widget) {
1207  case WID_AID_LOG_PANEL: {
1208  ScriptLog::LogData *log = this->GetLogPointer();
1209  if (log == NULL) return;
1210 
1211  int y = this->top_offset;
1212  for (int i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < log->used; i++) {
1213  int pos = (i + log->pos + 1 - log->used + log->count) % log->count;
1214  if (log->lines[pos] == NULL) break;
1215 
1216  TextColour colour;
1217  switch (log->type[pos]) {
1218  case ScriptLog::LOG_SQ_INFO: colour = TC_BLACK; break;
1219  case ScriptLog::LOG_SQ_ERROR: colour = TC_RED; break;
1220  case ScriptLog::LOG_INFO: colour = TC_BLACK; break;
1221  case ScriptLog::LOG_WARNING: colour = TC_YELLOW; break;
1222  case ScriptLog::LOG_ERROR: colour = TC_RED; break;
1223  default: colour = TC_BLACK; break;
1224  }
1225 
1226  /* Check if the current line should be highlighted */
1227  if (pos == this->highlight_row) {
1228  GfxFillRect(r.left + 1, r.top + y, r.right - 1, r.top + y + this->resize.step_height - WD_PAR_VSEP_NORMAL, PC_BLACK);
1229  if (colour == TC_BLACK) colour = TC_WHITE; // Make black text readable by inverting it to white.
1230  }
1231 
1232  DrawString(r.left + 7, r.right - 7, r.top + y, log->lines[pos], colour, SA_LEFT | SA_FORCE);
1233  y += this->resize.step_height;
1234  }
1235  break;
1236  }
1237  }
1238  }
1239 
1244  void ChangeToAI(CompanyID show_ai)
1245  {
1246  if (!this->IsValidDebugCompany(show_ai)) return;
1247 
1248  ai_debug_company = show_ai;
1249 
1250  this->highlight_row = -1; // The highlight of one AI make little sense for another AI.
1251 
1252  /* Close AI settings window to prevent confusion */
1254 
1255  this->InvalidateData(-1);
1256 
1257  this->autoscroll = true;
1258  this->last_vscroll_pos = this->vscroll->GetPosition();
1259  }
1260 
1261  virtual void OnClick(Point pt, int widget, int click_count)
1262  {
1263  /* Also called for hotkeys, so check for disabledness */
1264  if (this->IsWidgetDisabled(widget)) return;
1265 
1266  /* Check which button is clicked */
1268  ChangeToAI((CompanyID)(widget - WID_AID_COMPANY_BUTTON_START));
1269  }
1270 
1271  switch (widget) {
1272  case WID_AID_SCRIPT_GAME:
1273  ChangeToAI(OWNER_DEITY);
1274  break;
1275 
1276  case WID_AID_RELOAD_TOGGLE:
1277  if (ai_debug_company == OWNER_DEITY) break;
1278  /* First kill the company of the AI, then start a new one. This should start the current AI again */
1279  DoCommandP(0, 2 | ai_debug_company << 16, CRR_MANUAL, CMD_COMPANY_CTRL);
1280  DoCommandP(0, 1 | ai_debug_company << 16, 0, CMD_COMPANY_CTRL);
1281  break;
1282 
1283  case WID_AID_SETTINGS:
1284  ShowAISettingsWindow(ai_debug_company);
1285  break;
1286 
1288  this->break_check_enabled = !this->break_check_enabled;
1289  this->InvalidateData(-1);
1290  break;
1291 
1293  this->case_sensitive_break_check = !this->case_sensitive_break_check;
1294  this->InvalidateData(-1);
1295  break;
1296 
1297  case WID_AID_CONTINUE_BTN:
1298  /* Unpause current AI / game script and mark the corresponding script button dirty. */
1299  if (!this->IsDead()) {
1300  if (ai_debug_company == OWNER_DEITY) {
1301  Game::Unpause();
1302  } else {
1303  AI::Unpause(ai_debug_company);
1304  }
1305  }
1306 
1307  /* If the last AI/Game Script is unpaused, unpause the game too. */
1308  if ((_pause_mode & PM_PAUSED_NORMAL) == PM_PAUSED_NORMAL) {
1309  bool all_unpaused = !Game::IsPaused();
1310  if (all_unpaused) {
1311  Company *c;
1312  FOR_ALL_COMPANIES(c) {
1313  if (c->is_ai && AI::IsPaused(c->index)) {
1314  all_unpaused = false;
1315  break;
1316  }
1317  }
1318  if (all_unpaused) {
1319  /* All scripts have been unpaused => unpause the game. */
1320  DoCommandP(0, PM_PAUSED_NORMAL, 0, CMD_PAUSE);
1321  }
1322  }
1323  }
1324 
1325  this->highlight_row = -1;
1326  this->InvalidateData(-1);
1327  break;
1328  }
1329  }
1330 
1331  virtual void OnEditboxChanged(int wid)
1332  {
1333  if (wid == WID_AID_BREAK_STR_EDIT_BOX) {
1334  /* Save the current string to static member so it can be restored next time the window is opened. */
1335  strecpy(this->break_string, this->break_editbox.text.buf, lastof(this->break_string));
1336  break_string_filter.SetFilterTerm(this->break_string);
1337  }
1338  }
1339 
1346  virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
1347  {
1348  /* If the log message is related to the active company tab, check the break string.
1349  * This needs to be done in gameloop-scope, so the AI is suspended immediately. */
1350  if (!gui_scope && data == ai_debug_company && this->IsValidDebugCompany(ai_debug_company) && this->break_check_enabled && !this->break_string_filter.IsEmpty()) {
1351  /* Get the log instance of the active company */
1352  ScriptLog::LogData *log = this->GetLogPointer();
1353 
1354  if (log != NULL) {
1355  this->break_string_filter.ResetState();
1356  this->break_string_filter.AddLine(log->lines[log->pos]);
1357  if (this->break_string_filter.GetState()) {
1358  /* Pause execution of script. */
1359  if (!this->IsDead()) {
1360  if (ai_debug_company == OWNER_DEITY) {
1361  Game::Pause();
1362  } else {
1363  AI::Pause(ai_debug_company);
1364  }
1365  }
1366 
1367  /* Pause the game. */
1369  DoCommandP(0, PM_PAUSED_NORMAL, 1, CMD_PAUSE);
1370  }
1371 
1372  /* Highlight row that matched */
1373  this->highlight_row = log->pos;
1374  }
1375  }
1376  }
1377 
1378  if (!gui_scope) return;
1379 
1380  this->SelectValidDebugCompany();
1381 
1382  ScriptLog::LogData *log = ai_debug_company != INVALID_COMPANY ? this->GetLogPointer() : NULL;
1383  this->vscroll->SetCount((log == NULL) ? 0 : log->used);
1384 
1385  /* Update company buttons */
1386  for (CompanyID i = COMPANY_FIRST; i < MAX_COMPANIES; i++) {
1388  this->SetWidgetLoweredState(i + WID_AID_COMPANY_BUTTON_START, ai_debug_company == i);
1389  }
1390 
1392  this->SetWidgetLoweredState(WID_AID_SCRIPT_GAME, ai_debug_company == OWNER_DEITY);
1393 
1394  this->SetWidgetLoweredState(WID_AID_BREAK_STR_ON_OFF_BTN, this->break_check_enabled);
1395  this->SetWidgetLoweredState(WID_AID_MATCH_CASE_BTN, this->case_sensitive_break_check);
1396 
1397  this->SetWidgetDisabledState(WID_AID_SETTINGS, ai_debug_company == INVALID_COMPANY);
1398  this->SetWidgetDisabledState(WID_AID_RELOAD_TOGGLE, ai_debug_company == INVALID_COMPANY || ai_debug_company == OWNER_DEITY);
1399  this->SetWidgetDisabledState(WID_AID_CONTINUE_BTN, ai_debug_company == INVALID_COMPANY ||
1400  (ai_debug_company == OWNER_DEITY ? !Game::IsPaused() : !AI::IsPaused(ai_debug_company)));
1401  }
1402 
1403  virtual void OnResize()
1404  {
1405  this->vscroll->SetCapacityFromWidget(this, WID_AID_LOG_PANEL);
1406  }
1407 
1408  static HotkeyList hotkeys;
1409 };
1410 
1414 char AIDebugWindow::break_string[MAX_BREAK_STR_STRING_LENGTH] = "";
1417 StringFilter AIDebugWindow::break_string_filter(&AIDebugWindow::case_sensitive_break_check);
1418 
1421 {
1422  return MakeCompanyButtonRows(biggest_index, WID_AID_COMPANY_BUTTON_START, WID_AID_COMPANY_BUTTON_END, 8, STR_AI_DEBUG_SELECT_AI_TOOLTIP);
1423 }
1424 
1431 {
1432  if (_game_mode != GM_NORMAL) return ES_NOT_HANDLED;
1434  if (w == NULL) return ES_NOT_HANDLED;
1435  return w->OnHotkey(hotkey);
1436 }
1437 
1438 static Hotkey aidebug_hotkeys[] = {
1439  Hotkey('1', "company_1", WID_AID_COMPANY_BUTTON_START),
1440  Hotkey('2', "company_2", WID_AID_COMPANY_BUTTON_START + 1),
1441  Hotkey('3', "company_3", WID_AID_COMPANY_BUTTON_START + 2),
1442  Hotkey('4', "company_4", WID_AID_COMPANY_BUTTON_START + 3),
1443  Hotkey('5', "company_5", WID_AID_COMPANY_BUTTON_START + 4),
1444  Hotkey('6', "company_6", WID_AID_COMPANY_BUTTON_START + 5),
1445  Hotkey('7', "company_7", WID_AID_COMPANY_BUTTON_START + 6),
1446  Hotkey('8', "company_8", WID_AID_COMPANY_BUTTON_START + 7),
1447  Hotkey('9', "company_9", WID_AID_COMPANY_BUTTON_START + 8),
1448  Hotkey((uint16)0, "company_10", WID_AID_COMPANY_BUTTON_START + 9),
1449  Hotkey((uint16)0, "company_11", WID_AID_COMPANY_BUTTON_START + 10),
1450  Hotkey((uint16)0, "company_12", WID_AID_COMPANY_BUTTON_START + 11),
1451  Hotkey((uint16)0, "company_13", WID_AID_COMPANY_BUTTON_START + 12),
1452  Hotkey((uint16)0, "company_14", WID_AID_COMPANY_BUTTON_START + 13),
1453  Hotkey((uint16)0, "company_15", WID_AID_COMPANY_BUTTON_START + 14),
1454  Hotkey('S', "settings", WID_AID_SETTINGS),
1455  Hotkey('0', "game_script", WID_AID_SCRIPT_GAME),
1456  Hotkey((uint16)0, "reload", WID_AID_RELOAD_TOGGLE),
1457  Hotkey('B', "break_toggle", WID_AID_BREAK_STR_ON_OFF_BTN),
1458  Hotkey('F', "break_string", WID_AID_BREAK_STR_EDIT_BOX),
1459  Hotkey('C', "match_case", WID_AID_MATCH_CASE_BTN),
1460  Hotkey(WKC_RETURN, "continue", WID_AID_CONTINUE_BTN),
1461  HOTKEY_LIST_END
1462 };
1463 HotkeyList AIDebugWindow::hotkeys("aidebug", aidebug_hotkeys, AIDebugGlobalHotkeys);
1464 
1468  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1469  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_AI_DEBUG, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1470  NWidget(WWT_SHADEBOX, COLOUR_GREY),
1471  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1472  NWidget(WWT_STICKYBOX, COLOUR_GREY),
1473  EndContainer(),
1474  NWidget(WWT_PANEL, COLOUR_GREY, WID_AID_VIEW),
1476  EndContainer(),
1478  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_AID_SCRIPT_GAME), SetMinimalSize(100, 20), SetResize(1, 0), SetDataTip(STR_AI_GAME_SCRIPT, STR_AI_GAME_SCRIPT_TOOLTIP),
1479  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_AID_NAME_TEXT), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_JUST_STRING, STR_AI_DEBUG_NAME_TOOLTIP),
1480  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_AID_SETTINGS), SetMinimalSize(100, 20), SetDataTip(STR_AI_DEBUG_SETTINGS, STR_AI_DEBUG_SETTINGS_TOOLTIP),
1481  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_AID_RELOAD_TOGGLE), SetMinimalSize(100, 20), SetDataTip(STR_AI_DEBUG_RELOAD, STR_AI_DEBUG_RELOAD_TOOLTIP),
1482  EndContainer(),
1485  /* Log panel */
1487  EndContainer(),
1488  /* Break string widgets */
1491  NWidget(WWT_IMGBTN_2, COLOUR_GREY, WID_AID_BREAK_STR_ON_OFF_BTN), SetFill(0, 1), SetDataTip(SPR_FLAG_VEH_STOPPED, STR_AI_DEBUG_BREAK_STR_ON_OFF_TOOLTIP),
1492  NWidget(WWT_PANEL, COLOUR_GREY),
1494  NWidget(WWT_LABEL, COLOUR_GREY), SetPadding(2, 2, 2, 4), SetDataTip(STR_AI_DEBUG_BREAK_ON_LABEL, 0x0),
1495  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_AID_BREAK_STR_EDIT_BOX), SetFill(1, 1), SetResize(1, 0), SetPadding(2, 2, 2, 2), SetDataTip(STR_AI_DEBUG_BREAK_STR_OSKTITLE, STR_AI_DEBUG_BREAK_STR_TOOLTIP),
1496  EndContainer(),
1497  EndContainer(),
1498  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_AID_MATCH_CASE_BTN), SetMinimalSize(100, 0), SetFill(0, 1), SetDataTip(STR_AI_DEBUG_MATCH_CASE, STR_AI_DEBUG_MATCH_CASE_TOOLTIP),
1499  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_AID_CONTINUE_BTN), SetMinimalSize(100, 0), SetFill(0, 1), SetDataTip(STR_AI_DEBUG_CONTINUE, STR_AI_DEBUG_CONTINUE_TOOLTIP),
1500  EndContainer(),
1501  EndContainer(),
1502  EndContainer(),
1504  NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_AID_SCROLLBAR),
1505  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1506  EndContainer(),
1507  EndContainer(),
1508 };
1509 
1511 static WindowDesc _ai_debug_desc(
1512  WDP_AUTO, "script_debug", 600, 450,
1514  0,
1515  _nested_ai_debug_widgets, lengthof(_nested_ai_debug_widgets),
1516  &AIDebugWindow::hotkeys
1517 );
1518 
1524 {
1525  if (!_networking || _network_server) {
1527  if (w == NULL) w = new AIDebugWindow(&_ai_debug_desc, 0);
1528  if (show_company != INVALID_COMPANY) w->ChangeToAI(show_company);
1529  return w;
1530  } else {
1531  ShowErrorMessage(STR_ERROR_AI_DEBUG_SERVER_ONLY, INVALID_STRING_ID, WL_INFO);
1532  }
1533 
1534  return NULL;
1535 }
1536 
1541 {
1542  AIDebugWindow::ai_debug_company = INVALID_COMPANY;
1543 }
1544 
1547 {
1548  /* Network clients can't debug AIs. */
1549  if (_networking && !_network_server) return;
1550 
1551  Company *c;
1552  FOR_ALL_COMPANIES(c) {
1553  if (c->is_ai && c->ai_instance->IsDead()) {
1555  break;
1556  }
1557  }
1558 
1560  if (g != NULL && g->IsDead()) {
1562  }
1563 }
EventState
State of handling an event.
Definition: window_type.h:701
Colours colour
Colour of this widget.
Definition: widget_type.h:303
static void Swap(T &a, T &b)
Type safe swap operation.
Definition: math_func.hpp:277
int GetVersion() const
Get the version of the script.
Definition: script_info.hpp:74
used in multiplayer to create a new companies etc.
Definition: command_type.h:279
This setting will only be visible when the Script development tools are active.
bool _networking
are we in networking mode?
Definition: network.cpp:56
The row of company buttons.
Definition: ai_widget.h:57
void RebuildVisibleSettings()
Rebuilds the list of visible settings.
Definition: ai_gui.cpp:333
bool autoscroll
Whether automatically scrolling should be enabled or not.
Definition: ai_gui.cpp:997
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
Open AI readme, changelog (+1) or license (+2).
Definition: ai_widget.h:51
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition: window.cpp:590
Scrollbar * vscroll
Cache of the vertical scrollbar.
Definition: ai_gui.cpp:718
Enable breaking on string.
Definition: ai_widget.h:67
void ScrollTowards(int position)
Scroll towards the given position; if the item is visible nothing happens, otherwise it will be shown...
Definition: widget_type.h:731
bool Contains(const T &key) const
Tests whether a key is assigned in this map.
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:930
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition: ai_gui.cpp:223
ScriptConfig * ai_config
The configuration we&#39;re modifying.
Definition: ai_gui.cpp:284
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:112
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:387
A game normally paused.
Definition: openttd.h:59
Offset at right of a matrix cell.
Definition: window_gui.h:79
static bool SetScriptButtonColour(NWidgetCore &button, bool dead, bool paused)
Set the widget colour of a button based on the state of the script.
Definition: ai_gui.cpp:972
static bool break_check_enabled
Stop an AI when it prints a matching string.
Definition: ai_gui.cpp:999
A normal unpaused game.
Definition: openttd.h:58
static void ShowAIListWindow(CompanyID slot)
Open the AI list window to chose an AI for the given company slot.
Definition: ai_gui.cpp:273
static NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
Definition: widget_type.h:1146
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:448
virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
Definition: ai_gui.cpp:555
virtual void OnDropdownSelect(int widget, int index)
A dropdown option associated to this window has been selected.
Definition: ai_gui.cpp:544
virtual void OnPaint()
The window must be repainted.
Definition: ai_gui.cpp:423
All data for a single hotkey.
Definition: hotkeys.h:24
High level window description.
Definition: window_gui.h:168
(Toggle) Button with diff image when clicked
Definition: widget_type.h:53
static void Unpause(CompanyID company)
Resume execution of the AI.
Definition: ai_core.cpp:131
const Pair * Find(const T &key) const
Finds given key in this map.
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:604
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
Checkbox to use match caching or not.
Definition: ai_widget.h:69
static bool IsInsideMM(const T x, const uint min, const uint max)
Checks if a value is in an interval.
Definition: math_func.hpp:266
Centered label.
Definition: widget_type.h:57
Reset button.
Definition: ai_widget.h:34
Scrollbar data structure.
Definition: widget_type.h:589
const char * GetTextfile(TextfileType type, CompanyID slot) const
Search a textfile file next to this script.
Window for configuring the AIs
const ScriptConfigItemList * GetConfigList()
Get the config list for this ScriptConfig.
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:577
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
Scrollbar * vscroll
Cache of the vertical scrollbar.
Definition: ai_gui.cpp:1005
Normal amount of vertical space between two paragraphs of text.
Definition: window_gui.h:139
textfile; Window numbers:
Definition: window_type.h:182
Horizontal container.
Definition: widget_type.h:75
void ResetState()
Reset the matching state to process a new item.
The passed event is not handled.
Definition: window_type.h:703
Arrow to the right or in case of RTL to the left.
Definition: widget_type.h:38
Arrow to the left or in case of RTL to the right.
Definition: widget_type.h:37
int redraw_timer
Timer for redrawing the window, otherwise it&#39;ll happen every tick.
Definition: ai_gui.cpp:995
void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets,...)
Sets the enabled/disabled status of a list of widgets.
Definition: window.cpp:516
int min_value
The minimal value this configuration setting can have.
const char * GetName() const
Get the Name of the script.
Definition: script_info.hpp:59
bool GetState() const
Get the matching state of the current item.
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition: misc_gui.cpp:1065
Select another AI button.
Definition: ai_widget.h:48
static const NWidgetPart _nested_ai_settings_widgets[]
Widgets for the AI settings window.
Definition: ai_gui.cpp:591
static CompanyID ai_debug_company
The AI that is (was last) being debugged.
Definition: ai_gui.cpp:994
static const int top_offset
Offset of the text at the top of the WID_AID_LOG_PANEL.
Definition: ai_gui.cpp:989
std::map< const char *, class ScriptInfo *, StringCompare > ScriptInfoList
A list that maps AI names to their AIInfo object.
Definition: ai.hpp:21
CompanyID slot
The company we&#39;re selecting a new Script for.
Definition: ai_gui.cpp:62
The company is manually removed.
Definition: company_type.h:60
Reload button.
Definition: ai_widget.h:61
static bool IsPaused(CompanyID company)
Checks if the AI is paused.
Definition: ai_core.cpp:139
virtual void OnQueryTextFinished(char *str)
The query window opened from this window has closed.
Definition: ai_gui.cpp:532
void ChangeAI()
Changes the AI of the current slot.
Definition: ai_gui.cpp:171
CompanyID slot
View the textfile of this CompanyID slot.
Definition: ai_gui.cpp:632
a textbox for typing
Definition: widget_type.h:71
static void Pause(CompanyID company)
Suspend the AI and then pause execution of the script.
Definition: ai_core.cpp:118
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:68
void DrawCompanyIcon(CompanyID c, int x, int y)
Draw the icon of a company.
void SetPosition(int position)
Sets the position of the first visible element.
Definition: widget_type.h:701
void ShowNetworkContentListWindow(ContentVector *cv=NULL, ContentType type1=CONTENT_TYPE_END, ContentType type2=CONTENT_TYPE_END)
Show the content list window with a given set of content.
NewGRF changelog.
Definition: textfile_type.h:20
LabelMapping * labels
Text labels for the integer values.
Settings button.
Definition: ai_widget.h:59
void Change(const char *name, int version=-1, bool force_exact_match=false, bool is_random=false)
Set another Script to be loaded in this slot.
int highlight_row
The output row that matches the given string, or -1.
Definition: ai_gui.cpp:1004
void InitializeAIGui()
Reset the AI windows to their initial state.
Definition: ai_gui.cpp:1540
DifficultySettings difficulty
settings related to the difficulty
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
static WindowDesc _ai_list_desc(WDP_CENTER, "settings_script_list", 200, 234, WC_AI_LIST, WC_NONE, 0, _nested_ai_list_widgets, lengthof(_nested_ai_list_widgets))
Window definition for the ai list window.
Move up button.
Definition: ai_widget.h:46
Subdirectory for all game scripts.
Definition: fileio_type.h:123
Scrollbar next to the AI list.
Definition: ai_widget.h:22
Close box (at top-left of a window)
Definition: widget_type.h:69
Offset at top of a matrix cell.
Definition: window_gui.h:80
bool IsValidDebugCompany(CompanyID company) const
Check whether a company is a valid AI company or GS.
Definition: ai_gui.cpp:1031
int max_value
The maximal value this configuration setting can have.
void ShowAIConfigWindow()
Open the AI config window.
Definition: ai_gui.cpp:958
static const ScriptInfoList * GetUniqueInfoList()
Wrapper function for GameScanner::GetUniqueInfoList.
Definition: game_core.cpp:236
static const int bottom_offset
Offset of the text at the bottom of the WID_AID_LOG_PANEL.
Definition: ai_gui.cpp:990
static NWidgetPart SetMinimalTextLines(uint8 lines, uint8 spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
Definition: widget_type.h:965
String filter and state.
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
Number of AIs.
Definition: ai_widget.h:42
virtual void SetStringParameters(int widget) const
Initialize string parameters for a widget.
Definition: ai_gui.cpp:319
Script settings.
Scrollbar to scroll through all settings.
Definition: ai_widget.h:32
virtual void SetStringParameters(int widget) const
Initialize string parameters for a widget.
Definition: ai_gui.cpp:100
int last_vscroll_pos
Last position of the scrolling.
Definition: ai_gui.cpp:996
The AIInstance tracks an AI.
static GameConfig * GetConfig(ScriptSettingSource source=SSS_DEFAULT)
Get the config of a company.
Definition: game_config.cpp:20
static EventState AIDebugGlobalHotkeys(int hotkey)
Handler for global hotkeys of the AIDebugWindow.
Definition: ai_gui.cpp:1430
void ShowAIDebugWindowIfAIError()
Open the AI debug window if one of the AI scripts has crashed.
Definition: ai_gui.cpp:1546
NewGRF readme.
Definition: textfile_type.h:19
AI debug window; Window numbers:
Definition: window_type.h:658
Scrollbar of the log panel.
Definition: ai_widget.h:63
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:26
void SelectValidDebugCompany()
Ensure that ai_debug_company refers to a valid AI company or GS, or is set to INVALID_COMPANY.
Definition: ai_gui.cpp:1044
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: ai_gui.cpp:185
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: ai_gui.cpp:348
All static information from an Game like name, version, etc.
Definition: game_info.hpp:18
int clicked_button
The button we clicked.
Definition: ai_gui.cpp:285
AI settings.
Definition: window_type.h:17
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1804
void * GetLogPointer()
Get the log pointer of this script.
Pure simple text.
Definition: widget_type.h:58
bool IsDisabled() const
Return whether the widget is disabled.
Definition: widget_type.h:358
Last possible button in the VIEW.
Definition: ai_widget.h:65
Window that let you choose an available AI.
Definition: ai_gui.cpp:59
Cancel button.
Definition: ai_widget.h:25
NWidgetBase * MakeCompanyButtonRows(int *biggest_index, int widget_first, int widget_last, int max_length, StringID button_tooltip)
Make a number of rows with button-like graphics, for enabling/disabling each company.
Definition: widget.cpp:2864
Panel to draw the settings on.
Definition: ai_widget.h:31
static bool IsValidHumanID(size_t index)
Is this company a valid company, not controlled by a NoAI program?
Definition: company_base.h:144
Accept button.
Definition: ai_widget.h:33
bool _network_available
is network mode available?
Definition: network.cpp:58
void SetCapacity(int capacity)
Set the capacity of visible elements.
Definition: widget_type.h:686
T * Append(uint to_add=1)
Append an item and return it.
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:670
Force the alignment, i.e. don&#39;t swap for RTL languages.
Definition: gfx_func.h:110
Move down button.
Definition: ai_widget.h:47
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:910
NewGRF license.
Definition: textfile_type.h:21
The object is owned by a superuser / goal script.
Definition: company_type.h:29
Data structure for an opened window.
Definition: window_gui.h:271
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1820
static NWidgetPart SetMatrixDataTip(uint8 cols, uint8 rows, StringID tip)
Widget part function for setting the data and tooltip of WWT_MATRIX widgets.
Definition: widget_type.h:1032
void SetFilterTerm(const char *str)
Set the term to filter on.
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1046
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:3238
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1833
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=NULL, uint textref_stack_size=0, const uint32 *textref_stack=NULL)
Display an error message in a window.
Definition: error_gui.cpp:378
class ScriptInfo * GetInfo() const
Get the ScriptInfo linked to this ScriptConfig.
Runtime information about a game script like a pointer to the squirrel vm and the current state...
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:279
The content consists of a game script.
Definition: tcp_content.h:35
bool closing_dropdown
True, if the dropdown list is currently closing.
Definition: ai_gui.cpp:288
Download content button.
Definition: ai_widget.h:52
Only numeric ones.
Definition: string_type.h:28
uint8 valid
Bits indicating what variable is valid (for each bit, 0 is invalid, 1 is valid).
Invisible widget that takes some space.
Definition: widget_type.h:79
CompanyID slot
The currently show company&#39;s setting.
Definition: ai_gui.cpp:283
Offset at bottom of a matrix cell.
Definition: window_gui.h:81
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:65
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:1959
uint pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:178
Name of the current selected.
Definition: ai_widget.h:58
Panel where the log is in.
Definition: ai_widget.h:62
int line_height
Height of a row in the matrix widget.
Definition: ai_gui.cpp:63
bool complete_labels
True if all values have a label.
static WindowDesc _ai_config_desc(WDP_CENTER, "settings_script_config", 0, 0, WC_GAME_OPTIONS, WC_NONE, 0, _nested_ai_config_widgets, lengthof(_nested_ai_config_widgets))
Window definition for the configure AI window.
static bool IsPaused()
Checks if the Game Script is paused.
Definition: game_core.cpp:129
AISettingsWindow(WindowDesc *desc, CompanyID slot)
Constructor for the window.
Definition: ai_gui.cpp:301
static bool IsValidAiID(size_t index)
Is this company a valid company, controlled by the computer (a NoAI program)?
Definition: company_base.h:132
bool HasScript() const
Is this config attached to an Script? In other words, is there a Script that is assigned to this slot...
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:175
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:323
All static information from an Script like name, version, etc.
Definition: script_info.hpp:32
virtual void SetStringParameters(int widget) const
Initialize string parameters for a widget.
Definition: ai_gui.cpp:1179
virtual void OnResize()
Called after the window got resized.
Definition: ai_gui.cpp:213
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:180
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1014
Simple vector template class, with automatic delete.
Data stored about a string that can be modified in the GUI.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:76
Display plane with zero size vertically, and filling and resizing horizontally.
Definition: widget_type.h:389
int line_height
Height of a single AI-name line.
Definition: ai_gui.cpp:717
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:947
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:247
static const NWidgetPart _nested_ai_debug_widgets[]
Widgets for the AI debug window.
Definition: ai_gui.cpp:1466
List of hotkeys for a window.
Definition: hotkeys.h:42
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
First company, same as owner.
Definition: company_type.h:24
Simple depressed panel.
Definition: widget_type.h:50
AIDebugWindow(WindowDesc *desc, WindowNumber number)
Constructor for the window.
Definition: ai_gui.cpp:1068
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition: ai_gui.cpp:1346
int selected
The currently selected Script.
Definition: ai_gui.cpp:61
void DeleteChildWindows(WindowClass wc=WC_INVALID) const
Delete all children a window might have in a head-recursive manner.
Definition: window.cpp:1047
Buttons in the VIEW.
Definition: ai_widget.h:64
bool IsWidgetDisabled(byte widget_index) const
Gets the enabled/disabled status of a widget.
Definition: window_gui.h:416
Window to configure which AIs will start.
Definition: ai_gui.cpp:715
static const NWidgetPart _nested_ai_config_widgets[]
Widgets for the configure AI window.
Definition: ai_gui.cpp:662
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: ai_gui.cpp:1202
static AIConfig * GetConfig(CompanyID company, ScriptSettingSource source=SSS_DEFAULT)
Get the config of a company.
Definition: ai_config.cpp:38
Edit box for the string to break on.
Definition: ai_widget.h:68
uint step_height
Step-size of height resize changes.
Definition: window_gui.h:220
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:307
QueryString break_editbox
Break editbox.
Definition: ai_gui.cpp:1001
Offset at left of a matrix cell.
Definition: window_gui.h:78
static StringFilter break_string_filter
Log filter for break.
Definition: ai_gui.cpp:1002
Frame.
Definition: widget_type.h:60
bool clicked_dropdown
Whether the dropdown is open.
Definition: ai_gui.cpp:287
Center the window.
Definition: window_gui.h:157
int clicked_row
The clicked row of settings.
Definition: ai_gui.cpp:290
bool is_ai
If true, the company is (also) controlled by the computer (a NoAI program).
Definition: company_base.h:94
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1114
Window for settings the parameters of an AI.
Definition: ai_gui.cpp:282
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
Baseclass for nested widgets.
Definition: widget_type.h:126
Panel to draw some AI information on.
Definition: ai_widget.h:23
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:499
Window with everything an AI prints via ScriptLog.
Definition: ai_gui.cpp:988
static class GameInstance * GetInstance()
Get the current active instance.
Definition: game.hpp:113
Right offset of the text of the frame.
Definition: window_gui.h:73
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:527
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
const char * GetURL() const
Get the website for this script.
Definition: script_info.hpp:89
PauseModeByte _pause_mode
The current pause mode.
Definition: gfx.cpp:48
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:16
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition: ai_gui.cpp:584
Grid of rows and columns.
Definition: widget_type.h:59
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
uint pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:177
NWidgetBase * MakeCompanyButtonRowsAIDebug(int *biggest_index)
Make a number of rows with buttons for each company for the AI debug window.
Definition: ai_gui.cpp:1420
Left offset of the text of the frame.
Definition: window_gui.h:72
bool IsPaused()
Checks if the script is paused.
bool ai_developer_tools
activate AI developer tools
void DrawArrowButtons(int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
Draw [<][>] boxes.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1150
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:207
static class GameInfo * GetInfo()
Get the current GameInfo.
Definition: game.hpp:82
int timeout
Timeout for unclicking the button.
Definition: ai_gui.cpp:289
#define SETTING_BUTTON_WIDTH
Width of setting buttons.
Definition: settings_gui.h:18
This value is a boolean (either 0 (false) or 1 (true) ).
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: ai_gui.cpp:852
Maximum number of companies.
Definition: company_type.h:25
Window * ShowAIDebugWindow(CompanyID show_company)
Open the AI debug window and select the given company.
Definition: ai_gui.cpp:1523
static const int WIDGET_LIST_END
indicate the end of widgets&#39; list for vararg functions
Definition: widget_type.h:22
virtual void SetSetting(const char *name, int value)
Set the value of a setting for this config.
const char * GetDescription() const
Get the description of the script.
Definition: script_info.hpp:69
const char * description
The description of the configuration setting.
List with currently selected AIs.
Definition: ai_widget.h:44
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:959
bool IsVisible(uint16 item) const
Checks whether given current item is visible in the list.
Definition: widget_type.h:641
void Assign(StringID string)
Render a string into the textbuffer.
Definition: textbuf.cpp:399
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:699
void AddLine(const char *str)
Pass another text line from the current item to the filter.
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:613
bool IsDead() const
Return the "this script died" value.
virtual void OnResize()
Called after the window got resized.
Definition: ai_gui.cpp:566
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
ScriptConfigFlags flags
Flags for the configuration setting.
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:40
static char break_string[MAX_BREAK_STR_STRING_LENGTH]
The string to match to the AI output.
Definition: ai_gui.cpp:1000
AIListWindow(WindowDesc *desc, CompanyID slot)
Constructor for the window.
Definition: ai_gui.cpp:71
void SetStringParameters(int widget) const
Initialize string parameters for a widget.
Definition: ai_gui.cpp:640
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: ai_gui.cpp:761
virtual void OnTick()
Called once per (game) tick.
Definition: ai_gui.cpp:571
Scrollbar * vscroll
Cache of the vertical scrollbar.
Definition: ai_gui.cpp:292
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:34
const ScriptInfoList * info_list
The list of Scripts.
Definition: ai_gui.cpp:60
static class GameInstance * GetGameInstance()
Get the current GameScript instance.
Definition: game.hpp:77
virtual void OnEditboxChanged(int wid)
The text in an editbox has been edited.
Definition: ai_gui.cpp:1331
Scrollbar * vscroll
Cache of the vertical scrollbar.
Definition: ai_gui.cpp:64
GUISettings gui
settings related to the GUI
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: ai_gui.cpp:432
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
Window for displaying a textfile.
Definition: textfile_gui.h:23
All static information from an AI like name, version, etc.
Definition: ai_info.hpp:18
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:59
List with current selected GameScript.
Definition: ai_widget.h:43
Info about a single Script setting.
Window for displaying the textfile of a AI.
Definition: ai_gui.cpp:631
void ChangeToAI(CompanyID show_ai)
Change all settings to select another AI.
Definition: ai_gui.cpp:1244
CompanyID selected_slot
The currently selected AI slot or INVALID_COMPANY.
Definition: ai_gui.cpp:716
Close window button.
Definition: ai_widget.h:50
The content consists of an AI.
Definition: tcp_content.h:29
VisibleSettingsList visible_settings
List of visible AI settings.
Definition: ai_gui.cpp:294
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:52
static GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we&#39;re in the ...
bool show_break_box
Whether the break/debug box is visible.
Definition: ai_gui.cpp:998
Subdirectory for all AI files.
Definition: fileio_type.h:121
Vertical container.
Definition: widget_type.h:77
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:999
Caption of the window.
Definition: ai_widget.h:30
void ShowScriptTextfileWindow(TextfileType file_type, CompanyID slot)
Open the AI version of the textfile window.
Definition: ai_gui.cpp:654
static const NWidgetPart _nested_ai_list_widgets[]
Widgets for the AI list window.
Definition: ai_gui.cpp:240
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: depend.cpp:68
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:174
static const ScriptInfoList * GetUniqueInfoList()
Wrapper function for AIScanner::GetUniqueAIInfoList.
Definition: ai_core.cpp:332
Caption of the window.
Definition: ai_widget.h:20
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: ai_gui.cpp:109
Game Script button.
Definition: ai_widget.h:60
void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
Draw a dropdown button.
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: ai_gui.cpp:1093
static void Unpause()
Resume execution of the Game Script.
Definition: game_core.cpp:124
This setting can be changed while the Script is running.
const char * GetAuthor() const
Get the Author of the script.
Definition: script_info.hpp:54
bool _network_server
network-server is active
Definition: network.cpp:57
Coordinates of a point in 2D.
Continue button.
Definition: ai_widget.h:70
AI list; Window numbers:
Definition: window_type.h:279
List item containing a C char string.
Definition: dropdown_type.h:73
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-NULL) Titem.
Definition: pool_type.hpp:235
virtual void OnResize()
Called after the window got resized.
Definition: ai_gui.cpp:1403
byte max_no_competitors
the number of competitors (AIs)
Definition: settings_type.h:56
Normal push-button (no toggle button) with arrow caption.
Definition: widget_type.h:106
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:622
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
Definition: ai_gui.cpp:936
bool clicked_increase
Whether we clicked the increase or decrease button.
Definition: ai_gui.cpp:286
void ResetSettings()
Reset all settings to their default value.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:19
AI settings; Window numbers:
Definition: window_type.h:170
virtual void SetStringParameters(int widget) const
Initialize string parameters for a widget.
Definition: ai_gui.cpp:737
virtual int GetSetting(const char *name) const
Get the value of a setting for this config.
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:66
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:23
The caption of the window.
Definition: misc_widget.h:50
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: ai_gui.cpp:359
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:983
int line_height
Height of a row in the matrix widget.
Definition: ai_gui.cpp:291
Base functions for all AIs.
bool IsDead() const
Check whether the currently selected AI/GS is dead.
Definition: ai_gui.cpp:1017
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: ai_gui.cpp:120
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:695
void DrawBoolButton(int x, int y, bool state, bool clickable)
Draw a toggle button.
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget. ...
Definition: widget.cpp:1973
Specification of a rectangle with absolute coordinates of all edges.
Vertical scrollbar.
Definition: widget_type.h:84
bool IsShaded() const
Is window shaded currently?
Definition: window_gui.h:519
The panel to handle the breaking on string.
Definition: ai_widget.h:66
Text is written right-to-left by default.
Definition: strings_type.h:26
Left align the text.
Definition: gfx_func.h:98
Window background.
Definition: ai_widget.h:39
AIConfig stores the configuration settings of every AI.
Owner
Enum for all companies/owners.
Definition: company_type.h:20
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: ai_gui.cpp:813
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: ai_gui.cpp:1261
AIInfo keeps track of all information of an AI, like Author, Description, ...
const char * GetTextfile(TextfileType type, Subdirectory dir, const char *filename)
Search a textfile file next to the given content.
Find a place automatically.
Definition: window_gui.h:156
The matrix with all available AIs.
Definition: ai_widget.h:21
static bool case_sensitive_break_check
Is the matching done case-sensitive.
Definition: ai_gui.cpp:1003
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition: widget_type.h:80
int step_size
The step size in the gui.
#define SETTING_BUTTON_HEIGHT
Height of setting buttons.
Definition: settings_gui.h:20
Errors (eg. saving/loading failed)
Definition: error.h:25
An invalid company.
Definition: company_type.h:32
static void ShowAISettingsWindow(CompanyID slot)
Open the AI settings window to change the AI settings for an AI.
Definition: ai_gui.cpp:622
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1095
Decrease the number of AIs.
Definition: ai_widget.h:40
Dimensions (a width and height) of a rectangle in 2D.
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:429
Query string window; Window numbers:
Definition: window_type.h:118
bool IsEmpty() const
Check whether any filter words were entered.
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
const char * name
The name of the configuration setting.
Window * BringWindowToFrontById(WindowClass cls, WindowNumber number)
Find a window and make it the relative top-window on the screen.
Definition: window.cpp:1234
Accept button.
Definition: ai_widget.h:24
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:64
Game options window; Window numbers:
Definition: window_type.h:608
virtual void OnPaint()
The window must be repainted.
Definition: ai_gui.cpp:1101
static WindowDesc _ai_settings_desc(WDP_CENTER, "settings_script", 500, 208, WC_AI_SETTINGS, WC_NONE, 0, _nested_ai_settings_widgets, lengthof(_nested_ai_settings_widgets))
Window definition for the AI settings window.
Scrollbar to scroll through the selected AIs.
Definition: ai_widget.h:45
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1076
static void Pause()
Suspends the Game Script and then pause the execution of the script.
Definition: game_core.cpp:119
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window&#39;s data as invalid (in need of re-computing)
Definition: window.cpp:3161
Change AI settings button.
Definition: ai_widget.h:49
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:3220
Increase the number of AIs.
Definition: ai_widget.h:41
static bool IsEditable(CompanyID slot)
Can the AI config in the given company slot be edited?
Definition: ai_gui.cpp:797
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:620
(Toggle) Button with text
Definition: widget_type.h:55
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:631
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:201
Base class for a &#39;real&#39; widget.
Definition: widget_type.h:284
static WindowDesc _ai_debug_desc(WDP_AUTO, "script_debug", 600, 450, WC_AI_DEBUG, WC_NONE, 0, _nested_ai_debug_widgets, lengthof(_nested_ai_debug_widgets), &AIDebugWindow::hotkeys)
Window definition for the AI debug window.
pause the game
Definition: command_type.h:255