Interface for #SpriteGroup-s to access the gamestate. More...

#include <newgrf_spritegroup.h>

Inheritance diagram for ResolverObject:

Public Member Functions
	ResolverObject (const GRFFile *grffile, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
	Resolver constructor.
virtual	~ResolverObject ()=default
	Ensure the destructor of the sub classes are called as well.
ResolverResult	DoResolve ()
int32_t	GetRegister (uint i) const
	Gets the value of a so-called newgrf "register".
void	SetRegister (uint i, int32_t value)
	Sets the value of a so-called newgrf "register".
template<class TSpriteGroup>
const TSpriteGroup *	Resolve ()
	Resolve SpriteGroup.
void	ResolveRerandomisation ()
	Resolve bits to be rerandomised.
CallbackResult	ResolveCallback (std::span< int32_t > regs100)
	Resolve callback.
virtual const SpriteGroup *	ResolveReal (const RealSpriteGroup &group) const
	Get the real sprites of the grf.
virtual ScopeResolver *	GetScope (VarSpriteGroupScope scope=VarSpriteGroupScope::Self, uint8_t relative=0)
	Get a resolver for the scope.
uint32_t	GetWaitingRandomTriggers () const
	Used by RandomizedSpriteGroup: Triggers for rerandomisation.
void	AddUsedRandomTriggers (uint32_t triggers)
	Used by RandomizedSpriteGroup: Consume triggers.
uint32_t	GetReseedSum () const
	Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with.
virtual GrfSpecFeature	GetFeature () const
	Get the feature number being resolved for.
virtual uint32_t	GetDebugID () const
	Get an identifier for the item being resolved.

Data Fields
ScopeResolver	default_scope
	Default implementation of the grf scope.
CallbackID	callback {}
	Callback being resolved.
uint32_t	callback_param1 = 0
	First parameter (var 10) of the callback.
uint32_t	callback_param2 = 0
	Second parameter (var 18) of the callback.
uint32_t	last_value = 0
	Result of most recent DeterministicSpriteGroup (including procedure calls).
EnumIndexArray< uint32_t, VarSpriteGroupScope, VarSpriteGroupScope::End >	reseed
	Collects bits to rerandomise while triggering triggers.
const GRFFile *	grffile = nullptr
	GRFFile the resolved SpriteGroup belongs to.
const SpriteGroup *	root_spritegroup = nullptr
	Root SpriteGroup to use for resolving.

Protected Attributes
uint32_t	waiting_random_triggers = 0
	Waiting triggers to be used by any rerandomisation. (scope independent).
uint32_t	used_random_triggers = 0
	Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent).

Static Private Attributes
static TemporaryStorageArray< int32_t, 0x110 >	temp_store

Detailed Description

Interface for #SpriteGroup-s to access the gamestate.

Using this interface #SpriteGroup-chains (action 1-2-3 chains) can be resolved, to get the results of callbacks, rerandomisations or normal sprite lookups.

Definition at line 325 of file newgrf_spritegroup.h.

Constructor & Destructor Documentation

◆ ResolverObject()

ResolverObject::ResolverObject	(	const GRFFile *	grffile,
		CallbackID	callback = CBID_NO_CALLBACK,
		uint32_t	callback_param1 = 0,
		uint32_t	callback_param2 = 0 )

inline

Resolver constructor.

Parameters

grffile	NewGRF file associated with the object (or `nullptr` if none).
callback	Callback code being resolved (default value is CBID_NO_CALLBACK).
callback_param1	First parameter (var 10) of the callback (only used when callback is also set).
callback_param2	Second parameter (var 18) of the callback (only used when callback is also set).

Definition at line 337 of file newgrf_spritegroup.h.

References callback, callback_param1, callback_param2, CBID_NO_CALLBACK, default_scope, grffile, and root_spritegroup.

Referenced by AirportResolverObject::AirportResolverObject(), AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), GenericResolverObject::GenericResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), ObjectResolverObject::ObjectResolverObject(), RailTypeResolverObject::RailTypeResolverObject(), RoadTypeResolverObject::RoadTypeResolverObject(), and TownResolverObject::TownResolverObject().

Member Function Documentation

◆ AddUsedRandomTriggers()

void ResolverObject::AddUsedRandomTriggers ( uint32_t triggers )

inline

Used by RandomizedSpriteGroup: Consume triggers.

Parameters

triggers The triggers t0 set as having used random triggers.

Definition at line 454 of file newgrf_spritegroup.h.

◆ DoResolve()

ResolverResult ResolverObject::DoResolve ( )

inline

Definition at line 345 of file newgrf_spritegroup.h.

◆ GetDebugID()

virtual uint32_t ResolverObject::GetDebugID ( ) const

inlinevirtual

Get an identifier for the item being resolved.

This function is mainly intended for the callback profiling feature, and should return an identifier recognisable by the NewGRF developer.

Returns: The identifier.

