OpenTTD Source  20241108-master-g80f628063a
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 enum TownAcceptanceEffect : uint8_t {
22  TAE_BEGIN = 0,
23  TAE_NONE = TAE_BEGIN,
31 };
32 
34 enum TownProductionEffect : uint8_t {
38  NUM_TPE,
39 
45 };
46 
48 enum CargoClass : uint16_t {
50  CC_PASSENGERS = 1 << 0,
51  CC_MAIL = 1 << 1,
52  CC_EXPRESS = 1 << 2,
53  CC_ARMOURED = 1 << 3,
54  CC_BULK = 1 << 4,
55  CC_PIECE_GOODS = 1 << 5,
56  CC_LIQUID = 1 << 6,
57  CC_REFRIGERATED = 1 << 7,
58  CC_HAZARDOUS = 1 << 8,
59  CC_COVERED = 1 << 9,
60  CC_SPECIAL = 1 << 15,
61 };
62 
64 using CargoClasses = uint16_t;
65 
66 static const uint8_t INVALID_CARGO_BITNUM = 0xFF;
67 
68 static const uint TOWN_PRODUCTION_DIVISOR = 256;
69 
71 struct CargoSpec {
74  uint8_t legend_colour;
75  uint8_t rating_colour;
76  uint8_t weight;
77  uint16_t multiplier = 0x100;
79  int32_t initial_payment;
80  uint8_t transit_periods[2];
81 
82  bool is_freight;
85  uint16_t town_production_multiplier = TOWN_PRODUCTION_DIVISOR;
86  uint8_t callback_mask;
87 
93 
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:
197  static inline std::map<CargoLabel, CargoID> label_map{};
198 
199  friend void SetupCargoForClimate(LandscapeID l);
200  friend void BuildCargoLabelMap();
201  friend inline CargoID GetCargoIDByLabel(CargoLabel ct);
202  friend void FinaliseCargoArray();
203 };
204 
205 extern CargoTypes _cargo_mask;
206 extern CargoTypes _standard_cargo_mask;
207 
209 bool IsDefaultCargo(CargoID cid);
210 void BuildCargoLabelMap();
211 
212 inline CargoID GetCargoIDByLabel(CargoLabel label)
213 {
214  auto found = CargoSpec::label_map.find(label);
215  if (found != std::end(CargoSpec::label_map)) return found->second;
216  return INVALID_CARGO;
217 }
218 
220 
222 extern std::array<uint8_t, NUM_CARGO> _sorted_cargo_types;
223 extern std::vector<const CargoSpec *> _sorted_cargo_specs;
224 extern std::span<const CargoSpec *> _sorted_standard_cargo_specs;
225 
233 {
234  return (CargoSpec::Get(c)->classes & cc) != 0;
235 }
236 
238 
241  bool operator() (const CargoID &lhs, const CargoID &rhs) const { return _sorted_cargo_types[lhs] < _sorted_cargo_types[rhs]; }
242 };
243 
244 #endif /* CARGOTYPE_H */
Functions related to bit mathematics.
Types related to cargoes...
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
Definition: cargo_type.h:74
bool IsDefaultCargo(CargoID cid)
Test if a cargo is a default cargo type.
Definition: cargotype.cpp:140
std::array< uint8_t, NUM_CARGO > _sorted_cargo_types
Sort order of cargoes by cargo ID.
Definition: cargotype.cpp:179
Dimension GetLargestCargoIconSize()
Get dimensions of largest cargo icon.
Definition: cargotype.cpp:153
bool IsCargoInClass(CargoID c, CargoClass cc)
Does cargo c have cargo class cc?
Definition: cargotype.h:232
std::span< const CargoSpec * > _sorted_standard_cargo_specs
Standard cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:181
CargoTypes _standard_cargo_mask
Bitmask of real cargo types available.
Definition: cargotype.cpp:36
static const uint8_t INVALID_CARGO_BITNUM
Constant representing invalid cargo.
Definition: cargotype.h:66
void BuildCargoLabelMap()
Build cargo label map.
Definition: cargotype.cpp:122
CargoClass
Cargo classes.
Definition: cargotype.h:48
@ CC_MAIL
Mail.
Definition: cargotype.h:51
@ CC_REFRIGERATED
Refrigerated cargo (Food, Fruit)
Definition: cargotype.h:57
@ CC_ARMOURED
Armoured cargo (Valuables, Gold, Diamonds)
Definition: cargotype.h:53
@ CC_BULK
Bulk cargo (Coal, Grain etc., Ores, Fruit)
Definition: cargotype.h:54
@ CC_NOAVAILABLE
No cargo class has been specified.
Definition: cargotype.h:49
@ CC_EXPRESS
Express cargo (Goods, Food, Candy, but also possible for passengers)
Definition: cargotype.h:52
@ CC_COVERED
Covered/Sheltered Freight (Transportation in Box Vans, Silo Wagons, etc.)
Definition: cargotype.h:59
@ CC_LIQUID
Liquids (Oil, Water, Rubber)
Definition: cargotype.h:56
@ CC_PIECE_GOODS
Piece goods (Livestock, Wood, Steel, Paper)
Definition: cargotype.h:55
@ CC_PASSENGERS
Passengers.
Definition: cargotype.h:50
@ CC_HAZARDOUS
Hazardous cargo (Nuclear Fuel, Explosives, etc.)
Definition: cargotype.h:58
@ CC_SPECIAL
Special bit used for livery refit tricks instead of normal cargoes.
Definition: cargotype.h:60
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:180
TownProductionEffect
Town effect when producing cargo.
Definition: cargotype.h:34
@ INVALID_TPE
Invalid town production effect.
Definition: cargotype.h:44
@ TPE_NONE
Town will not produce this cargo type.
Definition: cargotype.h:35
@ TPE_PASSENGERS
Cargo behaves passenger-like for production.
Definition: cargotype.h:36
@ TPE_MAIL
Cargo behaves mail-like for production.
Definition: cargotype.h:37
void InitializeSortedCargoSpecs()
Initialize the list of sorted cargo specifications.
Definition: cargotype.cpp:213
void SetupCargoForClimate(LandscapeID l)
Set up the default cargo types for the given landscape type.
Definition: cargotype.cpp:62
uint16_t CargoClasses
Bitmask of cargo classes.
Definition: cargotype.h:64
TownAcceptanceEffect
Town growth effect when delivering cargo.
Definition: cargotype.h:21
@ NUM_TAE
Amount of town effects.
Definition: cargotype.h:30
@ TAE_END
End of town effects.
Definition: cargotype.h:29
@ TAE_GOODS
Cargo behaves goods/candy-like.
Definition: cargotype.h:26
@ TAE_NONE
Cargo has no effect.
Definition: cargotype.h:23
@ TAE_PASSENGERS
Cargo behaves passenger-like.
Definition: cargotype.h:24
@ TAE_MAIL
Cargo behaves mail-like.
Definition: cargotype.h:25
@ TAE_FOOD
Cargo behaves food/fizzy-drinks-like.
Definition: cargotype.h:28
@ TAE_WATER
Cargo behaves water-like.
Definition: cargotype.h:27
CargoTypes _cargo_mask
Bitmask of cargo types available.
Definition: cargotype.cpp:31
Types related to the economy.
Types related to the graphics and/or input devices.
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:18
Types related to the landscape.
uint8_t LandscapeID
Landscape type.
#define lengthof(array)
Return the length of an fixed size array.
Definition: stdafx.h:280
Types related to strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Comparator to sort CargoID by according to desired order.
Definition: cargotype.h:240
Iterator to iterate all valid CargoSpec.
Definition: cargotype.h:152
Specification of a cargo type.
Definition: cargotype.h:71
int32_t initial_payment
Initial payment rate before inflation is applied.
Definition: cargotype.h:79
CargoClasses classes
Classes of this cargo type.
Definition: cargotype.h:78
uint16_t multiplier
Capacity multiplier for vehicles. (8 fractional bits)
Definition: cargotype.h:77
StringID units_volume
Name of a single unit of cargo of this type.
Definition: cargotype.h:90
CargoID Index() const
Determines index of this cargospec.
Definition: cargotype.h:105
StringID abbrev
Two letter abbreviation for this cargo type.
Definition: cargotype.h:92
uint8_t bitnum
Cargo bit number, is INVALID_CARGO_BITNUM for a non-used spec.
Definition: cargotype.h:73
StringID quantifier
Text for multiple units of cargo of this type.
Definition: cargotype.h:91
SpriteID GetCargoIcon() const
Get sprite for showing cargo of this type.
Definition: cargotype.cpp:166
SpriteID sprite
Icon to display this cargo type, may be 0xFFF (which means to resolve an action123 chain).
Definition: cargotype.h:94
bool is_freight
Cargo type is considered to be freight (affects train freight multiplier).
Definition: cargotype.h:82
uint8_t weight
Weight of a single unit of this cargo type in 1/16 ton (62.5 kg).
Definition: cargotype.h:76
CargoLabel label
Unique label of the cargo type.
Definition: cargotype.h:72
const struct GRFFile * grffile
NewGRF where #group belongs to.
Definition: cargotype.h:96
static IterateWrapper Iterate(size_t from=0)
Returns an iterable ensemble of all valid CargoSpec.
Definition: cargotype.h:190
static CargoSpec array[NUM_CARGO]
Array holding all CargoSpecs.
Definition: cargotype.h:196
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:134
friend void BuildCargoLabelMap()
Build cargo label map.
Definition: cargotype.cpp:122
uint8_t callback_mask
Bitmask of cargo callbacks that have to be called.
Definition: cargotype.h:86
StringID name
Name of this type of cargo.
Definition: cargotype.h:88
friend void FinaliseCargoArray()
Check for invalid cargoes.
Definition: newgrf.cpp:9228
TownProductionEffect town_production_effect
The effect on town cargo production.
Definition: cargotype.h:84
TownAcceptanceEffect town_acceptance_effect
The effect that delivering this cargo type has on towns. Also affects destination of subsidies.
Definition: cargotype.h:83
static std::map< CargoLabel, CargoID > label_map
Translation map from CargoLabel to Cargo ID.
Definition: cargotype.h:197
friend void SetupCargoForClimate(LandscapeID l)
Set up the default cargo types for the given landscape type.
Definition: cargotype.cpp:62
uint16_t town_production_multiplier
Town production multipler, if commanded by TownProductionEffect.
Definition: cargotype.h:85
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
bool IsValid() const
Tests for validity of this cargospec.
Definition: cargotype.h:115
StringID name_single
Name of a single entity of this type of cargo.
Definition: cargotype.h:89
static size_t GetArraySize()
Total number of cargospecs, both valid and invalid.
Definition: cargotype.h:124
Dimensions (a width and height) of a rectangle in 2D.
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:108
Tindex index
Index of this pool item.
Definition: pool_type.hpp:238
Iterable ensemble of each set bit in a value.