src/company_base.h

   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
   8 /** @file company_base.h Definition of stuff that is very close to a company, like the company struct itself. */
   9
  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 #include <array>
  21
  22 /** Statistics about the economy. */
  23 struct CompanyEconomyEntry {
  24         Money income;               ///< The amount of income.
  25         Money expenses;             ///< The amount of expenses.
  26         CargoArray delivered_cargo; ///< The amount of delivered cargo.
  27         int32 performance_history;  ///< Company score (scale 0-1000)
  28         Money company_value;        ///< The value of the company.
  29 };
  30
  31 struct CompanyInfrastructure {
  32         uint32 road[ROADTYPE_END]; ///< Count of company owned track bits for each road type.
  33         uint32 signal;             ///< Count of company owned signals.
  34         uint32 rail[RAILTYPE_END]; ///< Count of company owned track bits for each rail type.
  35         uint32 water;              ///< Count of company owned track bits for canals.
  36         uint32 station;            ///< Count of company owned station tiles.
  37         uint32 airport;            ///< Count of company owned airports.
  38
  39         /** Get total sum of all owned track bits. */
  40         uint32 GetRailTotal() const
  41         {
  42                 uint32 total = 0;
  43                 for (RailType rt =  RAILTYPE_BEGIN; rt < RAILTYPE_END; rt++) total += this->rail[rt];
  44                 return total;
  45         }
  46
  47         uint32 GetRoadTotal() const;
  48         uint32 GetTramTotal() const;
  49 };
  50
  51 typedef Pool<Company, CompanyID, 1, MAX_COMPANIES> CompanyPool;
  52 extern CompanyPool _company_pool;
  53
  54
  55 /** Statically loadable part of Company pool item */
  56 struct CompanyProperties {
  57         uint32 name_2;                   ///< Parameter of #name_1.
  58         StringID name_1;                 ///< Name of the company if the user did not change it.
  59         std::string name;                ///< Name of the company if the user changed it.
  60
  61         StringID president_name_1;       ///< Name of the president if the user did not change it.
  62         uint32 president_name_2;         ///< Parameter of #president_name_1
  63         std::string president_name;      ///< Name of the president if the user changed it.
  64
  65         CompanyManagerFace face;         ///< Face description of the president.
  66
  67         Money money;                     ///< Money owned by the company.
  68         byte money_fraction;             ///< Fraction of money of the company, too small to represent in #money.
  69         Money current_loan;              ///< Amount of money borrowed from the bank.
  70
  71         byte colour;                     ///< Company colour.
  72
  73         byte block_preview;              ///< Number of quarters that the company is not allowed to get new exclusive engine previews (see CompaniesGenStatistics).
  74
  75         TileIndex location_of_HQ;        ///< Northern tile of HQ; #INVALID_TILE when there is none.
  76         TileIndex last_build_coordinate; ///< Coordinate of the last build thing by this company.
  77
  78         std::array<Owner, MAX_COMPANY_SHARE_OWNERS> share_owners; ///< Owners of the shares of the company. #INVALID_OWNER if nobody has bought them yet.
  79
  80         Year inaugurated_year;           ///< Year of starting the company.
  81
  82         byte months_of_bankruptcy;       ///< Number of months that the company is unable to pay its debts
  83         CompanyMask bankrupt_asked;      ///< which companies were asked about buying it?
  84         int16 bankrupt_timeout;          ///< If bigger than \c 0, amount of time to wait for an answer on an offer to buy this company.
  85         Money bankrupt_value;
  86
  87         uint32 terraform_limit;          ///< Amount of tileheights we can (still) terraform (times 65536).
  88         uint32 clear_limit;              ///< Amount of tiles we can (still) clear (times 65536).
  89         uint32 tree_limit;               ///< Amount of trees we can (still) plant (times 65536).
  90
  91         /**
  92          * If \c true, the company is (also) controlled by the computer (a NoAI program).
  93          * @note It is possible that the user is also participating in such a company.
  94          */
  95         bool is_ai;
  96
  97         Money yearly_expenses[3][EXPENSES_END];                ///< Expenses of the company for the last three years, in every #ExpensesType category.
  98         CompanyEconomyEntry cur_economy;                       ///< Economic data of the company of this quarter.
  99         CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS]; ///< Economic data of the company of the last #MAX_HISTORY_QUARTERS quarters.
 100         byte num_valid_stat_ent;                               ///< Number of valid statistical entries in #old_economy.
 101
 102         Livery livery[LS_END];
 103
 104         EngineRenewList engine_renew_list; ///< Engine renewals of this company.
 105         CompanySettings settings;          ///< settings specific for each company
 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), colour(0), block_preview(0),
 111                   location_of_HQ(0), last_build_coordinate(0), share_owners(), 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), is_ai(false), engine_renew_list(nullptr) {}
 114 };
 115
 116 struct Company : CompanyProperties, CompanyPool::PoolItem<&_company_pool> {
 117         Company(uint16 name_1 = 0, bool is_ai = false);
 118         ~Company();
 119
 120         RailTypes avail_railtypes;         ///< Rail types available to this company.
 121         RoadTypes avail_roadtypes;         ///< Road types available to this company.
 122
 123         class AIInstance *ai_instance;
 124         class AIInfo *ai_info;
 125
 126         GroupStatistics group_all[VEH_COMPANY_END];      ///< NOSAVE: Statistics for the ALL_GROUP group.
 127         GroupStatistics group_default[VEH_COMPANY_END];  ///< NOSAVE: Statistics for the DEFAULT_GROUP group.
 128
 129         CompanyInfrastructure infrastructure; ///< NOSAVE: Counts of company owned infrastructure.
 130
 131         /**
 132          * Is this company a valid company, controlled by the computer (a NoAI program)?
 133          * @param index Index in the pool.
 134          * @return \c true if it is a valid, computer controlled company, else \c false.
 135          */
 136         static inline bool IsValidAiID(size_t index)
 137         {
 138                 const Company *c = Company::GetIfValid(index);
 139                 return c != nullptr && c->is_ai;
 140         }
 141
 142         /**
 143          * Is this company a valid company, not controlled by a NoAI program?
 144          * @param index Index in the pool.
 145          * @return \c true if it is a valid, human controlled company, else \c false.
 146          * @note If you know that \a index refers to a valid company, you can use #IsHumanID() instead.
 147          */
 148         static inline bool IsValidHumanID(size_t index)
 149         {
 150                 const Company *c = Company::GetIfValid(index);
 151                 return c != nullptr && !c->is_ai;
 152         }
 153
 154         /**
 155          * Is this company a company not controlled by a NoAI program?
 156          * @param index Index in the pool.
 157          * @return \c true if it is a human controlled company, else \c false.
 158          * @pre \a index must be a valid CompanyID.
 159          * @note If you don't know whether \a index refers to a valid company, you should use #IsValidHumanID() instead.
 160          */
 161         static inline bool IsHumanID(size_t index)
 162         {
 163                 return !Company::Get(index)->is_ai;
 164         }
 165
 166         static void PostDestructor(size_t index);
 167 };
 168
 169 Money CalculateCompanyValue(const Company *c, bool including_loan = true);
 170 Money CalculateCompanyValueExcludingShares(const Company *c, bool including_loan = true);
 171
 172 extern uint _next_competitor_start;
 173 extern uint _cur_company_tick_index;
 174
 175 #endif /* COMPANY_BASE_H */