Reimplemented in AirportResolverObject, AirportTileResolverObject, BadgeResolverObject, CanalResolverObject, CargoResolverObject, GenericResolverObject, HouseResolverObject, IndustriesResolverObject, IndustryTileResolverObject, ObjectResolverObject, RailTypeResolverObject, RoadTypeResolverObject, StationResolverObject, and VehicleResolverObject.

Definition at line 485 of file newgrf_spritegroup.h.

Referenced by NewGRFProfiler::BeginResolve().

◆ GetFeature()

virtual GrfSpecFeature ResolverObject::GetFeature ( ) const

inlinevirtual

Get the feature number being resolved for.

This function is mainly intended for the callback profiling feature.

Returns: The feature.

Reimplemented in AirportResolverObject, AirportTileResolverObject, BadgeResolverObject, CanalResolverObject, CargoResolverObject, GenericResolverObject, HouseResolverObject, IndustriesResolverObject, IndustryTileResolverObject, ObjectResolverObject, RailTypeResolverObject, RoadTypeResolverObject, StationResolverObject, and VehicleResolverObject.

Definition at line 478 of file newgrf_spritegroup.h.

References Invalid.

Referenced by NewGRFProfiler::BeginResolve().

◆ GetRegister()

int32_t ResolverObject::GetRegister ( uint i ) const

inline

Gets the value of a so-called newgrf "register".

Parameters

i	index of the register

Returns: the value of the register

Precondition: i < 0x110

Definition at line 362 of file newgrf_spritegroup.h.

Referenced by VehicleResolverObject::GetScope(), and ResolveCallback().

◆ GetReseedSum()

uint32_t ResolverObject::GetReseedSum ( ) const

inline

Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with.

Returns: OR-sum of the bits.

Definition at line 464 of file newgrf_spritegroup.h.

References End.

◆ GetScope()

ScopeResolver * ResolverObject::GetScope	(	VarSpriteGroupScope	scope = VarSpriteGroupScope::Self,
		uint8_t	relative = 0 )

virtual

Get a resolver for the scope.

Parameters

scope	The scope to resolve.
relative	The relative in case of a VarSpriteGroupScope::Relative.

Returns: The resolver for the requested scope.

Reimplemented in AirportResolverObject, AirportTileResolverObject, BadgeResolverObject, CanalResolverObject, GenericResolverObject, HouseResolverObject, IndustriesResolverObject, IndustryTileResolverObject, ObjectResolverObject, RailTypeResolverObject, RoadStopResolverObject, RoadTypeResolverObject, StationResolverObject, TownResolverObject, and VehicleResolverObject.

Definition at line 137 of file newgrf_spritegroup.cpp.

References default_scope.

◆ GetWaitingRandomTriggers()

uint32_t ResolverObject::GetWaitingRandomTriggers ( ) const

inline

Used by RandomizedSpriteGroup: Triggers for rerandomisation.

Returns: The triggers waiting for randomisation.

Definition at line 445 of file newgrf_spritegroup.h.

◆ Resolve()

template<class TSpriteGroup>

const TSpriteGroup * ResolverObject::Resolve ( )

inline

Resolve SpriteGroup.

Returns: Result spritegroup.

Template Parameters

TSpriteGroup Sprite group type

Definition at line 399 of file newgrf_spritegroup.h.

◆ ResolveCallback()

CallbackResult ResolverObject::ResolveCallback ( std::span< int32_t > regs100 )

inline

Resolve callback.

Parameters

[out] regs100 Additional result values from registers 100+

Returns: Callback result.

Definition at line 426 of file newgrf_spritegroup.h.

References CALLBACK_FAILED, and GetRegister().

◆ ResolveReal()

const SpriteGroup * ResolverObject::ResolveReal ( const RealSpriteGroup & group ) const

virtual

Get the real sprites of the grf.

Parameters

group Group to get.

Returns: The available sprite group.

Reimplemented in StationResolverObject, and VehicleResolverObject.

Definition at line 123 of file newgrf_spritegroup.cpp.

References RealSpriteGroup::loaded, and RealSpriteGroup::loading.

◆ ResolveRerandomisation()

void ResolverObject::ResolveRerandomisation ( )

inline

Resolve bits to be rerandomised.

Access results via:

reseed: Bits to rerandomise per scope, for features with proper PARENT rerandomisation. (only industry tiles)
GetReseedSum: Bits to rerandomise for SELF scope, for features with broken-by-design PARENT randomisation. (all but industry tiles)
GetUsedRandomTriggers: Consumed random triggers to be reset.

Definition at line 414 of file newgrf_spritegroup.h.

◆ SetRegister()

void ResolverObject::SetRegister	(	uint	i,
		int32_t	value )

inline

Sets the value of a so-called newgrf "register".

Parameters

i	index of the register
value	the value of the register

Precondition: i < 0x110

Definition at line 373 of file newgrf_spritegroup.h.

Field Documentation

◆ callback

CallbackID ResolverObject::callback {}

