NewGRF Action 0x02 handler. More...

#include "../stdafx.h"
#include <ranges>
#include "../debug.h"
#include "../newgrf_engine.h"
#include "../newgrf_cargo.h"
#include "../error.h"
#include "../vehicle_base.h"
#include "../road.h"
#include "newgrf_bytereader.h"
#include "newgrf_internal.h"
#include "table/strings.h"
#include "../safeguards.h"

Typedefs
using	CachedCallback = std::pair<uint16_t, SpriteGroupID>

Functions
void	MapSpriteMappingRecolour (PalSpriteID *grf_sprite)
	Map the colour modifiers of TTDPatch to those that Open is using.
TileLayoutFlags	ReadSpriteLayoutSprite (ByteReader &buf, bool read_flags, bool invert_action1_flag, bool use_cur_spritesets, GrfSpecFeature feature, PalSpriteID grf_sprite, uint16_t max_sprite_offset, uint16_t *max_palette_offset)
	Read a sprite and a palette from the GRF and convert them into a format suitable to OpenTTD.
static void	ReadSpriteLayoutRegisters (ByteReader &buf, TileLayoutFlags flags, bool is_parent, NewGRFSpriteLayout *dts, uint index)
	Preprocess the TileLayoutFlags and read register modifiers from the GRF.
bool	ReadSpriteLayout (ByteReader &buf, uint num_building_sprites, bool use_cur_spritesets, GrfSpecFeature feature, bool allow_var10, bool no_z_position, NewGRFSpriteLayout *dts)
	Read a spritelayout from the GRF.
void	ResetCallbacks (bool final)
static const SpriteGroup *	GetCallbackResultGroup (uint16_t value)
static const SpriteGroup *	GetGroupFromGroupID (uint8_t setid, uint8_t type, uint16_t groupid)
static const SpriteGroup *	CreateGroupFromGroupID (GrfSpecFeature feature, uint8_t setid, uint8_t type, uint16_t spriteid)
	Helper function to either create a callback or a result sprite group.
static const SpriteGroup *	ReadDeterministicSpriteGroup (ByteReader &buf, uint8_t setid, uint8_t type)
	Read a Deterministic SpriteGroup.
static const SpriteGroup *	ReadRandomizedSpriteGroup (ByteReader &buf, GrfSpecFeature feature, uint8_t setid, uint8_t type)
	Read a Randomized SpriteGroup.
static const SpriteGroup *	ReadRealSpriteGroup (ByteReader &buf, GrfSpecFeature feature, uint8_t setid, uint8_t type)
	Read a Real SpriteGroup.
static const SpriteGroup *	ReadTileLayoutSpriteGroup (ByteReader &buf, GrfSpecFeature feature, uint8_t type)
	Read a Tile Layout SpriteGroup.
static const SpriteGroup *	ReadIndustryProductionSpriteGroup (ByteReader &buf, uint8_t type)
	Read an Industry Production SpriteGroup.
static const SpriteGroup *	ReadSpriteGroup (ByteReader &buf, GrfSpecFeature feature, uint8_t setid, uint8_t type)
	Read a SpriteGroup.
static void	NewSpriteGroup (ByteReader &buf)

Variables
constexpr uint16_t	GROUPID_CALLBACK_FAILED = 0x7FFF
	Explicit "failure" result.
constexpr uint16_t	GROUPID_CALCULATED_RESULT = 0x7FFE
	Return calculated result from VarAction2.
static std::vector< CachedCallback >	_cached_callback_groups
	Sorted list of cached callback result spritegroups.

Detailed Description

NewGRF Action 0x02 handler.

Definition in file newgrf_act2.cpp.

Typedef Documentation

◆ CachedCallback

using CachedCallback = std::pair<uint16_t, SpriteGroupID>

Definition at line 264 of file newgrf_act2.cpp.

Function Documentation

◆ CreateGroupFromGroupID()

const SpriteGroup * CreateGroupFromGroupID	(	GrfSpecFeature	feature,
		uint8_t	setid,
		uint8_t	type,
		uint16_t	spriteid )

static

Helper function to either create a callback or a result sprite group.

Parameters

feature	GrfSpecFeature to define spritegroup for.
setid	SetID of the currently being parsed Action2. (only for debug output)
type	Type of the currently being parsed Action2. (only for debug output)
spriteid	Raw value from the GRF for the new spritegroup; describes either the return value or the referenced spritegroup.

