OpenTTD Source  20241121-master-g67a0fccfad
StationResolverObject Struct Reference

Station resolver. More...

#include <newgrf_station.h>

Inheritance diagram for StationResolverObject:
ResolverObject

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. More...
 
TownScopeResolverGetTown ()
 Get the town scope associated with a station, if it exists. More...
 
ScopeResolverGetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
 Get a resolver for the scope. More...
 
const SpriteGroupResolveReal (const RealSpriteGroup *group) const override
 Get the real sprites of the grf. More...
 
GrfSpecFeature GetFeature () const override
 Get the feature number being resolved for. More...
 
uint32_t GetDebugID () const override
 Get an identifier for the item being resolved. More...
 
- 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. More...
 
const SpriteGroupResolve ()
 Resolve SpriteGroup. More...
 
uint16_t ResolveCallback ()
 Resolve callback. More...
 
uint32_t GetRemainingTriggers () const
 Returns the waiting triggers that did not trigger any rerandomisation.
 
uint32_t GetReseedSum () const
 Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with. More...
 
void ResetState ()
 Resets the dynamic state of the resolver object. More...
 

Data Fields

StationScopeResolver station_scope
 The station scope resolver.
 
std::optional< TownScopeResolvertown_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
 First parameter (var 10) of the callback.
 
uint32_t callback_param2
 Second parameter (var 18) of the callback.
 
uint32_t last_value
 Result of most recent DeterministicSpriteGroup (including procedure calls)
 
uint32_t waiting_triggers
 Waiting triggers to be used by any rerandomisation. (scope independent)
 
uint32_t used_triggers
 Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent)
 
uint32_t reseed [VSG_END]
 Collects bits to rerandomise while triggering triggers.
 
const GRFFilegrffile
 GRFFile the resolved SpriteGroup belongs to.
 
const SpriteGrouproot_spritegroup
 Root SpriteGroup to use for resolving.
 

Detailed Description

Station resolver.

Definition at line 51 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
statspecStation (type) specification.
base_stationInstance of the station.
tileTile of the station.
callbackCallback ID.
callback_param1First parameter (var 10) of the callback.
callback_param2Second parameter (var 18) of the callback.

Definition at line 569 of file newgrf_station.cpp.

References _svc, GoodsEntry::cargo, StationScopeResolver::cargo_type, SpecializedStation< Station, false >::From(), Station::goods, StationSpec::grf_prop, SpecializedStation< Station, false >::IsExpected(), CargoSpec::Iterate(), ResolverObject::root_spritegroup, SpriteGroupCargo::SG_DEFAULT, SpriteGroupCargo::SG_DEFAULT_NA, SpriteGroupCargo::SG_PURCHASE, GRFFilePropsBase< Tcnt >::spritegroup, StationScopeResolver::st, station_scope, StationScopeResolver::statspec, and StationCargoList::TotalCount().

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 555 of file newgrf_station.cpp.

References StationSpec::grf_prop, GRFFilePropsBase< Tcnt >::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 550 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 60 of file newgrf_station.h.

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

◆ 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 255 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
groupGroup to get.
Returns
The available sprite group.

Reimplemented from ResolverObject.

Definition at line 505 of file newgrf_station.cpp.

References StationScopeResolver::cargo_type, SpecializedStation< Station, false >::From(), SpecializedStation< Station, false >::IsExpected(), RealSpriteGroup::loading, StationScopeResolver::st, and station_scope.


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