OpenTTD Source 20260512-master-g20b387b91f
cargo_type.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#ifndef CARGO_TYPE_H
11#define CARGO_TYPE_H
12
13#include "core/strong_typedef_type.hpp"
14#include "core/enum_type.hpp"
15
17using CargoLabel = StrongType::Typedef<uint32_t, struct CargoLabelTag, StrongType::Compare>;
18
22enum CargoType : uint8_t {};
23DECLARE_INCREMENT_DECREMENT_OPERATORS(CargoType)
24
25
29
30/* Temperate */
31static constexpr CargoLabel CT_PASSENGERS{'PASS'};
32static constexpr CargoLabel CT_COAL{'COAL'};
33static constexpr CargoLabel CT_MAIL{'MAIL'};
34static constexpr CargoLabel CT_OIL{'OIL_'};
35static constexpr CargoLabel CT_LIVESTOCK{'LVST'};
36static constexpr CargoLabel CT_GOODS{'GOOD'};
37static constexpr CargoLabel CT_GRAIN{'GRAI'};
38static constexpr CargoLabel CT_WOOD{'WOOD'};
39static constexpr CargoLabel CT_IRON_ORE{'IORE'};
40static constexpr CargoLabel CT_STEEL{'STEL'};
41static constexpr CargoLabel CT_VALUABLES{'VALU'};
42
43/* Arctic */
44static constexpr CargoLabel CT_WHEAT{'WHEA'};
45static constexpr CargoLabel CT_PAPER{'PAPR'};
46static constexpr CargoLabel CT_GOLD{'GOLD'};
47static constexpr CargoLabel CT_FOOD{'FOOD'};
48
49/* Tropic */
50static constexpr CargoLabel CT_RUBBER{'RUBR'};
51static constexpr CargoLabel CT_FRUIT{'FRUT'};
52static constexpr CargoLabel CT_MAIZE{'MAIZ'};
53static constexpr CargoLabel CT_COPPER_ORE{'CORE'};
54static constexpr CargoLabel CT_WATER{'WATR'};
55static constexpr CargoLabel CT_DIAMONDS{'DIAM'};
56
57/* Toyland */
58static constexpr CargoLabel CT_SUGAR{'SUGR'};
59static constexpr CargoLabel CT_TOYS{'TOYS'};
60static constexpr CargoLabel CT_BATTERIES{'BATT'};
61static constexpr CargoLabel CT_CANDY{'SWET'};
62static constexpr CargoLabel CT_TOFFEE{'TOFF'};
63static constexpr CargoLabel CT_COLA{'COLA'};
64static constexpr CargoLabel CT_COTTON_CANDY{'CTCD'};
65static constexpr CargoLabel CT_BUBBLES{'BUBL'};
66static constexpr CargoLabel CT_PLASTIC{'PLST'};
67static constexpr CargoLabel CT_FIZZY_DRINKS{'FZDR'};
68
70static constexpr CargoLabel CT_NONE = CT_PASSENGERS;
71
72static constexpr CargoLabel CT_INVALID{UINT32_MAX};
73
74static constexpr CargoType NUM_ORIGINAL_CARGO{12};
75static constexpr CargoType NUM_CARGO{64};
76
77/* CARGO_AUTO_REFIT and CARGO_NO_REFIT are stored in save-games for refit-orders, so should not be changed. */
78static constexpr CargoType CARGO_AUTO_REFIT{0xFD};
79static constexpr CargoType CARGO_NO_REFIT{0xFE};
80
81static constexpr CargoType INVALID_CARGO{UINT8_MAX};
82
89
94namespace CargoFilterCriteria {
95 static constexpr CargoType CF_ANY{NUM_CARGO};
96 static constexpr CargoType CF_NONE{NUM_CARGO + 1};
97 static constexpr CargoType CF_ENGINES{NUM_CARGO + 2};
98 static constexpr CargoType CF_FREIGHT{NUM_CARGO + 3};
99
100 static constexpr CargoType CF_NO_RATING{NUM_CARGO + 4};
101 static constexpr CargoType CF_SELECT_ALL{NUM_CARGO + 5};
102 static constexpr CargoType CF_EXPAND_LIST{NUM_CARGO + 6};
103};
104
110inline bool IsValidCargoType(CargoType cargo) { return cargo != INVALID_CARGO; }
111
112using CargoTypes = EnumBitSet<CargoType, uint64_t>;
113
114static constexpr CargoTypes ALL_CARGOTYPES{UINT64_MAX};
115
117struct CargoArray : std::array<uint, NUM_CARGO> {
122 template <typename T>
123 inline const T GetSum() const
124 {
125 return std::reduce(this->begin(), this->end(), T{});
126 }
127
132 inline uint GetCount() const
133 {
134 return std::ranges::count_if(*this, [](uint amount) { return amount != 0; });
135 }
136};
137
138#endif /* CARGO_TYPE_H */
CT_INVALID
static constexpr CargoLabel CT_INVALID
Invalid cargo type.
Definition cargo_type.h:72
IsValidCargoType
bool IsValidCargoType(CargoType cargo)
Test whether cargo type is not INVALID_CARGO.
Definition cargo_type.h:110
CARGO_AUTO_REFIT
static constexpr CargoType CARGO_AUTO_REFIT
Automatically choose cargo type when doing auto refitting.
Definition cargo_type.h:78
CT_NONE
static constexpr CargoLabel CT_NONE
Dummy label for engines that carry no cargo; they actually carry 0 passengers.
Definition cargo_type.h:70
NUM_CARGO
static constexpr CargoType NUM_CARGO
Maximum number of cargo types in a game.
Definition cargo_type.h:75
NUM_ORIGINAL_CARGO
static constexpr CargoType NUM_ORIGINAL_CARGO
Original number of cargo types.
Definition cargo_type.h:74
MixedCargoType
MixedCargoType
Mixed cargo types for definitions with cargo that can vary depending on climate.
Definition cargo_type.h:84
MCT_GRAIN_WHEAT_MAIZE
@ MCT_GRAIN_WHEAT_MAIZE
Cargo can be grain, wheat or maize.
Definition cargo_type.h:86
MCT_LIVESTOCK_FRUIT
@ MCT_LIVESTOCK_FRUIT
Cargo can be livestock or fruit.
Definition cargo_type.h:85
MCT_VALUABLES_GOLD_DIAMONDS
@ MCT_VALUABLES_GOLD_DIAMONDS
Cargo can be valuables, gold or diamonds.
Definition cargo_type.h:87
CT_PASSENGERS
static constexpr CargoLabel CT_PASSENGERS
Available types of cargo Labels may be re-used between different climates.
Definition cargo_type.h:31
CARGO_NO_REFIT
static constexpr CargoType CARGO_NO_REFIT
Do not refit cargo of a vehicle (used in vehicle orders and auto-replace/auto-renew).
Definition cargo_type.h:79
CargoLabel
StrongType::Typedef< uint32_t, struct CargoLabelTag, StrongType::Compare > CargoLabel
Globally unique label of a cargo type.
Definition cargo_type.h:17
CargoType
CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:22
EnumBitSet
Enum-as-bit-set wrapper.
Definition enum_type.hpp:215
T
#define T
Climate temperate.
Definition engines.h:91
enum_type.hpp
Type (helpers) for enums.
DECLARE_INCREMENT_DECREMENT_OPERATORS
#define DECLARE_INCREMENT_DECREMENT_OPERATORS(enum_type)
For some enums it is useful to have pre/post increment/decrement operators.
Definition enum_type.hpp:86
CargoFilterCriteria
Special cargo filter criteria.
Definition cargo_type.h:94
CargoFilterCriteria::CF_FREIGHT
static constexpr CargoType CF_FREIGHT
Show only vehicles which carry any freight (non-passenger) cargo.
Definition cargo_type.h:98
CargoFilterCriteria::CF_NONE
static constexpr CargoType CF_NONE
Show only items which do not carry cargo (e.g. train engines).
Definition cargo_type.h:96
CargoFilterCriteria::CF_ENGINES
static constexpr CargoType CF_ENGINES
Show only engines (for rail vehicles only).
Definition cargo_type.h:97
CargoFilterCriteria::CF_EXPAND_LIST
static constexpr CargoType CF_EXPAND_LIST
Expand list to show all items (station list).
Definition cargo_type.h:102
CargoFilterCriteria::CF_ANY
static constexpr CargoType CF_ANY
Show all items independent of carried cargo (i.e. no filtering).
Definition cargo_type.h:95
CargoFilterCriteria::CF_NO_RATING
static constexpr CargoType CF_NO_RATING
Show items with no rating (station list).
Definition cargo_type.h:100
CargoFilterCriteria::CF_SELECT_ALL
static constexpr CargoType CF_SELECT_ALL
Select all items (station list).
Definition cargo_type.h:101
strong_typedef_type.hpp
Type (helpers) for making a strong typedef that is a distinct type.
CargoArray
Class for storing amounts of cargo.
Definition cargo_type.h:117
CargoArray::GetCount
uint GetCount() const
Get the amount of cargos that have an amount.
Definition cargo_type.h:132
CargoArray::GetSum
const T GetSum() const
Get the sum of all cargo amounts.
Definition cargo_type.h:123
StrongType::Typedef
Templated helper to make a type-safe 'typedef' representing a single POD value.
Definition strong_typedef_type.hpp:130