OpenTTD Source: src/cargotype.h Source File

OpenTTD Source 14.0-beta1

cargotype.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 CARGOTYPE_H
11 #define CARGOTYPE_H
12
13 #include "economy_type.h"
14 #include "cargo_type.h"
15 #include "gfx_type.h"
16 #include "strings_type.h"
17 #include "landscape_type.h"
18 #include "core/bitmath_func.hpp"
19
21 typedef uint32_t CargoLabel;
22
24 enum TownAcceptanceEffect : byte {
25 TAE_BEGIN = 0,
26 TAE_NONE = TAE_BEGIN,
27 TAE_PASSENGERS,
28 TAE_MAIL,
29 TAE_GOODS,
30 TAE_WATER,
31 TAE_FOOD,
32 TAE_END,
33 NUM_TAE = TAE_END,
34 };
35
37 enum TownProductionEffect : byte {
38 TPE_NONE,
39 TPE_PASSENGERS,
40 TPE_MAIL,
41 NUM_TPE,
42
47 INVALID_TPE,
48 };
49
51 enum CargoClass {
52 CC_NOAVAILABLE = 0,
53 CC_PASSENGERS = 1 << 0,
54 CC_MAIL = 1 << 1,
55 CC_EXPRESS = 1 << 2,
56 CC_ARMOURED = 1 << 3,
57 CC_BULK = 1 << 4,
58 CC_PIECE_GOODS = 1 << 5,
59 CC_LIQUID = 1 << 6,
60 CC_REFRIGERATED = 1 << 7,
61 CC_HAZARDOUS = 1 << 8,
62 CC_COVERED = 1 << 9,
63 CC_SPECIAL = 1 << 15,
64 };
65
66 static const byte INVALID_CARGO_BITNUM = 0xFF;
67
68 static const uint TOWN_PRODUCTION_DIVISOR = 256;
69
71 struct CargoSpec {
72 CargoLabel label;
73 uint8_t bitnum{INVALID_CARGO_BITNUM};
74 uint8_t legend_colour;
75 uint8_t rating_colour;
76 uint8_t weight;
77 uint16_t multiplier{0x100};
78 uint16_t classes;
79 int32_t initial_payment;
80 uint8_t transit_periods[2];
81
82 bool is_freight;
83 TownAcceptanceEffect town_acceptance_effect;
84 TownProductionEffect town_production_effect{INVALID_TPE};
85 uint16_t town_production_multiplier{TOWN_PRODUCTION_DIVISOR};
86 uint8_t callback_mask;
87
88 StringID name;
89 StringID name_single;
90 StringID units_volume;
91 StringID quantifier;
92 StringID abbrev;
93
94 SpriteID sprite;
95
96 const struct GRFFile *grffile;
97 const struct SpriteGroup *group;
98
99 Money current_payment;
100
105 inline CargoID Index() const
106 {
107 return this - CargoSpec::array;
108 }
109
115 inline bool IsValid() const
116 {
117 return this->bitnum != INVALID_CARGO_BITNUM;
118 }
119
124 static inline size_t GetArraySize()
125 {
126 return lengthof(CargoSpec::array);
127 }
128
134 static inline CargoSpec *Get(size_t index)
135 {
136 assert(index < lengthof(CargoSpec::array));
137 return &CargoSpec::array[index];
138 }
139
140 SpriteID GetCargoIcon() const;
141
142 inline uint64_t WeightOfNUnits(uint32_t n) const
143 {
144 return n * this->weight / 16u;
145 }
146
147 uint64_t WeightOfNUnitsInTrain(uint32_t n) const;
148
152 struct Iterator {
153 typedef CargoSpec value_type;
154 typedef CargoSpec *pointer;
155 typedef CargoSpec &reference;
156 typedef size_t difference_type;
157 typedef std::forward_iterator_tag iterator_category;
158
159 explicit Iterator(size_t index) : index(index)
160 {
161 this->ValidateIndex();
162 };
163
164 bool operator==(const Iterator &other) const { return this->index == other.index; }
165 bool operator!=(const Iterator &other) const { return !(*this == other); }
166 CargoSpec * operator*() const { return CargoSpec::Get(this->index); }
167 Iterator & operator++() { this->index++; this->ValidateIndex(); return *this; }
168
169 private:
170 size_t index;
171 void ValidateIndex() { while (this->index < CargoSpec::GetArraySize() && !(CargoSpec::Get(this->index)->IsValid())) this->index++; }
172 };
173
174 /*
175 * Iterable ensemble of all valid CargoSpec
176 */
177 struct IterateWrapper {
178 size_t from;
179 IterateWrapper(size_t from = 0) : from(from) {}
180 Iterator begin() { return Iterator(this->from); }
181 Iterator end() { return Iterator(CargoSpec::GetArraySize()); }
182 bool empty() { return this->begin() == this->end(); }
183 };
184
190 static IterateWrapper Iterate(size_t from = 0) { return IterateWrapper(from); }
191
193 static std::array<std::vector<const CargoSpec *>, NUM_TPE> town_production_cargoes;
194
195 private:
196 static CargoSpec array[NUM_CARGO];
197
198 friend void SetupCargoForClimate(LandscapeID l);
199 friend void FinaliseCargoArray();
200 };
201
202 extern CargoTypes _cargo_mask;
203 extern CargoTypes _standard_cargo_mask;
204
205 void SetupCargoForClimate(LandscapeID l);
206 CargoID GetCargoIDByLabel(CargoLabel cl);
207 CargoID GetCargoIDByBitnum(uint8_t bitnum);
208 CargoID GetDefaultCargoID(LandscapeID l, CargoType ct);
209 Dimension GetLargestCargoIconSize();
210
211 void InitializeSortedCargoSpecs();
212 extern std::array<uint8_t, NUM_CARGO> _sorted_cargo_types;
213 extern std::vector<const CargoSpec *> _sorted_cargo_specs;
214 extern std::span<const CargoSpec *> _sorted_standard_cargo_specs;
215
222 inline bool IsCargoInClass(CargoID c, CargoClass cc)
223 {
224 return (CargoSpec::Get(c)->classes & cc) != 0;
225 }
226
227 using SetCargoBitIterator = SetBitIterator<CargoID, CargoTypes>;
228
230 struct CargoIDComparator {
231 bool operator() (const CargoID &lhs, const CargoID &rhs) const { return _sorted_cargo_types[lhs] < _sorted_cargo_types[rhs]; }
232 };
233
234 #endif /* CARGOTYPE_H */
CargoType
CargoType
Available types of cargo.
Definition: cargo_type.h:23
GetDefaultCargoID
CargoID GetDefaultCargoID(LandscapeID l, CargoType ct)
Get the cargo ID of a default cargo, if present.
Definition: cargotype.cpp:94
CC_HAZARDOUS
@ CC_HAZARDOUS
Hazardous cargo (Nuclear Fuel, Explosives, etc.)
Definition: cargotype.h:61
CC_COVERED
@ CC_COVERED
Covered/Sheltered Freight (Transportation in Box Vans, Silo Wagons, etc.)
Definition: cargotype.h:62
TPE_NONE
@ TPE_NONE
Town will not produce this cargo type.
Definition: cargotype.h:38
TPE_MAIL
@ TPE_MAIL
Cargo behaves mail-like for production.
Definition: cargotype.h:40
CargoSpec::label
CargoLabel label
Unique label of the cargo type.
Definition: cargotype.h:72
landscape_type.h
TAE_FOOD
@ TAE_FOOD
Cargo behaves food/fizzy-drinks-like.
Definition: cargotype.h:31
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:30
CargoSpec::IterateWrapper
Definition: cargotype.h:177
CargoSpec::Iterator
Iterator to iterate all valid CargoSpec.
Definition: cargotype.h:152
_cargo_mask
CargoTypes _cargo_mask
Bitmask of cargo types available.
Definition: cargotype.cpp:31
CC_NOAVAILABLE
@ CC_NOAVAILABLE
No cargo class has been specified.
Definition: cargotype.h:52
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
CC_EXPRESS
@ CC_EXPRESS
Express cargo (Goods, Food, Candy, but also possible for passengers)
Definition: cargotype.h:55
Pool::PoolItem<&_spritegroup_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:234
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:134
InitializeSortedCargoSpecs
void InitializeSortedCargoSpecs()
Initialize the list of sorted cargo specifications.
Definition: cargotype.cpp:194
CargoSpec::Iterate
static IterateWrapper Iterate(size_t from=0)
Returns an iterable ensemble of all valid CargoSpec.
Definition: cargotype.h:190
CargoSpec
Specification of a cargo type.
Definition: cargotype.h:71
CC_LIQUID
@ CC_LIQUID
Liquids (Oil, Water, Rubber)
Definition: cargotype.h:59
CargoSpec::GetCargoIcon
SpriteID GetCargoIcon() const
Get sprite for showing cargo of this type.
Definition: cargotype.cpp:147
CC_PASSENGERS
@ CC_PASSENGERS
Passengers.
Definition: cargotype.h:53
CargoSpec::GetArraySize
static size_t GetArraySize()
Total number of cargospecs, both valid and invalid.
Definition: cargotype.h:124
strings_type.h
CargoSpec::initial_payment
int32_t initial_payment
Initial payment rate before inflation is applied.
Definition: cargotype.h:79
CargoSpec::array
static CargoSpec array[NUM_CARGO]
Array holding all CargoSpecs.
Definition: cargotype.h:196
bitmath_func.hpp
GetCargoIDByLabel
CargoID GetCargoIDByLabel(CargoLabel cl)
Get the cargo ID by cargo label.
Definition: cargotype.cpp:115
CargoSpec::Index
CargoID Index() const
Determines index of this cargospec.
Definition: cargotype.h:105
SetBitIterator
Iterable ensemble of each set bit in a value.
Definition: bitmath_func.hpp:282
CC_SPECIAL
@ CC_SPECIAL
Special bit used for livery refit tricks instead of normal cargoes.
Definition: cargotype.h:63
CargoSpec::weight
uint8_t weight
Weight of a single unit of this cargo type in 1/16 ton (62.5 kg).
Definition: cargotype.h:76
TownAcceptanceEffect
TownAcceptanceEffect
Town growth effect when delivering cargo.
Definition: cargotype.h:24
INVALID_CARGO_BITNUM
static const byte INVALID_CARGO_BITNUM
Constant representing invalid cargo.
Definition: cargotype.h:66
CargoSpec::units_volume
StringID units_volume
Name of a single unit of cargo of this type.
Definition: cargotype.h:90
CargoSpec::IsValid
bool IsValid() const
Tests for validity of this cargospec.
Definition: cargotype.h:115
CargoSpec::SetupCargoForClimate
friend void SetupCargoForClimate(LandscapeID l)
Set up the default cargo types for the given landscape type.
Definition: cargotype.cpp:42
TAE_GOODS
@ TAE_GOODS
Cargo behaves goods/candy-like.
Definition: cargotype.h:29
CC_PIECE_GOODS
@ CC_PIECE_GOODS
Piece goods (Livestock, Wood, Steel, Paper)
Definition: cargotype.h:58
NUM_TAE
@ NUM_TAE
Amount of town effects.
Definition: cargotype.h:33
CargoSpec::town_production_cargoes
static std::array< std::vector< const CargoSpec * >, NUM_TPE > town_production_cargoes
List of cargo specs for each Town Product Effect.
Definition: cargotype.h:193
cargo_type.h
CC_BULK
@ CC_BULK
Bulk cargo (Coal, Grain etc., Ores, Fruit)
Definition: cargotype.h:57
CargoSpec::grffile
const struct GRFFile * grffile
NewGRF where #group belongs to.
Definition: cargotype.h:96
GetLargestCargoIconSize
Dimension GetLargestCargoIconSize()
Get dimensions of largest cargo icon.
Definition: cargotype.cpp:79
CargoSpec::FinaliseCargoArray
friend void FinaliseCargoArray()
Check for invalid cargoes.
Definition: newgrf.cpp:9204
CargoSpec::sprite
SpriteID sprite
Icon to display this cargo type, may be 0xFFF (which means to resolve an action123 chain).
Definition: cargotype.h:94
CargoSpec::callback_mask
uint8_t callback_mask
Bitmask of cargo callbacks that have to be called.
Definition: cargotype.h:86
CargoSpec::is_freight
bool is_freight
Cargo type is considered to be freight (affects train freight multiplier).
Definition: cargotype.h:82
CargoSpec::bitnum
uint8_t bitnum
Cargo bit number, is INVALID_CARGO_BITNUM for a non-used spec.
Definition: cargotype.h:73
CargoLabel
uint32_t CargoLabel
Globally unique label of a cargo type.
Definition: cargotype.h:21
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
CargoClass
CargoClass
Cargo classes.
Definition: cargotype.h:51
INVALID_TPE
@ INVALID_TPE
Invalid town production effect.
Definition: cargotype.h:47
CargoSpec::town_production_effect
TownProductionEffect town_production_effect
The effect on town cargo production.
Definition: cargotype.h:84
CC_ARMOURED
@ CC_ARMOURED
Armoured cargo (Valuables, Gold, Diamonds)
Definition: cargotype.h:56
CC_REFRIGERATED
@ CC_REFRIGERATED
Refrigerated cargo (Food, Fruit)
Definition: cargotype.h:60
CargoSpec::quantifier
StringID quantifier
Text for multiple units of cargo of this type.
Definition: cargotype.h:91
TAE_WATER
@ TAE_WATER
Cargo behaves water-like.
Definition: cargotype.h:30
_sorted_standard_cargo_specs
std::span< const CargoSpec * > _sorted_standard_cargo_specs
Standard cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:162
CargoSpec::name
StringID name
Name of this type of cargo.
Definition: cargotype.h:88
CargoSpec::name_single
StringID name_single
Name of a single entity of this type of cargo.
Definition: cargotype.h:89
CargoSpec::abbrev
StringID abbrev
Two letter abbreviation for this cargo type.
Definition: cargotype.h:92
_sorted_cargo_specs
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:161
GetCargoIDByBitnum
CargoID GetCargoIDByBitnum(uint8_t bitnum)
Find the CargoID of a 'bitnum' value.
Definition: cargotype.cpp:131
TownProductionEffect
TownProductionEffect
Town effect when producing cargo.
Definition: cargotype.h:37
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:300
SetupCargoForClimate
void SetupCargoForClimate(LandscapeID l)
Set up the default cargo types for the given landscape type.
Definition: cargotype.cpp:42
CargoIDComparator
Comparator to sort CargoID by according to desired order.
Definition: cargotype.h:230
OverflowSafeInt< int64_t >
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
TAE_END
@ TAE_END
End of town effects.
Definition: cargotype.h:32
TAE_NONE
@ TAE_NONE
Cargo has no effect.
Definition: cargotype.h:26
LandscapeID
byte LandscapeID
Landscape type.
Definition: landscape_type.h:13
_sorted_cargo_types
std::array< uint8_t, NUM_CARGO > _sorted_cargo_types
Sort order of cargoes by cargo ID.
Definition: cargotype.cpp:160
TPE_PASSENGERS
@ TPE_PASSENGERS
Cargo behaves passenger-like for production.
Definition: cargotype.h:39
CargoSpec::town_production_multiplier
uint16_t town_production_multiplier
Town production multipler, if commanded by TownProductionEffect.
Definition: cargotype.h:85
NUM_CARGO
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
Definition: cargo_type.h:68
economy_type.h
TAE_MAIL
@ TAE_MAIL
Cargo behaves mail-like.
Definition: cargotype.h:28
gfx_type.h
IsCargoInClass
bool IsCargoInClass(CargoID c, CargoClass cc)
Does cargo c have cargo class cc?
Definition: cargotype.h:222
CC_MAIL
@ CC_MAIL
Mail.
Definition: cargotype.h:54
SpriteGroup
Definition: newgrf_spritegroup.h:57
CargoSpec::multiplier
uint16_t multiplier
Capacity multiplier for vehicles. (8 fractional bits)
Definition: cargotype.h:77
TAE_PASSENGERS
@ TAE_PASSENGERS
Cargo behaves passenger-like.
Definition: cargotype.h:27
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:107
_standard_cargo_mask
CargoTypes _standard_cargo_mask
Bitmask of real cargo types available.
Definition: cargotype.cpp:36
CargoSpec::classes
uint16_t classes
Classes of this cargo type.
Definition: cargotype.h:78
CargoSpec::town_acceptance_effect
TownAcceptanceEffect town_acceptance_effect
The effect that delivering this cargo type has on towns. Also affects destination of subsidies.
Definition: cargotype.h:83