OpenTTD
Public Member Functions | Data Fields
TownResolverObject Struct Reference

Resolver of town properties. More...

#include <newgrf_town.h>

Inheritance diagram for TownResolverObject:
ResolverObject

Public Member Functions

 TownResolverObject (const struct GRFFile *grffile, Town *t, bool readonly)
 Resolver for a town. More...
 
ScopeResolverGetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
 Get a resolver for the scope. More...
 
- Public Member Functions inherited from ResolverObject
 ResolverObject (const GRFFile *grffile, CallbackID callback=CBID_NO_CALLBACK, uint32 callback_param1=0, uint32 callback_param2=0)
 Resolver constructor. More...
 
const SpriteGroupResolve ()
 Resolve SpriteGroup. More...
 
uint16 ResolveCallback ()
 Resolve callback. More...
 
virtual const SpriteGroupResolveReal (const RealSpriteGroup *group) const
 Get the real sprites of the grf. More...
 
uint32 GetRemainingTriggers () const
 Returns the waiting triggers that did not trigger any rerandomisation.
 
uint32 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

TownScopeResolver town_scope
 Scope resolver specific for towns.
 
- Data Fields inherited from ResolverObject
ScopeResolver default_scope
 Default implementation of the grf scope.
 
CallbackID callback
 Callback being resolved.
 
uint32 callback_param1
 First parameter (var 10) of the callback.
 
uint32 callback_param2
 Second parameter (var 18) of the callback.
 
uint32 last_value
 Result of most recent DeterministicSpriteGroup (including procedure calls)
 
uint32 waiting_triggers
 Waiting triggers to be used by any rerandomisation. (scope independent)
 
uint32 used_triggers
 Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent)
 
uint32 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 of town properties.

Definition at line 44 of file newgrf_town.h.

Constructor & Destructor Documentation

◆ TownResolverObject()

TownResolverObject::TownResolverObject ( const struct GRFFile grffile,
Town t,
bool  readonly 
)

Resolver for a town.

Parameters
grffileNewGRF file associated with the town.
tTown of the scope.
readonlyScope may change persistent storage of the town.

Definition at line 159 of file newgrf_town.cpp.

Member Function Documentation

◆ GetScope()

ScopeResolver* TownResolverObject::GetScope ( VarSpriteGroupScope  scope = VSG_SCOPE_SELF,
byte  relative = 0 
)
inlinevirtual

Get a resolver for the scope.

Parameters
scopeScope to return.
relativeAdditional parameter for VSG_SCOPE_RELATIVE.
Returns
The resolver for the requested scope.

Reimplemented from ResolverObject.

Definition at line 49 of file newgrf_town.h.

References ResolverObject::GetScope(), and VSG_SCOPE_SELF.

Referenced by NIHTown::Resolve().


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