OpenTTD Source  20241108-master-g80f628063a
ResolverObject Struct Reference

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

#include <newgrf_spritegroup.h>

Inheritance diagram for ResolverObject:
AirportResolverObject AirportTileResolverObject CanalResolverObject CargoResolverObject GenericResolverObject HouseResolverObject IndustriesResolverObject IndustryTileResolverObject ObjectResolverObject RailTypeResolverObject RoadStopResolverObject RoadTypeResolverObject StationResolverObject TownResolverObject VehicleResolverObject

Public Member Functions

 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...
 
virtual const SpriteGroupResolveReal (const RealSpriteGroup *group) const
 Get the real sprites of the grf. More...
 
virtual ScopeResolverGetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0)
 Get a resolver for the scope. 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...
 
virtual GrfSpecFeature GetFeature () const
 Get the feature number being resolved for. More...
 
virtual uint32_t GetDebugID () const
 Get an identifier for the item being resolved. More...
 

Data Fields

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

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 308 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
grffileNewGRF file associated with the object (or nullptr if none).
callbackCallback code being resolved (default value is CBID_NO_CALLBACK).
callback_param1First parameter (var 10) of the callback (only used when callback is also set).
callback_param2Second parameter (var 18) of the callback (only used when callback is also set).

Definition at line 316 of file newgrf_spritegroup.h.

References ResetState().

Member Function Documentation

◆ 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.

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

Definition at line 406 of file newgrf_spritegroup.h.

Referenced by NewGRFProfiler::BeginResolve().

◆ GetFeature()

virtual GrfSpecFeature ResolverObject::GetFeature ( ) const
inlinevirtual

◆ 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 375 of file newgrf_spritegroup.h.

◆ GetScope()

◆ ResetState()

void ResolverObject::ResetState ( )
inline

Resets the dynamic state of the resolver object.

To be called before resolving an Action-1-2-3 chain.

Definition at line 388 of file newgrf_spritegroup.h.

Referenced by ResolverObject().

◆ Resolve()

const SpriteGroup* ResolverObject::Resolve ( )
inline

Resolve SpriteGroup.

Returns
Result spritegroup.

Definition at line 343 of file newgrf_spritegroup.h.

References SpriteGroup::Resolve().

◆ ResolveCallback()

uint16_t ResolverObject::ResolveCallback ( )
inline

Resolve callback.

Returns
Callback result.

Definition at line 352 of file newgrf_spritegroup.h.

◆ ResolveReal()

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

Get the real sprites of the grf.

Parameters
groupGroup to get.
Returns
The available sprite group.

Reimplemented in StationResolverObject, RoadStopResolverObject, and VehicleResolverObject.

Definition at line 123 of file newgrf_spritegroup.cpp.

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


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