Callback being resolved.

Definition at line 378 of file newgrf_spritegroup.h.

Referenced by AirportResolverObject::AirportResolverObject(), AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), NewGRFProfiler::BeginResolve(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), GenericResolverObject::GenericResolverObject(), HouseResolverObject::HouseResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), IndustryTileResolverObject::IndustryTileResolverObject(), ObjectResolverObject::ObjectResolverObject(), ResolverObject(), StationResolverObject::StationResolverObject(), and VehicleResolverObject::VehicleResolverObject().

◆ callback_param1

uint32_t ResolverObject::callback_param1 = 0

First parameter (var 10) of the callback.

Definition at line 379 of file newgrf_spritegroup.h.

Referenced by AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), IndustryTileResolverObject::IndustryTileResolverObject(), ResolverObject(), StationResolverObject::StationResolverObject(), and VehicleResolverObject::VehicleResolverObject().

◆ callback_param2

uint32_t ResolverObject::callback_param2 = 0

Second parameter (var 18) of the callback.

Definition at line 380 of file newgrf_spritegroup.h.

Referenced by AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), IndustryTileResolverObject::IndustryTileResolverObject(), ResolverObject(), StationResolverObject::StationResolverObject(), and VehicleResolverObject::VehicleResolverObject().

◆ default_scope

ScopeResolver ResolverObject::default_scope

Default implementation of the grf scope.

Definition at line 354 of file newgrf_spritegroup.h.

Referenced by GetScope(), and ResolverObject().

◆ grffile

const GRFFile* ResolverObject::grffile = nullptr

GRFFile the resolved SpriteGroup belongs to.

Definition at line 390 of file newgrf_spritegroup.h.

Referenced by AirportResolverObject::AirportResolverObject(), AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), ObjectResolverObject::ObjectResolverObject(), RailTypeResolverObject::RailTypeResolverObject(), ResolverObject(), RoadTypeResolverObject::RoadTypeResolverObject(), StationResolverObject::StationResolverObject(), and TownResolverObject::TownResolverObject().

◆ last_value

uint32_t ResolverObject::last_value = 0

Result of most recent DeterministicSpriteGroup (including procedure calls).

Definition at line 382 of file newgrf_spritegroup.h.

Referenced by ~ResolverObject().

◆ reseed

EnumIndexArray<uint32_t, VarSpriteGroupScope, VarSpriteGroupScope::End> ResolverObject::reseed

Collects bits to rerandomise while triggering triggers.

Definition at line 388 of file newgrf_spritegroup.h.

Referenced by ~ResolverObject().

◆ root_spritegroup

const SpriteGroup* ResolverObject::root_spritegroup = nullptr

Root SpriteGroup to use for resolving.

Definition at line 391 of file newgrf_spritegroup.h.

Referenced by AirportResolverObject::AirportResolverObject(), AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), NewGRFProfiler::BeginResolve(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), HouseResolverObject::HouseResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), IndustryTileResolverObject::IndustryTileResolverObject(), ObjectResolverObject::ObjectResolverObject(), RailTypeResolverObject::RailTypeResolverObject(), ResolverObject(), RoadTypeResolverObject::RoadTypeResolverObject(), VehicleResolverObject::VehicleResolverObject(), and ~ResolverObject().

◆ temp_store

TemporaryStorageArray< int32_t, 0x110 > ResolverObject::temp_store

staticprivate

Definition at line 327 of file newgrf_spritegroup.h.

◆ used_random_triggers

uint32_t ResolverObject::used_random_triggers = 0

protected

Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent).

Definition at line 386 of file newgrf_spritegroup.h.

Referenced by SpecializedResolverObject< RandomTriggers >::GetUsedRandomTriggers(), and ~ResolverObject().

◆ waiting_random_triggers

uint32_t ResolverObject::waiting_random_triggers = 0

protected

Waiting triggers to be used by any rerandomisation. (scope independent).

Definition at line 385 of file newgrf_spritegroup.h.

Referenced by SpecializedResolverObject< RandomTriggers >::SetWaitingRandomTriggers().

The documentation for this struct was generated from the following files:

src/newgrf_spritegroup.h
src/newgrf_spritegroup.cpp

Public Member Functions

Data Fields

Protected Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ResolverObject()

Member Function Documentation

◆ AddUsedRandomTriggers()

◆ DoResolve()

◆ GetDebugID()

◆ GetFeature()

◆ GetRegister()

◆ GetReseedSum()

◆ GetScope()

◆ GetWaitingRandomTriggers()

◆ Resolve()

◆ ResolveCallback()

◆ ResolveReal()

◆ ResolveRerandomisation()

◆ SetRegister()

Field Documentation

◆ callback

◆ callback_param1

◆ callback_param2

◆ default_scope

◆ grffile

◆ last_value

◆ reseed

◆ root_spritegroup

◆ temp_store

◆ used_random_triggers

◆ waiting_random_triggers