OpenTTD Source  20241108-master-g80f628063a
league_base.h
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 #ifndef LEAGUE_BASE_H
11 #define LEAGUE_BASE_H
12 
13 #include "company_type.h"
14 #include "goal_type.h"
15 #include "league_type.h"
16 #include "core/pool_type.hpp"
17 
18 bool IsValidLink(Link link);
19 
21 extern LeagueTableElementPool _league_table_element_pool;
22 
24 extern LeagueTablePool _league_table_pool;
25 
26 
31 struct LeagueTableElement : LeagueTableElementPool::PoolItem<&_league_table_element_pool> {
33  int64_t rating;
35  std::string text;
36  std::string score;
38 
43 
48 };
49 
50 
52 struct LeagueTable : LeagueTablePool::PoolItem<&_league_table_pool> {
53  std::string title;
54  std::string header;
55  std::string footer;
56 
61 
66 };
67 
68 #endif /* LEAGUE_BASE_H */
Types related to companies.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
basic types related to goals
bool IsValidLink(Link link)
Checks whether a link is valid, i.e.
Definition: league_cmd.cpp:34
basic types related to league tables
uint8_t LeagueTableID
ID of a league table.
Definition: league_type.h:32
Definition of Pool, structure used to access PoolItems, and PoolItem, base structure for Vehicle,...
Struct about league table elements.
Definition: league_base.h:31
std::string score
String representation of the score associated with the element.
Definition: league_base.h:36
std::string text
Text of the element.
Definition: league_base.h:35
int64_t rating
Value that determines ordering of elements in the table (higher=better)
Definition: league_base.h:33
~LeagueTableElement()
(Empty) destructor has to be defined else operator delete might be called with nullptr parameter
Definition: league_base.h:47
LeagueTableElement()
We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
Definition: league_base.h:42
Link link
What opens when element is clicked.
Definition: league_base.h:37
LeagueTableID table
Id of the table which this element belongs to.
Definition: league_base.h:32
CompanyID company
Company Id to show the color blob for or INVALID_COMPANY.
Definition: league_base.h:34
Struct about custom league tables.
Definition: league_base.h:52
LeagueTable()
We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
Definition: league_base.h:60
std::string header
Text to show above the table.
Definition: league_base.h:54
std::string title
Title of the table.
Definition: league_base.h:53
~LeagueTable()
(Empty) destructor has to be defined else operator delete might be called with nullptr parameter
Definition: league_base.h:65
std::string footer
Text to show below the table.
Definition: league_base.h:55
Base class for all PoolItems.
Definition: pool_type.hpp:237
Base class for all pools.
Definition: pool_type.hpp:80