OpenTTD
Public Member Functions | Data Fields
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.
ScopeResolverGetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
 Get a resolver for the scope.
const SpriteGroupResolveReal (const RealSpriteGroup *group) const
 Get the real sprites of the grf.
- 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.
const SpriteGroupResolve ()
 Resolve SpriteGroup.
uint16 ResolveCallback ()
 Resolve callback.
uint32 GetReseedSum () const
 Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with.
void ResetState ()
 Resets the dynamic state of the resolver object.

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 callback_param1
 First parameter (var 10) of the callback.
uint32 callback_param2
 Second parameter (var 18) of the callback.
byte trigger
uint32 last_value
 Result of most recent DeterministicSpriteGroup (including procedure calls)
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 object for generic objects/properties.

Definition at line 44 of file newgrf_generic.cpp.

Constructor & Destructor Documentation

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

Generic resolver.

Parameters
ai_callbackCallback comes from the AI.
callbackCallback ID.

Definition at line 144 of file newgrf_generic.cpp.

Member Function Documentation

ScopeResolver* GenericResolverObject::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_generic.cpp.

References VSG_SCOPE_SELF.

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

Get the real sprites of the grf.

Parameters
groupGroup to get.
Returns
The available sprite group.

Reimplemented from ResolverObject.

Definition at line 132 of file newgrf_generic.cpp.

References RealSpriteGroup::loaded, and RealSpriteGroup::num_loaded.


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