15 #ifndef NEWGRF_COMMONS_H 16 #define NEWGRF_COMMONS_H 79 assert(num_sprites > 0);
80 if (num_sprites > 4) num_sprites = 4;
81 switch (construction_stage) {
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();
124 void Allocate(uint num_sprites);
125 void AllocateRegisters();
135 assert(source != NULL &&
this != source);
136 this->ground = source->
ground;
137 this->Clone(source->
seq);
143 free(this->registers);
154 return this->registers != NULL;
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;
168 *ground = front->image;
196 uint16 *entity_overrides;
197 uint32 *grfid_overrides;
203 virtual bool CheckValidNewID(uint16 testid) {
return true; }
211 void ResetOverride();
214 void Add(uint8 local_id, uint32 grfid, uint entity_type);
215 virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id);
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;
221 inline uint16 GetMaxMapping()
const {
return max_new_entities; }
222 inline uint16 GetMaxOffset()
const {
return max_offset; }
241 virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id);
242 virtual uint16 GetID(uint8 grf_local_id, uint32 grfid)
const;
250 virtual bool CheckValidNewID(uint16 testid) {
return testid != 0xFF; }
270 virtual bool CheckValidNewID(uint16 testid) {
return testid != 0xFF; }
281 virtual bool CheckValidNewID(uint16 testid) {
return testid != 0xFF; }
310 template <
size_t Tcnt>
316 memset(spritegroup, 0,
sizeof(spritegroup));
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Different types to 'show' directions.
Add signed offset to child sprite Y positions from register TileLayoutRegisters::delta.child[1].
uint16 invalid_ID
ID used to detected invalid entities;.
Simple vector class that allows allocating an item without the need to copy this->data needlessly...
TileLayoutFlags
Flags to enable register usage in sprite layouts.
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 ...
Add signed offset to bounding box X and Y positions from register TileLayoutRegisters::delta.parent[0..1].
uint16 max_palette_offset
Maximum offset to add to the palette. (limited by size of the spriteset)
Resolve sprite with a specific value in variable 10.
Flags which require resolving the action-1-2-3 chain for the sprite, even if it is no action-1 sprite...
Combination of a palette sprite and a 'real' sprite.
Add signed offset to palette from register TileLayoutRegisters::palette.
Flags which do not work for the (first) ground sprite.
Add signed offset to sprite from register TileLayoutRegisters::sprite.
Allow incrementing of ObjectClassID variables.
const DrawTileSeqStruct * GetLayout(PalSpriteID *ground) const
Returns the result spritelayout after preprocessing.
static SmallVector< DrawTileSeqStruct, 8 > result_seq
Temporary storage when preprocessing spritelayouts.
Helper types related to the allocation of memory.
Common return value for all commands.
Types related to commands.
const DrawTileSeqStruct * seq
Array of child sprites. Terminated with a terminator entry.
uint32 grfid
The GRF ID of the file the entity belongs to.
Only draw sprite if value of register TileLayoutRegisters::dodraw is non-zero.
Querying information about stuff on the bridge (via some bridgehead).
uint8 palette_var10
Value for variable 10 when resolving the palette.
uint16 max_new_entities
what is the amount of entities, old and new summed
Querying information about the upper part of a tile with halftile foundation.
uint16 max_sprite_offset
Maximum offset to add to the sprite. (limited by size of the spriteset)
Ground palette sprite of a tile, together with its sprite layout.
uint8 substitute_id
The (original) entity ID to use if this GRF is not available.
uint consistent_max_offset
Number of sprites in all referenced spritesets.
Maps an entity id stored on the map to a GRF file.
Data related to the handling of grf files.
bool ConvertBooleanCallback(const GRFFile *grffile, uint16 cbid, uint16 cb_res)
Converts a callback result into a boolean.
TileIndex GetNearbyTile(byte parameter, TileIndex tile, bool signed_offsets=true, Axis axis=INVALID_AXIS)
Get the tile at the given offset.
Information about a particular livery.
uint8 sprite_var10
Value for variable 10 when resolving the sprite.
Defines the data structure for constructing industry.
uint8 sprite
Register specifying a signed offset for the sprite.
Add signed offset to bounding box Z positions from register TileLayoutRegisters::delta.parent[2].
Flags which are still required after loading the GRF.
NewGRF supplied spritelayout.
Base class that provides memory initialization on dynamically created objects.
bool Convert8bitBooleanCallback(const GRFFile *grffile, uint16 cbid, uint16 cb_res)
Converts a callback result into a boolean.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Flags which require resolving the action-1-2-3 chain for the palette, even if it is no action-1 palet...
Known flags. Any unknown set flag will disable the GRF.
uint8 entity_id
The entity ID within the GRF file.
Resolve palette with a specific value in variable 10.
GRFFileProps(uint16 subst_id=0)
Set all default data constructor for the props.
Additional modifiers for items in sprite layouts.
EntityIDMapping * mapping_ID
mapping of ids from grf files. Public out of convenience
PalSpriteID ground
Palette and sprite for the ground.
uint8 child[2]
Registers for signed offsets for the position of child sprites.
void ErrorUnknownCallbackResult(uint32 grfid, uint16 cbid, uint16 cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
bool NeedsPreprocessing() const
Tests whether this spritelayout needs preprocessing by PrepareLayout() and ProcessRegisters(), or whether it can be used directly.
uint32 TileIndex
The index/ID of a Tile.
Add signed offset to child sprite X positions from register TileLayoutRegisters::delta.child[0].
uint32 GetCompanyInfo(CompanyID owner, const Livery *l)
Returns company information like in vehicle var 43 or station var 43.
Data related to the handling of grf files.
Base for drawing complex sprites.
Defines the data structure of each individual tile of an airport.
uint16 local_id
id defined by the grf file for this entity
Types related to companies.
static const uint TLR_MAX_VAR10
Maximum value for var 10.
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
const struct GRFFile * grffile
grf file that introduced this entity
static uint GetConstructionStageOffset(uint construction_stage, uint num_sprites)
Determines which sprite to use from a spriteset for a specific construction stage.
Defines the data structure of each individual tile of an industry.
CommandCost GetErrorMessageFromLocationCallbackResult(uint16 cb_res, const GRFFile *grffile, StringID default_error)
Get the error message from a shape/location/slope check callback result.
Owner
Enum for all companies/owners.
Defines the data structure for an airport.
uint16 max_offset
what is the length of the original entity's array of specs
Flag for an invalid Axis.
uint8 parent[3]
Registers for signed offsets for the bounding box position of parent sprites.
uint32 GetNearbyTileInformation(TileIndex tile, bool grf_version8)
Common part of station var 0x67, house var 0x62, indtile var 0x60, industry var 0x62.
uint8 dodraw
Register deciding whether the sprite shall be drawn at all. Non-zero means drawing.
A tile child sprite and palette to draw for stations etc, with 3D bounding box.
Palette is from Action 1 (moved to SPRITE_MODIFIER_CUSTOM_SPRITE in palette during loading)...
void Clone(const DrawTileSprites *source)
Clone a spritelayout.
Axis
Allow incrementing of DiagDirDiff variables.
ObjectOverrideManager _object_mngr
The override manager for our objects.
uint8 palette
Register specifying a signed offset for the palette.
TileLayoutFlags flags
Flags defining which members are valid and to be used.
Dynamic data of a loaded NewGRF.
Flags which refer to using multiple action-1-2-3 chains.
TileContext
Context for tile accesses.