OpenTTD
fios_gui.cpp
Go to the documentation of this file.
1 /* $Id$ */
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 "saveload/saveload.h"
14 #include "error.h"
15 #include "gui.h"
16 #include "gfx_func.h"
17 #include "command_func.h"
18 #include "network/network.h"
20 #include "strings_func.h"
21 #include "fileio_func.h"
22 #include "fios.h"
23 #include "window_func.h"
24 #include "tilehighlight_func.h"
25 #include "querystring_gui.h"
26 #include "engine_func.h"
27 #include "landscape_type.h"
28 #include "date_func.h"
29 #include "core/geometry_func.hpp"
30 #include "gamelog.h"
31 #include "stringfilter_type.h"
32 
33 #include "widgets/fios_widget.h"
34 
35 #include "table/sprites.h"
36 #include "table/strings.h"
37 
38 #include "safeguards.h"
39 
41 
42 static bool _fios_path_changed;
43 static bool _savegame_sort_dirty;
44 
45 
50 {
51  this->checkable = false;
52  this->error = INVALID_STRING_ID;
53  free(this->error_data);
54  this->error_data = nullptr;
55 
56  this->map_size_x = this->map_size_y = 256; // Default for old savegames which do not store mapsize.
57  this->current_date = 0;
58  memset(&this->settings, 0, sizeof(this->settings));
59 
60  for (auto &pair : this->companies) {
61  delete pair.second;
62  }
63  companies.clear();
64 
66  this->gamelog_action = nullptr;
67  this->gamelog_actions = 0;
68 
70 }
71 
75  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
76  NWidget(WWT_CAPTION, COLOUR_GREY, WID_SL_CAPTION),
77  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
78  EndContainer(),
79  /* Current directory and free space */
80  NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_BACKGROUND), SetFill(1, 0), SetResize(1, 0), EndContainer(),
81 
83  /* Left side : filter box and available files */
84  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 1),
85  /* Filter box with label */
88  NWidget(WWT_TEXT, COLOUR_GREY), SetFill(0, 1), SetDataTip(STR_SAVELOAD_FILTER_TITLE , STR_NULL),
89  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
90  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
91  EndContainer(),
92  /* Sort buttons */
95  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYNAME), SetDataTip(STR_SORT_BY_CAPTION_NAME, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
96  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYDATE), SetDataTip(STR_SORT_BY_CAPTION_DATE, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
97  EndContainer(),
98  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SL_HOME_BUTTON), SetMinimalSize(12, 12), SetDataTip(SPR_HOUSE_ICON, STR_SAVELOAD_HOME_BUTTON),
99  EndContainer(),
100  /* Files */
103  NWidget(WWT_INSET, COLOUR_GREY, WID_SL_DRIVES_DIRECTORIES_LIST), SetFill(1, 1), SetPadding(2, 1, 2, 2),
104  SetDataTip(0x0, STR_SAVELOAD_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SL_SCROLLBAR), EndContainer(),
106  EndContainer(),
109  SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
110  EndContainer(),
111  EndContainer(),
112  EndContainer(),
113 
114  /* Right side : game details */
115  NWidget(WWT_PANEL, COLOUR_GREY),
116  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SL_DETAILS), SetResize(1, 1), SetFill(1, 1),
117  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_MISSING_NEWGRFS), SetDataTip(STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_BUTTON, STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
120  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_NEWGRF_INFO), SetDataTip(STR_INTRO_NEWGRF_SETTINGS, STR_NULL), SetFill(1, 0), SetResize(1, 0),
121  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_LOAD_BUTTON), SetDataTip(STR_SAVELOAD_LOAD_BUTTON, STR_SAVELOAD_LOAD_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
122  EndContainer(),
123  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
124  EndContainer(),
125  EndContainer(),
126  EndContainer(),
127 };
128 
132  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
133  NWidget(WWT_CAPTION, COLOUR_GREY, WID_SL_CAPTION),
134  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
135  EndContainer(),
136  /* Current directory and free space */
137  NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_BACKGROUND), SetFill(1, 0), SetResize(1, 0), EndContainer(),
138 
139  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 1),
140  /* Filter box with label */
143  NWidget(WWT_TEXT, COLOUR_GREY), SetFill(0, 1), SetDataTip(STR_SAVELOAD_FILTER_TITLE , STR_NULL),
144  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
145  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
146  EndContainer(),
147  /* Sort Buttons */
150  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYNAME), SetDataTip(STR_SORT_BY_CAPTION_NAME, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
151  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYDATE), SetDataTip(STR_SORT_BY_CAPTION_DATE, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
152  EndContainer(),
153  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SL_HOME_BUTTON), SetMinimalSize(12, 12), SetDataTip(SPR_HOUSE_ICON, STR_SAVELOAD_HOME_BUTTON),
154  EndContainer(),
155  /* Files */
158  NWidget(WWT_INSET, COLOUR_GREY, WID_SL_DRIVES_DIRECTORIES_LIST), SetFill(1, 1), SetPadding(2, 1, 2, 2),
159  SetDataTip(0x0, STR_SAVELOAD_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SL_SCROLLBAR), EndContainer(),
161  EndContainer(),
163  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_CONTENT_DOWNLOAD), SetResize(1, 0), SetFill(1, 0),
164  SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
165  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_LOAD_BUTTON), SetResize(1, 0), SetFill(1, 0),
166  SetDataTip(STR_SAVELOAD_LOAD_BUTTON, STR_SAVELOAD_LOAD_HEIGHTMAP_TOOLTIP),
167  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
168  EndContainer(),
169  EndContainer(),
170  EndContainer(),
171 };
172 
176  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
177  NWidget(WWT_CAPTION, COLOUR_GREY, WID_SL_CAPTION),
178  NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
179  EndContainer(),
180  /* Current directory and free space */
181  NWidget(WWT_PANEL, COLOUR_GREY, WID_SL_BACKGROUND), SetFill(1, 0), SetResize(1, 0), EndContainer(),
183  /* Left side : filter box and available files */
184  NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 1),
185  /* Filter box with label */
188  NWidget(WWT_TEXT, COLOUR_GREY), SetFill(0, 1), SetDataTip(STR_SAVELOAD_FILTER_TITLE , STR_NULL),
189  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
190  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
191  EndContainer(),
192  /* Sort buttons */
195  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYNAME), SetDataTip(STR_SORT_BY_CAPTION_NAME, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
196  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SORT_BYDATE), SetDataTip(STR_SORT_BY_CAPTION_DATE, STR_TOOLTIP_SORT_ORDER), SetFill(1, 0), SetResize(1, 0),
197  EndContainer(),
198  NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_SL_HOME_BUTTON), SetMinimalSize(12, 12), SetDataTip(SPR_HOUSE_ICON, STR_SAVELOAD_HOME_BUTTON),
199  EndContainer(),
200  /* Files */
203  NWidget(WWT_INSET, COLOUR_GREY, WID_SL_DRIVES_DIRECTORIES_LIST), SetPadding(2, 1, 0, 2),
204  SetDataTip(0x0, STR_SAVELOAD_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SL_SCROLLBAR), EndContainer(),
206  EndContainer(),
207  NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SL_SAVE_OSK_TITLE), SetPadding(3, 2, 2, 2), SetFill(1, 0), SetResize(1, 0),
208  SetDataTip(STR_SAVELOAD_OSKTITLE, STR_SAVELOAD_EDITBOX_TOOLTIP),
209  EndContainer(),
210  /* Save/delete buttons */
212  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_DELETE_SELECTION), SetDataTip(STR_SAVELOAD_DELETE_BUTTON, STR_SAVELOAD_DELETE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
213  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SL_SAVE_GAME), SetDataTip(STR_SAVELOAD_SAVE_BUTTON, STR_SAVELOAD_SAVE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
214  EndContainer(),
215  EndContainer(),
216 
217  /* Right side : game details */
218  NWidget(WWT_PANEL, COLOUR_GREY),
219  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SL_DETAILS), SetResize(1, 1), SetFill(1, 1),
221  NWidget(NWID_SPACER), SetResize(1, 0), SetFill(1, 1),
222  NWidget(WWT_RESIZEBOX, COLOUR_GREY),
223  EndContainer(),
224  EndContainer(),
225  EndContainer(),
226 };
227 
229 static const TextColour _fios_colours[] = {
230  TC_LIGHT_BROWN, // DFT_OLD_GAME_FILE
231  TC_ORANGE, // DFT_GAME_FILE
232  TC_YELLOW, // DFT_HEIGHTMAP_BMP
233  TC_ORANGE, // DFT_HEIGHTMAP_PNG
234  TC_LIGHT_BLUE, // DFT_FIOS_DRIVE
235  TC_DARK_GREEN, // DFT_FIOS_PARENT
236  TC_DARK_GREEN, // DFT_FIOS_DIR
237  TC_ORANGE, // DFT_FIOS_DIRECT
238 };
239 
240 
245 static void SortSaveGameList(FileList &file_list)
246 {
247  size_t sort_start = 0;
248  size_t sort_end = 0;
249 
250  /* Directories are always above the files (FIOS_TYPE_DIR)
251  * Drives (A:\ (windows only) are always under the files (FIOS_TYPE_DRIVE)
252  * Only sort savegames/scenarios, not directories
253  */
254  for (const FiosItem *item = file_list.Begin(); item != file_list.End(); item++) {
255  switch (item->type) {
256  case FIOS_TYPE_DIR: sort_start++; break;
257  case FIOS_TYPE_PARENT: sort_start++; break;
258  case FIOS_TYPE_DRIVE: sort_end++; break;
259  default: break;
260  }
261  }
262 
263  std::sort(file_list.files.begin() + sort_start, file_list.files.end() - sort_end);
264 }
265 
266 struct SaveLoadWindow : public Window {
267 private:
268  static const uint EDITBOX_MAX_SIZE = 50;
269 
271  AbstractFileType abstract_filetype;
274  FiosItem o_dir;
276  Scrollbar *vscroll;
277 
280  std::vector<bool> fios_items_shown;
281 
282  static void SaveGameConfirmationCallback(Window *w, bool confirmed)
283  {
284  /* File name has already been written to _file_to_saveload */
285  if (confirmed) _switch_mode = SM_SAVE_GAME;
286  }
287 
288  static void SaveHeightmapConfirmationCallback(Window *w, bool confirmed)
289  {
290  /* File name has already been written to _file_to_saveload */
291  if (confirmed) _switch_mode = SM_SAVE_HEIGHTMAP;
292  }
293 
294 public:
295 
298  {
299  GenerateDefaultSaveName(this->filename_editbox.text.buf, &this->filename_editbox.text.buf[this->filename_editbox.text.max_bytes - 1]);
300  this->filename_editbox.text.UpdateSize();
301  }
302 
303  SaveLoadWindow(WindowDesc *desc, AbstractFileType abstract_filetype, SaveLoadOperation fop)
304  : Window(desc), filename_editbox(64), abstract_filetype(abstract_filetype), fop(fop), filter_editbox(EDITBOX_MAX_SIZE)
305  {
306  assert(this->fop == SLO_SAVE || this->fop == SLO_LOAD);
307 
308  /* For saving, construct an initial file name. */
309  if (this->fop == SLO_SAVE) {
310  switch (this->abstract_filetype) {
311  case FT_SAVEGAME:
312  this->GenerateFileName();
313  break;
314 
315  case FT_SCENARIO:
316  case FT_HEIGHTMAP:
317  this->filename_editbox.text.Assign("UNNAMED");
318  break;
319 
320  default:
321  NOT_REACHED();
322  }
323  }
324  this->querystrings[WID_SL_SAVE_OSK_TITLE] = &this->filename_editbox;
325  this->filename_editbox.ok_button = WID_SL_SAVE_GAME;
326 
327  this->CreateNestedTree(true);
328  if (this->fop == SLO_LOAD && this->abstract_filetype == FT_SAVEGAME) {
329  this->GetWidget<NWidgetStacked>(WID_SL_CONTENT_DOWNLOAD_SEL)->SetDisplayedPlane(SZSP_HORIZONTAL);
330  }
331 
332  /* Select caption string of the window. */
333  StringID caption_string;
334  switch (this->abstract_filetype) {
335  case FT_SAVEGAME:
336  caption_string = (this->fop == SLO_SAVE) ? STR_SAVELOAD_SAVE_CAPTION : STR_SAVELOAD_LOAD_CAPTION;
337  break;
338 
339  case FT_SCENARIO:
340  caption_string = (this->fop == SLO_SAVE) ? STR_SAVELOAD_SAVE_SCENARIO : STR_SAVELOAD_LOAD_SCENARIO;
341  break;
342 
343  case FT_HEIGHTMAP:
344  caption_string = (this->fop == SLO_SAVE) ? STR_SAVELOAD_SAVE_HEIGHTMAP : STR_SAVELOAD_LOAD_HEIGHTMAP;
345  break;
346 
347  default:
348  NOT_REACHED();
349  }
350  this->GetWidget<NWidgetCore>(WID_SL_CAPTION)->widget_data = caption_string;
351 
352  this->vscroll = this->GetScrollbar(WID_SL_SCROLLBAR);
353  this->FinishInitNested(0);
354 
355  this->LowerWidget(WID_SL_DRIVES_DIRECTORIES_LIST);
356  this->querystrings[WID_SL_FILTER] = &this->filter_editbox;
357  this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
358 
359  /* pause is only used in single-player, non-editor mode, non-menu mode. It
360  * will be unpaused in the WE_DESTROY event handler. */
361  if (_game_mode != GM_MENU && !_networking && _game_mode != GM_EDITOR) {
363  }
364  SetObjectToPlace(SPR_CURSOR_ZZZ, PAL_NONE, HT_NONE, WC_MAIN_WINDOW, 0);
365 
366  this->OnInvalidateData(SLIWD_RESCAN_FILES);
367 
369 
370  /* Select the initial directory. */
371  o_dir.type = FIOS_TYPE_DIRECT;
372  switch (this->abstract_filetype) {
373  case FT_SAVEGAME:
374  FioGetDirectory(o_dir.name, lastof(o_dir.name), SAVE_DIR);
375  break;
376 
377  case FT_SCENARIO:
378  FioGetDirectory(o_dir.name, lastof(o_dir.name), SCENARIO_DIR);
379  break;
380 
381  case FT_HEIGHTMAP:
382  FioGetDirectory(o_dir.name, lastof(o_dir.name), HEIGHTMAP_DIR);
383  break;
384 
385  default:
386  strecpy(o_dir.name, _personal_dir, lastof(o_dir.name));
387  }
388 
389  switch (this->fop) {
390  case SLO_SAVE:
391  /* Focus the edit box by default in the save window */
392  this->SetFocusedWidget(WID_SL_SAVE_OSK_TITLE);
393  break;
394 
395  default:
396  this->SetFocusedWidget(WID_SL_FILTER);
397  }
398  }
399 
400  virtual ~SaveLoadWindow()
401  {
402  /* pause is only used in single-player, non-editor mode, non menu mode */
403  if (!_networking && _game_mode != GM_EDITOR && _game_mode != GM_MENU) {
405  }
406  }
407 
408  void DrawWidget(const Rect &r, int widget) const override
409  {
410  switch (widget) {
411  case WID_SL_SORT_BYNAME:
412  case WID_SL_SORT_BYDATE:
413  if (((_savegame_sort_order & SORT_BY_NAME) != 0) == (widget == WID_SL_SORT_BYNAME)) {
414  this->DrawSortButtonState(widget, _savegame_sort_order & SORT_DESCENDING ? SBS_DOWN : SBS_UP);
415  }
416  break;
417 
418  case WID_SL_BACKGROUND: {
419  static const char *path = nullptr;
420  static StringID str = STR_ERROR_UNABLE_TO_READ_DRIVE;
421  static uint64 tot = 0;
422 
423  if (_fios_path_changed) {
424  str = FiosGetDescText(&path, &tot);
425  _fios_path_changed = false;
426  }
427 
428  if (str != STR_ERROR_UNABLE_TO_READ_DRIVE) SetDParam(0, tot);
430  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, path, TC_BLACK);
431  break;
432  }
433 
435  GfxFillRect(r.left + 1, r.top + 1, r.right, r.bottom, PC_BLACK);
436 
437  uint y = r.top + WD_FRAMERECT_TOP;
438  uint scroll_pos = this->vscroll->GetPosition();
439  for (uint row = 0; row < this->fios_items.Length(); row++) {
440  if (!this->fios_items_shown[row]) {
441  /* The current item is filtered out : we do not show it */
442  scroll_pos++;
443  continue;
444  }
445  if (row < scroll_pos) continue;
446  const FiosItem *item = this->fios_items.Get(row);
447 
448  if (item == this->selected) {
449  GfxFillRect(r.left + 1, y, r.right, y + this->resize.step_height, PC_DARK_BLUE);
450  }
451  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, item->title, _fios_colours[GetDetailedFileType(item->type)]);
452  y += this->resize.step_height;
453  if (y >= this->vscroll->GetCapacity() * this->resize.step_height + r.top + WD_FRAMERECT_TOP) break;
454  }
455  break;
456  }
457 
458  case WID_SL_DETAILS: {
461  DrawString(r.left, r.right, r.top + FONT_HEIGHT_NORMAL / 2 + WD_FRAMERECT_TOP, STR_SAVELOAD_DETAIL_CAPTION, TC_FROMSTRING, SA_HOR_CENTER);
462 
463  if (this->selected == nullptr) break;
464 
466  uint y_max = r.bottom - FONT_HEIGHT_NORMAL - WD_FRAMERECT_BOTTOM;
467 
468  if (y > y_max) break;
469  if (!_load_check_data.checkable) {
470  /* Old savegame, no information available */
471  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_SAVELOAD_DETAIL_NOT_AVAILABLE);
472  y += FONT_HEIGHT_NORMAL;
473  } else if (_load_check_data.error != INVALID_STRING_ID) {
474  /* Incompatible / broken savegame */
475  SetDParamStr(0, _load_check_data.error_data);
477  y, r.bottom - WD_FRAMERECT_BOTTOM, _load_check_data.error, TC_RED);
478  } else {
479  /* Mapsize */
480  SetDParam(0, _load_check_data.map_size_x);
481  SetDParam(1, _load_check_data.map_size_y);
482  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_MAP_SIZE);
483  y += FONT_HEIGHT_NORMAL;
484  if (y > y_max) break;
485 
486  /* Climate */
487  byte landscape = _load_check_data.settings.game_creation.landscape;
488  if (landscape < NUM_LANDSCAPE) {
489  SetDParam(0, STR_CHEAT_SWITCH_CLIMATE_TEMPERATE_LANDSCAPE + landscape);
490  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_LANDSCAPE);
491  y += FONT_HEIGHT_NORMAL;
492  }
493 
494  y += WD_PAR_VSEP_NORMAL;
495  if (y > y_max) break;
496 
497  /* Start date (if available) */
498  if (_load_check_data.settings.game_creation.starting_year != 0) {
499  SetDParam(0, ConvertYMDToDate(_load_check_data.settings.game_creation.starting_year, 0, 1));
500  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_START_DATE);
501  y += FONT_HEIGHT_NORMAL;
502  }
503  if (y > y_max) break;
504 
505  /* Hide current date for scenarios */
506  if (this->abstract_filetype != FT_SCENARIO) {
507  /* Current date */
508  SetDParam(0, _load_check_data.current_date);
509  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_NETWORK_SERVER_LIST_CURRENT_DATE);
510  y += FONT_HEIGHT_NORMAL;
511  }
512 
513  /* Hide the NewGRF stuff when saving. We also hide the button. */
514  if (this->fop == SLO_LOAD && (this->abstract_filetype == FT_SAVEGAME || this->abstract_filetype == FT_SCENARIO)) {
515  y += WD_PAR_VSEP_NORMAL;
516  if (y > y_max) break;
517 
518  /* NewGrf compatibility */
519  SetDParam(0, _load_check_data.grfconfig == nullptr ? STR_NEWGRF_LIST_NONE :
520  STR_NEWGRF_LIST_ALL_FOUND + _load_check_data.grf_compatibility);
521  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_SAVELOAD_DETAIL_GRFSTATUS);
522  y += FONT_HEIGHT_NORMAL;
523  }
524  if (y > y_max) break;
525 
526  /* Hide the company stuff for scenarios */
527  if (this->abstract_filetype != FT_SCENARIO) {
528  y += FONT_HEIGHT_NORMAL;
529  if (y > y_max) break;
530 
531  /* Companies / AIs */
532  for (auto &pair : _load_check_data.companies) {
533  SetDParam(0, pair.first + 1);
534  const CompanyProperties &c = *pair.second;
535  if (c.name != nullptr) {
536  SetDParam(1, STR_JUST_RAW_STRING);
537  SetDParamStr(2, c.name);
538  } else {
539  SetDParam(1, c.name_1);
540  SetDParam(2, c.name_2);
541  }
542  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_SAVELOAD_DETAIL_COMPANY_INDEX);
543  y += FONT_HEIGHT_NORMAL;
544  if (y > y_max) break;
545  }
546  }
547  }
548  break;
549  }
550  }
551  }
552 
553  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
554  {
555  switch (widget) {
556  case WID_SL_BACKGROUND:
558  break;
559 
561  resize->height = FONT_HEIGHT_NORMAL;
562  size->height = resize->height * 10 + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
563  break;
564  case WID_SL_SORT_BYNAME:
565  case WID_SL_SORT_BYDATE: {
566  Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
567  d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
568  d.height += padding.height;
569  *size = maxdim(*size, d);
570  break;
571  }
572  }
573  }
574 
575  void OnPaint() override
576  {
577  if (_savegame_sort_dirty) {
578  _savegame_sort_dirty = false;
579  SortSaveGameList(this->fios_items);
580  this->OnInvalidateData(SLIWD_FILTER_CHANGES);
581  }
582 
583  this->DrawWidgets();
584  }
585 
586  void OnClick(Point pt, int widget, int click_count) override
587  {
588  switch (widget) {
589  case WID_SL_SORT_BYNAME: // Sort save names by name
590  _savegame_sort_order = (_savegame_sort_order == SORT_BY_NAME) ?
591  SORT_BY_NAME | SORT_DESCENDING : SORT_BY_NAME;
592  _savegame_sort_dirty = true;
593  this->SetDirty();
594  break;
595 
596  case WID_SL_SORT_BYDATE: // Sort save names by date
597  _savegame_sort_order = (_savegame_sort_order == SORT_BY_DATE) ?
598  SORT_BY_DATE | SORT_DESCENDING : SORT_BY_DATE;
599  _savegame_sort_dirty = true;
600  this->SetDirty();
601  break;
602 
603  case WID_SL_HOME_BUTTON: // OpenTTD 'button', jumps to OpenTTD directory
604  FiosBrowseTo(&o_dir);
605  this->InvalidateData(SLIWD_RESCAN_FILES);
606  break;
607 
608  case WID_SL_LOAD_BUTTON: {
609  if (this->selected == nullptr || _load_check_data.HasErrors()) break;
610 
611  const char *name = FiosBrowseTo(this->selected);
612  _file_to_saveload.SetMode(this->selected->type);
614  _file_to_saveload.SetTitle(this->selected->title);
615 
616  if (this->abstract_filetype == FT_HEIGHTMAP) {
617  delete this;
619  } else if (!_load_check_data.HasNewGrfs() || _load_check_data.grf_compatibility != GLC_NOT_FOUND || _settings_client.gui.UserIsAllowedToChangeNewGRFs()) {
620  _switch_mode = (_game_mode == GM_EDITOR) ? SM_LOAD_SCENARIO : SM_LOAD_GAME;
622  delete this;
623  }
624  break;
625  }
626 
627  case WID_SL_NEWGRF_INFO:
628  if (_load_check_data.HasNewGrfs()) {
629  ShowNewGRFSettings(false, false, false, &_load_check_data.grfconfig);
630  }
631  break;
632 
634  if (!_network_available) {
635  ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
636  } else if (_load_check_data.HasNewGrfs()) {
637  ShowMissingContentWindow(_load_check_data.grfconfig);
638  }
639  break;
640 
641  case WID_SL_DRIVES_DIRECTORIES_LIST: { // Click the listbox
642  int y = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_SL_DRIVES_DIRECTORIES_LIST, WD_FRAMERECT_TOP);
643  if (y == INT_MAX) return;
644 
645  /* Get the corresponding non-filtered out item from the list */
646  int i = 0;
647  while (i <= y) {
648  if (!this->fios_items_shown[i]) y++;
649  i++;
650  }
651  const FiosItem *file = this->fios_items.Get(y);
652 
653  const char *name = FiosBrowseTo(file);
654  if (name == nullptr) {
655  /* Changed directory, need refresh. */
656  this->InvalidateData(SLIWD_RESCAN_FILES);
657  break;
658  }
659 
660  if (click_count == 1) {
661  if (this->selected != file) {
662  this->selected = file;
663  _load_check_data.Clear();
664 
665  if (GetDetailedFileType(file->type) == DFT_GAME_FILE) {
666  /* Other detailed file types cannot be checked before. */
668  }
669 
670  this->InvalidateData(SLIWD_SELECTION_CHANGES);
671  }
672  if (this->fop == SLO_SAVE) {
673  /* Copy clicked name to editbox */
674  this->filename_editbox.text.Assign(file->title);
675  this->SetWidgetDirty(WID_SL_SAVE_OSK_TITLE);
676  }
677  } else if (!_load_check_data.HasErrors()) {
678  this->selected = file;
679  if (this->fop == SLO_LOAD) {
680  if (this->abstract_filetype == FT_SAVEGAME || this->abstract_filetype == FT_SCENARIO) {
681  this->OnClick(pt, WID_SL_LOAD_BUTTON, 1);
682  } else {
683  assert(this->abstract_filetype == FT_HEIGHTMAP);
684  _file_to_saveload.SetMode(file->type);
686  _file_to_saveload.SetTitle(file->title);
687 
688  delete this;
690  }
691  }
692  }
693  break;
694  }
695 
697  if (!_network_available) {
698  ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
699  } else {
700  assert(this->fop == SLO_LOAD);
701  switch (this->abstract_filetype) {
702  default: NOT_REACHED();
705  }
706  }
707  break;
708 
709  case WID_SL_DELETE_SELECTION: // Delete
710  break;
711 
712  case WID_SL_SAVE_GAME: // Save game
713  /* Note, this is also called via the OSK; and we need to lower the button. */
714  this->HandleButtonClick(WID_SL_SAVE_GAME);
715  break;
716  }
717  }
718 
719  EventState OnKeyPress(WChar key, uint16 keycode) override
720  {
721  if (keycode == WKC_ESC) {
722  delete this;
723  return ES_HANDLED;
724  }
725 
726  return ES_NOT_HANDLED;
727  }
728 
729  void OnTimeout() override
730  {
731  /* Widgets WID_SL_DELETE_SELECTION and WID_SL_SAVE_GAME only exist when saving to a file. */
732  if (this->fop != SLO_SAVE) return;
733 
734  if (this->IsWidgetLowered(WID_SL_DELETE_SELECTION)) { // Delete button clicked
735  if (!FiosDelete(this->filename_editbox.text.buf)) {
736  ShowErrorMessage(STR_ERROR_UNABLE_TO_DELETE_FILE, INVALID_STRING_ID, WL_ERROR);
737  } else {
738  this->InvalidateData(SLIWD_RESCAN_FILES);
739  /* Reset file name to current date on successful delete */
740  if (this->abstract_filetype == FT_SAVEGAME) GenerateFileName();
741  }
742  } else if (this->IsWidgetLowered(WID_SL_SAVE_GAME)) { // Save button clicked
743  if (this->abstract_filetype == FT_SAVEGAME || this->abstract_filetype == FT_SCENARIO) {
744  FiosMakeSavegameName(_file_to_saveload.name, this->filename_editbox.text.buf, lastof(_file_to_saveload.name));
746  ShowQuery(STR_SAVELOAD_OVERWRITE_TITLE, STR_SAVELOAD_OVERWRITE_WARNING, this, SaveLoadWindow::SaveGameConfirmationCallback);
747  } else {
749  }
750  } else {
751  FiosMakeHeightmapName(_file_to_saveload.name, this->filename_editbox.text.buf, lastof(_file_to_saveload.name));
753  ShowQuery(STR_SAVELOAD_OVERWRITE_TITLE, STR_SAVELOAD_OVERWRITE_WARNING, this, SaveLoadWindow::SaveHeightmapConfirmationCallback);
754  } else {
756  }
757  }
758 
759  /* In the editor set up the vehicle engines correctly (date might have changed) */
760  if (_game_mode == GM_EDITOR) StartupEngines();
761  }
762  }
763 
764  void OnResize() override
765  {
767  }
768 
774  void OnInvalidateData(int data = 0, bool gui_scope = true) override
775  {
776  switch (data) {
777  case SLIWD_RESCAN_FILES:
778  /* Rescan files */
779  this->selected = nullptr;
780  _load_check_data.Clear();
781  if (!gui_scope) break;
782 
783  _fios_path_changed = true;
784  this->fios_items.BuildFileList(this->abstract_filetype, this->fop);
785  this->vscroll->SetCount((uint)this->fios_items.Length());
786  this->selected = nullptr;
787  _load_check_data.Clear();
788 
789  /* We reset the files filtered */
790  this->OnInvalidateData(SLIWD_FILTER_CHANGES);
791 
792  FALLTHROUGH;
793 
795  /* Selection changes */
796  if (!gui_scope) break;
797 
798  if (this->fop != SLO_LOAD) break;
799 
800  switch (this->abstract_filetype) {
801  case FT_HEIGHTMAP:
802  this->SetWidgetDisabledState(WID_SL_LOAD_BUTTON, this->selected == nullptr || _load_check_data.HasErrors());
803  break;
804 
805  case FT_SAVEGAME:
806  case FT_SCENARIO: {
807  bool disabled = this->selected == nullptr || _load_check_data.HasErrors();
809  disabled |= _load_check_data.HasNewGrfs() && _load_check_data.grf_compatibility == GLC_NOT_FOUND;
810  }
811  this->SetWidgetDisabledState(WID_SL_LOAD_BUTTON, disabled);
812  this->SetWidgetDisabledState(WID_SL_NEWGRF_INFO, !_load_check_data.HasNewGrfs());
813  this->SetWidgetDisabledState(WID_SL_MISSING_NEWGRFS,
814  !_load_check_data.HasNewGrfs() || _load_check_data.grf_compatibility == GLC_ALL_GOOD);
815  break;
816  }
817 
818  default:
819  NOT_REACHED();
820  }
821  break;
822 
824  /* Filter changes */
825  this->fios_items_shown.resize(this->fios_items.Length());
826  uint items_shown_count = 0;
827  /* We pass through every fios item */
828  for (uint i = 0; i < this->fios_items.Length(); i++) {
829  if (this->string_filter.IsEmpty()) {
830  /* We don't filter anything out if the filter editbox is empty */
831  this->fios_items_shown[i] = true;
832  items_shown_count++;
833  } else {
834  this->string_filter.ResetState();
835  this->string_filter.AddLine(this->fios_items[i].title);
836  /* We set the vector to show this fios element as filtered depending on the result of the filter */
837  this->fios_items_shown[i] = this->string_filter.GetState();
838  if (this->fios_items_shown[i]) items_shown_count++;
839 
840  if (&(this->fios_items[i]) == this->selected && this->fios_items_shown[i] == false) {
841  /* The selected element has been filtered out */
842  this->selected = nullptr;
843  this->OnInvalidateData(SLIWD_SELECTION_CHANGES);
844  }
845  }
846  }
847  this->vscroll->SetCount(items_shown_count);
848  break;
849  }
850  }
851 
852  void OnEditboxChanged(int wid) override
853  {
854  if (wid == WID_SL_FILTER) {
855  this->string_filter.SetFilterTerm(this->filter_editbox.text.buf);
856  this->InvalidateData(SLIWD_FILTER_CHANGES);
857  }
858  }
859 };
860 
863  WDP_CENTER, "load_game", 500, 294,
865  0,
866  _nested_load_dialog_widgets, lengthof(_nested_load_dialog_widgets)
867 );
868 
871  WDP_CENTER, "load_heightmap", 257, 320,
873  0,
874  _nested_load_heightmap_dialog_widgets, lengthof(_nested_load_heightmap_dialog_widgets)
875 );
876 
879  WDP_CENTER, "save_game", 500, 294,
881  0,
882  _nested_save_dialog_widgets, lengthof(_nested_save_dialog_widgets)
883 );
884 
891 {
893 
894  WindowDesc *sld;
895  if (fop == SLO_SAVE) {
896  sld = &_save_dialog_desc;
897  } else {
898  /* Dialogue for loading a file. */
899  sld = (abstract_filetype == FT_HEIGHTMAP) ? &_load_heightmap_dialog_desc : &_load_dialog_desc;
900  }
901 
902  _file_to_saveload.abstract_ftype = abstract_filetype;
903 
904  new SaveLoadWindow(sld, abstract_filetype, fop);
905 }
EventState
State of handling an event.
Definition: window_type.h:713
static const NWidgetPart _nested_load_heightmap_dialog_widgets[]
Load heightmap with content download.
Definition: fios_gui.cpp:130
Functions related to OTTD&#39;s strings.
AbstractFileType
The different abstract types of files that the system knows about.
Definition: fileio_type.h:18
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:48
static const TextColour _fios_colours[]
Text colours of DetailedFileType fios entries in the window.
Definition: fios_gui.cpp:229
Normal push-button (no toggle button) with image caption.
Definition: widget_type.h:105
bool _networking
are we in networking mode?
Definition: network.cpp:54
Button to open NewGgrf configuration.
Definition: fios_widget.h:32
Button to load game/scenario.
Definition: fios_widget.h:33
Horizontally center the text.
Definition: gfx_func.h:97
const FiosItem * Get(size_t index) const
Get a pointer to the indicated file information.
Definition: fios.h:159
char * name
Name of the company if the user changed it.
Definition: company_base.h:59
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:930
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
Container for loading in mode SL_LOAD_CHECK.
Definition: fios.h:33
byte landscape
the landscape we&#39;re currently in
High level window description.
Definition: window_gui.h:168
void GenerateDefaultSaveName(char *buf, const char *last)
Fill the buffer with the default name for a savegame or screenshot.
Definition: saveload.cpp:2814
Saveload window; Window numbers:
Definition: window_type.h:139
All GRF needed by game are present.
Definition: newgrf_config.h:54
struct LoggedAction * gamelog_action
Gamelog actions.
Definition: fios.h:48
void SetName(const char *name)
Set the name of the file.
Definition: saveload.cpp:2877
Functions related to dates.
Scrollbar data structure.
Definition: widget_type.h:589
std::vector< FiosItem > files
The list of files.
Definition: fios.h:202
void ClearGRFConfigList(GRFConfig **config)
Clear a GRF Config list, freeing all nodes.
Load game, Play Scenario.
Definition: openttd.h:31
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
Normal amount of vertical space between two paragraphs of text.
Definition: window_gui.h:139
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:715
bool GetState() const
Get the matching state of the current item.
Functions to be called to log possibly unsafe game events.
size_t Length() const
Get the number of files in the list.
Definition: fios.h:132
Types related to the fios widgets.
The content consists of a scenario.
Definition: tcp_content.h:29
FileToSaveLoad _file_to_saveload
File to save or load in the openttd loop.
Definition: saveload.cpp:60
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
Definition: fios_gui.cpp:852
Subdirectory of scenario for heightmaps.
Definition: fileio_type.h:115
void GenerateFileName()
Generate a default save filename.
Definition: fios_gui.cpp:297
a textbox for typing
Definition: widget_type.h:71
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:68
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:51
Title textbox, only available for save operations.
Definition: fios_widget.h:27
static const int ACTION_CLEAR
Clear editbox.
FileList fios_items
Save game list.
Definition: fios_gui.cpp:273
GRFConfig * grfconfig
NewGrf configuration from save.
Definition: fios.h:45
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:382
const FiosItem * Begin() const
Get a pointer to the first file information.
Definition: fios.h:141
Close box (at top-left of a window)
Definition: widget_type.h:69
Functions for Standard In/Out file operations.
DetailedFileType GetDetailedFileType(FiosType fios_type)
Extract the detailed file type from a FiosType.
Definition: fileio_type.h:102
String filter and state.
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
uint32 name_2
Parameter of name_1.
Definition: company_base.h:57
File selection has changed (user click, ...)
Definition: fios.h:24
Panel with game details.
Definition: fios_widget.h:31
Background of file selection.
Definition: fios_widget.h:22
Pure simple text.
Definition: widget_type.h:58
File is being saved.
Definition: fileio_type.h:52
Deals with finding savegames.
Definition: fios.h:105
Save button, only available for save operations.
Definition: fios_widget.h:29
Load file for checking and/or preview.
Definition: fileio_type.h:50
StringID FiosGetDescText(const char **path, uint64 *total_free)
Get descriptive texts.
Definition: fios.cpp:141
void OnTimeout() override
Called when this window&#39;s timeout has been reached.
Definition: fios_gui.cpp:729
bool _network_available
is network mode available?
Definition: network.cpp:56
QueryString filter_editbox
Filter editbox;.
Definition: fios_gui.cpp:279
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:670
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:910
Base for the GUIs that have an edit box in them.
Data structure for an opened window.
Definition: window_gui.h:278
Save game or scenario file.
Definition: fileio_type.h:33
bool checkable
True if the savegame could be checked by SL_LOAD_CHECK. (Old savegames are not checkable.)
Definition: fios.h:34
void SetFilterTerm(const char *str)
Set the term to filter on.
old or new savegame
Definition: fileio_type.h:20
old or new scenario
Definition: fileio_type.h:21
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
static WindowDesc _load_dialog_desc(WDP_CENTER, "load_game", 500, 294, WC_SAVELOAD, WC_NONE, 0, _nested_load_dialog_widgets, lengthof(_nested_load_dialog_widgets))
Load game/scenario.
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:281
Main window; Window numbers:
Definition: window_type.h:46
void ShowMissingContentWindow(const GRFConfig *list)
Show the content list window with all missing grfs from the given list.
std::vector< bool > fios_items_shown
Map of the filtered out fios items.
Definition: fios_gui.cpp:280
Sort by name button.
Definition: fios_widget.h:18
Base directory for all scenarios.
Definition: fileio_type.h:114
const FiosItem * End() const
Get a pointer behind the last file information.
Definition: fios.h:150
void SetTitle(const char *title)
Set the title of the file.
Definition: saveload.cpp:2886
Functions/types related to saving and loading games.
Invisible widget that takes some space.
Definition: widget_type.h:79
void FiosMakeSavegameName(char *buf, const char *name, const char *last)
Make a save game or scenario filename from a name.
Definition: fios.cpp:228
Functions related to errors.
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:65
Caption of the window.
Definition: fios_widget.h:17
Delete button, only available for save operations.
Definition: fios_widget.h:28
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
void GamelogFree(LoggedAction *gamelog_action, uint gamelog_actions)
Frees the memory allocated by a gamelog.
Definition: gamelog.cpp:95
Home button.
Definition: fios_widget.h:23
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
Show a modal confirmation window with standard &#39;yes&#39; and &#39;no&#39; buttons The window is aligned to the ce...
Definition: misc_gui.cpp:1262
Functions related to engines.
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
Sort descending.
Definition: window_gui.h:227
A game paused for saving/loading.
Definition: openttd.h:60
CompanyPropertiesMap companies
Company information.
Definition: fios.h:43
Statically loadable part of Company pool item.
Definition: company_base.h:56
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:178
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1014
Functions related to the gfx engine.
Data stored about a string that can be modified in the GUI.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:80
Display plane with zero size vertically, and filling and resizing horizontally.
Definition: widget_type.h:389
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:947
A path without any base directory.
Definition: fileio_type.h:127
Definition of base types and functions in a cross-platform compatible way.
void Clear()
Reset read data.
Definition: fios_gui.cpp:49
void ShowHeightmapLoad()
Start with loading a heightmap.
A number of safeguards to prevent using unsafe methods.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:247
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
Geometry functions.
Simple depressed panel.
Definition: widget_type.h:50
Base directory for all savegames.
Definition: fileio_type.h:112
void BuildFileList(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Construct a file list with the given kind of files, for the stated purpose.
Definition: fios.cpp:76
static void SortSaveGameList(FileList &file_list)
Sort the collected list save games prior to displaying it in the save/load gui.
Definition: fios_gui.cpp:245
const char * _personal_dir
custom directory for personal settings, saves, newgrf, etc.
Definition: fileio.cpp:1119
char * error_data
Data to pass to SetDParamStr when displaying error.
Definition: fios.h:36
Center the window.
Definition: window_gui.h:157
bool HasErrors()
Check whether loading the game resulted in errors.
Definition: fios.h:69
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
static WindowDesc _save_dialog_desc(WDP_CENTER, "save_game", 500, 294, WC_SAVELOAD, WC_NONE, 0, _nested_save_dialog_widgets, lengthof(_nested_save_dialog_widgets))
Save game/scenario.
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
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
EventState OnKeyPress(WChar key, uint16 keycode) override
A key has been pressed.
Definition: fios_gui.cpp:719
Basic functions/variables used all over the place.
Part of the network protocol handling content distribution.
SaveOrLoadResult SaveOrLoad(const char *filename, SaveLoadOperation fop, DetailedFileType dft, Subdirectory sb, bool threaded)
Main Save or Load function where the high-level saveload functions are handled.
Definition: saveload.cpp:2719
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:534
The filename filter has changed (via the editbox)
Definition: fios.h:25
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
File is being loaded.
Definition: fileio_type.h:51
Left offset of the text of the frame.
Definition: window_gui.h:72
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
bool FioCheckFileExists(const char *filename, Subdirectory subdir)
Check whether the given file exists.
Definition: fileio.cpp:312
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition: widget.cpp:658
StringID error
Error message from loading. INVALID_STRING_ID if no error.
Definition: fios.h:35
SaveLoadOperation fop
Type of file to select.
Definition: fios_gui.cpp:272
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:205
SaveLoadOperation
Operation performed on the file.
Definition: fileio_type.h:49
Save game.
Definition: openttd.h:33
void Assign(StringID string)
Render a string into the textbuffer.
Definition: textbuf.cpp:398
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:698
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: fios_gui.cpp:408
void AddLine(const char *str)
Pass another text line from the current item to the filter.
bool FiosDelete(const char *name)
Delete a file.
Definition: fios.cpp:255
void StartupEngines()
Start/initialise all our engines.
Definition: engine.cpp:697
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:40
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1146
static const uint8 PC_GREY
Grey palette colour.
Definition: gfx_func.h:207
static const uint8 PC_DARK_BLUE
Dark blue palette colour.
Definition: gfx_func.h:224
Sort by date button.
Definition: fios_widget.h:19
void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Launch save/load dialog in the given mode.
Definition: fios_gui.cpp:890
void OnResize() override
Called after the window got resized.
Definition: fios_gui.cpp:764
void FiosMakeHeightmapName(char *buf, const char *name, const char *last)
Construct a filename for a height map.
Definition: fios.cpp:241
default
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:34
void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config)
Setup the NewGRF gui.
Background of window.
Definition: fios_widget.h:21
GUISettings gui
settings related to the GUI
QueryString filename_editbox
Filename editbox.
Definition: fios_gui.cpp:270
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
void ClearErrorMessages()
Clear all errors from the queue.
Definition: error_gui.cpp:340
Declarations for savegames operations.
Types related to the landscape.
LoadCheckData _load_check_data
Data loaded from save during SL_LOAD_CHECK.
Definition: fios_gui.cpp:40
The content consists of a heightmap.
Definition: tcp_content.h:30
StringID name_1
Name of the company if the user did not change it.
Definition: company_base.h:58
List of file information.
Definition: fios.h:114
At least one GRF couldn&#39;t be found (higher priority than GLC_COMPATIBLE)
Definition: newgrf_config.h:56
const char * FiosBrowseTo(const FiosItem *item)
Browse to a new path based on the passed item, starting at #_fios_path.
Definition: fios.cpp:152
Searching and filtering using a stringterm.
Sort ascending.
Definition: window_gui.h:226
static const NWidgetPart _nested_load_dialog_widgets[]
Load game/scenario with optional content download.
Definition: fios_gui.cpp:73
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
Filter list of files.
Definition: fios_widget.h:20
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: depend.cpp:68
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:48
uint gamelog_actions
Number of gamelog actions.
Definition: fios.h:49
Rescan all files (when changed directory, ...)
Definition: fios.h:23
Functions related to commands.
char name[MAX_PATH]
Name of the file.
Definition: saveload.h:322
Coordinates of a point in 2D.
AbstractFileType abstract_ftype
Abstract type of file (scenario, heightmap, etc).
Definition: saveload.h:321
const FiosItem * selected
Selected game in fios_items, or nullptr.
Definition: fios_gui.cpp:275
void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowClass window_class, WindowNumber window_num)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
Definition: viewport.cpp:3326
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:622
Load scenario from scenario editor.
Definition: openttd.h:36
heightmap file
Definition: fileio_type.h:22
bool UserIsAllowedToChangeNewGRFs() const
Returns true when the user has sufficient privileges to edit newgrfs on a running game...
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:19
static WindowDesc _load_heightmap_dialog_desc(WDP_CENTER, "load_heightmap", 257, 320, WC_SAVELOAD, WC_NONE, 0, _nested_load_heightmap_dialog_widgets, lengthof(_nested_load_heightmap_dialog_widgets))
Load heightmap.
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:131
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
Selection &#39;stack&#39; to &#39;hide&#39; the content download.
Definition: fios_widget.h:30
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: fios_gui.cpp:586
Button to find missing NewGRFs online.
Definition: fios_widget.h:34
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:983
StringFilter string_filter
Filter for available games.
Definition: fios_gui.cpp:278
bool HasNewGrfs()
Check whether the game uses any NewGrfs.
Definition: fios.h:78
GameCreationSettings game_creation
settings used during the creation of a game (map)
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
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Definition: viewport.cpp:3374
Specification of a rectangle with absolute coordinates of all edges.
Vertical scrollbar.
Definition: widget_type.h:84
void SetMode(FiosType ft)
Set the mode and file type of the file to save or load based on the type of file entry at the file sy...
Definition: saveload.cpp:2848
The passed event is handled.
Definition: window_type.h:714
Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
Definition: date.cpp:149
Functions related to tile highlights.
Window functions not directly related to making/drawing windows.
void OnPaint() override
The window must be repainted.
Definition: fios_gui.cpp:575
Scrollbar of the file list.
Definition: fios_widget.h:25
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition: widget_type.h:80
GUI functions that shouldn&#39;t be here.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: fios_gui.cpp:774
Errors (eg. saving/loading failed)
Definition: error.h:25
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: fios_gui.cpp:553
uint32 WChar
Type for wide characters, i.e.
Definition: string_type.h:37
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1095
Dimensions (a width and height) of a rectangle in 2D.
GRFListCompatibility grf_compatibility
Summary state of NewGrfs, whether missing files or only compatible found.
Definition: fios.h:46
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:429
bool IsEmpty() const
Check whether any filter words were entered.
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
Year starting_year
starting date
This file contains all sprite-related enums and defines.
static const NWidgetPart _nested_save_dialog_widgets[]
Save game/scenario.
Definition: fios_gui.cpp:174
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1076
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.
Save heightmap.
Definition: openttd.h:34
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
void UpdateSize()
Update Textbuf type with its actual physical character and screenlength Get the count of characters i...
Definition: textbuf.cpp:432
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:631
Content download button, only available for play scenario/heightmap.
Definition: fios_widget.h:26
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
pause the game
Definition: command_type.h:256