OpenTTD

newgrf_commons.h
Go to the documentation of this file.
1 /* $Id: newgrf_commons.h 27534 2016-04-02 16:02:22Z 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
15 #ifndef NEWGRF_COMMONS_H
16 #define NEWGRF_COMMONS_H
17
18 #include "sprite.h"
19 #include "core/alloc_type.hpp"
20 #include "core/smallvec_type.hpp"
21 #include "command_type.h"
22 #include "direction_type.h"
23 #include "company_type.h"
24
26 enum TileContext {
27 TCX_NORMAL,
28 TCX_UPPER_HALFTILE,
29 TCX_ON_BRIDGE,
30 };
31
35 enum TileLayoutFlags {
36 TLF_NOTHING = 0x00,
37
38 TLF_DODRAW = 0x01,
39 TLF_SPRITE = 0x02,
40 TLF_PALETTE = 0x04,
41 TLF_CUSTOM_PALETTE = 0x08,
42
43 TLF_BB_XY_OFFSET = 0x10,
44 TLF_BB_Z_OFFSET = 0x20,
45
46 TLF_CHILD_X_OFFSET = 0x10,
47 TLF_CHILD_Y_OFFSET = 0x20,
48
49 TLF_SPRITE_VAR10 = 0x40,
50 TLF_PALETTE_VAR10 = 0x80,
51
52 TLF_KNOWN_FLAGS = 0xFF,
53
55 TLF_DRAWING_FLAGS = ~TLF_CUSTOM_PALETTE,
56
58 TLF_NON_GROUND_FLAGS = TLF_BB_XY_OFFSET | TLF_BB_Z_OFFSET | TLF_CHILD_X_OFFSET | TLF_CHILD_Y_OFFSET,
59
61 TLF_VAR10_FLAGS = TLF_SPRITE_VAR10 | TLF_PALETTE_VAR10,
62
64 TLF_SPRITE_REG_FLAGS = TLF_DODRAW | TLF_SPRITE | TLF_BB_XY_OFFSET | TLF_BB_Z_OFFSET | TLF_CHILD_X_OFFSET | TLF_CHILD_Y_OFFSET,
65
67 TLF_PALETTE_REG_FLAGS = TLF_PALETTE,
68 };
69 DECLARE_ENUM_AS_BIT_SET(TileLayoutFlags)
70
71
77 static inline uint GetConstructionStageOffset(uint construction_stage, uint num_sprites)
78 {
79 assert(num_sprites > 0);
80 if (num_sprites > 4) num_sprites = 4;
81 switch (construction_stage) {
82 case 0: return 0;
83 case 1: return num_sprites > 2 ? 1 : 0;
84 case 2: return num_sprites > 2 ? num_sprites - 2 : 0;
85 case 3: return num_sprites - 1;
86 default: NOT_REACHED();
87 }
88 }
89
93 struct TileLayoutRegisters {
94 TileLayoutFlags flags;
95 uint8 dodraw;
96 uint8 sprite;
97 uint8 palette;
98 uint16 max_sprite_offset;
99 uint16 max_palette_offset;
100 union {
101 uint8 parent[3];
102 uint8 child[2];
103 } delta;
104 uint8 sprite_var10;
105 uint8 palette_var10;
106 };
107
108 static const uint TLR_MAX_VAR10 = 7;
109
115 struct NewGRFSpriteLayout : ZeroedMemoryAllocator, DrawTileSprites {
116 const TileLayoutRegisters *registers;
117
122 uint consistent_max_offset;
123
124 void Allocate(uint num_sprites);
125 void AllocateRegisters();
126 void Clone(const DrawTileSeqStruct *source);
127 void Clone(const NewGRFSpriteLayout *source);
128
133 void Clone(const DrawTileSprites *source)
134 {
135 assert(source != NULL && this != source);
136 this->ground = source->ground;
137 this->Clone(source->seq);
138 }
139
140 virtual ~NewGRFSpriteLayout()
141 {
142 free(this->seq);
143 free(this->registers);
144 }
145
152 bool NeedsPreprocessing() const
153 {
154 return this->registers != NULL;
155 }
156
157 uint32 PrepareLayout(uint32 orig_offset, uint32 newgrf_ground_offset, uint32 newgrf_offset, uint constr_stage, bool separate_ground) const;
158 void ProcessRegisters(uint8 resolved_var10, uint32 resolved_sprite, bool separate_ground) const;
159
165 const DrawTileSeqStruct *GetLayout(PalSpriteID *ground) const
166 {
167 DrawTileSeqStruct *front = result_seq.Begin();
168 *ground = front->image;
169 return front + 1;
170 }
171
172 private:
173 static SmallVector<DrawTileSeqStruct, 8> result_seq;
174 };
175
188 struct EntityIDMapping {
189 uint32 grfid;
190 uint8 entity_id;
191 uint8 substitute_id;
192 };
193
194 class OverrideManagerBase {
195 protected:
196 uint16 *entity_overrides;
197 uint32 *grfid_overrides;
198
199 uint16 max_offset;
200 uint16 max_new_entities;
201
202 uint16 invalid_ID;
203 virtual bool CheckValidNewID(uint16 testid) { return true; }
204
205 public:
206 EntityIDMapping *mapping_ID;
207
208 OverrideManagerBase(uint16 offset, uint16 maximum, uint16 invalid);
209 virtual ~OverrideManagerBase();
210
211 void ResetOverride();
212 void ResetMapping();
213
214 void Add(uint8 local_id, uint32 grfid, uint entity_type);
215 virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id);
216
217 uint32 GetGRFID(uint16 entity_id) const;
218 uint16 GetSubstituteID(uint16 entity_id) const;
219 virtual uint16 GetID(uint8 grf_local_id, uint32 grfid) const;
220
221 inline uint16 GetMaxMapping() const { return max_new_entities; }
222 inline uint16 GetMaxOffset() const { return max_offset; }
223 };
224
225
226 struct HouseSpec;
227 class HouseOverrideManager : public OverrideManagerBase {
228 public:
229 HouseOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :
230 OverrideManagerBase(offset, maximum, invalid) {}
231 void SetEntitySpec(const HouseSpec *hs);
232 };
233
234
235 struct IndustrySpec;
236 class IndustryOverrideManager : public OverrideManagerBase {
237 public:
238 IndustryOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :
239 OverrideManagerBase(offset, maximum, invalid) {}
240
241 virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id);
242 virtual uint16 GetID(uint8 grf_local_id, uint32 grfid) const;
243 void SetEntitySpec(IndustrySpec *inds);
244 };
245
246
247 struct IndustryTileSpec;
248 class IndustryTileOverrideManager : public OverrideManagerBase {
249 protected:
250 virtual bool CheckValidNewID(uint16 testid) { return testid != 0xFF; }
251 public:
252 IndustryTileOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :
253 OverrideManagerBase(offset, maximum, invalid) {}
254
255 void SetEntitySpec(const IndustryTileSpec *indts);
256 };
257
258 struct AirportSpec;
259 class AirportOverrideManager : public OverrideManagerBase {
260 public:
261 AirportOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :
262 OverrideManagerBase(offset, maximum, invalid) {}
263
264 void SetEntitySpec(AirportSpec *inds);
265 };
266
267 struct AirportTileSpec;
268 class AirportTileOverrideManager : public OverrideManagerBase {
269 protected:
270 virtual bool CheckValidNewID(uint16 testid) { return testid != 0xFF; }
271 public:
272 AirportTileOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :
273 OverrideManagerBase(offset, maximum, invalid) {}
274
275 void SetEntitySpec(const AirportTileSpec *ats);
276 };
277
278 struct ObjectSpec;
279 class ObjectOverrideManager : public OverrideManagerBase {
280 protected:
281 virtual bool CheckValidNewID(uint16 testid) { return testid != 0xFF; }
282 public:
283 ObjectOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :
284 OverrideManagerBase(offset, maximum, invalid) {}
285
286 void SetEntitySpec(ObjectSpec *spec);
287 };
288
289 extern HouseOverrideManager _house_mngr;
290 extern IndustryOverrideManager _industry_mngr;
291 extern IndustryTileOverrideManager _industile_mngr;
292 extern AirportOverrideManager _airport_mngr;
293 extern AirportTileOverrideManager _airporttile_mngr;
294 extern ObjectOverrideManager _object_mngr;
295
296 uint32 GetTerrainType(TileIndex tile, TileContext context = TCX_NORMAL);
297 TileIndex GetNearbyTile(byte parameter, TileIndex tile, bool signed_offsets = true, Axis axis = INVALID_AXIS);
298 uint32 GetNearbyTileInformation(TileIndex tile, bool grf_version8);
299 uint32 GetCompanyInfo(CompanyID owner, const struct Livery *l = NULL);
300 CommandCost GetErrorMessageFromLocationCallbackResult(uint16 cb_res, const GRFFile *grffile, StringID default_error);
301
302 void ErrorUnknownCallbackResult(uint32 grfid, uint16 cbid, uint16 cb_res);
303 bool ConvertBooleanCallback(const struct GRFFile *grffile, uint16 cbid, uint16 cb_res);
304 bool Convert8bitBooleanCallback(const struct GRFFile *grffile, uint16 cbid, uint16 cb_res);
305
310 template <size_t Tcnt>
311 struct GRFFilePropsBase {
312 GRFFilePropsBase() : local_id(0), grffile(0)
313 {
314 /* The lack of some compilers to provide default constructors complying to the specs
315 * requires us to zero the stuff ourself. */
316 memset(spritegroup, 0, sizeof(spritegroup));
317 }
318
319 uint16 local_id;
320 const struct GRFFile *grffile;
321 const struct SpriteGroup *spritegroup[Tcnt];
322 };
323
325 struct GRFFileProps : GRFFilePropsBase<1> {
327 GRFFileProps(uint16 subst_id = 0) :
328 GRFFilePropsBase<1>(), subst_id(subst_id), override(subst_id)
329 {
330 }
331
332 uint16 subst_id;
333 uint16 override;
334 };
335
336 #endif /* NEWGRF_COMMONS_H */
DECLARE_ENUM_AS_BIT_SET
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition: company_manager_face.h:31
direction_type.h
Different types to &#39;show&#39; directions.
ObjectOverrideManager
Definition: newgrf_commons.h:279
TLF_CHILD_Y_OFFSET
Add signed offset to child sprite Y positions from register TileLayoutRegisters::delta.child[1].
Definition: newgrf_commons.h:47
OverrideManagerBase::invalid_ID
uint16 invalid_ID
ID used to detected invalid entities;.
Definition: newgrf_commons.h:202
smallvec_type.hpp
Simple vector class that allows allocating an item without the need to copy this->data needlessly...
TileLayoutFlags
TileLayoutFlags
Flags to enable register usage in sprite layouts.
Definition: newgrf_commons.h:35
GetTerrainType
uint32 GetTerrainType(TileIndex tile, TileContext context=TCX_NORMAL)
Function used by houses (and soon industries) to get information on type of "terrain" the tile it is ...
Definition: newgrf_commons.cpp:350
TLF_BB_XY_OFFSET
Add signed offset to bounding box X and Y positions from register TileLayoutRegisters::delta.parent[0..1].
Definition: newgrf_commons.h:43
TileLayoutRegisters::max_palette_offset
uint16 max_palette_offset
Maximum offset to add to the palette. (limited by size of the spriteset)
Definition: newgrf_commons.h:99
TLF_SPRITE_VAR10
Resolve sprite with a specific value in variable 10.
Definition: newgrf_commons.h:49
TLF_SPRITE_REG_FLAGS
Flags which require resolving the action-1-2-3 chain for the sprite, even if it is no action-1 sprite...
Definition: newgrf_commons.h:64
PalSpriteID
Combination of a palette sprite and a &#39;real&#39; sprite.
Definition: gfx_type.h:24
TLF_PALETTE
Add signed offset to palette from register TileLayoutRegisters::palette.
Definition: newgrf_commons.h:40
TLF_NON_GROUND_FLAGS
Flags which do not work for the (first) ground sprite.
Definition: newgrf_commons.h:58
TLF_SPRITE
Add signed offset to sprite from register TileLayoutRegisters::sprite.
Definition: newgrf_commons.h:39
ObjectSpec
Allow incrementing of ObjectClassID variables.
Definition: newgrf_object.h:60
IndustryOverrideManager
Definition: newgrf_commons.h:236
NewGRFSpriteLayout::GetLayout
const DrawTileSeqStruct * GetLayout(PalSpriteID *ground) const
Returns the result spritelayout after preprocessing.
Definition: newgrf_commons.h:165
NewGRFSpriteLayout::result_seq
static SmallVector< DrawTileSeqStruct, 8 > result_seq
Temporary storage when preprocessing spritelayouts.
Definition: newgrf_commons.h:173
SmallVector< DrawTileSeqStruct, 8 >
TCX_NORMAL
Nothing special.
Definition: newgrf_commons.h:27
alloc_type.hpp
Helper types related to the allocation of memory.
CommandCost
Common return value for all commands.
Definition: command_type.h:25
command_type.h
Types related to commands.
DrawTileSprites::seq
const DrawTileSeqStruct * seq
Array of child sprites. Terminated with a terminator entry.
Definition: sprite.h:62
EntityIDMapping::grfid
uint32 grfid
The GRF ID of the file the entity belongs to.
Definition: newgrf_commons.h:189
TLF_DODRAW
Only draw sprite if value of register TileLayoutRegisters::dodraw is non-zero.
Definition: newgrf_commons.h:38
TCX_ON_BRIDGE
Querying information about stuff on the bridge (via some bridgehead).
Definition: newgrf_commons.h:29
TileLayoutRegisters::palette_var10
uint8 palette_var10
Value for variable 10 when resolving the palette.
Definition: newgrf_commons.h:105
OverrideManagerBase::max_new_entities
uint16 max_new_entities
what is the amount of entities, old and new summed
Definition: newgrf_commons.h:200
TCX_UPPER_HALFTILE
Querying information about the upper part of a tile with halftile foundation.
Definition: newgrf_commons.h:28
TileLayoutRegisters::max_sprite_offset
uint16 max_sprite_offset
Maximum offset to add to the sprite. (limited by size of the spriteset)
Definition: newgrf_commons.h:98
DrawTileSprites
Ground palette sprite of a tile, together with its sprite layout.
Definition: sprite.h:60
EntityIDMapping::substitute_id
uint8 substitute_id
The (original) entity ID to use if this GRF is not available.
Definition: newgrf_commons.h:191
NewGRFSpriteLayout::consistent_max_offset
uint consistent_max_offset
Number of sprites in all referenced spritesets.
Definition: newgrf_commons.h:122
EntityIDMapping
Maps an entity id stored on the map to a GRF file.
Definition: newgrf_commons.h:188
GRFFileProps
Data related to the handling of grf files.
Definition: newgrf_commons.h:325
ConvertBooleanCallback
bool ConvertBooleanCallback(const GRFFile *grffile, uint16 cbid, uint16 cb_res)
Converts a callback result into a boolean.
Definition: newgrf_commons.cpp:552
GetNearbyTile
TileIndex GetNearbyTile(byte parameter, TileIndex tile, bool signed_offsets=true, Axis axis=INVALID_AXIS)
Get the tile at the given offset.
Definition: newgrf_commons.cpp:425
SpriteGroup
Definition: newgrf_spritegroup.h:58
Livery
Information about a particular livery.
Definition: livery.h:76
TileLayoutRegisters::sprite_var10
uint8 sprite_var10
Value for variable 10 when resolving the sprite.
Definition: newgrf_commons.h:104
AirportTileOverrideManager
Definition: newgrf_commons.h:268
IndustrySpec
Defines the data structure for constructing industry.
Definition: industrytype.h:101
TileLayoutRegisters::sprite
uint8 sprite
Register specifying a signed offset for the sprite.
Definition: newgrf_commons.h:96
TLF_BB_Z_OFFSET
Add signed offset to bounding box Z positions from register TileLayoutRegisters::delta.parent[2].
Definition: newgrf_commons.h:44
TLF_DRAWING_FLAGS
Flags which are still required after loading the GRF.
Definition: newgrf_commons.h:55
NewGRFSpriteLayout
NewGRF supplied spritelayout.
Definition: newgrf_commons.h:115
ZeroedMemoryAllocator
Base class that provides memory initialization on dynamically created objects.
Definition: alloc_type.hpp:150
Convert8bitBooleanCallback
bool Convert8bitBooleanCallback(const GRFFile *grffile, uint16 cbid, uint16 cb_res)
Converts a callback result into a boolean.
Definition: newgrf_commons.cpp:571
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
TLF_PALETTE_REG_FLAGS
Flags which require resolving the action-1-2-3 chain for the palette, even if it is no action-1 palet...
Definition: newgrf_commons.h:67
TLF_KNOWN_FLAGS
Known flags. Any unknown set flag will disable the GRF.
Definition: newgrf_commons.h:52
EntityIDMapping::entity_id
uint8 entity_id
The entity ID within the GRF file.
Definition: newgrf_commons.h:190
TLF_PALETTE_VAR10
Resolve palette with a specific value in variable 10.
Definition: newgrf_commons.h:50
GRFFileProps::GRFFileProps
GRFFileProps(uint16 subst_id=0)
Set all default data constructor for the props.
Definition: newgrf_commons.h:327
TileLayoutRegisters
Additional modifiers for items in sprite layouts.
Definition: newgrf_commons.h:93
OverrideManagerBase::mapping_ID
EntityIDMapping * mapping_ID
mapping of ids from grf files. Public out of convenience
Definition: newgrf_commons.h:206
HouseSpec
Definition: house.h:98
HouseOverrideManager
Definition: newgrf_commons.h:227
DrawTileSprites::ground
PalSpriteID ground
Palette and sprite for the ground.
Definition: sprite.h:61
TileLayoutRegisters::child
uint8 child[2]
Registers for signed offsets for the position of child sprites.
Definition: newgrf_commons.h:102
ErrorUnknownCallbackResult
void ErrorUnknownCallbackResult(uint32 grfid, uint16 cbid, uint16 cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Definition: newgrf_commons.cpp:518
NewGRFSpriteLayout::NeedsPreprocessing
bool NeedsPreprocessing() const
Tests whether this spritelayout needs preprocessing by PrepareLayout() and ProcessRegisters(), or whether it can be used directly.
Definition: newgrf_commons.h:152
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
IndustryTileOverrideManager
Definition: newgrf_commons.h:248
TLF_CHILD_X_OFFSET
Add signed offset to child sprite X positions from register TileLayoutRegisters::delta.child[0].
Definition: newgrf_commons.h:46
GetCompanyInfo
uint32 GetCompanyInfo(CompanyID owner, const Livery *l)
Returns company information like in vehicle var 43 or station var 43.
Definition: newgrf_commons.cpp:469
GRFFilePropsBase
Data related to the handling of grf files.
Definition: newgrf_commons.h:311
sprite.h
Base for drawing complex sprites.
AirportTileSpec
Defines the data structure of each individual tile of an airport.
Definition: newgrf_airporttiles.h:64
AirportOverrideManager
Definition: newgrf_commons.h:259
GRFFilePropsBase::local_id
uint16 local_id
id defined by the grf file for this entity
Definition: newgrf_commons.h:319
company_type.h
Types related to companies.
TLR_MAX_VAR10
static const uint TLR_MAX_VAR10
Maximum value for var 10.
Definition: newgrf_commons.h:108
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:114
GRFFilePropsBase::grffile
const struct GRFFile * grffile
grf file that introduced this entity
Definition: newgrf_commons.h:320
GetConstructionStageOffset
static uint GetConstructionStageOffset(uint construction_stage, uint num_sprites)
Determines which sprite to use from a spriteset for a specific construction stage.
Definition: newgrf_commons.h:77
OverrideManagerBase
Definition: newgrf_commons.h:194
IndustryTileSpec
Defines the data structure of each individual tile of an industry.
Definition: industrytype.h:148
GetErrorMessageFromLocationCallbackResult
CommandCost GetErrorMessageFromLocationCallbackResult(uint16 cb_res, const GRFFile *grffile, StringID default_error)
Get the error message from a shape/location/slope check callback result.
Definition: newgrf_commons.cpp:482
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:20
AirportSpec
Defines the data structure for an airport.
Definition: newgrf_airport.h:100
OverrideManagerBase::max_offset
uint16 max_offset
what is the length of the original entity&#39;s array of specs
Definition: newgrf_commons.h:199
INVALID_AXIS
Flag for an invalid Axis.
Definition: direction_type.h:131
TileLayoutRegisters::parent
uint8 parent[3]
Registers for signed offsets for the bounding box position of parent sprites.
Definition: newgrf_commons.h:101
GetNearbyTileInformation
uint32 GetNearbyTileInformation(TileIndex tile, bool grf_version8)
Common part of station var 0x67, house var 0x62, indtile var 0x60, industry var 0x62.
Definition: newgrf_commons.cpp:448
TileLayoutRegisters::dodraw
uint8 dodraw
Register deciding whether the sprite shall be drawn at all. Non-zero means drawing.
Definition: newgrf_commons.h:95
DrawTileSeqStruct
A tile child sprite and palette to draw for stations etc, with 3D bounding box.
Definition: sprite.h:27
TLF_CUSTOM_PALETTE
Palette is from Action 1 (moved to SPRITE_MODIFIER_CUSTOM_SPRITE in palette during loading)...
Definition: newgrf_commons.h:41
NewGRFSpriteLayout::Clone
void Clone(const DrawTileSprites *source)
Clone a spritelayout.
Definition: newgrf_commons.h:133
Axis
Axis
Allow incrementing of DiagDirDiff variables.
Definition: direction_type.h:127
_object_mngr
ObjectOverrideManager _object_mngr
The override manager for our objects.
TileLayoutRegisters::palette
uint8 palette
Register specifying a signed offset for the palette.
Definition: newgrf_commons.h:97
TileLayoutRegisters::flags
TileLayoutFlags flags
Flags defining which members are valid and to be used.
Definition: newgrf_commons.h:94
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:104
TLF_VAR10_FLAGS
Flags which refer to using multiple action-1-2-3 chains.
Definition: newgrf_commons.h:61
TileContext
TileContext
Context for tile accesses.
Definition: newgrf_commons.h:26