Returns: Created spritegroup.

Definition at line 317 of file newgrf_act2.cpp.

References HasBit().

Referenced by ReadRealSpriteGroup().

◆ GetCallbackResultGroup()

const SpriteGroup * GetCallbackResultGroup ( uint16_t value )

static

Definition at line 273 of file newgrf_act2.cpp.

◆ GetGroupFromGroupID()

const SpriteGroup * GetGroupFromGroupID	(	uint8_t	setid,
		uint8_t	type,
		uint16_t	groupid )

static

Definition at line 296 of file newgrf_act2.cpp.

◆ MapSpriteMappingRecolour()

void MapSpriteMappingRecolour ( PalSpriteID * grf_sprite )

Map the colour modifiers of TTDPatch to those that Open is using.

Parameters

grf_sprite Pointer to the structure been modified.

Definition at line 32 of file newgrf_act2.cpp.

References ClrBit(), HasBit(), PalSpriteID::pal, PALETTE_MODIFIER_COLOUR, PALETTE_MODIFIER_TRANSPARENT, SetBit(), PalSpriteID::sprite, and SPRITE_MODIFIER_OPAQUE.

Referenced by BridgeChangeInfo(), and ReadSpriteLayoutSprite().

◆ NewSpriteGroup()

void NewSpriteGroup ( ByteReader & buf )

static

Definition at line 759 of file newgrf_act2.cpp.

◆ ReadDeterministicSpriteGroup()

const SpriteGroup * ReadDeterministicSpriteGroup	(	ByteReader &	buf,
		uint8_t	setid,
		uint8_t	type )

static

Read a Deterministic SpriteGroup.

Parameters

buf	Input stream.
setid	SetID of the currently being parsed Action2. (only for debug output)
type	Type of the currently being parsed Action2. (only for debug output)

Returns: The SpriteGroup.

Definition at line 343 of file newgrf_act2.cpp.

References Add, Byte, DeterministicSpriteGroup::default_result, DWord, DeterministicSpriteGroup::error_group, GB(), GROUPID_CALCULATED_RESULT, HasBit(), IsInsideMM(), None, DeterministicSpriteGroupAdjust::parameter, Parent, ByteReader::ReadByte(), ByteReader::ReadVarSize(), ByteReader::ReadWord(), Self, and Word.

Referenced by ReadSpriteGroup().

◆ ReadIndustryProductionSpriteGroup()

const SpriteGroup * ReadIndustryProductionSpriteGroup	(	ByteReader &	buf,
		uint8_t	type )

static

Read an Industry Production SpriteGroup.

Parameters

buf	Input stream.
type	Type of the currently being parsed Action2.

Returns: The SpriteGroup.

Definition at line 602 of file newgrf_act2.cpp.

References IndustryProductionSpriteGroup::add_output, IndustryProductionSpriteGroup::cargo_input, IndustryProductionSpriteGroup::cargo_output, GRFError::data, DisableGrf(), GetCargoTranslation(), INDUSTRY_ORIGINAL_NUM_INPUTS, INDUSTRY_ORIGINAL_NUM_OUTPUTS, IsValidCargoType(), IndustryProductionSpriteGroup::num_input, IndustryProductionSpriteGroup::num_output, ByteReader::ReadByte(), ByteReader::ReadWord(), IndustryProductionSpriteGroup::subtract_input, and IndustryProductionSpriteGroup::version.

Referenced by ReadSpriteGroup().

◆ ReadRandomizedSpriteGroup()

const SpriteGroup * ReadRandomizedSpriteGroup	(	ByteReader &	buf,
		GrfSpecFeature	feature,
		uint8_t	setid,
		uint8_t	type )

static

Read a Randomized SpriteGroup.

Parameters

buf	Input stream.
feature	GrfSpecFeature to define spritegroup for.
setid	SetID of the currently being parsed Action2. (only for debug output)
type	Type of the currently being parsed Action2. (only for debug output)

Returns: The SpriteGroup.

Definition at line 469 of file newgrf_act2.cpp.

