OpenTTD
highscore_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 "highscore.h"
12 #include "table/strings.h"
13 #include "gfx_func.h"
14 #include "table/sprites.h"
15 #include "window_gui.h"
16 #include "window_func.h"
17 #include "network/network.h"
18 #include "command_func.h"
19 #include "company_func.h"
20 #include "company_base.h"
21 #include "strings_func.h"
22 #include "hotkeys.h"
23 #include "zoom_func.h"
24 
26 
27 #include "safeguards.h"
28 
30  uint32 background_img;
31  int8 rank;
32 
34  {
35  this->InitNested();
37  ResizeWindow(this, _screen.width - this->width, _screen.height - this->height);
38  }
39 
40  /* Always draw a maximized window and within it the centered background */
41  void SetupHighScoreEndWindow()
42  {
43  /* Resize window to "full-screen". */
44  if (this->width != _screen.width || this->height != _screen.height) ResizeWindow(this, _screen.width - this->width, _screen.height - this->height);
45 
46  this->DrawWidgets();
47 
48  /* Standard background slices are 50 pixels high, but it's designed
49  * for 480 pixels total. 96% of 500 is 480. */
50  Dimension dim = GetSpriteSize(this->background_img);
51  Point pt = this->GetTopLeft(dim.width, dim.height * 96 / 10);
52  /* Center Highscore/Endscreen background */
53  for (uint i = 0; i < 10; i++) { // the image is split into 10 50px high parts
54  DrawSprite(this->background_img + i, PAL_NONE, pt.x, pt.y + (i * dim.height));
55  }
56  }
57 
59  Point GetTopLeft(int x, int y)
60  {
61  Point pt = {max(0, (_screen.width / 2) - (x / 2)), max(0, (_screen.height / 2) - (y / 2))};
62  return pt;
63  }
64 
65  void OnClick(Point pt, int widget, int click_count) override
66  {
67  delete this;
68  }
69 
70  EventState OnKeyPress(WChar key, uint16 keycode) override
71  {
72  /* All keys are 'handled' by this window but we want to make
73  * sure that 'quit' still works correctly. Not handling the
74  * quit key is enough so the main toolbar can handle it. */
75  if (IsQuitKey(keycode)) return ES_NOT_HANDLED;
76 
77  switch (keycode) {
78  /* Keys for telling we want to go on */
79  case WKC_RETURN:
80  case WKC_ESC:
81  case WKC_SPACE:
82  delete this;
83  return ES_HANDLED;
84 
85  default:
86  /* We want to handle all keys; we don't want windows in
87  * the background to open. Especially the ones that do
88  * locate themselves based on the status-/toolbars. */
89  return ES_HANDLED;
90  }
91  }
92 };
93 
97  {
98  /* Pause in single-player to have a look at the highscore at your own leisure */
100 
101  this->background_img = SPR_TYCOON_IMG1_BEGIN;
102 
104  const Company *c = Company::Get(_local_company);
106  this->background_img = SPR_TYCOON_IMG2_BEGIN;
107  }
108  }
109 
110  /* In a network game show the endscores of the custom difficulty 'network' which is
111  * a TOP5 of that game, and not an all-time TOP5. */
112  if (_networking) {
114  this->rank = SaveHighScoreValueNetwork();
115  } else {
116  /* in single player _local company is always valid */
117  const Company *c = Company::Get(_local_company);
118  this->window_number = SP_CUSTOM;
119  this->rank = SaveHighScoreValue(c);
120  }
121 
123  }
124 
125  ~EndGameWindow()
126  {
127  if (!_networking) DoCommandP(0, PM_PAUSED_NORMAL, 0, CMD_PAUSE); // unpause
128  ShowHighscoreTable(this->window_number, this->rank);
129  }
130 
131  void OnPaint() override
132  {
133  this->SetupHighScoreEndWindow();
134  Point pt = this->GetTopLeft(ScaleGUITrad(640), ScaleGUITrad(480));
135 
137  if (c == nullptr) return;
138 
139  /* We need to get performance from last year because the image is shown
140  * at the start of the new year when these things have already been copied */
141  if (this->background_img == SPR_TYCOON_IMG2_BEGIN) { // Tycoon of the century \o/
142  SetDParam(0, c->index);
143  SetDParam(1, c->index);
144  SetDParam(2, EndGameGetPerformanceTitleFromValue(c->old_economy[0].performance_history));
145  DrawStringMultiLine(pt.x + ScaleGUITrad(15), pt.x + ScaleGUITrad(640) - ScaleGUITrad(25), pt.y + ScaleGUITrad(90), pt.y + ScaleGUITrad(160), STR_HIGHSCORE_PRESIDENT_OF_COMPANY_ACHIEVES_STATUS, TC_FROMSTRING, SA_CENTER);
146  } else {
147  SetDParam(0, c->index);
148  SetDParam(1, EndGameGetPerformanceTitleFromValue(c->old_economy[0].performance_history));
149  DrawStringMultiLine(pt.x + ScaleGUITrad(36), pt.x + ScaleGUITrad(640), pt.y + ScaleGUITrad(140), pt.y + ScaleGUITrad(206), STR_HIGHSCORE_COMPANY_ACHIEVES_STATUS, TC_FROMSTRING, SA_CENTER);
150  }
151  }
152 };
153 
156 
157  HighScoreWindow(WindowDesc *desc, int difficulty, int8 ranking) : EndGameHighScoreBaseWindow(desc)
158  {
159  /* pause game to show the chart */
160  this->game_paused_by_player = _pause_mode == PM_PAUSED_NORMAL;
161  if (!_networking && !this->game_paused_by_player) DoCommandP(0, PM_PAUSED_NORMAL, 1, CMD_PAUSE);
162 
163  /* Close all always on-top windows to get a clean screen */
164  if (_game_mode != GM_MENU) HideVitalWindows();
165 
167  this->window_number = difficulty; // show highscore chart for difficulty...
168  this->background_img = SPR_HIGHSCORE_CHART_BEGIN; // which background to show
169  this->rank = ranking;
170  }
171 
172  ~HighScoreWindow()
173  {
174  if (_game_mode != GM_MENU) ShowVitalWindows();
175 
176  if (!_networking && !this->game_paused_by_player) DoCommandP(0, PM_PAUSED_NORMAL, 0, CMD_PAUSE); // unpause
177  }
178 
179  void OnPaint() override
180  {
181  const HighScore *hs = _highscore_table[this->window_number];
182 
183  this->SetupHighScoreEndWindow();
184  Point pt = this->GetTopLeft(ScaleGUITrad(640), ScaleGUITrad(480));
185 
187  DrawStringMultiLine(pt.x + ScaleGUITrad(70), pt.x + ScaleGUITrad(570), pt.y, pt.y + ScaleGUITrad(140), !_networking ? STR_HIGHSCORE_TOP_COMPANIES_WHO_REACHED : STR_HIGHSCORE_TOP_COMPANIES_NETWORK_GAME, TC_FROMSTRING, SA_CENTER);
188 
189  /* Draw Highscore peepz */
190  for (uint8 i = 0; i < lengthof(_highscore_table[0]); i++) {
191  SetDParam(0, i + 1);
192  DrawString(pt.x + ScaleGUITrad(40), pt.x + ScaleGUITrad(600), pt.y + ScaleGUITrad(140 + i * 55), STR_HIGHSCORE_POSITION);
193 
194  if (hs[i].company[0] != '\0') {
195  TextColour colour = (this->rank == i) ? TC_RED : TC_BLACK; // draw new highscore in red
196 
197  SetDParamStr(0, hs[i].company);
198  DrawString(pt.x + ScaleGUITrad(71), pt.x + ScaleGUITrad(569), pt.y + ScaleGUITrad(140 + i * 55), STR_JUST_BIG_RAW_STRING, colour);
199  SetDParam(0, hs[i].title);
200  SetDParam(1, hs[i].score);
201  DrawString(pt.x + ScaleGUITrad(71), pt.x + ScaleGUITrad(569), pt.y + ScaleGUITrad(140) + FONT_HEIGHT_LARGE + ScaleGUITrad(i * 55), STR_HIGHSCORE_STATS, colour);
202  }
203  }
204  }
205 };
206 
207 static const NWidgetPart _nested_highscore_widgets[] = {
208  NWidget(WWT_PANEL, COLOUR_BROWN, WID_H_BACKGROUND), SetMinimalSize(641, 481), SetResize(1, 1), EndContainer(),
209 };
210 
211 static WindowDesc _highscore_desc(
212  WDP_MANUAL, nullptr, 0, 0,
214  0,
215  _nested_highscore_widgets, lengthof(_nested_highscore_widgets)
216 );
217 
218 static WindowDesc _endgame_desc(
219  WDP_MANUAL, nullptr, 0, 0,
221  0,
222  _nested_highscore_widgets, lengthof(_nested_highscore_widgets)
223 );
224 
230 void ShowHighscoreTable(int difficulty, int8 ranking)
231 {
233  new HighScoreWindow(&_highscore_desc, difficulty, ranking);
234 }
235 
241 {
242  /* Dedicated server doesn't need the highscore window and neither does -v null. */
244 
247  new EndGameWindow(&_endgame_desc);
248 }
EventState
State of handling an event.
Definition: window_type.h:711
Functions related to OTTD&#39;s strings.
int8 SaveHighScoreValueNetwork()
Save the highscores in a network game when it has ended.
Definition: highscore.cpp:88
Definition of stuff that is very close to a company, like the company struct itself.
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:302
bool _networking
are we in networking mode?
Definition: network.cpp:52
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:928
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1867
void OnPaint() override
The window must be repainted.
High level window description.
Definition: window_gui.h:166
EventState OnKeyPress(WChar key, uint16 keycode) override
A key has been pressed.
WindowFlags flags
Window flags.
Definition: window_gui.h:310
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:602
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:291
Hotkey related functions.
int32 performance_history
Company score (scale 0-1000)
Definition: company_base.h:25
The passed event is not handled.
Definition: window_type.h:713
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
HighScore _highscore_table[SP_HIGHSCORE_END][5]
various difficulty-settings; top 5
Definition: highscore.cpp:22
No profile, special "custom" highscore.
Definition: settings_type.h:33
Tindex index
Index of this pool item.
Definition: pool_type.hpp:189
Types related to the highscore widgets.
#define CLRBITS(x, y)
Clears several bits in a variable.
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:24
Functions, definitions and such used only by the GUI.
Special "multiplayer" highscore. Not saved, always specific to the current game.
Definition: settings_type.h:36
bool _network_dedicated
are we a dedicated server?
Definition: network.cpp:55
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
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1857
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
void HideVitalWindows()
Delete all always on-top windows to get an empty screen.
Definition: window.cpp:3444
The client is spectating.
Definition: company_type.h:35
Functions related to the gfx engine.
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:945
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.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:245
Simple depressed panel.
Definition: widget_type.h:48
End game window shown at the end of the game.
void ShowEndGameChart()
Show the endgame victory screen in 2050.
Highscore; Window numbers:
Definition: window_type.h:643
bool game_paused_by_player
True if the game was paused by the player when the highscore window was opened.
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
A game normally paused.
Definition: openttd.h:57
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:498
Basic functions/variables used all over the place.
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:532
#define FONT_HEIGHT_LARGE
Height of characters in the large (FS_LARGE) font.
Definition: gfx_func.h:179
Point GetTopLeft(int x, int y)
Return the coordinate of the screen such that a window of 640x480 is centered at the screen...
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:40
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:47
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1175
The max score that can be in the performance history.
Definition: economy_type.h:50
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
Functions related to companies.
int8 SaveHighScoreValue(const Company *c)
Save the highscore for the company.
Definition: highscore.cpp:52
Declaration of functions and types defined in highscore.h and highscore_gui.h.
bool IsQuitKey(uint16 keycode)
Does the given keycode match one of the keycodes bound to &#39;quit game&#39;?
Definition: main_gui.cpp:540
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
Functions related to zooming.
CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS]
Economic data of the company of the last MAX_HISTORY_QUARTERS quarters.
Definition: company_base.h:97
void OnPaint() override
The window must be repainted.
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Functions related to commands.
Coordinates of a point in 2D.
void ShowHighscoreTable(int difficulty, int8 ranking)
Show the highscore table for a given difficulty.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:770
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:280
Endscreen; Window numbers:
Definition: window_type.h:649
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:319
Background of the window.
The passed event is handled.
Definition: window_type.h:712
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:312
Window functions not directly related to making/drawing windows.
Manually align the window (so no automatic location finding)
Definition: window_gui.h:153
uint32 WChar
Type for wide characters, i.e.
Definition: string_type.h:35
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Definition: window.cpp:2142
Window white border counter bit mask.
Definition: window_gui.h:240
void ShowVitalWindows()
Show the vital in-game windows.
Definition: main_gui.cpp:580
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:44
Dimensions (a width and height) of a rectangle in 2D.
This file contains all sprite-related enums and defines.
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:835
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1462
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
static const Year ORIGINAL_END_YEAR
The original ending year.
Definition: date_type.h:51
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
pause the game
Definition: command_type.h:254