OpenTTD Source  20241121-master-g67a0fccfad
GenericResolverObject Struct Reference

Resolver object for generic objects/properties. More...

Inheritance diagram for GenericResolverObject:
ResolverObject

Public Member Functions

 GenericResolverObject (bool ai_callback, CallbackID callback=CBID_NO_CALLBACK)
 Generic resolver. More...
 
ScopeResolverGetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
 Get a resolver for the scope. 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...
 
virtual const SpriteGroupResolveReal (const RealSpriteGroup *group) const
 Get the real sprites of the grf. 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

GenericScopeResolver generic_scope
 
- 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

Resolver object for generic objects/properties.

Definition at line 52 of file newgrf_generic.cpp.

Constructor & Destructor Documentation

◆ GenericResolverObject()

GenericResolverObject::GenericResolverObject ( bool  ai_callback,
CallbackID  callback = CBID_NO_CALLBACK 
)

Generic resolver.

Parameters
ai_callbackCallback comes from the AI.
callbackCallback ID.

Definition at line 152 of file newgrf_generic.cpp.

Member Function Documentation

◆ GetDebugID()

uint32_t GenericResolverObject::GetDebugID ( ) const
inlineoverridevirtual

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 70 of file newgrf_generic.cpp.

◆ GetFeature()

GrfSpecFeature GenericResolverObject::GetFeature ( ) const
inlineoverridevirtual

Get the feature number being resolved for.

This function is mainly intended for the callback profiling feature.

Reimplemented from ResolverObject.

Definition at line 65 of file newgrf_generic.cpp.

◆ GetScope()

ScopeResolver* GenericResolverObject::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 57 of file newgrf_generic.cpp.

References ResolverObject::GetScope(), and VSG_SCOPE_SELF.


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