OpenTTD Source: src/league_gui.cpp Source File

OpenTTD Source 15.3

league_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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#include "stdafx.h"
11#include "league_gui.h"
12#include "company_base.h"
13#include "company_gui.h"
14#include "gui.h"
15#include "industry.h"
16#include "league_base.h"
17#include "sortlist_type.h"
18#include "story_base.h"
19#include "strings_func.h"
20#include "tile_map.h"
21#include "town.h"
22#include "viewport_func.h"
23#include "window_gui.h"
24
25#include "widgets/league_widget.h"
26
27#include "table/strings.h"
28#include "table/sprites.h"
29
30#include "safeguards.h"
31
32
33static const StringID _performance_titles[] = {
34 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ENGINEER,
35 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ENGINEER,
36 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRAFFIC_MANAGER,
37 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRAFFIC_MANAGER,
38 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRANSPORT_COORDINATOR,
39 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TRANSPORT_COORDINATOR,
40 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ROUTE_SUPERVISOR,
41 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_ROUTE_SUPERVISOR,
42 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_DIRECTOR,
43 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_DIRECTOR,
44 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHIEF_EXECUTIVE,
45 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHIEF_EXECUTIVE,
46 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHAIRMAN,
47 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_CHAIRMAN,
48 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_PRESIDENT,
49 STR_COMPANY_LEAGUE_PERFORMANCE_TITLE_TYCOON,
50};
51
52static inline StringID GetPerformanceTitleFromValue(uint value)
53{
54 return _performance_titles[std::min(value, 1000u) >> 6];
55}
56
57 class PerformanceLeagueWindow : public Window {
58private:
59 GUIList<const Company *> companies{};
60 uint rank_width = 0;
61 uint text_width = 0;
62 int line_height = 0;
63 Dimension icon{};
64
68 void BuildCompanyList()
69 {
70 if (!this->companies.NeedRebuild()) return;
71
72 this->companies.clear();
73 this->companies.reserve(Company::GetNumItems());
74
75 for (const Company *c : Company::Iterate()) {
76 this->companies.push_back(c);
77 }
78
79 this->companies.RebuildDone();
80 }
81
83 static bool PerformanceSorter(const Company * const &c1, const Company * const &c2)
84 {
85 return c2->old_economy[0].performance_history < c1->old_economy[0].performance_history;
86 }
87
88public:
89 PerformanceLeagueWindow(WindowDesc &desc, WindowNumber window_number) : Window(desc)
90 {
91 this->InitNested(window_number);
92 this->companies.ForceRebuild();
93 this->companies.NeedResort();
94 }
95
96 void OnPaint() override
97 {
98 this->BuildCompanyList();
99 this->companies.Sort(&PerformanceSorter);
100
101 this->DrawWidgets();
102 }
103
104 void DrawWidget(const Rect &r, WidgetID widget) const override
105 {
106 if (widget != WID_PLT_BACKGROUND) return;
107
108 Rect ir = r.Shrink(WidgetDimensions::scaled.framerect);
109 int icon_y_offset = (this->line_height - this->icon.height) / 2;
110 int text_y_offset = (this->line_height - GetCharacterHeight(FS_NORMAL)) / 2;
111
112 bool rtl = _current_text_dir == TD_RTL;
113 Rect rank_rect = ir.WithWidth(this->rank_width, rtl);
114 Rect icon_rect = ir.Indent(this->rank_width + WidgetDimensions::scaled.hsep_wide, rtl).WithWidth(this->icon.width, rtl);
115 Rect text_rect = ir.Indent(this->rank_width + this->icon.width + WidgetDimensions::scaled.hsep_wide * 2, rtl);
116
117 for (uint i = 0; i != this->companies.size(); i++) {
118 const Company *c = this->companies[i];
119 DrawString(rank_rect.left, rank_rect.right, ir.top + text_y_offset, GetString(STR_COMPANY_LEAGUE_COMPANY_RANK, i + 1));
120
121 DrawCompanyIcon(c->index, icon_rect.left, ir.top + icon_y_offset);
122
123 DrawString(text_rect.left, text_rect.right, ir.top + text_y_offset, GetString(STR_COMPANY_LEAGUE_COMPANY_NAME, c->index, c->index, GetPerformanceTitleFromValue(c->old_economy[0].performance_history)));
124 ir.top += this->line_height;
125 }
126 }
127
128 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
129 {
130 if (widget != WID_PLT_BACKGROUND) return;
131
132 this->rank_width = 0;
133 for (uint i = 0; i < MAX_COMPANIES; i++) {
134 this->rank_width = std::max(this->rank_width, GetStringBoundingBox(GetString(STR_COMPANY_LEAGUE_COMPANY_RANK, i + 1)).width);
135 }
136
137 uint widest_width = 0;
138 StringID widest_title = STR_NULL;
139 for (auto title : _performance_titles) {
140 uint width = GetStringBoundingBox(title).width;
141 if (width > widest_width) {
142 widest_title = title;
143 widest_width = width;
144 }
145 }
146
147 this->icon = GetSpriteSize(SPR_COMPANY_ICON);
148 this->line_height = std::max<int>(this->icon.height + WidgetDimensions::scaled.vsep_normal, GetCharacterHeight(FS_NORMAL));
149
150 for (const Company *c : Company::Iterate()) {
151 widest_width = std::max(widest_width, GetStringBoundingBox(GetString(STR_COMPANY_LEAGUE_COMPANY_NAME, c->index, c->index, widest_title)).width);
152 }
153
154 this->text_width = widest_width + WidgetDimensions::scaled.hsep_indent * 3; // Keep some extra spacing
155
156 size.width = WidgetDimensions::scaled.framerect.Horizontal() + this->rank_width + WidgetDimensions::scaled.hsep_wide + this->icon.width + WidgetDimensions::scaled.hsep_wide + this->text_width;
157 size.height = this->line_height * MAX_COMPANIES + WidgetDimensions::scaled.framerect.Vertical();
158 }
159
160 void OnGameTick() override
161 {
162 if (this->companies.NeedResort()) {
163 this->SetDirty();
164 }
165 }
166
172 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
173 {
174 if (data == 0) {
175 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
176 this->companies.ForceRebuild();
177 } else {
178 this->companies.ForceResort();
179 }
180 }
181};
182
183static constexpr std::initializer_list<NWidgetPart> _nested_performance_league_widgets = {
184 NWidget(NWID_HORIZONTAL),
185 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
186 NWidget(WWT_CAPTION, COLOUR_BROWN), SetStringTip(STR_COMPANY_LEAGUE_TABLE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
187 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
188 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
189 EndContainer(),
190 NWidget(WWT_PANEL, COLOUR_BROWN, WID_PLT_BACKGROUND), SetMinimalSize(400, 0), SetMinimalTextLines(15, WidgetDimensions::unscaled.framerect.Vertical()),
191 EndContainer(),
192};
193
194static WindowDesc _performance_league_desc(
195 WDP_AUTO, "performance_league", 0, 0,
196 WC_COMPANY_LEAGUE, WC_NONE,
197 {},
198 _nested_performance_league_widgets
199);
200
201void ShowPerformanceLeagueTable()
202{
203 AllocateWindowDescFront<PerformanceLeagueWindow>(_performance_league_desc, 0);
204}
205
206static void HandleLinkClick(Link link)
207{
208 TileIndex xy;
209 switch (link.type) {
210 case LT_NONE: return;
211
212 case LT_TILE:
213 if (!IsValidTile(link.target)) return;
214 xy = TileIndex{link.target};
215 break;
216
217 case LT_INDUSTRY:
218 if (!Industry::IsValidID(link.target)) return;
219 xy = Industry::Get(link.target)->location.tile;
220 break;
221
222 case LT_TOWN:
223 if (!Town::IsValidID(link.target)) return;
224 xy = Town::Get(link.target)->xy;
225 break;
226
227 case LT_COMPANY:
228 ShowCompany((CompanyID)link.target);
229 return;
230
231 case LT_STORY_PAGE: {
232 if (!StoryPage::IsValidID(link.target)) return;
233 CompanyID story_company = StoryPage::Get(link.target)->company;
234 ShowStoryBook(story_company, static_cast<StoryPageID>(link.target));
235 return;
236 }
237
238 default: NOT_REACHED();
239 }
240
241 if (_ctrl_pressed) {
242 ShowExtraViewportWindow(xy);
243 } else {
244 ScrollMainWindowToTile(xy);
245 }
246}
247
248
249 class ScriptLeagueWindow : public Window {
250private:
251 LeagueTableID table{};
252 std::vector<std::pair<uint, const LeagueTableElement *>> rows{};
253 uint rank_width = 0;
254 uint text_width = 0;
255 uint score_width = 0;
256 uint header_height = 0;
257 int line_height = 0;
258 Dimension icon_size{};
259 EncodedString title{};
260
264 void BuildTable()
265 {
266 this->rows.clear();
267 this->title = {};
268
269 const LeagueTable *lt = LeagueTable::GetIfValid(this->table);
270 if (lt == nullptr) return;
271
272 /* We store title in the window class so we can safely reference the string later */
273 this->title = lt->title;
274
275 std::vector<const LeagueTableElement *> elements;
276 for (const LeagueTableElement *lte : LeagueTableElement::Iterate()) {
277 if (lte->table != this->table) continue;
278 elements.push_back(lte);
279 }
280 std::ranges::sort(elements, [](const LeagueTableElement *a, const LeagueTableElement *b) { return a->rating > b->rating; });
281
282 /* Calculate rank, companies with the same rating share the ranks */
283 uint rank = 0;
284 for (uint i = 0; i != elements.size(); i++) {
285 const LeagueTableElement *lte = elements[i];
286 if (i > 0 && elements[i - 1]->rating != lte->rating) rank = i;
287 this->rows.emplace_back(rank, lte);
288 }
289 }
290
291public:
292 ScriptLeagueWindow(WindowDesc &desc, WindowNumber table) : Window(desc), table(table)
293 {
294 this->BuildTable();
295 this->InitNested(table);
296 }
297
298 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
299 {
300 if (widget != WID_SLT_CAPTION) return this->Window::GetWidgetString(widget, stringid);
301
302 return this->title.GetDecodedString();
303 }
304
305 void OnPaint() override
306 {
307 this->DrawWidgets();
308 }
309
310 void DrawWidget(const Rect &r, WidgetID widget) const override
311 {
312 if (widget != WID_SLT_BACKGROUND) return;
313
314 const LeagueTable *lt = LeagueTable::GetIfValid(this->table);
315 if (lt == nullptr) return;
316
317 Rect ir = r.Shrink(WidgetDimensions::scaled.framerect);
318
319 if (!lt->header.empty()) {
320 ir.top = DrawStringMultiLine(ir, lt->header.GetDecodedString(), TC_BLACK) + WidgetDimensions::scaled.vsep_wide;
321 }
322
323 int icon_y_offset = (this->line_height - this->icon_size.height) / 2;
324 int text_y_offset = (this->line_height - GetCharacterHeight(FS_NORMAL)) / 2;
325
326 /* Calculate positions.of the columns */
327 bool rtl = _current_text_dir == TD_RTL;
328 int spacer = WidgetDimensions::scaled.hsep_wide;
329 Rect rank_rect = ir.WithWidth(this->rank_width, rtl);
330 Rect icon_rect = ir.Indent(this->rank_width + (rtl ? 0 : spacer), rtl).WithWidth(this->icon_size.width, rtl);
331 Rect text_rect = ir.Indent(this->rank_width + spacer + this->icon_size.width, rtl).WithWidth(this->text_width, rtl);
332 Rect score_rect = ir.Indent(this->rank_width + 2 * spacer + this->icon_size.width + this->text_width, rtl).WithWidth(this->score_width, rtl);
333
334 for (const auto &[rank, lte] : this->rows) {
335 DrawString(rank_rect.left, rank_rect.right, ir.top + text_y_offset, GetString(STR_COMPANY_LEAGUE_COMPANY_RANK, rank + 1));
336 if (this->icon_size.width > 0 && lte->company != CompanyID::Invalid()) DrawCompanyIcon(lte->company, icon_rect.left, ir.top + icon_y_offset);
337 DrawString(text_rect.left, text_rect.right, ir.top + text_y_offset, lte->text.GetDecodedString(), TC_BLACK);
338 DrawString(score_rect.left, score_rect.right, ir.top + text_y_offset, lte->score.GetDecodedString(), TC_BLACK, SA_RIGHT | SA_FORCE);
339 ir.top += this->line_height;
340 }
341
342 if (!lt->footer.empty()) {
343 ir.top += WidgetDimensions::scaled.vsep_wide;
344 ir.top = DrawStringMultiLine(ir, lt->footer.GetDecodedString(), TC_BLACK);
345 }
346 }
347
348 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
349 {
350 if (widget != WID_SLT_BACKGROUND) return;
351
352 const LeagueTable *lt = LeagueTable::GetIfValid(this->table);
353 if (lt == nullptr) return;
354
355 this->icon_size = GetSpriteSize(SPR_COMPANY_ICON);
356 this->line_height = std::max<int>(this->icon_size.height + WidgetDimensions::scaled.fullbevel.Vertical(), GetCharacterHeight(FS_NORMAL));
357
358 /* Calculate maximum width of every column */
359 this->rank_width = this->text_width = this->score_width = 0;
360 bool show_icon_column = false;
361 for (const auto &[rank, lte] : this->rows) {
362 this->rank_width = std::max(this->rank_width, GetStringBoundingBox(GetString(STR_COMPANY_LEAGUE_COMPANY_RANK, rank + 1)).width);
363 this->text_width = std::max(this->text_width, GetStringBoundingBox(lte->text.GetDecodedString()).width);
364 this->score_width = std::max(this->score_width, GetStringBoundingBox(lte->score.GetDecodedString()).width);
365 if (lte->company != CompanyID::Invalid()) show_icon_column = true;
366 }
367
368 if (!show_icon_column) {
369 this->icon_size.width = 0;
370 } else {
371 this->icon_size.width += WidgetDimensions::scaled.hsep_wide;
372 }
373
374 uint non_text_width = this->rank_width + this->icon_size.width + this->score_width + WidgetDimensions::scaled.framerect.Horizontal() + WidgetDimensions::scaled.hsep_wide * 2;
375 size.width = std::max(size.width, non_text_width + this->text_width);
376 uint used_height = this->line_height * std::max<uint>(3u, static_cast<uint>(this->rows.size())) + WidgetDimensions::scaled.framerect.Vertical();
377
378 /* Adjust text_width to fill any space left over if the preset minimal width is larger than our calculated width. */
379 this->text_width = size.width - non_text_width;
380
381 if (!lt->header.empty()) {
382 this->header_height = GetStringHeight(lt->header.GetDecodedString(), size.width - WidgetDimensions::scaled.framerect.Horizontal()) + WidgetDimensions::scaled.vsep_wide;
383 } else {
384 this->header_height = 0;
385 }
386 used_height += this->header_height;
387
388 if (!lt->footer.empty()) {
389 used_height += GetStringHeight(lt->footer.GetDecodedString(), size.width - WidgetDimensions::scaled.framerect.Horizontal()) + WidgetDimensions::scaled.vsep_wide;
390 }
391
392 size.height = std::max(size.height, used_height);
393 }
394
395 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
396 {
397 if (widget != WID_SLT_BACKGROUND) return;
398
399 auto *wid = this->GetWidget<NWidgetResizeBase>(WID_SLT_BACKGROUND);
400 int index = (pt.y - WidgetDimensions::scaled.framerect.top - wid->pos_y - this->header_height) / this->line_height;
401 if (index >= 0 && static_cast<uint>(index) < this->rows.size()) {
402 const LeagueTableElement *lte = this->rows[index].second;
403 HandleLinkClick(lte->link);
404 }
405 }
406
412 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
413 {
414 this->BuildTable();
415 this->ReInit();
416 }
417};
418
419static constexpr std::initializer_list<NWidgetPart> _nested_script_league_widgets = {
420 NWidget(NWID_HORIZONTAL),
421 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
422 NWidget(WWT_CAPTION, COLOUR_BROWN, WID_SLT_CAPTION),
423 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
424 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
425 EndContainer(),
426 NWidget(WWT_PANEL, COLOUR_BROWN, WID_SLT_BACKGROUND), SetMinimalSize(400, 0), SetMinimalTextLines(15, WidgetDimensions::unscaled.framerect.Vertical()),
427 EndContainer(),
428};
429
430static WindowDesc _script_league_desc(
431 WDP_AUTO, "script_league", 0, 0,
432 WC_COMPANY_LEAGUE, WC_NONE,
433 {},
434 _nested_script_league_widgets
435);
436
437void ShowScriptLeagueTable(LeagueTableID table)
438{
439 if (!LeagueTable::IsValidID(table)) return;
440 AllocateWindowDescFront<ScriptLeagueWindow>(_script_league_desc, table);
441}
442
443void ShowFirstLeagueTable()
444{
445 auto it = LeagueTable::Iterate();
446 if (!it.empty()) {
447 ShowScriptLeagueTable((*it.begin())->index);
448 } else {
449 ShowPerformanceLeagueTable();
450 }
451}
EncodedString
Container for an encoded string, created by GetEncodedString.
Definition strings_type.h:98
EncodedString::GetDecodedString
std::string GetDecodedString() const
Decode the encoded string.
Definition strings.cpp:207
GUIList
List template of 'things' T to sort in a GUI.
Definition sortlist_type.h:43
GUIList::RebuildDone
void RebuildDone()
Notify the sortlist that the rebuild is done.
Definition sortlist_type.h:405
GUIList::NeedRebuild
bool NeedRebuild() const
Check if a rebuild is needed.
Definition sortlist_type.h:387
GUIList::ForceRebuild
void ForceRebuild()
Force that a rebuild is needed.
Definition sortlist_type.h:395
GUIList::Sort
bool Sort(Comp compare)
Sort the list.
Definition sortlist_type.h:266
GUIList::ForceResort
void ForceResort()
Force a resort next Sort call Reset the resort timer if used too.
Definition sortlist_type.h:232
GUIList::NeedResort
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0.
Definition sortlist_type.h:218
PerformanceLeagueWindow
Definition league_gui.cpp:57
PerformanceLeagueWindow::UpdateWidgetSize
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
Definition league_gui.cpp:128
PerformanceLeagueWindow::DrawWidget
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
Definition league_gui.cpp:104
PerformanceLeagueWindow::rank_width
uint rank_width
The width of the rank.
Definition league_gui.cpp:60
PerformanceLeagueWindow::line_height
int line_height
Height of the text lines.
Definition league_gui.cpp:62
PerformanceLeagueWindow::BuildCompanyList
void BuildCompanyList()
(Re)Build the company league list
Definition league_gui.cpp:68
PerformanceLeagueWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition league_gui.cpp:96
PerformanceLeagueWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition league_gui.cpp:172
PerformanceLeagueWindow::icon
Dimension icon
Dimension of the company icon.
Definition league_gui.cpp:63
PerformanceLeagueWindow::OnGameTick
void OnGameTick() override
Called once per (game) tick.
Definition league_gui.cpp:160
PerformanceLeagueWindow::text_width
uint text_width
The width of the actual text.
Definition league_gui.cpp:61
PerformanceLeagueWindow::PerformanceSorter
static bool PerformanceSorter(const Company *const &c1, const Company *const &c2)
Sort the company league by performance history.
Definition league_gui.cpp:83
ScriptLeagueWindow
Definition league_gui.cpp:249
ScriptLeagueWindow::DrawWidget
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
Definition league_gui.cpp:310
ScriptLeagueWindow::line_height
int line_height
Height of the text lines.
Definition league_gui.cpp:257
ScriptLeagueWindow::header_height
uint header_height
Height of the table header.
Definition league_gui.cpp:256
ScriptLeagueWindow::GetWidgetString
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
Definition league_gui.cpp:298
ScriptLeagueWindow::text_width
uint text_width
The width of the actual text.
Definition league_gui.cpp:254
ScriptLeagueWindow::UpdateWidgetSize
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
Definition league_gui.cpp:348
ScriptLeagueWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition league_gui.cpp:305
ScriptLeagueWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition league_gui.cpp:412
ScriptLeagueWindow::OnClick
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition league_gui.cpp:395
ScriptLeagueWindow::score_width
uint score_width
The width of the score text.
Definition league_gui.cpp:255
ScriptLeagueWindow::rank_width
uint rank_width
The width of the rank ordinal.
Definition league_gui.cpp:253
ScriptLeagueWindow::icon_size
Dimension icon_size
Dimension of the company icon.
Definition league_gui.cpp:258
ScriptLeagueWindow::BuildTable
void BuildTable()
Rebuild the company league list.
Definition league_gui.cpp:264
WidgetDimensions::framerect
RectPadding framerect
Standard padding inside many panels.
Definition window_gui.h:40
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
WidgetDimensions::vsep_normal
int vsep_normal
Normal vertical spacing.
Definition window_gui.h:58
WidgetDimensions::vsep_wide
int vsep_wide
Wide vertical spacing.
Definition window_gui.h:60
WidgetDimensions::hsep_wide
int hsep_wide
Wide horizontal spacing.
Definition window_gui.h:62
WidgetDimensions::fullbevel
RectPadding fullbevel
Always-scaled bevel thickness.
Definition window_gui.h:39
WidgetDimensions::unscaled
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:93
WidgetDimensions::hsep_indent
int hsep_indent
Width of indentation for tree layouts.
Definition window_gui.h:63
company_base.h
Definition of stuff that is very close to a company, like the company struct itself.
DrawCompanyIcon
void DrawCompanyIcon(CompanyID c, int x, int y)
Draw the icon of a company.
Definition company_cmd.cpp:175
ShowCompany
void ShowCompany(CompanyID company)
Show the window with the overview of the company.
Definition company_gui.cpp:2307
company_gui.h
GUI Functions related to companies.
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:87
GetStringHeight
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition gfx.cpp:715
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition gfx.cpp:968
GetStringBoundingBox
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:897
DrawString
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:668
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:38
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition gfx.cpp:785
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:249
SA_RIGHT
@ SA_RIGHT
Right align the text (must be a single bit).
Definition gfx_type.h:390
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition gfx_type.h:400
SetStringTip
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
Definition widget_type.h:1243
SetMinimalSize
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition widget_type.h:1159
EndContainer
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition widget_type.h:1232
NWidget
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
Definition widget_type.h:1427
SetMinimalTextLines
constexpr NWidgetPart SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
Definition widget_type.h:1190
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:968
gui.h
GUI functions that shouldn't be here.
ShowStoryBook
void ShowStoryBook(CompanyID company, StoryPageID page_id=StoryPageID::Invalid(), bool centered=false)
Raise or create the story book window for company, at page page_id.
Definition story_gui.cpp:1043
ShowExtraViewportWindow
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition viewport_gui.cpp:159
industry.h
Base of all industries.
league_base.h
LeagueTable base class.
league_gui.h
League table GUI functions.
LT_COMPANY
@ LT_COMPANY
Link a company.
Definition league_type.h:21
LT_STORY_PAGE
@ LT_STORY_PAGE
Link a story page.
Definition league_type.h:22
LT_TILE
@ LT_TILE
Link a tile.
Definition league_type.h:18
LT_NONE
@ LT_NONE
No link.
Definition league_type.h:17
LT_INDUSTRY
@ LT_INDUSTRY
Link an industry.
Definition league_type.h:19
LT_TOWN
@ LT_TOWN
Link a town.
Definition league_type.h:20
league_widget.h
Types related to the graph widgets.
WID_PLT_BACKGROUND
@ WID_PLT_BACKGROUND
Background of the window.
Definition league_widget.h:15
WID_SLT_BACKGROUND
@ WID_SLT_BACKGROUND
Background of the window.
Definition league_widget.h:21
WID_SLT_CAPTION
@ WID_SLT_CAPTION
Caption of the window.
Definition league_widget.h:20
safeguards.h
A number of safeguards to prevent using unsafe methods.
sortlist_type.h
Base types for having sorted lists in GUIs.
sprites.h
This file contains all sprite-related enums and defines.
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
story_base.h
StoryPage base class.
GetString
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:56
strings_func.h
Functions related to OTTD's strings.
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:19
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition strings_type.h:27
CompanyProperties::old_economy
std::array< CompanyEconomyEntry, MAX_HISTORY_QUARTERS > old_economy
Economic data of the company of the last MAX_HISTORY_QUARTERS quarters.
Definition company_base.h:118
Company
Definition company_base.h:127
Coord2D< int >
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition geometry_type.hpp:56
LeagueTableElement
Struct about league table elements.
Definition league_base.h:32
LeagueTableElement::rating
int64_t rating
Value that determines ordering of elements in the table (higher=better)
Definition league_base.h:34
LeagueTableElement::link
Link link
What opens when element is clicked.
Definition league_base.h:38
LeagueTable
Struct about custom league tables.
Definition league_base.h:55
LeagueTable::header
EncodedString header
Text to show above the table.
Definition league_base.h:57
LeagueTable::title
EncodedString title
Title of the table.
Definition league_base.h:56
LeagueTable::footer
EncodedString footer
Text to show below the table.
Definition league_base.h:58
Link
Definition league_type.h:27
PoolID< uint8_t, struct CompanyIDTag, 0xF, 0xFF >
Pool::PoolItem<&_company_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition pool_type.hpp:436
Pool::PoolItem<&_industry_pool >::Get
static Titem * Get(auto index)
Returns Titem with given index.
Definition pool_type.hpp:387
Pool::PoolItem<&_company_pool >::GetNumItems
static size_t GetNumItems()
Returns number of valid items in the pool.
Definition pool_type.hpp:417
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition pool_type.hpp:286
Pool::PoolItem<&_industry_pool >::IsValidID
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition pool_type.hpp:376
Pool::PoolItem<&_league_table_pool >::GetIfValid
static Titem * GetIfValid(auto index)
Returns Titem with given index.
Definition pool_type.hpp:398
RectPadding::Horizontal
constexpr uint Horizontal() const
Get total horizontal padding of RectPadding.
Definition geometry_type.hpp:89
RectPadding::Vertical
constexpr uint Vertical() const
Get total vertical padding of RectPadding.
Definition geometry_type.hpp:95
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition geometry_type.hpp:101
Rect::WithWidth
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
Definition geometry_type.hpp:211
Rect::Shrink
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Definition geometry_type.hpp:124
Rect::Indent
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Definition geometry_type.hpp:224
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
WindowDesc
High level window description.
Definition window_gui.h:168
WindowNumber
Number to differentiate different windows of the same class.
Definition window_type.h:760
Window
Data structure for an opened window.
Definition window_gui.h:274
Window::ReInit
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:980
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:784
Window::GetWidgetString
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:506
Window::resize
ResizeInfo resize
Resize information.
Definition window_gui.h:315
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1823
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:312
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:303
tile_map.h
Map writing/reading functions for tiles.
IsValidTile
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition tile_map.h:161
town.h
Base of the town class.
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition viewport.cpp:2592
viewport_func.h
Functions related to (drawing on) viewports.
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:39
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition widget_type.h:57
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition widget_type.h:55
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition widget_type.h:52
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:60
window_gui.h
Functions, definitions and such used only by the GUI.
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:144
WidgetID
int WidgetID
Widget ID.
Definition window_type.h:20
WC_COMPANY_LEAGUE
@ WC_COMPANY_LEAGUE
Company league window; Window numbers:
Definition window_type.h:568
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:50