OpenTTD Source: src/newgrf.h Source File

OpenTTD Source 14.1

newgrf.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 NEWGRF_H
11 #define NEWGRF_H
12
13 #include "cargotype.h"
14 #include "rail_type.h"
15 #include "road_type.h"
16 #include "fileio_type.h"
17 #include "core/bitmath_func.hpp"
18 #include "core/alloc_type.hpp"
19 #include "core/mem_func.hpp"
20
25 enum CanalFeature {
26 CF_WATERSLOPE,
27 CF_LOCKS,
28 CF_DIKES,
29 CF_ICON,
30 CF_DOCKS,
31 CF_RIVER_SLOPE,
32 CF_RIVER_EDGE,
33 CF_RIVER_GUI,
34 CF_BUOY,
35 CF_END,
36 };
37
39 struct CanalProperties {
40 uint8_t callback_mask;
41 uint8_t flags;
42 };
43
44 enum GrfLoadingStage {
45 GLS_FILESCAN,
46 GLS_SAFETYSCAN,
47 GLS_LABELSCAN,
48 GLS_INIT,
49 GLS_RESERVE,
50 GLS_ACTIVATION,
51 GLS_END,
52 };
53
54 DECLARE_POSTFIX_INCREMENT(GrfLoadingStage)
55
56 enum GrfMiscBit {
57 GMB_DESERT_TREES_FIELDS = 0, // Unsupported.
58 GMB_DESERT_PAVED_ROADS = 1,
59 GMB_FIELD_BOUNDING_BOX = 2, // Unsupported.
60 GMB_TRAIN_WIDTH_32_PIXELS = 3,
61 GMB_AMBIENT_SOUND_CALLBACK = 4,
62 GMB_CATENARY_ON_3RD_TRACK = 5, // Unsupported.
63 GMB_SECOND_ROCKY_TILE_SET = 6,
64 };
65
66 enum GrfSpecFeature {
67 GSF_TRAINS,
68 GSF_ROADVEHICLES,
69 GSF_SHIPS,
70 GSF_AIRCRAFT,
71 GSF_STATIONS,
72 GSF_CANALS,
73 GSF_BRIDGES,
74 GSF_HOUSES,
75 GSF_GLOBALVAR,
76 GSF_INDUSTRYTILES,
77 GSF_INDUSTRIES,
78 GSF_CARGOES,
79 GSF_SOUNDFX,
80 GSF_AIRPORTS,
81 GSF_SIGNALS,
82 GSF_OBJECTS,
83 GSF_RAILTYPES,
84 GSF_AIRPORTTILES,
85 GSF_ROADTYPES,
86 GSF_TRAMTYPES,
87 GSF_ROADSTOPS,
88 GSF_END,
89
90 GSF_FAKE_TOWNS = GSF_END,
91 GSF_FAKE_END,
92
93 GSF_INVALID = 0xFF,
94 };
95
96 static const uint32_t INVALID_GRFID = 0xFFFFFFFF;
97
98 struct GRFLabel {
99 byte label;
100 uint32_t nfo_line;
101 size_t pos;
102
103 GRFLabel(byte label, uint32_t nfo_line, size_t pos) : label(label), nfo_line(nfo_line), pos(pos) {}
104 };
105
107 struct GRFFile : ZeroedMemoryAllocator {
108 std::string filename;
109 uint32_t grfid;
110 byte grf_version;
111
112 uint sound_offset;
113 uint16_t num_sounds;
114
115 std::vector<std::unique_ptr<struct StationSpec>> stations;
116 std::vector<std::unique_ptr<struct HouseSpec>> housespec;
117 std::vector<std::unique_ptr<struct IndustrySpec>> industryspec;
118 std::vector<std::unique_ptr<struct IndustryTileSpec>> indtspec;
119 std::vector<std::unique_ptr<struct ObjectSpec>> objectspec;
120 std::vector<std::unique_ptr<struct AirportSpec>> airportspec;
121 std::vector<std::unique_ptr<struct AirportTileSpec>> airtspec;
122 std::vector<std::unique_ptr<struct RoadStopSpec>> roadstops;
123
124 std::array<uint32_t, 0x80> param;
125 uint param_end;
126
127 std::vector<GRFLabel> labels;
128
129 std::vector<CargoLabel> cargo_list;
130 std::array<uint8_t, NUM_CARGO> cargo_map{};
131
132 std::vector<RailTypeLabel> railtype_list;
133 RailType railtype_map[RAILTYPE_END];
134
135 std::vector<RoadTypeLabel> roadtype_list;
136 RoadType roadtype_map[ROADTYPE_END];
137
138 std::vector<RoadTypeLabel> tramtype_list;
139 RoadType tramtype_map[ROADTYPE_END];
140
141 CanalProperties canal_local_properties[CF_END];
142
143 struct LanguageMap *language_map;
144
145 int traininfo_vehicle_pitch;
146 uint traininfo_vehicle_width;
147
148 uint32_t grf_features;
149 PriceMultipliers price_base_multipliers;
150
151 GRFFile(const struct GRFConfig *config);
152 ~GRFFile();
153
155 uint32_t GetParam(uint number) const
156 {
157 /* Note: We implicitly test for number < this->param.size() and return 0 for invalid parameters.
158 * In fact this is the more important test, as param is zeroed anyway. */
159 assert(this->param_end <= this->param.size());
160 return (number < this->param_end) ? this->param[number] : 0;
161 }
162 };
163
164 enum ShoreReplacement {
165 SHORE_REPLACE_NONE,
166 SHORE_REPLACE_ACTION_5,
167 SHORE_REPLACE_ACTION_A,
168 SHORE_REPLACE_ONLY_NEW,
169 };
170
171 enum TramReplacement {
172 TRAMWAY_REPLACE_DEPOT_NONE,
173 TRAMWAY_REPLACE_DEPOT_WITH_TRACK,
174 TRAMWAY_REPLACE_DEPOT_NO_TRACK,
175 };
176
177 struct GRFLoadedFeatures {
178 bool has_2CC;
179 uint64_t used_liveries;
180 ShoreReplacement shore;
181 TramReplacement tram;
182 };
183
189 inline bool HasGrfMiscBit(GrfMiscBit bit)
190 {
191 extern byte _misc_grf_features;
192 return HasBit(_misc_grf_features, bit);
193 }
194
195 /* Indicates which are the newgrf features currently loaded ingame */
196 extern GRFLoadedFeatures _loaded_newgrf_features;
197
198 void LoadNewGRFFile(struct GRFConfig *config, GrfLoadingStage stage, Subdirectory subdir, bool temporary);
199 void LoadNewGRF(uint load_index, uint num_baseset);
200 void ReloadNewGRFData(); // in saveload/afterload.cpp
201 void ResetNewGRFData();
202 void ResetPersistentNewGRFData();
203
204 void GrfMsgI(int severity, const std::string &msg);
205 #define GrfMsg(severity, format_string, ...) GrfMsgI(severity, fmt::format(FMT_STRING(format_string), ## __VA_ARGS__))
206
207 bool GetGlobalVariable(byte param, uint32_t *value, const GRFFile *grffile);
208
209 StringID MapGRFStringID(uint32_t grfid, StringID str);
210 void ShowNewGRFError();
211
212 #endif /* NEWGRF_H */
ROADTYPE_END
@ ROADTYPE_END
Used for iterations.
Definition: road_type.h:29
GRFFile::language_map
struct LanguageMap * language_map
Mappings related to the languages.
Definition: newgrf.h:143
GRFFile::roadtype_list
std::vector< RoadTypeLabel > roadtype_list
Roadtype translation table (road)
Definition: newgrf.h:135
ReloadNewGRFData
void ReloadNewGRFData()
Reload all NewGRF files during a running game.
Definition: afterload.cpp:3344
mem_func.hpp
GRFFile::price_base_multipliers
PriceMultipliers price_base_multipliers
Price base multipliers as set by the grf.
Definition: newgrf.h:149
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
CanalProperties::callback_mask
uint8_t callback_mask
Bitmask of canal callbacks that have to be called.
Definition: newgrf.h:40
CanalProperties::flags
uint8_t flags
Flags controlling display.
Definition: newgrf.h:41
MapGRFStringID
StringID MapGRFStringID(uint32_t grfid, StringID str)
Used when setting an object's property to map to the GRF's strings while taking in consideration the ...
Definition: newgrf.cpp:550
GrfMiscBit
GrfMiscBit
Definition: newgrf.h:56
GRFLoadedFeatures::used_liveries
uint64_t used_liveries
Bitmask of LiveryScheme used by the defined engines.
Definition: newgrf.h:179
GMB_TRAIN_WIDTH_32_PIXELS
@ GMB_TRAIN_WIDTH_32_PIXELS
Use 32 pixels per train vehicle in depot gui and vehicle details. Never set in the global variable;.
Definition: newgrf.h:60
GSF_INVALID
@ GSF_INVALID
An invalid spec feature.
Definition: newgrf.h:93
ShowNewGRFError
void ShowNewGRFError()
Show the first NewGRF error we can find.
Definition: newgrf_gui.cpp:45
alloc_type.hpp
TramReplacement
TramReplacement
Definition: newgrf.h:171
GetGlobalVariable
bool GetGlobalVariable(byte param, uint32_t *value, const GRFFile *grffile)
Reads a variable common to VarAction2 and Action7/9/D.
Definition: newgrf.cpp:6552
GRFFile::traininfo_vehicle_pitch
int traininfo_vehicle_pitch
Vertical offset for drawing train images in depot GUI and vehicle details.
Definition: newgrf.h:145
ResetPersistentNewGRFData
void ResetPersistentNewGRFData()
Reset NewGRF data which is stored persistently in savegames.
Definition: newgrf.cpp:8877
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:14
LoadNewGRFFile
void LoadNewGRFFile(struct GRFConfig *config, GrfLoadingStage stage, Subdirectory subdir, bool temporary)
Load a particular NewGRF.
Definition: newgrf.cpp:9731
bitmath_func.hpp
GRFLoadedFeatures::has_2CC
bool has_2CC
Set if any vehicle is loaded which uses 2cc (two company colours).
Definition: newgrf.h:178
SHORE_REPLACE_NONE
@ SHORE_REPLACE_NONE
No shore sprites were replaced.
Definition: newgrf.h:165
GRFLoadedFeatures::shore
ShoreReplacement shore
In which way shore sprites were replaced.
Definition: newgrf.h:180
ResetNewGRFData
void ResetNewGRFData()
Reset all NewGRF loaded data.
Definition: newgrf.cpp:8779
RailType
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
GRFFile::tramtype_list
std::vector< RoadTypeLabel > tramtype_list
Roadtype translation table (tram)
Definition: newgrf.h:138
GRFConfig
Information about GRF, used in the game and (part of it) in savegames.
Definition: newgrf_config.h:147
GSF_FAKE_TOWNS
@ GSF_FAKE_TOWNS
Fake town GrfSpecFeature for NewGRF debugging (parent scope)
Definition: newgrf.h:90
SHORE_REPLACE_ONLY_NEW
@ SHORE_REPLACE_ONLY_NEW
Only corner-shores were loaded by Action5 (openttd(w/d).grf only).
Definition: newgrf.h:168
ZeroedMemoryAllocator
Base class that provides memory initialization on dynamically created objects.
Definition: alloc_type.hpp:85
GSF_FAKE_END
@ GSF_FAKE_END
End of the fake features.
Definition: newgrf.h:91
SHORE_REPLACE_ACTION_5
@ SHORE_REPLACE_ACTION_5
Shore sprites were replaced by Action5.
Definition: newgrf.h:166
GRFFile::param_end
uint param_end
one more than the highest set parameter
Definition: newgrf.h:125
ShoreReplacement
ShoreReplacement
Definition: newgrf.h:164
HasGrfMiscBit
bool HasGrfMiscBit(GrfMiscBit bit)
Check for grf miscellaneous bits.
Definition: newgrf.h:189
GRFFile::traininfo_vehicle_width
uint traininfo_vehicle_width
Width (in pixels) of a 8/8 train vehicle in depot GUI and vehicle details.
Definition: newgrf.h:146
_loaded_newgrf_features
GRFLoadedFeatures _loaded_newgrf_features
Indicates which are the newgrf features currently loaded ingame.
Definition: newgrf.cpp:82
LoadNewGRF
void LoadNewGRF(uint load_index, uint num_baseset)
Load all the NewGRFs.
Definition: newgrf.cpp:10053
GrfSpecFeature
GrfSpecFeature
Definition: newgrf.h:66
GRFFile::canal_local_properties
CanalProperties canal_local_properties[CF_END]
Canal properties as set by this NewGRF.
Definition: newgrf.h:141
GRFFile::GRFFile
GRFFile(const struct GRFConfig *config)
Constructor for GRFFile.
Definition: newgrf.cpp:8931
LanguageMap
Mapping of language data between a NewGRF and OpenTTD.
Definition: newgrf_text.h:53
GRFLoadedFeatures::tram
TramReplacement tram
In which way tram depots were replaced.
Definition: newgrf.h:181
SHORE_REPLACE_ACTION_A
@ SHORE_REPLACE_ACTION_A
Shore sprites were replaced by ActionA (using grass tiles for the corner-shores).
Definition: newgrf.h:167
TRAMWAY_REPLACE_DEPOT_WITH_TRACK
@ TRAMWAY_REPLACE_DEPOT_WITH_TRACK
Electrified depot graphics with tram track were loaded.
Definition: newgrf.h:173
RAILTYPE_END
@ RAILTYPE_END
Used for iterations.
Definition: rail_type.h:33
TRAMWAY_REPLACE_DEPOT_NONE
@ TRAMWAY_REPLACE_DEPOT_NONE
No tram depot graphics were loaded.
Definition: newgrf.h:172
TRAMWAY_REPLACE_DEPOT_NO_TRACK
@ TRAMWAY_REPLACE_DEPOT_NO_TRACK
Electrified depot graphics without tram track were loaded.
Definition: newgrf.h:174
cargotype.h
fileio_type.h
RoadType
RoadType
The different roadtypes we support.
Definition: road_type.h:25
Subdirectory
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:108
GRFFile::cargo_list
std::vector< CargoLabel > cargo_list
Cargo translation table (local ID -> label)
Definition: newgrf.h:129
GRFFile::labels
std::vector< GRFLabel > labels
List of labels.
Definition: newgrf.h:127
rail_type.h
road_type.h
GRFFile::GetParam
uint32_t GetParam(uint number) const
Get GRF Parameter with range checking.
Definition: newgrf.h:155
_misc_grf_features
byte _misc_grf_features
Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E.
Definition: newgrf.cpp:76
CanalProperties
Canal properties local to the NewGRF.
Definition: newgrf.h:39
GrfMsgI
void GrfMsgI(int severity, const std::string &msg)
Debug() function dedicated to newGRF debugging messages Function is essentially the same as Debug(grf...
Definition: newgrf.cpp:393
GRFLoadedFeatures
Definition: newgrf.h:177
GRFFile::cargo_map
std::array< uint8_t, NUM_CARGO > cargo_map
Inverse cargo translation table (CargoID -> local ID)
Definition: newgrf.h:130
GRFFile::railtype_list
std::vector< RailTypeLabel > railtype_list
Railtype translation table.
Definition: newgrf.h:132
GRFLabel
Definition: newgrf.h:98
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:107
GRFFile::grf_features
uint32_t grf_features
Bitset of GrfSpecFeature the grf uses.
Definition: newgrf.h:148
CanalFeature
CanalFeature
List of different canal 'features'.
Definition: newgrf.h:25
HasBit
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103