References Aircraft, All, Any, RandomizedSpriteGroup::cmp_mode, GB(), RandomizedSpriteGroup::groups, HasBit(), HasExactlyOneBit(), RandomizedSpriteGroup::lowest_randbit, Parent, ByteReader::ReadByte(), ByteReader::ReadWord(), Relative, Self, and RandomizedSpriteGroup::var_scope.

Referenced by ReadSpriteGroup().

◆ ReadRealSpriteGroup()

const SpriteGroup * ReadRealSpriteGroup	(	ByteReader &	buf,
		GrfSpecFeature	feature,
		uint8_t	setid,
		uint8_t	type )

static

Read a Real SpriteGroup.

Parameters

buf	Input stream.
feature	GrfSpecFeature to define spritegroup for.
setid	SetID of the currently being parsed Action2. (only for debug output)
type	Type of the currently being parsed Action2.

Returns: The SpriteGroup.

Definition at line 507 of file newgrf_act2.cpp.

References CreateGroupFromGroupID(), RealSpriteGroup::loaded, RealSpriteGroup::loading, ByteReader::ReadByte(), and ByteReader::ReadWord().

Referenced by ReadSpriteGroup().

◆ ReadSpriteGroup()

const SpriteGroup * ReadSpriteGroup	(	ByteReader &	buf,
		GrfSpecFeature	feature,
		uint8_t	setid,
		uint8_t	type )

static

Read a SpriteGroup.

Parameters

buf	Input stream.
feature	GrfSpecFeature to define spritegroup for.
setid	SetID of the currently being parsed Action2. (only for debug output)
type	Type of the currently being parsed Action2. (only for debug output)

Returns: The SpriteGroup.

Definition at line 693 of file newgrf_act2.cpp.

References Aircraft, Airports, AirportTiles, Badges, Canals, Cargoes, End, Houses, Industries, IndustryTiles, Objects, RailTypes, ReadDeterministicSpriteGroup(), ReadIndustryProductionSpriteGroup(), ReadRandomizedSpriteGroup(), ReadRealSpriteGroup(), ReadTileLayoutSpriteGroup(), RoadStops, RoadTypes, RoadVehicles, Ships, Stations, Trains, and TramTypes.

◆ ReadSpriteLayout()

bool ReadSpriteLayout	(	ByteReader &	buf,
		uint	num_building_sprites,
		bool	use_cur_spritesets,
		GrfSpecFeature	feature,
		bool	allow_var10,
		bool	no_z_position,
		NewGRFSpriteLayout *	dts )

Read a spritelayout from the GRF.

Parameters

buf	Input
num_building_sprites	Number of building sprites to read
use_cur_spritesets	Whether to use currently referenceable action 1 sets.
feature	GrfSpecFeature to use spritesets from.
allow_var10	Whether the spritelayout may specify var10 values for resolving multiple action-1-2-3 chains
no_z_position	Whether bounding boxes have no Z offset
dts	Layout container to output into

Returns: True on error (GRF was disabled).

Definition at line 174 of file newgrf_act2.cpp.

References NewGRFSpriteLayout::Allocate(), NewGRFSpriteLayout::AllocateRegisters(), ClrBit(), NewGRFSpriteLayout::consistent_max_offset, DisableGrf(), SpriteBounds::extent, DrawTileSprites::ground, HasBit(), DrawTileSeqStruct::IsParentSprite(), TileLayoutRegisters::max_palette_offset, TileLayoutRegisters::max_sprite_offset, SpriteBounds::origin, ByteReader::ReadByte(), ReadSpriteLayoutRegisters(), ReadSpriteLayoutSprite(), TLF_KNOWN_FLAGS, TLF_NON_GROUND_FLAGS, TLF_VAR10_FLAGS, Coord3D< T >::x, Coord3D< T >::y, and Coord3D< T >::z.

Referenced by ReadTileLayoutSpriteGroup(), and StationChangeInfo().

◆ ReadSpriteLayoutRegisters()

void ReadSpriteLayoutRegisters	(	ByteReader &	buf,
		TileLayoutFlags	flags,
		bool	is_parent,
		NewGRFSpriteLayout *	dts,
		uint	index )

static

Preprocess the TileLayoutFlags and read register modifiers from the GRF.

Parameters

buf	Input stream.
flags	TileLayoutFlags to process.
is_parent	Whether the sprite is a parentsprite with a bounding box.
dts	Sprite layout to insert data into.
index	Sprite index to process; 0 for ground sprite.

