OpenTTD Source: src/cargotype.h Source File

OpenTTD Source 12.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 #include "core/span_type.hpp"
20 #include <vector>
21
23 typedef uint32 CargoLabel;
24
26 enum TownEffect {
27 TE_BEGIN = 0,
28 TE_NONE = TE_BEGIN,
29 TE_PASSENGERS,
30 TE_MAIL,
31 TE_GOODS,
32 TE_WATER,
33 TE_FOOD,
34 TE_END,
35 NUM_TE = TE_END,
36 };
37
39 enum CargoClass {
40 CC_NOAVAILABLE = 0,
41 CC_PASSENGERS = 1 << 0,
42 CC_MAIL = 1 << 1,
43 CC_EXPRESS = 1 << 2,
44 CC_ARMOURED = 1 << 3,
45 CC_BULK = 1 << 4,
46 CC_PIECE_GOODS = 1 << 5,
47 CC_LIQUID = 1 << 6,
48 CC_REFRIGERATED = 1 << 7,
49 CC_HAZARDOUS = 1 << 8,
50 CC_COVERED = 1 << 9,
51 CC_SPECIAL = 1 << 15,
52 };
53
54 static const byte INVALID_CARGO = 0xFF;
55
57 struct CargoSpec {
58 uint8 bitnum;
59 CargoLabel label;
60 uint8 legend_colour;
61 uint8 rating_colour;
62 uint8 weight;
63 uint16 multiplier;
64 int32 initial_payment;
65 uint8 transit_days[2];
66
67 bool is_freight;
68 TownEffect town_effect;
69 uint16 multipliertowngrowth;
70 uint8 callback_mask;
71
72 StringID name;
73 StringID name_single;
74 StringID units_volume;
75 StringID quantifier;
76 StringID abbrev;
77
78 SpriteID sprite;
79
80 uint16 classes;
81 const struct GRFFile *grffile;
82 const struct SpriteGroup *group;
83
84 Money current_payment;
85
90 inline CargoID Index() const
91 {
92 return this - CargoSpec::array;
93 }
94
100 inline bool IsValid() const
101 {
102 return this->bitnum != INVALID_CARGO;
103 }
104
109 static inline size_t GetArraySize()
110 {
111 return lengthof(CargoSpec::array);
112 }
113
119 static inline CargoSpec *Get(size_t index)
120 {
121 assert(index < lengthof(CargoSpec::array));
122 return &CargoSpec::array[index];
123 }
124
125 SpriteID GetCargoIcon() const;
126
130 struct Iterator {
131 typedef CargoSpec value_type;
132 typedef CargoSpec *pointer;
133 typedef CargoSpec &reference;
134 typedef size_t difference_type;
135 typedef std::forward_iterator_tag iterator_category;
136
137 explicit Iterator(size_t index) : index(index)
138 {
139 this->ValidateIndex();
140 };
141
142 bool operator==(const Iterator &other) const { return this->index == other.index; }
143 bool operator!=(const Iterator &other) const { return !(*this == other); }
144 CargoSpec * operator*() const { return CargoSpec::Get(this->index); }
145 Iterator & operator++() { this->index++; this->ValidateIndex(); return *this; }
146
147 private:
148 size_t index;
149 void ValidateIndex() { while (this->index < CargoSpec::GetArraySize() && !(CargoSpec::Get(this->index)->IsValid())) this->index++; }
150 };
151
152 /*
153 * Iterable ensemble of all valid CargoSpec
154 */
155 struct IterateWrapper {
156 size_t from;
157 IterateWrapper(size_t from = 0) : from(from) {}
158 Iterator begin() { return Iterator(this->from); }
159 Iterator end() { return Iterator(CargoSpec::GetArraySize()); }
160 bool empty() { return this->begin() == this->end(); }
161 };
162
168 static IterateWrapper Iterate(size_t from = 0) { return IterateWrapper(from); }
169
170 private:
171 static CargoSpec array[NUM_CARGO];
172
173 friend void SetupCargoForClimate(LandscapeID l);
174 };
175
176 extern CargoTypes _cargo_mask;
177 extern CargoTypes _standard_cargo_mask;
178
179 void SetupCargoForClimate(LandscapeID l);
180 CargoID GetCargoIDByLabel(CargoLabel cl);
181 CargoID GetCargoIDByBitnum(uint8 bitnum);
182 CargoID GetDefaultCargoID(LandscapeID l, CargoType ct);
183
184 void InitializeSortedCargoSpecs();
185 extern std::vector<const CargoSpec *> _sorted_cargo_specs;
186 extern span<const CargoSpec *> _sorted_standard_cargo_specs;
187
194 static inline bool IsCargoInClass(CargoID c, CargoClass cc)
195 {
196 return (CargoSpec::Get(c)->classes & cc) != 0;
197 }
198
199 using SetCargoBitIterator = SetBitIterator<CargoID, CargoTypes>;
200
201 #endif /* CARGOTYPE_H */
TE_WATER
@ TE_WATER
Cargo behaves water-like.
Definition: cargotype.h:32
INVALID_CARGO
static const byte INVALID_CARGO
Constant representing invalid cargo.
Definition: cargotype.h:54
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:86
CC_HAZARDOUS
@ CC_HAZARDOUS
Hazardous cargo (Nuclear Fuel, Explosives, etc.)
Definition: cargotype.h:49
CargoSpec::callback_mask
uint8 callback_mask
Bitmask of cargo callbacks that have to be called.
Definition: cargotype.h:70
CC_COVERED
@ CC_COVERED
Covered/Sheltered Freight (Transportation in Box Vans, Silo Wagons, etc.)
Definition: cargotype.h:50
CargoSpec::label
CargoLabel label
Unique label of the cargo type.
Definition: cargotype.h:59
landscape_type.h
GetCargoIDByBitnum
CargoID GetCargoIDByBitnum(uint8 bitnum)
Find the CargoID of a 'bitnum' value.
Definition: cargotype.cpp:123
CargoSpec::IterateWrapper
Definition: cargotype.h:155
CargoSpec::Iterator
Iterator to iterate all valid CargoSpec.
Definition: cargotype.h:130
CargoSpec::initial_payment
int32 initial_payment
Initial payment rate before inflation is applied.
Definition: cargotype.h:64
CargoSpec::town_effect
TownEffect town_effect
The effect that delivering this cargo type has on towns. Also affects destination of subsidies.
Definition: cargotype.h:68
_cargo_mask
CargoTypes _cargo_mask
Bitmask of cargo types available.
Definition: cargotype.cpp:28
CC_NOAVAILABLE
@ CC_NOAVAILABLE
No cargo class has been specified.
Definition: cargotype.h:40
CC_EXPRESS
@ CC_EXPRESS
Express cargo (Goods, Food, Candy, but also possible for passengers)
Definition: cargotype.h:43
TE_FOOD
@ TE_FOOD
Cargo behaves food/fizzy-drinks-like.
Definition: cargotype.h:33
Pool::PoolItem<&_spritegroup_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:119
InitializeSortedCargoSpecs
void InitializeSortedCargoSpecs()
Initialize the list of sorted cargo specifications.
Definition: cargotype.cpp:188
CargoSpec::Iterate
static IterateWrapper Iterate(size_t from=0)
Returns an iterable ensemble of all valid CargoSpec.
Definition: cargotype.h:168
TE_NONE
@ TE_NONE
Cargo has no effect.
Definition: cargotype.h:28
CargoSpec
Specification of a cargo type.
Definition: cargotype.h:57
CC_LIQUID
@ CC_LIQUID
Liquids (Oil, Water, Rubber)
Definition: cargotype.h:47
CargoSpec::GetCargoIcon
SpriteID GetCargoIcon() const
Get sprite for showing cargo of this type.
Definition: cargotype.cpp:139
CC_PASSENGERS
@ CC_PASSENGERS
Passengers.
Definition: cargotype.h:41
CargoSpec::GetArraySize
static size_t GetArraySize()
Total number of cargospecs, both valid and invalid.
Definition: cargotype.h:109
strings_type.h
CargoLabel
uint32 CargoLabel
Globally unique label of a cargo type.
Definition: cargotype.h:23
CargoSpec::bitnum
uint8 bitnum
Cargo bit number, is INVALID_CARGO for a non-used spec.
Definition: cargotype.h:58
CargoSpec::array
static CargoSpec array[NUM_CARGO]
Array holding all CargoSpecs.
Definition: cargotype.h:171
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
TE_MAIL
@ TE_MAIL
Cargo behaves mail-like.
Definition: cargotype.h:30
TE_PASSENGERS
@ TE_PASSENGERS
Cargo behaves passenger-like.
Definition: cargotype.h:29
bitmath_func.hpp
GetCargoIDByLabel
CargoID GetCargoIDByLabel(CargoLabel cl)
Get the cargo ID by cargo label.
Definition: cargotype.cpp:107
CargoSpec::Index
CargoID Index() const
Determines index of this cargospec.
Definition: cargotype.h:90
_sorted_standard_cargo_specs
span< const CargoSpec * > _sorted_standard_cargo_specs
Standard cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:153
SetBitIterator
Iterable ensemble of each set bit in a value.
Definition: bitmath_func.hpp:329
CC_SPECIAL
@ CC_SPECIAL
Special bit used for livery refit tricks instead of normal cargoes.
Definition: cargotype.h:51
span
A trimmed down version of what std::span will be in C++20.
Definition: span_type.hpp:60
NUM_TE
@ NUM_TE
Amount of town effects.
Definition: cargotype.h:35
CargoSpec::units_volume
StringID units_volume
Name of a single unit of cargo of this type.
Definition: cargotype.h:74
CargoSpec::IsValid
bool IsValid() const
Tests for validity of this cargospec.
Definition: cargotype.h:100
CargoSpec::SetupCargoForClimate
friend void SetupCargoForClimate(LandscapeID l)
Set up the default cargo types for the given landscape type.
Definition: cargotype.cpp:39
CC_PIECE_GOODS
@ CC_PIECE_GOODS
Piece goods (Livestock, Wood, Steel, Paper)
Definition: cargotype.h:46
TE_END
@ TE_END
End of town effects.
Definition: cargotype.h:34
cargo_type.h
CC_BULK
@ CC_BULK
Bulk cargo (Coal, Grain etc., Ores, Fruit)
Definition: cargotype.h:45
CargoSpec::multipliertowngrowth
uint16 multipliertowngrowth
Size of the effect.
Definition: cargotype.h:69
CargoSpec::grffile
const struct GRFFile * grffile
NewGRF where #group belongs to.
Definition: cargotype.h:81
CargoSpec::sprite
SpriteID sprite
Icon to display this cargo type, may be 0xFFF (which means to resolve an action123 chain).
Definition: cargotype.h:78
span_type.hpp
CargoSpec::weight
uint8 weight
Weight of a single unit of this cargo type in 1/16 ton (62.5 kg).
Definition: cargotype.h:62
CargoSpec::is_freight
bool is_freight
Cargo type is considered to be freight (affects train freight multiplier).
Definition: cargotype.h:67
TownEffect
TownEffect
Town growth effect when delivering cargo.
Definition: cargotype.h:26
CargoClass
CargoClass
Cargo classes.
Definition: cargotype.h:39
TE_GOODS
@ TE_GOODS
Cargo behaves goods/candy-like.
Definition: cargotype.h:31
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
CC_ARMOURED
@ CC_ARMOURED
Armoured cargo (Valuables, Gold, Diamonds)
Definition: cargotype.h:44
CC_REFRIGERATED
@ CC_REFRIGERATED
Refrigerated cargo (Food, Fruit)
Definition: cargotype.h:48
CargoSpec::quantifier
StringID quantifier
Text for multiple units of cargo of this type.
Definition: cargotype.h:75
CargoSpec::classes
uint16 classes
Classes of this cargo type.
Definition: cargotype.h:80
NUM_CARGO
@ NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:65
CargoSpec::name
StringID name
Name of this type of cargo.
Definition: cargotype.h:72
CargoSpec::name_single
StringID name_single
Name of a single entity of this type of cargo.
Definition: cargotype.h:73
CargoSpec::abbrev
StringID abbrev
Two letter abbreviation for this cargo type.
Definition: cargotype.h:76
_sorted_cargo_specs
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:152
CargoSpec::multiplier
uint16 multiplier
Capacity multiplier for vehicles. (8 fractional bits)
Definition: cargotype.h:63
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
SetupCargoForClimate
void SetupCargoForClimate(LandscapeID l)
Set up the default cargo types for the given landscape type.
Definition: cargotype.cpp:39
OverflowSafeInt< int64 >
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
LandscapeID
byte LandscapeID
Landscape type.
Definition: landscape_type.h:13
IsCargoInClass
static bool IsCargoInClass(CargoID c, CargoClass cc)
Does cargo c have cargo class cc?
Definition: cargotype.h:194
economy_type.h
gfx_type.h
CC_MAIL
@ CC_MAIL
Mail.
Definition: cargotype.h:42
SpriteGroup
Definition: newgrf_spritegroup.h:57
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:105
_standard_cargo_mask
CargoTypes _standard_cargo_mask
Bitmask of real cargo types available.
Definition: cargotype.cpp:33