OpenTTD Source
20241108-master-g80f628063a
|
This file simplyfies and embeds a common mechanism of loading/saving and mapping of grf entities. More...
#include "sprite.h"
#include "core/alloc_type.hpp"
#include "command_type.h"
#include "direction_type.h"
#include "company_type.h"
Go to the source code of this file.
Data Structures | |
struct | TileLayoutRegisters |
Additional modifiers for items in sprite layouts. More... | |
struct | NewGRFSpriteLayout |
NewGRF supplied spritelayout. More... | |
struct | EntityIDMapping |
Maps an entity id stored on the map to a GRF file. More... | |
class | OverrideManagerBase |
class | HouseOverrideManager |
class | IndustryOverrideManager |
class | IndustryTileOverrideManager |
class | AirportOverrideManager |
class | AirportTileOverrideManager |
class | ObjectOverrideManager |
struct | GRFFilePropsBase< Tcnt > |
Data related to the handling of grf files. More... | |
struct | GRFFileProps |
Data related to the handling of grf files. More... | |
Enumerations | |
enum | TileContext { TCX_NORMAL , TCX_UPPER_HALFTILE , TCX_ON_BRIDGE } |
Context for tile accesses. More... | |
enum | TileLayoutFlags { TLF_NOTHING = 0x00 , TLF_DODRAW = 0x01 , TLF_SPRITE = 0x02 , TLF_PALETTE = 0x04 , TLF_CUSTOM_PALETTE = 0x08 , TLF_BB_XY_OFFSET = 0x10 , TLF_BB_Z_OFFSET = 0x20 , TLF_CHILD_X_OFFSET = 0x10 , TLF_CHILD_Y_OFFSET = 0x20 , TLF_SPRITE_VAR10 = 0x40 , TLF_PALETTE_VAR10 = 0x80 , TLF_KNOWN_FLAGS = 0xFF , TLF_DRAWING_FLAGS = ~TLF_CUSTOM_PALETTE , TLF_NON_GROUND_FLAGS = TLF_BB_XY_OFFSET | TLF_BB_Z_OFFSET | TLF_CHILD_X_OFFSET | TLF_CHILD_Y_OFFSET , TLF_VAR10_FLAGS = TLF_SPRITE_VAR10 | TLF_PALETTE_VAR10 , TLF_SPRITE_REG_FLAGS = TLF_DODRAW | TLF_SPRITE | TLF_BB_XY_OFFSET | TLF_BB_Z_OFFSET | TLF_CHILD_X_OFFSET | TLF_CHILD_Y_OFFSET , TLF_PALETTE_REG_FLAGS = TLF_PALETTE } |
Flags to enable register usage in sprite layouts. More... | |
Functions | |
uint | GetConstructionStageOffset (uint construction_stage, uint num_sprites) |
Determines which sprite to use from a spriteset for a specific construction stage. More... | |
uint32_t | 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 queries sits on. More... | |
TileIndex | GetNearbyTile (uint8_t parameter, TileIndex tile, bool signed_offsets=true, Axis axis=INVALID_AXIS) |
Get the tile at the given offset. More... | |
uint32_t | GetNearbyTileInformation (TileIndex tile, bool grf_version8) |
Common part of station var 0x67, house var 0x62, indtile var 0x60, industry var 0x62. More... | |
uint32_t | GetCompanyInfo (CompanyID owner, const struct Livery *l=nullptr) |
CommandCost | GetErrorMessageFromLocationCallbackResult (uint16_t cb_res, const GRFFile *grffile, StringID default_error) |
Get the error message from a shape/location/slope check callback result. More... | |
void | ErrorUnknownCallbackResult (uint32_t grfid, uint16_t cbid, uint16_t cb_res) |
Record that a NewGRF returned an unknown/invalid callback result. More... | |
bool | ConvertBooleanCallback (const struct GRFFile *grffile, uint16_t cbid, uint16_t cb_res) |
bool | Convert8bitBooleanCallback (const struct GRFFile *grffile, uint16_t cbid, uint16_t cb_res) |
Variables | |
static const uint | TLR_MAX_VAR10 = 7 |
Maximum value for var 10. | |
HouseOverrideManager | _house_mngr |
IndustryOverrideManager | _industry_mngr |
IndustryTileOverrideManager | _industile_mngr |
AirportOverrideManager | _airport_mngr |
AirportTileOverrideManager | _airporttile_mngr |
ObjectOverrideManager | _object_mngr |
This file simplyfies and embeds a common mechanism of loading/saving and mapping of grf entities.
Definition in file newgrf_commons.h.
enum TileContext |
Context for tile accesses.
Definition at line 23 of file newgrf_commons.h.
enum TileLayoutFlags |
Flags to enable register usage in sprite layouts.
Enumerator | |
---|---|
TLF_DODRAW | Only draw sprite if value of register TileLayoutRegisters::dodraw is non-zero. |
TLF_SPRITE | Add signed offset to sprite from register TileLayoutRegisters::sprite. |
TLF_PALETTE | Add signed offset to palette from register TileLayoutRegisters::palette. |
TLF_CUSTOM_PALETTE | Palette is from Action 1 (moved to SPRITE_MODIFIER_CUSTOM_SPRITE in palette during loading). |
TLF_BB_XY_OFFSET | Add signed offset to bounding box X and Y positions from register TileLayoutRegisters::delta.parent[0..1]. |
TLF_BB_Z_OFFSET | Add signed offset to bounding box Z positions from register TileLayoutRegisters::delta.parent[2]. |
TLF_CHILD_X_OFFSET | Add signed offset to child sprite X positions from register TileLayoutRegisters::delta.child[0]. |
TLF_CHILD_Y_OFFSET | Add signed offset to child sprite Y positions from register TileLayoutRegisters::delta.child[1]. |
TLF_SPRITE_VAR10 | Resolve sprite with a specific value in variable 10. |
TLF_PALETTE_VAR10 | Resolve palette with a specific value in variable 10. |
TLF_KNOWN_FLAGS | Known flags. Any unknown set flag will disable the GRF. |
TLF_DRAWING_FLAGS | Flags which are still required after loading the GRF. |
TLF_NON_GROUND_FLAGS | Flags which do not work for the (first) ground sprite. |
TLF_VAR10_FLAGS | Flags which refer to using multiple action-1-2-3 chains. |
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. |
TLF_PALETTE_REG_FLAGS | Flags which require resolving the action-1-2-3 chain for the palette, even if it is no action-1 palette. |
Definition at line 32 of file newgrf_commons.h.
void ErrorUnknownCallbackResult | ( | uint32_t | grfid, |
uint16_t | cbid, | ||
uint16_t | cb_res | ||
) |
Record that a NewGRF returned an unknown/invalid callback result.
Also show an error to the user.
grfid | ID of the NewGRF causing the problem. |
cbid | Callback causing the problem. |
cb_res | Invalid result returned by the callback. |
Definition at line 505 of file newgrf_commons.cpp.
|
inline |
Determines which sprite to use from a spriteset for a specific construction stage.
construction_stage | Construction stage 0 - 3. |
num_sprites | Number of available sprites to select stage from. |
Definition at line 74 of file newgrf_commons.h.
Referenced by TileLayoutSpriteGroup::ProcessRegisters().
CommandCost GetErrorMessageFromLocationCallbackResult | ( | uint16_t | cb_res, |
const GRFFile * | grffile, | ||
StringID | default_error | ||
) |
Get the error message from a shape/location/slope check callback result.
cb_res | Callback result to translate. If bit 10 is set this is a standard error message, otherwise a NewGRF provided string. |
grffile | NewGRF to use to resolve a custom error message. |
default_error | Error message to use for the generic error. |
Definition at line 469 of file newgrf_commons.cpp.
Get the tile at the given offset.
parameter | The NewGRF "encoded" offset. |
tile | The tile to base the offset from. |
signed_offsets | Whether the offsets are to be interpreted as signed or not. |
axis | Axis of a railways station. |
Definition at line 410 of file newgrf_commons.cpp.
Referenced by GetNearbyAirportTileInformation(), GetNearbyIndustryTileInformation(), GetNearbyObjectTileInformation(), GetNearbyTileInformation(), AirportTileScopeResolver::GetVariable(), ObjectScopeResolver::GetVariable(), and StationScopeResolver::GetVariable().
uint32_t GetNearbyTileInformation | ( | TileIndex | tile, |
bool | grf_version8 | ||
) |
Common part of station var 0x67, house var 0x62, indtile var 0x60, industry var 0x62.
tile | the tile of interest. |
grf_version8 | True, if we are dealing with a new NewGRF which uses GRF version >= 8. |
Definition at line 433 of file newgrf_commons.cpp.
References GetTerrainType(), GetTilePixelSlope(), GetTileType(), GetTreeGround(), GetWaterClass(), HasTileWaterClass(), IsRoadWaypointTile(), IsTileType(), MP_ROAD, MP_TREES, MP_WATER, TILE_HEIGHT, and TREE_GROUND_SHORE.
Referenced by GetNearbyAirportTileInformation(), GetNearbyIndustryTileInformation(), and GetNearbyObjectTileInformation().
uint32_t GetTerrainType | ( | TileIndex | tile, |
TileContext | context | ||
) |
Function used by houses (and soon industries) to get information on type of "terrain" the tile it is queries sits on.
tile | TileIndex of the tile been queried |
context | The context of the tile. |
Definition at line 335 of file newgrf_commons.cpp.
References _settings_game, GameSettings::game_creation, and GameCreationSettings::landscape.
Referenced by GetNearbyTileInformation(), AirportTileScopeResolver::GetVariable(), CanalScopeResolver::GetVariable(), HouseScopeResolver::GetVariable(), IndustriesScopeResolver::GetVariable(), IndustryTileScopeResolver::GetVariable(), and ObjectScopeResolver::GetVariable().