Definition at line 121 of file newgrf_act2.cpp.

Referenced by ReadSpriteLayout().

◆ ReadSpriteLayoutSprite()

TileLayoutFlags ReadSpriteLayoutSprite	(	ByteReader &	buf,
		bool	read_flags,
		bool	invert_action1_flag,
		bool	use_cur_spritesets,
		GrfSpecFeature	feature,
		PalSpriteID *	grf_sprite,
		uint16_t *	max_sprite_offset,
		uint16_t *	max_palette_offset )

Read a sprite and a palette from the GRF and convert them into a format suitable to OpenTTD.

Parameters

	buf	Input stream.
	read_flags	Whether to read TileLayoutFlags.
	invert_action1_flag	Set to true, if palette bit 15 means 'not from action 1'.
	use_cur_spritesets	Whether to use currently referenceable action 1 sets.
	feature	GrfSpecFeature to use spritesets from.
[out]	grf_sprite	Read sprite and palette.
[out]	max_sprite_offset	Optionally returns the number of sprites in the spriteset of the sprite. (0 if no spritset)
[out]	max_palette_offset	Optionally returns the number of sprites in the spriteset of the palette. (0 if no spritset)

Returns: Read TileLayoutFlags.

Definition at line 63 of file newgrf_act2.cpp.

References ClrBit(), DisableGrf(), GB(), HasBit(), MapSpriteMappingRecolour(), PalSpriteID::pal, ByteReader::ReadWord(), SB(), SetBit(), SPR_IMG_QUERY, PalSpriteID::sprite, SPRITE_MODIFIER_CUSTOM_SPRITE, SPRITE_WIDTH, TLF_CUSTOM_PALETTE, TLF_PALETTE_REG_FLAGS, TLF_PALETTE_VAR10, TLF_SPRITE_REG_FLAGS, and TLF_SPRITE_VAR10.

Referenced by ReadSpriteLayout(), and StationChangeInfo().

◆ ReadTileLayoutSpriteGroup()

const SpriteGroup * ReadTileLayoutSpriteGroup	(	ByteReader &	buf,
		GrfSpecFeature	feature,
		uint8_t	type )

static

Read a Tile Layout SpriteGroup.

Parameters

buf	Input stream.
feature	GrfSpecFeature to define spritegroup for.
type	Type of the currently being parsed Action2. (only for debug output)

Returns: The SpriteGroup.

Definition at line 582 of file newgrf_act2.cpp.

References ReadSpriteLayout().

Referenced by ReadSpriteGroup().

◆ ResetCallbacks()

void ResetCallbacks ( bool final )

Definition at line 267 of file newgrf_act2.cpp.

Variable Documentation

◆ _cached_callback_groups

std::vector<CachedCallback> _cached_callback_groups

static

Sorted list of cached callback result spritegroups.

Definition at line 265 of file newgrf_act2.cpp.

◆ GROUPID_CALCULATED_RESULT

uint16_t GROUPID_CALCULATED_RESULT = 0x7FFE

constexpr

Return calculated result from VarAction2.

Definition at line 26 of file newgrf_act2.cpp.

Referenced by ReadDeterministicSpriteGroup().

◆ GROUPID_CALLBACK_FAILED

uint16_t GROUPID_CALLBACK_FAILED = 0x7FFF

constexpr

Explicit "failure" result.

Definition at line 25 of file newgrf_act2.cpp.

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ CachedCallback

Function Documentation

◆ CreateGroupFromGroupID()

◆ GetCallbackResultGroup()

◆ GetGroupFromGroupID()

◆ MapSpriteMappingRecolour()

◆ NewSpriteGroup()

◆ ReadDeterministicSpriteGroup()

◆ ReadIndustryProductionSpriteGroup()

◆ ReadRandomizedSpriteGroup()

◆ ReadRealSpriteGroup()

◆ ReadSpriteGroup()

◆ ReadSpriteLayout()

◆ ReadSpriteLayoutRegisters()

◆ ReadSpriteLayoutSprite()

◆ ReadTileLayoutSpriteGroup()

◆ ResetCallbacks()

Variable Documentation

◆ _cached_callback_groups

◆ GROUPID_CALCULATED_RESULT

◆ GROUPID_CALLBACK_FAILED