OpenTTD Source: src/highscore_gui.cpp Source File

OpenTTD Source 13.1

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 #include "misc_cmd.h"
25
26 #include "widgets/highscore_widget.h"
27
28 #include "safeguards.h"
29
30 struct EndGameHighScoreBaseWindow : Window {
31 uint32 background_img;
32 int8 rank;
33
34 EndGameHighScoreBaseWindow(WindowDesc *desc) : Window(desc)
35 {
36 this->InitNested();
37 CLRBITS(this->flags, WF_WHITE_BORDER);
38 ResizeWindow(this, _screen.width - this->width, _screen.height - this->height);
39 }
40
41 /* Always draw a maximized window and within it the centered background */
42 void SetupHighScoreEndWindow()
43 {
44 /* Resize window to "full-screen". */
45 if (this->width != _screen.width || this->height != _screen.height) ResizeWindow(this, _screen.width - this->width, _screen.height - this->height);
46
47 this->DrawWidgets();
48
49 /* Standard background slices are 50 pixels high, but it's designed
50 * for 480 pixels total. 96% of 500 is 480. */
51 Dimension dim = GetSpriteSize(this->background_img);
52 Point pt = this->GetTopLeft(dim.width, dim.height * 96 / 10);
53 /* Center Highscore/Endscreen background */
54 for (uint i = 0; i < 10; i++) { // the image is split into 10 50px high parts
55 DrawSprite(this->background_img + i, PAL_NONE, pt.x, pt.y + (i * dim.height));
56 }
57 }
58
60 Point GetTopLeft(int x, int y)
61 {
62 Point pt = {std::max(0, (_screen.width / 2) - (x / 2)), std::max(0, (_screen.height / 2) - (y / 2))};
63 return pt;
64 }
65
66 void OnClick(Point pt, int widget, int click_count) override
67 {
68 this->Close();
69 }
70
71 EventState OnKeyPress(WChar key, uint16 keycode) override
72 {
73 /* All keys are 'handled' by this window but we want to make
74 * sure that 'quit' still works correctly. Not handling the
75 * quit key is enough so the main toolbar can handle it. */
76 if (IsQuitKey(keycode)) return ES_NOT_HANDLED;
77
78 switch (keycode) {
79 /* Keys for telling we want to go on */
80 case WKC_RETURN:
81 case WKC_ESC:
82 case WKC_SPACE:
83 this->Close();
84 return ES_HANDLED;
85
86 default:
87 /* We want to handle all keys; we don't want windows in
88 * the background to open. Especially the ones that do
89 * locate themselves based on the status-/toolbars. */
90 return ES_HANDLED;
91 }
92 }
93 };
94
96 struct EndGameWindow : EndGameHighScoreBaseWindow {
97 EndGameWindow(WindowDesc *desc) : EndGameHighScoreBaseWindow(desc)
98 {
99 /* Pause in single-player to have a look at the highscore at your own leisure */
100 if (!_networking) Command<CMD_PAUSE>::Post(PM_PAUSED_NORMAL, true);
101
102 this->background_img = SPR_TYCOON_IMG1_BEGIN;
103
104 if (_local_company != COMPANY_SPECTATOR) {
105 const Company *c = Company::Get(_local_company);
106 if (c->old_economy[0].performance_history == SCORE_MAX) {
107 this->background_img = SPR_TYCOON_IMG2_BEGIN;
108 }
109 }
110
111 /* In a network game show the endscores of the custom difficulty 'network' which is
112 * a TOP5 of that game, and not an all-time TOP5. */
113 if (_networking) {
114 this->window_number = SP_MULTIPLAYER;
115 this->rank = SaveHighScoreValueNetwork();
116 } else {
117 /* in singleplayer mode _local company is always valid */
118 const Company *c = Company::Get(_local_company);
119 this->window_number = SP_CUSTOM;
120 this->rank = SaveHighScoreValue(c);
121 }
122
123 MarkWholeScreenDirty();
124 }
125
126 void Close() override
127 {
128 if (!_networking) Command<CMD_PAUSE>::Post(PM_PAUSED_NORMAL, false); // unpause
129 if (_game_mode != GM_MENU) ShowHighscoreTable(this->window_number, this->rank);
130 this->EndGameHighScoreBaseWindow::Close();
131 }
132
133 void OnPaint() override
134 {
135 this->SetupHighScoreEndWindow();
136 Point pt = this->GetTopLeft(ScaleSpriteTrad(640), ScaleSpriteTrad(480));
137
138 const Company *c = Company::GetIfValid(_local_company);
139 if (c == nullptr) return;
140
141 /* We need to get performance from last year because the image is shown
142 * at the start of the new year when these things have already been copied */
143 if (this->background_img == SPR_TYCOON_IMG2_BEGIN) { // Tycoon of the century \o/
144 SetDParam(0, c->index);
145 SetDParam(1, c->index);
146 SetDParam(2, EndGameGetPerformanceTitleFromValue(c->old_economy[0].performance_history));
147 DrawStringMultiLine(pt.x + ScaleSpriteTrad(15), pt.x + ScaleSpriteTrad(640) - ScaleSpriteTrad(25), pt.y + ScaleSpriteTrad(90), pt.y + ScaleSpriteTrad(160), STR_HIGHSCORE_PRESIDENT_OF_COMPANY_ACHIEVES_STATUS, TC_FROMSTRING, SA_CENTER);
148 } else {
149 SetDParam(0, c->index);
150 SetDParam(1, EndGameGetPerformanceTitleFromValue(c->old_economy[0].performance_history));
151 DrawStringMultiLine(pt.x + ScaleSpriteTrad(36), pt.x + ScaleSpriteTrad(640), pt.y + ScaleSpriteTrad(140), pt.y + ScaleSpriteTrad(206), STR_HIGHSCORE_COMPANY_ACHIEVES_STATUS, TC_FROMSTRING, SA_CENTER);
152 }
153 }
154 };
155
156 struct HighScoreWindow : EndGameHighScoreBaseWindow {
157 bool game_paused_by_player;
158
159 HighScoreWindow(WindowDesc *desc, int difficulty, int8 ranking) : EndGameHighScoreBaseWindow(desc)
160 {
161 /* pause game to show the chart */
162 this->game_paused_by_player = _pause_mode == PM_PAUSED_NORMAL;
163 if (!_networking && !this->game_paused_by_player) Command<CMD_PAUSE>::Post(PM_PAUSED_NORMAL, true);
164
165 /* Close all always on-top windows to get a clean screen */
166 if (_game_mode != GM_MENU) HideVitalWindows();
167
168 MarkWholeScreenDirty();
169 this->window_number = difficulty; // show highscore chart for difficulty...
170 this->background_img = SPR_HIGHSCORE_CHART_BEGIN; // which background to show
171 this->rank = ranking;
172 }
173
174 void Close() override
175 {
176 if (_game_mode != GM_MENU) ShowVitalWindows();
177
178 if (!_networking && !this->game_paused_by_player) Command<CMD_PAUSE>::Post(PM_PAUSED_NORMAL, false); // unpause
179
180 this->EndGameHighScoreBaseWindow::Close();
181 }
182
183 void OnPaint() override
184 {
185 const HighScore *hs = _highscore_table[this->window_number];
186
187 this->SetupHighScoreEndWindow();
188 Point pt = this->GetTopLeft(ScaleSpriteTrad(640), ScaleSpriteTrad(480));
189
190 SetDParam(0, _settings_game.game_creation.ending_year);
191 DrawStringMultiLine(pt.x + ScaleSpriteTrad(70), pt.x + ScaleSpriteTrad(570), pt.y, pt.y + ScaleSpriteTrad(140), !_networking ? STR_HIGHSCORE_TOP_COMPANIES_WHO_REACHED : STR_HIGHSCORE_TOP_COMPANIES_NETWORK_GAME, TC_FROMSTRING, SA_CENTER);
192
193 /* Draw Highscore peepz */
194 for (uint8 i = 0; i < lengthof(_highscore_table[0]); i++) {
195 SetDParam(0, i + 1);
196 DrawString(pt.x + ScaleSpriteTrad(40), pt.x + ScaleSpriteTrad(600), pt.y + ScaleSpriteTrad(140 + i * 55), STR_HIGHSCORE_POSITION);
197
198 if (hs[i].company[0] != '\0') {
199 TextColour colour = (this->rank == i) ? TC_RED : TC_BLACK; // draw new highscore in red
200
201 SetDParamStr(0, hs[i].company);
202 DrawString(pt.x + ScaleSpriteTrad(71), pt.x + ScaleSpriteTrad(569), pt.y + ScaleSpriteTrad(140 + i * 55), STR_JUST_BIG_RAW_STRING, colour);
203 SetDParam(0, hs[i].title);
204 SetDParam(1, hs[i].score);
205 DrawString(pt.x + ScaleSpriteTrad(71), pt.x + ScaleSpriteTrad(569), pt.y + ScaleSpriteTrad(140) + FONT_HEIGHT_LARGE + ScaleSpriteTrad(i * 55), STR_HIGHSCORE_STATS, colour);
206 }
207 }
208 }
209 };
210
211 static const NWidgetPart _nested_highscore_widgets[] = {
212 NWidget(WWT_PANEL, COLOUR_BROWN, WID_H_BACKGROUND), SetResize(1, 1), EndContainer(),
213 };
214
215 static WindowDesc _highscore_desc(
216 WDP_MANUAL, nullptr, 0, 0,
217 WC_HIGHSCORE, WC_NONE,
218 0,
219 _nested_highscore_widgets, lengthof(_nested_highscore_widgets)
220 );
221
222 static WindowDesc _endgame_desc(
223 WDP_MANUAL, nullptr, 0, 0,
224 WC_ENDSCREEN, WC_NONE,
225 0,
226 _nested_highscore_widgets, lengthof(_nested_highscore_widgets)
227 );
228
234 void ShowHighscoreTable(int difficulty, int8 ranking)
235 {
236 CloseWindowByClass(WC_HIGHSCORE);
237 new HighScoreWindow(&_highscore_desc, difficulty, ranking);
238 }
239
244 void ShowEndGameChart()
245 {
246 /* Dedicated server doesn't need the highscore window and neither does -v null. */
247 if (_network_dedicated || (!_networking && !Company::IsValidID(_local_company))) return;
248
249 HideVitalWindows();
250 CloseWindowByClass(WC_ENDSCREEN);
251 new EndGameWindow(&_endgame_desc);
252 }
ES_HANDLED
@ ES_HANDLED
The passed event is handled.
Definition: window_type.h:720
HideVitalWindows
void HideVitalWindows()
Close all always on-top windows to get an empty screen.
Definition: window.cpp:3358
Pool::PoolItem<&_company_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:36
HighScoreWindow::game_paused_by_player
bool game_paused_by_player
True if the game was paused by the player when the highscore window was opened.
Definition: highscore_gui.cpp:157
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
command_func.h
Pool::PoolItem<&_company_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:348
company_base.h
HighScore
Definition: highscore.h:17
SaveHighScoreValue
int8 SaveHighScoreValue(const Company *c)
Save the highscore for the company.
Definition: highscore.cpp:52
HighScoreWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: highscore_gui.cpp:174
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
highscore_widget.h
SP_MULTIPLAYER
@ SP_MULTIPLAYER
Special "multiplayer" highscore. Not saved, always specific to the current game.
Definition: settings_type.h:48
misc_cmd.h
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:257
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:995
zoom_func.h
DrawString
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:644
WID_H_BACKGROUND
@ WID_H_BACKGROUND
Background of the window.
Definition: highscore_widget.h:15
Window::Window
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1810
SetDParam
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:196
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:973
EndGameHighScoreBaseWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: highscore_gui.cpp:66
HighScoreWindow
Definition: highscore_gui.cpp:156
DrawStringMultiLine
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:789
GameSettings::game_creation
GameCreationSettings game_creation
settings used during the creation of a game (map)
Definition: settings_type.h:587
WC_HIGHSCORE
@ WC_HIGHSCORE
Highscore; Window numbers:
Definition: window_type.h:643
gfx_func.h
_highscore_table
HighScore _highscore_table[SP_HIGHSCORE_END][5]
various difficulty-settings; top 5
Definition: highscore.cpp:22
WindowDesc
High level window description.
Definition: window_gui.h:102
window_gui.h
ShowVitalWindows
void ShowVitalWindows()
Show the vital in-game windows.
Definition: main_gui.cpp:566
CompanyEconomyEntry::performance_history
int32 performance_history
Company score (scale 0-1000)
Definition: company_base.h:27
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1800
WF_WHITE_BORDER
@ WF_WHITE_BORDER
Window white border counter bit mask.
Definition: window_gui.h:176
highscore.h
ES_NOT_HANDLED
@ ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:721
SP_CUSTOM
@ SP_CUSTOM
No profile, special "custom" highscore.
Definition: settings_type.h:45
ScaleSpriteTrad
static int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition: zoom_func.h:107
_pause_mode
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:50
EndGameHighScoreBaseWindow
Definition: highscore_gui.cpp:30
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:54
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
safeguards.h
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:239
_networking
bool _networking
are we in networking mode?
Definition: network.cpp:58
FONT_HEIGHT_LARGE
#define FONT_HEIGHT_LARGE
Height of characters in the large (FS_LARGE) font.
Definition: gfx_func.h:209
DrawSprite
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:1058
sprites.h
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
_network_dedicated
bool _network_dedicated
are we a dedicated server?
Definition: network.cpp:61
stdafx.h
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:241
EndGameWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: highscore_gui.cpp:133
SCORE_MAX
@ SCORE_MAX
The max score that can be in the performance history.
Definition: economy_type.h:59
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
GameCreationSettings::ending_year
Year ending_year
scoring end date
Definition: settings_type.h:314
EndGameHighScoreBaseWindow::OnKeyPress
EventState OnKeyPress(WChar key, uint16 keycode) override
A key has been pressed.
Definition: highscore_gui.cpp:71
ShowEndGameChart
void ShowEndGameChart()
Show the endgame victory screen in 2050.
Definition: highscore_gui.cpp:244
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:993
EndGameWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: highscore_gui.cpp:126
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1094
strings_func.h
EndGameHighScoreBaseWindow::GetTopLeft
Point GetTopLeft(int x, int y)
Return the coordinate of the screen such that a window of 640x480 is centered at the screen.
Definition: highscore_gui.cpp:60
IsQuitKey
bool IsQuitKey(uint16 keycode)
Does the given keycode match one of the keycodes bound to 'quit game'?
Definition: main_gui.cpp:526
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1227
COMPANY_SPECTATOR
@ COMPANY_SPECTATOR
The client is spectating.
Definition: company_type.h:35
CloseWindowByClass
void CloseWindowByClass(WindowClass cls)
Close all windows of a given class.
Definition: window.cpp:1199
HighScoreWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: highscore_gui.cpp:183
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
PM_PAUSED_NORMAL
@ PM_PAUSED_NORMAL
A game normally paused.
Definition: openttd.h:62
EventState
EventState
State of handling an event.
Definition: window_type.h:719
EndGameWindow
End game window shown at the end of the game.
Definition: highscore_gui.cpp:96
WC_ENDSCREEN
@ WC_ENDSCREEN
Endscreen; Window numbers:
Definition: window_type.h:649
company_func.h
network.h
CommandHelper
Definition: command_func.h:94
window_func.h
SA_CENTER
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_type.h:345
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:386
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:248
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1767
WDP_MANUAL
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition: window_gui.h:89
SaveHighScoreValueNetwork
int8 SaveHighScoreValueNetwork()
Save the highscores in a network game when it has ended.
Definition: highscore.cpp:88
Window
Data structure for an opened window.
Definition: window_gui.h:213
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:858
ShowHighscoreTable
void ShowHighscoreTable(int difficulty, int8 ranking)
Show the highscore table for a given difficulty.
Definition: highscore_gui.cpp:234
Company
Definition: company_base.h:117
CompanyProperties::old_economy
CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS]
Economic data of the company of the last MAX_HISTORY_QUARTERS quarters.
Definition: company_base.h:100
CLRBITS
#define CLRBITS(x, y)
Clears several bits in a variable.
Definition: bitmath_func.hpp:166
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:297
hotkeys.h
ResizeWindow
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Definition: window.cpp:2084
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1103