OpenTTD Source: src/company_base.h Source File

OpenTTD Source 14.0-beta1

company_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 COMPANY_BASE_H
11 #define COMPANY_BASE_H
12
13 #include "road_type.h"
14 #include "livery.h"
15 #include "autoreplace_type.h"
16 #include "tile_type.h"
17 #include "timer/timer_game_economy.h"
18 #include "settings_type.h"
19 #include "group.h"
20
21 static const Money COMPANY_MAX_LOAN_DEFAULT = INT64_MIN;
22
24 struct CompanyEconomyEntry {
25 Money income;
26 Money expenses;
27 CargoArray delivered_cargo{};
28 int32_t performance_history;
29 Money company_value;
30 };
31
32 struct CompanyInfrastructure {
33 uint32_t road[ROADTYPE_END];
34 uint32_t signal;
35 uint32_t rail[RAILTYPE_END];
36 uint32_t water;
37 uint32_t station;
38 uint32_t airport;
39
41 uint32_t GetRailTotal() const
42 {
43 uint32_t total = 0;
44 for (RailType rt = RAILTYPE_BEGIN; rt < RAILTYPE_END; rt++) total += this->rail[rt];
45 return total;
46 }
47
48 uint32_t GetRoadTotal() const;
49 uint32_t GetTramTotal() const;
50 };
51
52 typedef Pool<Company, CompanyID, 1, MAX_COMPANIES> CompanyPool;
53 extern CompanyPool _company_pool;
54
56 struct CompanyProperties {
57 uint32_t name_2;
58 StringID name_1;
59 std::string name;
60
61 StringID president_name_1;
62 uint32_t president_name_2;
63 std::string president_name;
64
65 CompanyManagerFace face;
66
67 Money money;
68 byte money_fraction;
69 Money current_loan;
70 Money max_loan;
71
72 Colours colour;
73
74 byte block_preview;
75
76 TileIndex location_of_HQ;
77 TileIndex last_build_coordinate;
78
79 TimerGameEconomy::Year inaugurated_year;
80
81 byte months_of_bankruptcy;
82 CompanyMask bankrupt_asked;
83 int16_t bankrupt_timeout;
84 Money bankrupt_value;
85
86 uint32_t terraform_limit;
87 uint32_t clear_limit;
88 uint32_t tree_limit;
89 uint32_t build_object_limit;
90
95 bool is_ai;
96
97 std::array<Expenses, 3> yearly_expenses{};
98 CompanyEconomyEntry cur_economy;
99 CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS];
100 byte num_valid_stat_ent;
101
102 Livery livery[LS_END];
103
104 EngineRenewList engine_renew_list;
105 CompanySettings settings;
106
107 // TODO: Change some of these member variables to use relevant INVALID_xxx constants
108 CompanyProperties()
109 : name_2(0), name_1(0), president_name_1(0), president_name_2(0),
110 face(0), money(0), money_fraction(0), current_loan(0), max_loan(COMPANY_MAX_LOAN_DEFAULT),
111 colour(COLOUR_BEGIN), block_preview(0), location_of_HQ(0), last_build_coordinate(0), inaugurated_year(0),
112 months_of_bankruptcy(0), bankrupt_asked(0), bankrupt_timeout(0), bankrupt_value(0),
113 terraform_limit(0), clear_limit(0), tree_limit(0), build_object_limit(0), is_ai(false), engine_renew_list(nullptr) {}
114 };
115
116 struct Company : CompanyProperties, CompanyPool::PoolItem<&_company_pool> {
117 Company(uint16_t name_1 = 0, bool is_ai = false);
118 ~Company();
119
120 RailTypes avail_railtypes;
121 RoadTypes avail_roadtypes;
122
123 class AIInstance *ai_instance;
124 class AIInfo *ai_info;
125
126 GroupStatistics group_all[VEH_COMPANY_END];
127 GroupStatistics group_default[VEH_COMPANY_END];
128
129 CompanyInfrastructure infrastructure;
130
131 Money GetMaxLoan() const;
132
138 static inline bool IsValidAiID(size_t index)
139 {
140 const Company *c = Company::GetIfValid(index);
141 return c != nullptr && c->is_ai;
142 }
143
150 static inline bool IsValidHumanID(size_t index)
151 {
152 const Company *c = Company::GetIfValid(index);
153 return c != nullptr && !c->is_ai;
154 }
155
163 static inline bool IsHumanID(size_t index)
164 {
165 return !Company::Get(index)->is_ai;
166 }
167
168 static void PostDestructor(size_t index);
169 };
170
171 Money CalculateCompanyValue(const Company *c, bool including_loan = true);
172 Money CalculateHostileTakeoverValue(const Company *c);
173
174 extern uint _cur_company_tick_index;
175
176 #endif /* COMPANY_BASE_H */
CompanyProperties::is_ai
bool is_ai
If true, the company is (also) controlled by the computer (a NoAI program).
Definition: company_base.h:95
_company_pool
CompanyPool _company_pool
Pool of companies.
CompanyProperties::clear_limit
uint32_t clear_limit
Amount of tiles we can (still) clear (times 65536).
Definition: company_base.h:87
CompanyEconomyEntry::company_value
Money company_value
The value of the company.
Definition: company_base.h:29
ROADTYPE_END
@ ROADTYPE_END
Used for iterations.
Definition: road_type.h:29
Pool::PoolItem<&_company_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:335
Company::group_all
GroupStatistics group_all[VEH_COMPANY_END]
NOSAVE: Statistics for the ALL_GROUP group.
Definition: company_base.h:126
Pool::PoolItem<&_company_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:346
Company::avail_railtypes
RailTypes avail_railtypes
Rail types available to this company.
Definition: company_base.h:120
Company::avail_roadtypes
RoadTypes avail_roadtypes
Road types available to this company.
Definition: company_base.h:121
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Pool::PoolItem<&_company_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:234
CompanyProperties::money_fraction
byte money_fraction
Fraction of money of the company, too small to represent in money.
Definition: company_base.h:68
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:97
CompanyInfrastructure
Definition: company_base.h:32
Company::PostDestructor
static void PostDestructor(size_t index)
Invalidating some stuff after removing item from the pool.
Definition: company_cmd.cpp:88
group.h
CompanyProperties::bankrupt_timeout
int16_t bankrupt_timeout
If bigger than 0, amount of time to wait for an answer on an offer to buy this company.
Definition: company_base.h:83
CompanyProperties::name
std::string name
Name of the company if the user changed it.
Definition: company_base.h:59
Company::IsValidHumanID
static bool IsValidHumanID(size_t index)
Is this company a valid company, not controlled by a NoAI program?
Definition: company_base.h:150
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
Company::infrastructure
CompanyInfrastructure infrastructure
NOSAVE: Counts of company owned infrastructure.
Definition: company_base.h:129
CompanyInfrastructure::road
uint32_t road[ROADTYPE_END]
Count of company owned track bits for each road type.
Definition: company_base.h:33
CompanyProperties::last_build_coordinate
TileIndex last_build_coordinate
Coordinate of the last build thing by this company.
Definition: company_base.h:77
CompanyProperties::face
CompanyManagerFace face
Face description of the president.
Definition: company_base.h:65
CompanyProperties::president_name_2
uint32_t president_name_2
Parameter of president_name_1.
Definition: company_base.h:62
CompanyProperties::block_preview
byte block_preview
Number of quarters that the company is not allowed to get new exclusive engine previews (see Companie...
Definition: company_base.h:74
CalculateCompanyValue
Money CalculateCompanyValue(const Company *c, bool including_loan=true)
Calculate the value of the company.
Definition: economy.cpp:149
RailTypes
RailTypes
Allow incrementing of Track variables.
Definition: rail_type.h:44
Company::Company
Company(uint16_t name_1=0, bool is_ai=false)
Constructor.
Definition: company_cmd.cpp:63
CompanyProperties::current_loan
Money current_loan
Amount of money borrowed from the bank.
Definition: company_base.h:69
CompanyInfrastructure::station
uint32_t station
Count of company owned station tiles.
Definition: company_base.h:37
CompanyEconomyEntry
Statistics about the economy.
Definition: company_base.h:24
GroupStatistics
Statistics and caches on the vehicles in a group.
Definition: group.h:24
RailType
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
CompanyProperties::tree_limit
uint32_t tree_limit
Amount of trees we can (still) plant (times 65536).
Definition: company_base.h:88
CompanyInfrastructure::GetRailTotal
uint32_t GetRailTotal() const
Get total sum of all owned track bits.
Definition: company_base.h:41
CompanyProperties::num_valid_stat_ent
byte num_valid_stat_ent
Number of valid statistical entries in old_economy.
Definition: company_base.h:100
VEH_COMPANY_END
@ VEH_COMPANY_END
Last company-ownable type.
Definition: vehicle_type.h:29
RoadTypes
RoadTypes
The different roadtypes we support, but then a bitmask of them.
Definition: road_type.h:38
Company::group_default
GroupStatistics group_default[VEH_COMPANY_END]
NOSAVE: Statistics for the DEFAULT_GROUP group.
Definition: company_base.h:127
CompanyProperties::months_of_bankruptcy
byte months_of_bankruptcy
Number of months that the company is unable to pay its debts.
Definition: company_base.h:81
CompanyProperties::colour
Colours colour
Company colour.
Definition: company_base.h:72
CompanyProperties::money
Money money
Money owned by the company.
Definition: company_base.h:67
CompanyProperties::settings
CompanySettings settings
settings specific for each company
Definition: company_base.h:105
CompanyProperties::name_2
uint32_t name_2
Parameter of name_1.
Definition: company_base.h:57
Company::IsValidAiID
static bool IsValidAiID(size_t index)
Is this company a valid company, controlled by the computer (a NoAI program)?
Definition: company_base.h:138
CompanyProperties::location_of_HQ
TileIndex location_of_HQ
Northern tile of HQ; INVALID_TILE when there is none.
Definition: company_base.h:76
CompanyManagerFace
uint32_t CompanyManagerFace
Company manager face bits, info see in company_manager_face.h.
Definition: company_type.h:52
settings_type.h
CompanyProperties::president_name
std::string president_name
Name of the president if the user changed it.
Definition: company_base.h:63
MAX_HISTORY_QUARTERS
static const uint MAX_HISTORY_QUARTERS
The maximum number of quarters kept as performance's history.
Definition: company_type.h:43
Company::GetMaxLoan
Money GetMaxLoan() const
Calculate the max allowed loan for this company.
Definition: company_cmd.cpp:102
livery.h
EngineRenew
Struct to store engine replacements.
Definition: autoreplace_base.h:33
Company::IsHumanID
static bool IsHumanID(size_t index)
Is this company a company not controlled by a NoAI program?
Definition: company_base.h:163
_cur_company_tick_index
uint _cur_company_tick_index
used to generate a name for one company that doesn't have a name yet per tick
Definition: company_cmd.cpp:53
CompanyProperties::bankrupt_asked
CompanyMask bankrupt_asked
which companies were asked about buying it?
Definition: company_base.h:82
CompanyEconomyEntry::delivered_cargo
CargoArray delivered_cargo
The amount of delivered cargo.
Definition: company_base.h:27
CompanyEconomyEntry::expenses
Money expenses
The amount of expenses.
Definition: company_base.h:26
CompanyProperties::inaugurated_year
TimerGameEconomy::Year inaugurated_year
Economy year of starting the company.
Definition: company_base.h:79
CompanySettings
Settings that can be set per company.
Definition: settings_type.h:608
CompanyEconomyEntry::performance_history
int32_t performance_history
Company score (scale 0-1000)
Definition: company_base.h:28
Pool
Base class for all pools.
Definition: pool_type.hpp:80
CompanyInfrastructure::GetTramTotal
uint32_t GetTramTotal() const
Get total sum of all owned tram bits.
Definition: company_cmd.cpp:1219
CompanyProperties::cur_economy
CompanyEconomyEntry cur_economy
Economic data of the company of this quarter.
Definition: company_base.h:98
CompanyInfrastructure::airport
uint32_t airport
Count of company owned airports.
Definition: company_base.h:38
CompanyInfrastructure::signal
uint32_t signal
Count of company owned signals.
Definition: company_base.h:34
CompanyProperties::yearly_expenses
std::array< Expenses, 3 > yearly_expenses
Expenses of the company for the last three years.
Definition: company_base.h:97
tile_type.h
RAILTYPE_END
@ RAILTYPE_END
Used for iterations.
Definition: rail_type.h:33
CompanyProperties::terraform_limit
uint32_t terraform_limit
Amount of tileheights we can (still) terraform (times 65536).
Definition: company_base.h:86
CompanyInfrastructure::GetRoadTotal
uint32_t GetRoadTotal() const
Get total sum of all owned road bits.
Definition: company_cmd.cpp:1206
CompanyEconomyEntry::income
Money income
The amount of income.
Definition: company_base.h:25
CompanyProperties::president_name_1
StringID president_name_1
Name of the president if the user did not change it.
Definition: company_base.h:61
Company::~Company
~Company()
Destructor.
Definition: company_cmd.cpp:77
road_type.h
AIInfo
All static information from an AI like name, version, etc.
Definition: ai_info.hpp:16
OverflowSafeInt< int64_t >
CompanyProperties::build_object_limit
uint32_t build_object_limit
Amount of tiles we can (still) build objects on (times 65536). Also applies to buying land.
Definition: company_base.h:89
AIInstance
Runtime information about an AI like a pointer to the squirrel vm and the current state.
Definition: ai_instance.hpp:16
autoreplace_type.h
CompanyProperties::engine_renew_list
EngineRenewList engine_renew_list
Engine renewals of this company.
Definition: company_base.h:104
Company
Definition: company_base.h:116
Pool::PoolItem
Base class for all PoolItems.
Definition: pool_type.hpp:233
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:99
CalculateHostileTakeoverValue
Money CalculateHostileTakeoverValue(const Company *c)
Calculate what you have to pay to take over a company.
Definition: economy.cpp:176
Livery
Information about a particular livery.
Definition: livery.h:78
CompanyProperties
Statically loadable part of Company pool item.
Definition: company_base.h:56
CompanyInfrastructure::water
uint32_t water
Count of company owned track bits for canals.
Definition: company_base.h:36
timer_game_economy.h
CompanyInfrastructure::rail
uint32_t rail[RAILTYPE_END]
Count of company owned track bits for each rail type.
Definition: company_base.h:35
CompanyProperties::name_1
StringID name_1
Name of the company if the user did not change it.
Definition: company_base.h:58
CompanyProperties::max_loan
Money max_loan
Max allowed amount of the loan or COMPANY_MAX_LOAN_DEFAULT.
Definition: company_base.h:70
RAILTYPE_BEGIN
@ RAILTYPE_BEGIN
Used for iterations.
Definition: rail_type.h:28