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