OpenTTD
intro_gui.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "stdafx.h"
11 #include "error.h"
12 #include "gui.h"
13 #include "window_gui.h"
14 #include "textbuf_gui.h"
15 #include "network/network.h"
16 #include "genworld.h"
17 #include "network/network_gui.h"
19 #include "landscape_type.h"
20 #include "strings_func.h"
21 #include "fios.h"
22 #include "ai/ai_gui.hpp"
23 #include "gfx_func.h"
24 #include "core/geometry_func.hpp"
25 #include "language.h"
26 #include "rev.h"
27 #include "highscore.h"
28 
29 #include "widgets/intro_widget.h"
30 
31 #include "table/strings.h"
32 #include "table/sprites.h"
33 
34 #include "safeguards.h"
35 
36 struct SelectGameWindow : public Window {
37 
38  SelectGameWindow(WindowDesc *desc) : Window(desc)
39  {
40  this->CreateNestedTree();
41  this->FinishInitNested(0);
42  this->OnInvalidateData();
43  }
44 
50  void OnInvalidateData(int data = 0, bool gui_scope = true) override
51  {
52  if (!gui_scope) return;
57  }
58 
59  void OnInit() override
60  {
61  bool missing_sprites = _missing_extra_graphics > 0 && !IsReleasedVersion();
62  this->GetWidget<NWidgetStacked>(WID_SGI_BASESET_SELECTION)->SetDisplayedPlane(missing_sprites ? 0 : SZSP_NONE);
63 
64  bool missing_lang = _current_language->missing >= _settings_client.gui.missing_strings_threshold && !IsReleasedVersion();
65  this->GetWidget<NWidgetStacked>(WID_SGI_TRANSLATION_SELECTION)->SetDisplayedPlane(missing_lang ? 0 : SZSP_NONE);
66  }
67 
68  void DrawWidget(const Rect &r, int widget) const override
69  {
70  switch (widget) {
71  case WID_SGI_BASESET:
73  DrawStringMultiLine(r.left, r.right, r.top, r.bottom, STR_INTRO_BASESET, TC_FROMSTRING, SA_CENTER);
74  break;
75 
78  DrawStringMultiLine(r.left, r.right, r.top, r.bottom, STR_INTRO_TRANSLATION, TC_FROMSTRING, SA_CENTER);
79  break;
80  }
81  }
82 
83  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
84  {
85  StringID str = 0;
86  switch (widget) {
87  case WID_SGI_BASESET:
89  str = STR_INTRO_BASESET;
90  break;
91 
94  str = STR_INTRO_TRANSLATION;
95  break;
96  }
97 
98  if (str != 0) {
99  int height = GetStringHeight(str, size->width);
100  if (height > 3 * FONT_HEIGHT_NORMAL) {
101  /* Don't let the window become too high. */
102  Dimension textdim = GetStringBoundingBox(str);
103  textdim.height *= 3;
104  textdim.width -= textdim.width / 2;
105  *size = maxdim(*size, textdim);
106  } else {
107  size->height = height + padding.height;
108  }
109  }
110  }
111 
112  void OnClick(Point pt, int widget, int click_count) override
113  {
114  /* Do not create a network server when you (just) have closed one of the game
115  * creation/load windows for the network server. */
117 
118  switch (widget) {
120  if (_ctrl_pressed) {
122  } else {
124  }
125  break;
126 
131 
133  if (!_network_available) {
134  ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
135  } else {
136  ShowNetworkGameWindow();
137  }
138  break;
139 
143  break;
144 
145  case WID_SGI_OPTIONS: ShowGameOptions(); break;
146  case WID_SGI_HIGHSCORE: ShowHighscoreTable(); break;
148  case WID_SGI_GRF_SETTINGS: ShowNewGRFSettings(true, true, false, &_grfconfig_newgame); break;
150  if (!_network_available) {
151  ShowErrorMessage(STR_NETWORK_ERROR_NOTAVAILABLE, INVALID_STRING_ID, WL_ERROR);
152  } else {
154  }
155  break;
157  case WID_SGI_EXIT: HandleExitGameRequest(); break;
158  }
159  }
160 };
161 
162 static const NWidgetPart _nested_select_game_widgets[] = {
163  NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_INTRO_CAPTION, STR_NULL),
164  NWidget(WWT_PANEL, COLOUR_BROWN),
166 
167  /* 'generate game' and 'load game' buttons */
169  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_GENERATE_GAME), SetMinimalSize(158, 12),
170  SetDataTip(STR_INTRO_NEW_GAME, STR_INTRO_TOOLTIP_NEW_GAME), SetPadding(0, 0, 0, 10), SetFill(1, 0),
171  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_LOAD_GAME), SetMinimalSize(158, 12),
172  SetDataTip(STR_INTRO_LOAD_GAME, STR_INTRO_TOOLTIP_LOAD_GAME), SetPadding(0, 10, 0, 0), SetFill(1, 0),
173  EndContainer(),
174 
176 
177  /* 'play scenario' and 'play heightmap' buttons */
179  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_PLAY_SCENARIO), SetMinimalSize(158, 12),
180  SetDataTip(STR_INTRO_PLAY_SCENARIO, STR_INTRO_TOOLTIP_PLAY_SCENARIO), SetPadding(0, 0, 0, 10), SetFill(1, 0),
181  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_PLAY_HEIGHTMAP), SetMinimalSize(158, 12),
182  SetDataTip(STR_INTRO_PLAY_HEIGHTMAP, STR_INTRO_TOOLTIP_PLAY_HEIGHTMAP), SetPadding(0, 10, 0, 0), SetFill(1, 0),
183  EndContainer(),
184 
186 
187  /* 'edit scenario' and 'play multiplayer' buttons */
189  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_EDIT_SCENARIO), SetMinimalSize(158, 12),
190  SetDataTip(STR_INTRO_SCENARIO_EDITOR, STR_INTRO_TOOLTIP_SCENARIO_EDITOR), SetPadding(0, 0, 0, 10), SetFill(1, 0),
191  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_PLAY_NETWORK), SetMinimalSize(158, 12),
192  SetDataTip(STR_INTRO_MULTIPLAYER, STR_INTRO_TOOLTIP_MULTIPLAYER), SetPadding(0, 10, 0, 0), SetFill(1, 0),
193  EndContainer(),
194 
196 
197  /* climate selection buttons */
199  NWidget(NWID_SPACER), SetMinimalSize(10, 0), SetFill(1, 0),
201  SetDataTip(SPR_SELECT_TEMPERATE, STR_INTRO_TOOLTIP_TEMPERATE),
202  NWidget(NWID_SPACER), SetMinimalSize(3, 0), SetFill(1, 0),
204  SetDataTip(SPR_SELECT_SUB_ARCTIC, STR_INTRO_TOOLTIP_SUB_ARCTIC_LANDSCAPE),
205  NWidget(NWID_SPACER), SetMinimalSize(3, 0), SetFill(1, 0),
207  SetDataTip(SPR_SELECT_SUB_TROPICAL, STR_INTRO_TOOLTIP_SUB_TROPICAL_LANDSCAPE),
208  NWidget(NWID_SPACER), SetMinimalSize(3, 0), SetFill(1, 0),
210  SetDataTip(SPR_SELECT_TOYLAND, STR_INTRO_TOOLTIP_TOYLAND_LANDSCAPE),
211  NWidget(NWID_SPACER), SetMinimalSize(10, 0), SetFill(1, 0),
212  EndContainer(),
213 
217  NWidget(WWT_EMPTY, COLOUR_ORANGE, WID_SGI_BASESET), SetMinimalSize(316, 12), SetFill(1, 0), SetPadding(0, 10, 7, 10),
218  EndContainer(),
219  EndContainer(),
222  NWidget(WWT_EMPTY, COLOUR_ORANGE, WID_SGI_TRANSLATION), SetMinimalSize(316, 12), SetFill(1, 0), SetPadding(0, 10, 7, 10),
223  EndContainer(),
224  EndContainer(),
225 
226  /* 'game options' and 'advanced settings' buttons */
228  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_OPTIONS), SetMinimalSize(158, 12),
229  SetDataTip(STR_INTRO_GAME_OPTIONS, STR_INTRO_TOOLTIP_GAME_OPTIONS), SetPadding(0, 0, 0, 10), SetFill(1, 0),
231  SetDataTip(STR_INTRO_CONFIG_SETTINGS_TREE, STR_INTRO_TOOLTIP_CONFIG_SETTINGS_TREE), SetPadding(0, 10, 0, 0), SetFill(1, 0),
232  EndContainer(),
233 
235 
236  /* 'script settings' and 'newgrf settings' buttons */
238  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_AI_SETTINGS), SetMinimalSize(158, 12),
239  SetDataTip(STR_INTRO_SCRIPT_SETTINGS, STR_INTRO_TOOLTIP_SCRIPT_SETTINGS), SetPadding(0, 0, 0, 10), SetFill(1, 0),
240  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_GRF_SETTINGS), SetMinimalSize(158, 12),
241  SetDataTip(STR_INTRO_NEWGRF_SETTINGS, STR_INTRO_TOOLTIP_NEWGRF_SETTINGS), SetPadding(0, 10, 0, 0), SetFill(1, 0),
242  EndContainer(),
243 
245 
246  /* 'online content' and 'highscore' buttons */
249  SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT), SetPadding(0, 0, 0, 10), SetFill(1, 0),
250  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_HIGHSCORE), SetMinimalSize(158, 12),
251  SetDataTip(STR_INTRO_HIGHSCORE, STR_INTRO_TOOLTIP_HIGHSCORE), SetPadding(0, 10, 0, 0), SetFill(1, 0),
252  EndContainer(),
253 
255 
256  /* 'exit program' button */
258  NWidget(NWID_SPACER), SetFill(1, 0),
259  NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_SGI_EXIT), SetMinimalSize(128, 12),
260  SetDataTip(STR_INTRO_QUIT, STR_INTRO_TOOLTIP_QUIT),
261  NWidget(NWID_SPACER), SetFill(1, 0),
262  EndContainer(),
263 
265 
266  EndContainer(),
267 };
268 
269 static WindowDesc _select_game_desc(
270  WDP_CENTER, nullptr, 0, 0,
272  0,
273  _nested_select_game_widgets, lengthof(_nested_select_game_widgets)
274 );
275 
276 void ShowSelectGameWindow()
277 {
278  new SelectGameWindow(&_select_game_desc);
279 }
280 
281 static void AskExitGameCallback(Window *w, bool confirmed)
282 {
283  if (confirmed) _exit_game = true;
284 }
285 
286 void AskExitGame()
287 {
288 #if defined(_WIN32)
289  SetDParam(0, STR_OSNAME_WINDOWS);
290 #elif defined(__APPLE__)
291  SetDParam(0, STR_OSNAME_OSX);
292 #elif defined(__HAIKU__)
293  SetDParam(0, STR_OSNAME_HAIKU);
294 #elif defined(__OS2__)
295  SetDParam(0, STR_OSNAME_OS2);
296 #elif defined(SUNOS)
297  SetDParam(0, STR_OSNAME_SUNOS);
298 #else
299  SetDParam(0, STR_OSNAME_UNIX);
300 #endif
301  ShowQuery(
302  STR_QUIT_CAPTION,
303  STR_QUIT_ARE_YOU_SURE_YOU_WANT_TO_EXIT_OPENTTD,
304  nullptr,
305  AskExitGameCallback
306  );
307 }
308 
309 
310 static void AskExitToGameMenuCallback(Window *w, bool confirmed)
311 {
312  if (confirmed) {
315  }
316 }
317 
318 void AskExitToGameMenu()
319 {
320  ShowQuery(
321  STR_ABANDON_GAME_CAPTION,
322  (_game_mode != GM_EDITOR) ? STR_ABANDON_GAME_QUERY : STR_ABANDON_SCENARIO_QUERY,
323  nullptr,
324  AskExitToGameMenuCallback
325  );
326 }
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: intro_gui.cpp:59
Functions related to OTTD&#39;s strings.
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
Highscore button.
Definition: intro_widget.h:30
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1867
byte landscape
the landscape we&#39;re currently in
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:453
Edit scenario button.
Definition: intro_widget.h:19
High level window description.
Definition: window_gui.h:166
(Toggle) Button with diff image when clicked
Definition: widget_type.h:51
Settings button.
Definition: intro_widget.h:31
GRFConfig * _grfconfig_newgame
First item in list of default GRF set up.
Switch to game intro menu.
Definition: openttd.h:30
Play heightmap button.
Definition: intro_widget.h:18
Baseset errors.
Definition: intro_widget.h:26
GUIs related to networking.
Window for configuring the AIs
Horizontal container.
Definition: widget_type.h:73
Types related to the intro widgets.
uint _missing_extra_graphics
Number of sprites provided by the fallback extra GRF, i.e. missing in the baseset.
const LanguageMetadata * _current_language
The currently loaded language.
Definition: strings.cpp:46
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:380
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:547
void ShowAIConfigWindow()
Open the AI config window.
Definition: ai_gui.cpp:962
Functions related to world/map generation.
Stuff related to the text buffer GUI.
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1828
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: intro_gui.cpp:112
Functions, definitions and such used only by the GUI.
static const uint32 GENERATE_NEW_SEED
Create a new random seed.
Definition: genworld.h:24
bool _network_available
is network mode available?
Definition: network.cpp:54
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:908
Data structure for an opened window.
Definition: window_gui.h:276
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1844
old or new savegame
Definition: fileio_type.h:18
old or new scenario
Definition: fileio_type.h:19
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:1044
static bool IsInsideMM(const T x, const size_t min, const size_t max)
Checks if a value is in an interval.
Definition: math_func.hpp:264
void StartNewGameWithoutGUI(uint32 seed)
Start a normal game without the GUI.
bool _is_network_server
Does this client wants to be a network-server?
Definition: network.cpp:56
Invisible widget that takes some space.
Definition: widget_type.h:77
Functions related to errors.
Translation selection.
Definition: intro_widget.h:27
Exit button.
Definition: intro_widget.h:35
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:1260
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:176
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1012
Functions related to the gfx engine.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:78
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:945
Load game button.
Definition: intro_widget.h:16
Definition of base types and functions in a cross-platform compatible way.
Center both horizontally and vertically.
Definition: gfx_func.h:104
A number of safeguards to prevent using unsafe methods.
Select tropic landscape button.
Definition: intro_widget.h:23
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
Geometry functions.
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
Definition: settings.cpp:80
Simple depressed panel.
Definition: widget_type.h:48
Information about languages and their files.
void ShowGenerateLandscape()
Start with a normal game.
Translation errors.
Definition: intro_widget.h:28
Center the window.
Definition: window_gui.h:155
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:1112
Content Download button.
Definition: intro_widget.h:33
Basic functions/variables used all over the place.
Part of the network protocol handling content distribution.
void StartScenarioEditor()
Start with a scenario editor.
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:40
File is being loaded.
Definition: fileio_type.h:49
Display plane with zero size in both directions (none filling and resizing).
Definition: widget_type.h:388
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Select toyland landscape button.
Definition: intro_widget.h:24
void ShowHighscoreTable(int difficulty=SP_CUSTOM, int8 rank=-1)
Show the highscore table for a given difficulty.
Baseset selection.
Definition: intro_widget.h:25
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:700
Select game window; Window numbers:
Definition: window_type.h:435
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:38
Options button.
Definition: intro_widget.h:29
uint16 missing
number of missing strings.
Definition: language.h:40
void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config)
Setup the NewGRF gui.
Generate game button.
Definition: intro_widget.h:15
Declaration of functions and types defined in highscore.h and highscore_gui.h.
GUISettings gui
settings related to the GUI
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
byte missing_strings_threshold
the number of missing strings before showing the warning
void ClearErrorMessages()
Clear all errors from the queue.
Definition: error_gui.cpp:338
Declarations for savegames operations.
Types related to the landscape.
void ShowSaveLoadDialog(AbstractFileType abstract_filetype, SaveLoadOperation fop)
Launch save/load dialog in the given mode.
Definition: fios_gui.cpp:888
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: intro_gui.cpp:50
Vertical container.
Definition: widget_type.h:75
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:997
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: intro_gui.cpp:68
Play network button.
Definition: intro_widget.h:20
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:46
Select arctic landscape button.
Definition: intro_widget.h:22
NewGRF button.
Definition: intro_widget.h:32
Coordinates of a point in 2D.
heightmap file
Definition: fileio_type.h:20
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
void ShowGameSettings()
Open advanced settings window.
declaration of OTTD revision dependent variables
Select temperate landscape button.
Definition: intro_widget.h:21
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:981
GameCreationSettings game_creation
settings used during the creation of a game (map)
Specification of a rectangle with absolute coordinates of all edges.
void ShowGameOptions()
Open the game options window.
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: intro_gui.cpp:83
void SetNewLandscapeType(byte landscape)
Changes landscape type and sets genworld window dirty.
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition: widget_type.h:78
GUI functions that shouldn&#39;t be here.
Errors (eg. saving/loading failed)
Definition: error.h:23
Dimensions (a width and height) of a rectangle in 2D.
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:427
This file contains all sprite-related enums and defines.
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.
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:320
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:621
Play scenario button.
Definition: intro_widget.h:17
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:199