OpenTTD Source 20250717-master-g55605ae8f2
industry.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 INDUSTRY_H
11#define INDUSTRY_H
12
13#include "core/flatset_type.hpp"
14#include "misc/history_type.hpp"
15#include "newgrf_storage.h"
16#include "subsidy_type.h"
17#include "industry_map.h"
18#include "industrytype.h"
19#include "tilearea_type.h"
20#include "station_base.h"
23
24
26extern IndustryPool _industry_pool;
27
28static const TimerGameEconomy::Year PROCESSING_INDUSTRY_ABANDONMENT_YEARS{5};
29
30/*
31 * Production level maximum, minimum and default values.
32 * It is not a value been really used in order to change, but rather an indicator
33 * of how the industry is behaving.
34 */
35static constexpr uint8_t PRODLEVEL_CLOSURE = 0x00;
36static constexpr uint8_t PRODLEVEL_MINIMUM = 0x04;
37static constexpr uint8_t PRODLEVEL_DEFAULT = 0x10;
38static constexpr uint8_t PRODLEVEL_MAXIMUM = 0x80;
39
44enum class IndustryControlFlag : uint8_t {
52 NoClosure = 2,
55 End,
56};
58
62struct Industry : IndustryPool::PoolItem<&_industry_pool> {
64 uint16_t production = 0;
65 uint16_t transported = 0;
66
67 uint8_t PctTransported() const
68 {
69 if (this->production == 0) return 0;
70 return ClampTo<uint8_t>(this->transported * 256 / this->production);
71 }
72 };
79
85
86 using ProducedCargoes = std::vector<ProducedCargo>;
87 using AcceptedCargoes = std::vector<AcceptedCargo>;
88
90 Town *town = nullptr;
93 ProducedCargoes produced{};
94 AcceptedCargoes accepted{};
95 uint8_t prod_level = 0;
96 uint16_t counter = 0;
97
98 IndustryType type = 0;
100 Colours random_colour = COLOUR_BEGIN;
104
107 mutable std::string cached_name{};
108
111 uint8_t construction_type = 0;
112 uint8_t selected_layout = 0;
116
117 uint16_t random = 0;
118
120
121 Industry(TileIndex tile = INVALID_TILE) : location(tile, 0, 0) {}
122 ~Industry();
123
125
131 inline bool TileBelongsToIndustry(TileIndex tile) const
132 {
133 return IsTileType(tile, MP_INDUSTRY) && GetIndustryIndex(tile) == this->index;
134 }
135
141 inline const ProducedCargo &GetProduced(size_t slot) const
142 {
143 static const ProducedCargo empty{INVALID_CARGO, 0, 0, {}};
144 return slot < this->produced.size() ? this->produced[slot] : empty;
145 }
146
152 inline const AcceptedCargo &GetAccepted(size_t slot) const
153 {
154 static const AcceptedCargo empty{INVALID_CARGO, 0, {}};
155 return slot < this->accepted.size() ? this->accepted[slot] : empty;
156 }
157
163 inline ProducedCargoes::iterator GetCargoProduced(CargoType cargo)
164 {
165 if (!IsValidCargoType(cargo)) return std::end(this->produced);
166 return std::ranges::find(this->produced, cargo, &ProducedCargo::cargo);
167 }
168
174 inline ProducedCargoes::const_iterator GetCargoProduced(CargoType cargo) const
175 {
176 if (!IsValidCargoType(cargo)) return std::end(this->produced);
177 return std::ranges::find(this->produced, cargo, &ProducedCargo::cargo);
178 }
179
185 inline AcceptedCargoes::iterator GetCargoAccepted(CargoType cargo)
186 {
187 if (!IsValidCargoType(cargo)) return std::end(this->accepted);
188 return std::ranges::find(this->accepted, cargo, &AcceptedCargo::cargo);
189 }
190
196 inline AcceptedCargoes::const_iterator GetCargoAccepted(CargoType cargo) const
197 {
198 if (!IsValidCargoType(cargo)) return std::end(this->accepted);
199 return std::ranges::find(this->accepted, cargo, &AcceptedCargo::cargo);
200 }
201
206 bool IsCargoAccepted() const { return std::any_of(std::begin(this->accepted), std::end(this->accepted), [](const auto &a) { return IsValidCargoType(a.cargo); }); }
207
212 bool IsCargoProduced() const { return std::any_of(std::begin(this->produced), std::end(this->produced), [](const auto &p) { return IsValidCargoType(p.cargo); }); }
213
219 bool IsCargoAccepted(CargoType cargo) const { return std::any_of(std::begin(this->accepted), std::end(this->accepted), [&cargo](const auto &a) { return a.cargo == cargo; }); }
220
226 bool IsCargoProduced(CargoType cargo) const { return std::any_of(std::begin(this->produced), std::end(this->produced), [&cargo](const auto &p) { return p.cargo == cargo; }); }
227
234 static inline Industry *GetByTile(TileIndex tile)
235 {
236 return Industry::Get(GetIndustryIndex(tile));
237 }
238
239 static Industry *GetRandom();
240 static void PostDestructor(size_t index);
241
247 static inline uint16_t GetIndustryTypeCount(IndustryType type)
248 {
249 assert(type < NUM_INDUSTRYTYPES);
250 return static_cast<uint16_t>(std::size(industries[type]));
251 }
252
253 inline const std::string &GetCachedName() const
254 {
255 if (this->cached_name.empty()) this->FillCachedName();
256 return this->cached_name;
257 }
258
259 static std::array<FlatSet<IndustryID>, NUM_INDUSTRYTYPES> industries;
260
261private:
262 void FillCachedName() const;
263};
264
265void ClearAllIndustryCachedNames();
266
267void PlantRandomFarmField(const Industry *i);
268
270
272
275 uint32_t probability;
276 uint8_t min_number;
277 uint16_t target_count;
278 uint16_t max_wait;
279 uint16_t wait_count;
280
281 void Reset();
282
283 bool GetIndustryTypeData(IndustryType it);
284};
285
300
302
303
306 IDIWD_FORCE_REBUILD,
307 IDIWD_PRODUCTION_CHANGE,
308 IDIWD_FORCE_RESORT,
309};
310
312
313#endif /* INDUSTRY_H */
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:23
bool IsValidCargoType(CargoType cargo)
Test whether cargo type is not INVALID_CARGO.
Definition cargo_type.h:106
Container for an encoded string, created by GetEncodedString.
static constexpr Owner INVALID_OWNER
An invalid owner.
Flat set container implementation.
Types for storing historical data.
std::array< T, HISTORY_RECORDS > HistoryData
Container type for storing history data.
uint64_t ValidHistoryMask
Mask of valid history records.
static constexpr uint8_t PRODLEVEL_MAXIMUM
the industry is running at full speed
Definition industry.h:38
void ReleaseDisastersTargetingIndustry(IndustryID)
Marks all disasters targeting this industry in such a way they won't call Industry::Get(v->dest_tile)...
static constexpr uint8_t PRODLEVEL_DEFAULT
default level set when the industry is created
Definition industry.h:37
static const TimerGameEconomy::Year PROCESSING_INDUSTRY_ABANDONMENT_YEARS
If a processing industry doesn't produce for this many consecutive economy years, it may close.
Definition industry.h:28
bool IsTileForestIndustry(TileIndex tile)
Check whether the tile is a forest.
IndustryBuildData _industry_builder
In-game manager of industries.
IndustryDirectoryInvalidateWindowData
Special values for the industry list window for the data parameter of InvalidateWindowData.
Definition industry.h:305
static constexpr uint8_t PRODLEVEL_MINIMUM
below this level, the industry is set to be closing
Definition industry.h:36
static constexpr uint8_t PRODLEVEL_CLOSURE
signal set to actually close the industry
Definition industry.h:35
void TrimIndustryAcceptedProduced(Industry *ind)
Remove unused industry accepted/produced slots – entries after the last slot with valid cargo.
IndustryControlFlag
Flags to control/override the behaviour of an industry.
Definition industry.h:44
@ ExternalProdLevel
Indicates that the production level of the industry is externally controlled.
@ NoClosure
Industry can not close regardless of production level or time since last delivery.
@ NoProductionDecrease
When industry production change is evaluated, rolls to decrease are ignored.
@ NoProductionIncrease
When industry production change is evaluated, rolls to increase are ignored.
Accessors for industries.
IndustryID GetIndustryIndex(Tile t)
Get the industry ID of the given tile.
static const IndustryType NUM_INDUSTRYTYPES
total number of industry types, new and old; limited to 240 because we need some special ids like IT_...
Industry type specs.
Functionality related to the temporary and persistent storage arrays for NewGRFs.
Base classes/functions for stations.
std::set< Station *, StationCompare > StationList
List of stations.
Data for managing the number and type of industries in the game.
Definition industry.h:289
void Reset()
Completely reset the industry build data.
void EconomyMonthlyLoop()
Monthly update of industry build data.
uint32_t wanted_inds
Number of wanted industries (bits 31-16), and a fraction (bits 15-0).
Definition industry.h:291
void SetupTargetCount()
Decide how many industries of each type are needed.
void TryBuildNewIndustry()
Try to create a random industry, during gameplay.
IndustryTypeBuildData builddata[NUM_INDUSTRYTYPES]
Industry build data for every industry type.
Definition industry.h:290
Data for managing the number of industries of a single industry type.
Definition industry.h:274
uint32_t probability
Relative probability of building this industry.
Definition industry.h:275
uint16_t target_count
Desired number of industries of this type.
Definition industry.h:277
uint8_t min_number
Smallest number of industries that should exist (either 0 or 1).
Definition industry.h:276
void Reset()
Reset the entry.
bool GetIndustryTypeData(IndustryType it)
Set the probability and min_number fields for the industry type it for a running game.
uint16_t wait_count
Number of turns to wait before trying to build again.
Definition industry.h:279
uint16_t max_wait
Starting number of turns to wait (copied to wait_count).
Definition industry.h:278
CargoType cargo
Cargo type.
Definition industry.h:81
uint16_t waiting
Amount of cargo waiting to processed.
Definition industry.h:82
TimerGameEconomy::Date last_accepted
Last day cargo was accepted by this industry.
Definition industry.h:83
uint16_t waiting
Amount of cargo produced.
Definition industry.h:75
CargoType cargo
Cargo type.
Definition industry.h:74
HistoryData< ProducedHistory > history
History of cargo produced and transported for this month and 24 previous months.
Definition industry.h:77
uint8_t rate
Production rate.
Definition industry.h:76
uint16_t transported
Total transported.
Definition industry.h:65
uint16_t production
Total produced.
Definition industry.h:64
Defines the internal data of a functional industry.
Definition industry.h:62
static Industry * GetRandom()
Return a random valid industry.
IndustryType type
type of industry.
Definition industry.h:98
Owner exclusive_supplier
Which company has exclusive rights to deliver cargo (INVALID_OWNER = anyone)
Definition industry.h:113
TimerGameCalendar::Date construction_date
Date of the construction of the industry.
Definition industry.h:110
IndustryControlFlags ctlflags
flags overriding standard behaviours
Definition industry.h:103
bool IsCargoAccepted() const
Test if this industry accepts any cargo.
Definition industry.h:206
PersistentStorage * psa
Persistent storage for NewGRF industries.
Definition industry.h:119
uint8_t prod_level
general production level
Definition industry.h:95
Colours random_colour
randomized colour of the industry, for display purpose
Definition industry.h:100
void RecomputeProductionMultipliers()
Recompute #production_rate for current prod_level.
EncodedString text
General text with additional information.
Definition industry.h:115
ProducedCargoes::iterator GetCargoProduced(CargoType cargo)
Get produced cargo slot for a specific cargo type.
Definition industry.h:163
uint8_t construction_type
Way the industry was constructed (.
Definition industry.h:111
std::string cached_name
NOSAVE: Cache of the resolved name of the industry.
Definition industry.h:107
const ProducedCargo & GetProduced(size_t slot) const
Safely get a produced cargo slot, or an empty data if the slot does not exist.
Definition industry.h:141
ValidHistoryMask valid_history
Mask of valid history records.
Definition industry.h:92
TimerGameEconomy::Year last_prod_year
last economy year of production
Definition industry.h:101
ProducedCargoes produced
produced cargo slots
Definition industry.h:93
uint16_t random
Random value used for randomisation of all kinds of things.
Definition industry.h:117
AcceptedCargoes::const_iterator GetCargoAccepted(CargoType cargo) const
Get accepted cargo slot for a specific cargo type (const-variant).
Definition industry.h:196
static void PostDestructor(size_t index)
Invalidating some stuff after removing item from the pool.
Town * town
Nearest town.
Definition industry.h:90
Owner founder
Founder of the industry.
Definition industry.h:109
ProducedCargoes::const_iterator GetCargoProduced(CargoType cargo) const
Get produced cargo slot for a specific cargo type (const-variant).
Definition industry.h:174
uint8_t selected_layout
Which tile layout was used when creating the industry.
Definition industry.h:112
AcceptedCargoes accepted
accepted cargo slots
Definition industry.h:94
static uint16_t GetIndustryTypeCount(IndustryType type)
Get the count of industries for this type.
Definition industry.h:247
const AcceptedCargo & GetAccepted(size_t slot) const
Safely get an accepted cargo slot, or an empty data if the slot does not exist.
Definition industry.h:152
bool IsCargoAccepted(CargoType cargo) const
Test if this industry accepts a specific cargo.
Definition industry.h:219
Owner owner
owner of the industry. Which SHOULD always be (imho) OWNER_NONE
Definition industry.h:99
static Industry * GetByTile(TileIndex tile)
Get the industry of the given tile.
Definition industry.h:234
PartsOfSubsidy part_of_subsidy
NOSAVE: is this industry a source/destination of a subsidy?
Definition industry.h:105
TileArea location
Location of the industry.
Definition industry.h:89
bool IsCargoProduced(CargoType cargo) const
Test if this industry produces a specific cargo.
Definition industry.h:226
Station * neutral_station
Associated neutral station.
Definition industry.h:91
StationList stations_near
NOSAVE: List of nearby stations.
Definition industry.h:106
bool IsCargoProduced() const
Test if this industry produces any cargo.
Definition industry.h:212
Owner exclusive_consumer
Which company has exclusive rights to take cargo (INVALID_OWNER = anyone)
Definition industry.h:114
uint16_t counter
used for animation and/or production (if available cargo)
Definition industry.h:96
uint8_t was_cargo_delivered
flag that indicate this has been the closest industry chosen for cargo delivery by a station....
Definition industry.h:102
bool TileBelongsToIndustry(TileIndex tile) const
Check if a given tile belongs to this industry.
Definition industry.h:131
AcceptedCargoes::iterator GetCargoAccepted(CargoType cargo)
Get accepted cargo slot for a specific cargo type.
Definition industry.h:185
static std::array< FlatSet< IndustryID >, NUM_INDUSTRYTYPES > industries
List of industries of each type.
Definition industry.h:259
Represents the covered area of e.g.
Class for pooled persistent storage of data.
Base class for all PoolItems.
static Titem * Get(auto index)
Returns Titem with given index.
Tindex index
Index of this pool item.
Base class for all pools.
Station data structure.
Templated helper to make a type-safe 'typedef' representing a single POD value.
Town data structure.
Definition town.h:52
basic types related to subsidies
static debug_inline bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
@ MP_INDUSTRY
Part of an industry.
Definition tile_type.h:56
Type for storing the 'area' of something uses on the map.
Definition of the game-calendar-timer.
Definition of the game-economy-timer.