OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

cargotype.h
Go to the documentation of this file.
1 /* $Id: cargotype.h 24915 2013-01-14 21:16:56Z smatz $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #ifndef CARGOTYPE_H
13 #define CARGOTYPE_H
14
15 #include "economy_type.h"
16 #include "cargo_type.h"
17 #include "gfx_type.h"
18 #include "strings_type.h"
19 #include "landscape_type.h"
20
22 typedef uint32 CargoLabel;
23
25 enum TownEffect {
26 TE_BEGIN = 0,
27 TE_NONE = TE_BEGIN,
28 TE_PASSENGERS,
29 TE_MAIL,
30 TE_GOODS,
31 TE_WATER,
32 TE_FOOD,
33 TE_END,
34 NUM_TE = TE_END,
35 };
36
38 enum CargoClass {
39 CC_NOAVAILABLE = 0,
40 CC_PASSENGERS = 1 << 0,
41 CC_MAIL = 1 << 1,
42 CC_EXPRESS = 1 << 2,
43 CC_ARMOURED = 1 << 3,
44 CC_BULK = 1 << 4,
45 CC_PIECE_GOODS = 1 << 5,
46 CC_LIQUID = 1 << 6,
47 CC_REFRIGERATED = 1 << 7,
48 CC_HAZARDOUS = 1 << 8,
49 CC_COVERED = 1 << 9,
50 CC_SPECIAL = 1 << 15,
51 };
52
53 static const byte INVALID_CARGO = 0xFF;
54
56 struct CargoSpec {
57 uint8 bitnum;
58 CargoLabel label;
59 uint8 legend_colour;
60 uint8 rating_colour;
61 uint8 weight;
62 uint16 multiplier;
63 uint16 initial_payment;
64 uint8 transit_days[2];
65
66 bool is_freight;
67 TownEffect town_effect;
68 uint16 multipliertowngrowth;
69 uint8 callback_mask;
70
71 StringID name;
72 StringID name_single;
73 StringID units_volume;
74 StringID quantifier;
75 StringID abbrev;
76
77 SpriteID sprite;
78
79 uint16 classes;
80 const struct GRFFile *grffile;
81 const struct SpriteGroup *group;
82
83 Money current_payment;
84
89 inline CargoID Index() const
90 {
91 return this - CargoSpec::array;
92 }
93
99 inline bool IsValid() const
100 {
101 return this->bitnum != INVALID_CARGO;
102 }
103
108 static inline size_t GetArraySize()
109 {
110 return lengthof(CargoSpec::array);
111 }
112
118 static inline CargoSpec *Get(size_t index)
119 {
120 assert(index < lengthof(CargoSpec::array));
121 return &CargoSpec::array[index];
122 }
123
124 SpriteID GetCargoIcon() const;
125
126 private:
127 static CargoSpec array[NUM_CARGO];
128
129 friend void SetupCargoForClimate(LandscapeID l);
130 };
131
132 extern uint32 _cargo_mask;
133 extern uint32 _standard_cargo_mask;
134
135 void SetupCargoForClimate(LandscapeID l);
136 CargoID GetCargoIDByLabel(CargoLabel cl);
137 CargoID GetCargoIDByBitnum(uint8 bitnum);
138
139 void InitializeSortedCargoSpecs();
140 extern const CargoSpec *_sorted_cargo_specs[NUM_CARGO];
141 extern uint8 _sorted_cargo_specs_size;
142 extern uint8 _sorted_standard_cargo_specs_size;
143
150 static inline bool IsCargoInClass(CargoID c, CargoClass cc)
151 {
152 return (CargoSpec::Get(c)->classes & cc) != 0;
153 }
154
155 #define FOR_ALL_CARGOSPECS_FROM(var, start) for (size_t cargospec_index = start; var = NULL, cargospec_index < CargoSpec::GetArraySize(); cargospec_index++) \
156 if ((var = CargoSpec::Get(cargospec_index))->IsValid())
157 #define FOR_ALL_CARGOSPECS(var) FOR_ALL_CARGOSPECS_FROM(var, 0)
158
159 #define FOR_EACH_SET_CARGO_ID(var, cargo_bits) FOR_EACH_SET_BIT_EX(CargoID, var, uint, cargo_bits)
160
166 #define FOR_ALL_SORTED_CARGOSPECS(var) for (uint8 index = 0; index < _sorted_cargo_specs_size && (var = _sorted_cargo_specs[index], true) ; index++)
167
173 #define FOR_ALL_SORTED_STANDARD_CARGOSPECS(var) for (uint8 index = 0; index < _sorted_standard_cargo_specs_size && (var = _sorted_cargo_specs[index], true); index++)
174
175 #endif /* CARGOTYPE_H */