OpenTTD Source  1.11.2
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 "settings_type.h"
18 #include "group.h"
19 #include <string>
20 
28 };
29 
31  uint32 road[ROADTYPE_END];
32  uint32 signal;
33  uint32 rail[RAILTYPE_END];
34  uint32 water;
35  uint32 station;
36  uint32 airport;
37 
39  uint32 GetRailTotal() const
40  {
41  uint32 total = 0;
42  for (RailType rt = RAILTYPE_BEGIN; rt < RAILTYPE_END; rt++) total += this->rail[rt];
43  return total;
44  }
45 
46  uint32 GetRoadTotal() const;
47  uint32 GetTramTotal() const;
48 };
49 
52 
53 
56  uint32 name_2;
58  std::string name;
59 
62  std::string president_name;
63 
65 
69 
70  byte colour;
71 
73 
76 
78 
80 
82  CompanyMask bankrupt_asked;
84  Money bankrupt_value;
85 
86  uint32 terraform_limit;
87  uint32 clear_limit;
88  uint32 tree_limit;
89 
94  bool is_ai;
95 
100 
101  // TODO: Change some of these member variables to use relevant INVALID_xxx constants
104  face(0), money(0), money_fraction(0), current_loan(0), colour(0), block_preview(0),
106  months_of_bankruptcy(0), bankrupt_asked(0), bankrupt_timeout(0), bankrupt_value(0),
107  terraform_limit(0), clear_limit(0), tree_limit(0), is_ai(false) {}
108 };
109 
111  Company(uint16 name_1 = 0, bool is_ai = false);
112  ~Company();
113 
114  Livery livery[LS_END];
117 
118  class AIInstance *ai_instance;
119  class AIInfo *ai_info;
120 
125 
127 
133  static inline bool IsValidAiID(size_t index)
134  {
135  const Company *c = Company::GetIfValid(index);
136  return c != nullptr && c->is_ai;
137  }
138 
145  static inline bool IsValidHumanID(size_t index)
146  {
147  const Company *c = Company::GetIfValid(index);
148  return c != nullptr && !c->is_ai;
149  }
150 
158  static inline bool IsHumanID(size_t index)
159  {
160  return !Company::Get(index)->is_ai;
161  }
162 
163  static void PostDestructor(size_t index);
164 };
165 
166 Money CalculateCompanyValue(const Company *c, bool including_loan = true);
167 
168 extern uint _next_competitor_start;
169 extern uint _cur_company_tick_index;
170 
171 #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:94
_company_pool
CompanyPool _company_pool
Pool of companies.
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
CompanyEconomyEntry::company_value
Money company_value
The value of the company.
Definition: company_base.h:27
Pool::PoolItem<&_company_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:329
EXPENSES_END
@ EXPENSES_END
Number of expense types.
Definition: economy_type.h:171
Company::group_all
GroupStatistics group_all[VEH_COMPANY_END]
NOSAVE: Statistics for the ALL_GROUP group.
Definition: company_base.h:123
Pool::PoolItem<&_company_pool >::GetIfValid
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:340
Company::avail_railtypes
RailTypes avail_railtypes
Rail types available to this company.
Definition: company_base.h:115
CompanyManagerFace
uint32 CompanyManagerFace
Company manager face bits, info see in company_manager_face.h.
Definition: company_type.h:51
Company::avail_roadtypes
RoadTypes avail_roadtypes
Road types available to this company.
Definition: company_base.h:116
CompanyProperties::inaugurated_year
Year inaugurated_year
Year of starting the company.
Definition: company_base.h:79
CompanyProperties::tree_limit
uint32 tree_limit
Amount of trees we can (still) plant (times 65536).
Definition: company_base.h:88
CompanyInfrastructure::water
uint32 water
Count of company owned track bits for canals.
Definition: company_base.h:34
Pool::PoolItem<&_company_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:227
CompanyProperties::money_fraction
byte money_fraction
Fraction of money of the company, too small to represent in money.
Definition: company_base.h:67
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:81
CompanyInfrastructure
Definition: company_base.h:30
Company::PostDestructor
static void PostDestructor(size_t index)
Invalidating some stuff after removing item from the pool.
Definition: company_cmd.cpp:86
CompanyInfrastructure::station
uint32 station
Count of company owned station tiles.
Definition: company_base.h:35
group.h
Year
int32 Year
Type for the year, note: 0 based, i.e. starts at the year 0.
Definition: date_type.h:18
ROADTYPE_END
@ ROADTYPE_END
Used for iterations.
Definition: road_type.h:26
CompanyProperties::name
std::string name
Name of the company if the user changed it.
Definition: company_base.h:58
Company::IsValidHumanID
static bool IsValidHumanID(size_t index)
Is this company a valid company, not controlled by a NoAI program?
Definition: company_base.h:145
Company::infrastructure
CompanyInfrastructure infrastructure
NOSAVE: Counts of company owned infrastructure.
Definition: company_base.h:126
CompanyProperties::last_build_coordinate
TileIndex last_build_coordinate
Coordinate of the last build thing by this company.
Definition: company_base.h:75
CompanyProperties::face
CompanyManagerFace face
Face description of the president.
Definition: company_base.h:64
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:72
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
CalculateCompanyValue
Money CalculateCompanyValue(const Company *c, bool including_loan=true)
Calculate the value of the company.
Definition: economy.cpp:111
CompanyProperties::current_loan
Money current_loan
Amount of money borrowed from the bank.
Definition: company_base.h:68
CompanyEconomyEntry
Statistics about the economy.
Definition: company_base.h:22
CompanyInfrastructure::GetRoadTotal
uint32 GetRoadTotal() const
Get total sum of all owned road bits.
Definition: company_cmd.cpp:1169
CompanyProperties::name_2
uint32 name_2
Parameter of name_1.
Definition: company_base.h:56
CompanyProperties::clear_limit
uint32 clear_limit
Amount of tiles we can (still) clear (times 65536).
Definition: company_base.h:87
GroupStatistics
Statistics and caches on the vehicles in a group.
Definition: group.h:25
CompanyInfrastructure::GetTramTotal
uint32 GetTramTotal() const
Get total sum of all owned tram bits.
Definition: company_cmd.cpp:1182
Company::Company
Company(uint16 name_1=0, bool is_ai=false)
Constructor.
Definition: company_cmd.cpp:61
CompanyProperties::colour
byte colour
Company colour.
Definition: company_base.h:70
RailType
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
CompanyEconomyEntry::performance_history
int32 performance_history
Company score (scale 0-1000)
Definition: company_base.h:26
CompanyProperties::terraform_limit
uint32 terraform_limit
Amount of tileheights we can (still) terraform (times 65536).
Definition: company_base.h:86
CompanyProperties::num_valid_stat_ent
byte num_valid_stat_ent
Number of valid statistical entries in old_economy.
Definition: company_base.h:99
VEH_COMPANY_END
@ VEH_COMPANY_END
Last company-ownable type.
Definition: vehicle_type.h:29
Company::group_default
GroupStatistics group_default[VEH_COMPANY_END]
NOSAVE: Statistics for the DEFAULT_GROUP group.
Definition: company_base.h:124
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::money
Money money
Money owned by the company.
Definition: company_base.h:66
RoadTypes
RoadTypes
The different roadtypes we support, but then a bitmask of them.
Definition: road_type.h:36
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:133
CompanyProperties::location_of_HQ
TileIndex location_of_HQ
Northern tile of HQ; INVALID_TILE when there is none.
Definition: company_base.h:74
settings_type.h
CompanyProperties::president_name
std::string president_name
Name of the president if the user changed it.
Definition: company_base.h:62
MAX_HISTORY_QUARTERS
static const uint MAX_HISTORY_QUARTERS
The maximum number of quarters kept as performance's history.
Definition: company_type.h:42
CompanyInfrastructure::road
uint32 road[ROADTYPE_END]
Count of company owned track bits for each road type.
Definition: company_base.h:31
CompanyInfrastructure::signal
uint32 signal
Count of company owned signals.
Definition: company_base.h:32
CompanyProperties::yearly_expenses
Money yearly_expenses[3][EXPENSES_END]
Expenses of the company for the last three years, in every ExpensesType category.
Definition: company_base.h:96
Company::engine_renew_list
EngineRenewList engine_renew_list
Engine renewals of this company.
Definition: company_base.h:121
CompanyProperties::share_owners
Owner share_owners[4]
Owners of the 4 shares of the company. INVALID_OWNER if nobody has bought them yet.
Definition: company_base.h:77
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:158
_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:51
CompanyProperties::bankrupt_asked
CompanyMask bankrupt_asked
which companies were asked about buying it?
Definition: company_base.h:82
CompanyProperties::president_name_2
uint32 president_name_2
Parameter of president_name_1.
Definition: company_base.h:61
CompanyEconomyEntry::delivered_cargo
CargoArray delivered_cargo
The amount of delivered cargo.
Definition: company_base.h:25
_next_competitor_start
uint _next_competitor_start
the number of ticks before the next AI is started
Definition: company_cmd.cpp:50
CompanyEconomyEntry::expenses
Money expenses
The amount of expenses.
Definition: company_base.h:24
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
CompanySettings
Settings that can be set per company.
Definition: settings_type.h:553
Pool
Base class for all pools.
Definition: pool_type.hpp:81
CompanyProperties::cur_economy
CompanyEconomyEntry cur_economy
Economic data of the company of this quarter.
Definition: company_base.h:97
tile_type.h
RAILTYPE_END
@ RAILTYPE_END
Used for iterations.
Definition: rail_type.h:33
CompanyInfrastructure::rail
uint32 rail[RAILTYPE_END]
Count of company owned track bits for each rail type.
Definition: company_base.h:33
CompanyInfrastructure::airport
uint32 airport
Count of company owned airports.
Definition: company_base.h:36
CompanyEconomyEntry::income
Money income
The amount of income.
Definition: company_base.h:23
CompanyProperties::president_name_1
StringID president_name_1
Name of the president if the user did not change it.
Definition: company_base.h:60
Company::~Company
~Company()
Destructor.
Definition: company_cmd.cpp:75
road_type.h
AIInfo
All static information from an AI like name, version, etc.
Definition: ai_info.hpp:16
OverflowSafeInt< int64, INT64_MAX, INT64_MIN >
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
Company
Definition: company_base.h:110
RailTypes
RailTypes
The different railtypes we support, but then a bitmask of them.
Definition: rail_type.h:46
Pool::PoolItem
Base class for all PoolItems.
Definition: pool_type.hpp:226
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:98
CompanyProperties::bankrupt_timeout
int16 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
Company::settings
CompanySettings settings
settings specific for each company
Definition: company_base.h:122
Livery
Information about a particular livery.
Definition: livery.h:78
CompanyProperties
Statically loadable part of Company pool item.
Definition: company_base.h:55
CompanyInfrastructure::GetRailTotal
uint32 GetRailTotal() const
Get total sum of all owned track bits.
Definition: company_base.h:39
CompanyProperties::name_1
StringID name_1
Name of the company if the user did not change it.
Definition: company_base.h:57
RAILTYPE_BEGIN
@ RAILTYPE_BEGIN
Used for iterations.
Definition: rail_type.h:28