OpenTTD
newgrf.h
Go to the documentation of this file.
1 /* $Id: newgrf.h 27200 2015-03-20 19:27:15Z frosch $ */
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 NEWGRF_H
13 #define NEWGRF_H
14 
15 #include "cargotype.h"
16 #include "rail_type.h"
17 #include "fileio_type.h"
18 #include "core/bitmath_func.hpp"
19 #include "core/alloc_type.hpp"
20 #include "core/smallvec_type.hpp"
21 
27  CF_WATERSLOPE,
28  CF_LOCKS,
29  CF_DIKES,
30  CF_ICON,
31  CF_DOCKS,
32  CF_RIVER_SLOPE,
33  CF_RIVER_EDGE,
34  CF_RIVER_GUI,
35  CF_BUOY,
36  CF_END,
37 };
38 
41  uint8 callback_mask;
42  uint8 flags;
43 };
44 
45 enum GrfLoadingStage {
46  GLS_FILESCAN,
47  GLS_SAFETYSCAN,
48  GLS_LABELSCAN,
49  GLS_INIT,
50  GLS_RESERVE,
51  GLS_ACTIVATION,
52  GLS_END,
53 };
54 
55 DECLARE_POSTFIX_INCREMENT(GrfLoadingStage)
56 
57 enum GrfMiscBit {
58  GMB_DESERT_TREES_FIELDS = 0, // Unsupported.
59  GMB_DESERT_PAVED_ROADS = 1,
60  GMB_FIELD_BOUNDING_BOX = 2, // Unsupported.
62  GMB_AMBIENT_SOUND_CALLBACK = 4,
63  GMB_CATENARY_ON_3RD_TRACK = 5, // Unsupported.
64  GMB_SECOND_ROCKY_TILE_SET = 6,
65 };
66 
68  GSF_TRAINS,
69  GSF_ROADVEHICLES,
70  GSF_SHIPS,
71  GSF_AIRCRAFT,
72  GSF_STATIONS,
73  GSF_CANALS,
74  GSF_BRIDGES,
75  GSF_HOUSES,
76  GSF_GLOBALVAR,
77  GSF_INDUSTRYTILES,
78  GSF_INDUSTRIES,
79  GSF_CARGOES,
80  GSF_SOUNDFX,
81  GSF_AIRPORTS,
82  GSF_SIGNALS,
83  GSF_OBJECTS,
84  GSF_RAILTYPES,
85  GSF_AIRPORTTILES,
86  GSF_END,
87 
88  GSF_FAKE_TOWNS = GSF_END,
90 
91  GSF_INVALID = 0xFF,
92 };
93 
94 static const uint32 INVALID_GRFID = 0xFFFFFFFF;
95 
96 struct GRFLabel {
97  byte label;
98  uint32 nfo_line;
99  size_t pos;
100  struct GRFLabel *next;
101 };
102 
105  char *filename;
106  bool is_ottdfile;
107  uint32 grfid;
108  byte grf_version;
109 
110  uint sound_offset;
111  uint16 num_sounds;
112 
113  struct StationSpec **stations;
114  struct HouseSpec **housespec;
115  struct IndustrySpec **industryspec;
116  struct IndustryTileSpec **indtspec;
117  struct ObjectSpec **objectspec;
118  struct AirportSpec **airportspec;
119  struct AirportTileSpec **airtspec;
120 
121  uint32 param[0x80];
122  uint param_end;
123 
125 
128 
130  RailTypeByte railtype_map[RAILTYPE_END];
131 
133 
135 
138 
139  uint32 grf_features;
140  PriceMultipliers price_base_multipliers;
141 
142  GRFFile(const struct GRFConfig *config);
143  ~GRFFile();
144 
146  uint32 GetParam(uint number) const
147  {
148  /* Note: We implicitly test for number < lengthof(this->param) and return 0 for invalid parameters.
149  * In fact this is the more important test, as param is zeroed anyway. */
150  assert(this->param_end <= lengthof(this->param));
151  return (number < this->param_end) ? this->param[number] : 0;
152  }
153 };
154 
160 };
161 
163  bool has_2CC;
164  uint64 used_liveries;
168 };
169 
175 static inline bool HasGrfMiscBit(GrfMiscBit bit)
176 {
177  extern byte _misc_grf_features;
178  return HasBit(_misc_grf_features, bit);
179 }
180 
181 /* Indicates which are the newgrf features currently loaded ingame */
183 
185 
186 void LoadNewGRFFile(struct GRFConfig *config, uint file_index, GrfLoadingStage stage, Subdirectory subdir);
187 void LoadNewGRF(uint load_index, uint file_index);
188 void ReloadNewGRFData(); // in saveload/afterload.cpp
189 void ResetNewGRFData();
191 
192 void CDECL grfmsg(int severity, const char *str, ...) WARN_FORMAT(2, 3);
193 
194 bool GetGlobalVariable(byte param, uint32 *value, const GRFFile *grffile);
195 
196 StringID MapGRFStringID(uint32 grfid, StringID str);
197 void ShowNewGRFError();
198 
199 #endif /* NEWGRF_H */