#include <newgrf_station.h>

Inheritance diagram for StationResolverObject:

Public Member Functions
	StationResolverObject (const StationSpec statspec, BaseStation st, TileIndex tile, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
	Resolver for stations.

TownScopeResolver *	GetTown ()
	Get the town scope associated with a station, if it exists.

ScopeResolver *	GetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
	Get a resolver for the scope.

const SpriteGroup *	ResolveReal (const RealSpriteGroup &group) const override
	Get the real sprites of the grf.

GrfSpecFeature	GetFeature () const override
	Get the feature number being resolved for.

uint32_t	GetDebugID () const override
	Get an identifier for the item being resolved.

Public Member Functions inherited from SpecializedResolverObject< StationRandomTriggers >
void	SetWaitingRandomTriggers (StationRandomTriggers triggers)
	Set waiting triggers for rerandomisation.

StationRandomTriggers	GetUsedRandomTriggers () const
	Get the triggers, which were "consumed" by some rerandomisation.

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

Public Member Functions inherited from ResolverObject
	ResolverObject (const GRFFile *grffile, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
	Resolver constructor.

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.

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.

Data Fields
StationScopeResolver	station_scope
	The station scope resolver.

std::optional< TownScopeResolver >	town_scope = std::nullopt
	The town scope resolver (created on the first call).

Data Fields inherited from ResolverObject
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)

std::array< uint32_t, VSG_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.

Additional Inherited Members
Protected Attributes inherited from ResolverObject
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)

Detailed Description

Station resolver.

Definition at line 67 of file newgrf_station.h.

Constructor & Destructor Documentation

◆ StationResolverObject()

StationResolverObject::StationResolverObject	(	const StationSpec *	statspec,
		BaseStation *	base_station,
		TileIndex	tile,
		CallbackID	callback = `CBID_NO_CALLBACK`,
		uint32_t	callback_param1 = `0`,
		uint32_t	callback_param2 = `0`
	)

Resolver for stations.

Parameters

statspec	Station (type) specification.
base_station	Instance of the station.
tile	Tile of the station.
callback	Callback ID.
callback_param1	First parameter (var 10) of the callback.
callback_param2	Second parameter (var 18) of the callback.

Definition at line 576 of file newgrf_station.cpp.

References StationScopeResolver::cargo_type, SpecializedStation< Station, false >::From(), VariableGRFFileProps< Tkey >::GetSpriteGroup(), Station::goods, StationSpec::grf_prop, SpecializedStation< Station, false >::IsExpected(), ResolverObject::root_spritegroup, CargoGRFFileProps::SG_DEFAULT, CargoGRFFileProps::SG_DEFAULT_NA, CargoGRFFileProps::SG_PURCHASE, VariableGRFFileProps< Tkey >::spritegroups, StationScopeResolver::st, and station_scope.

Member Function Documentation

◆ GetDebugID()

uint32_t StationResolverObject::GetDebugID ( ) const

overridevirtual

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.

Reimplemented from ResolverObject.

Definition at line 562 of file newgrf_station.cpp.

References StationSpec::grf_prop, GRFFilePropsBase::local_id, station_scope, and StationScopeResolver::statspec.

◆ GetFeature()

GrfSpecFeature StationResolverObject::GetFeature ( ) const

overridevirtual

Get the feature number being resolved for.

This function is mainly intended for the callback profiling feature.

Reimplemented from ResolverObject.

Definition at line 557 of file newgrf_station.cpp.

◆ GetScope()

ScopeResolver * StationResolverObject::GetScope	(	VarSpriteGroupScope	scope = `VSG_SCOPE_SELF`,
		uint8_t	relative = `0`
	)

inlineoverridevirtual

Get a resolver for the scope.

Returns: The resolver for the requested scope.

Reimplemented from ResolverObject.

Definition at line 76 of file newgrf_station.h.

References ResolverObject::GetScope(), GetTown(), station_scope, VSG_SCOPE_PARENT, and VSG_SCOPE_SELF.

Referenced by NIHStation::Resolve().

◆ GetTown()

TownScopeResolver * StationResolverObject::GetTown ( )

Get the town scope associated with a station, if it exists.

On the first call, the town scope is created (if possible).

Returns: Town scope, if available.

Definition at line 258 of file newgrf_station.cpp.

References ClosestTownFromTile(), INVALID_TILE, StationScopeResolver::st, station_scope, StationScopeResolver::tile, BaseStation::town, and town_scope.

Referenced by GetScope().

◆ ResolveReal()

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

overridevirtual

Get the real sprites of the grf.

Parameters

group Group to get.

Returns: The available sprite group.

Reimplemented from ResolverObject.

Definition at line 507 of file newgrf_station.cpp.

References GoodsEntry::GoodsEntryData::cargo, StationSpec::cargo_threshold, StationScopeResolver::cargo_type, DivByStationSize, StationSpec::flags, SpecializedStation< Station, false >::From(), GoodsEntry::GetData(), Station::goods, OrthogonalTileArea::h, GoodsEntry::HasData(), SpecializedStation< Station, false >::IsExpected(), RealSpriteGroup::loaded, RealSpriteGroup::loading, CargoGRFFileProps::SG_DEFAULT, CargoGRFFileProps::SG_DEFAULT_NA, CargoGRFFileProps::SG_PURCHASE, StationScopeResolver::st, station_scope, StationScopeResolver::statspec, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), StationCargoList::TotalCount(), BaseStation::train_station, and OrthogonalTileArea::w.

Field Documentation

◆ station_scope

StationScopeResolver StationResolverObject::station_scope

The station scope resolver.

Definition at line 68 of file newgrf_station.h.

Referenced by GetDebugID(), GetScope(), GetTown(), ResolveReal(), and StationResolverObject().

◆ town_scope

std::optional<TownScopeResolver> StationResolverObject::town_scope = std::nullopt

The town scope resolver (created on the first call).

Definition at line 69 of file newgrf_station.h.

Referenced by GetTown().

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

src/newgrf_station.h
src/newgrf_station.cpp

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StationResolverObject()

Member Function Documentation

◆ GetDebugID()

◆ GetFeature()

◆ GetScope()

◆ GetTown()

◆ ResolveReal()

Field Documentation

◆ station_scope

◆ town_scope