OpenTTD Source  20241108-master-g80f628063a
RailTypeResolverObject Struct Reference

Resolver object for rail types. More...

#include <newgrf_railtype.h>

Inheritance diagram for RailTypeResolverObject:
ResolverObject

Public Member Functions

 RailTypeResolverObject (const RailTypeInfo *rti, TileIndex tile, TileContext context, RailTypeSpriteGroup rtsg, uint32_t param1=0, uint32_t param2=0)
 Resolver object for rail types. 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

RailTypeScopeResolver railtype_scope
 Resolver for the railtype 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 rail types.

Definition at line 39 of file newgrf_railtype.h.

Constructor & Destructor Documentation

◆ RailTypeResolverObject()

RailTypeResolverObject::RailTypeResolverObject ( const RailTypeInfo rti,
TileIndex  tile,
TileContext  context,
RailTypeSpriteGroup  rtsg,
uint32_t  param1 = 0,
uint32_t  param2 = 0 
)

Resolver object for rail types.

Parameters
rtiRailtype. nullptr in NewGRF Inspect window.
tileTile containing the track. For track on a bridge this is the southern bridgehead.
contextAre we resolving sprites for the upper halftile, or on a bridge?
rtsgRailpart of interest
param1Extra parameter (first parameter of the callback, except railtypes do not have callbacks).
param2Extra parameter (second parameter of the callback, except railtypes do not have callbacks).

Definition at line 81 of file newgrf_railtype.cpp.

References RailTypeInfo::group, and ResolverObject::root_spritegroup.

Member Function Documentation

◆ GetDebugID()

uint32_t RailTypeResolverObject::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 67 of file newgrf_railtype.cpp.

References RailTypeInfo::label, and railtype_scope.

◆ GetFeature()

GrfSpecFeature RailTypeResolverObject::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 62 of file newgrf_railtype.cpp.

◆ GetScope()

ScopeResolver* RailTypeResolverObject::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 44 of file newgrf_railtype.h.

References ResolverObject::GetScope(), railtype_scope, and VSG_SCOPE_SELF.


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