OpenTTD Source
20241108-master-g80f628063a
|
Interface for SpriteGroup-s to access the gamestate. More...
#include <newgrf_spritegroup.h>
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 SpriteGroup * | Resolve () |
Resolve SpriteGroup. More... | |
uint16_t | ResolveCallback () |
Resolve callback. More... | |
virtual const SpriteGroup * | ResolveReal (const RealSpriteGroup *group) const |
Get the real sprites of the grf. More... | |
virtual ScopeResolver * | GetScope (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 GRFFile * | grffile |
GRFFile the resolved SpriteGroup belongs to. | |
const SpriteGroup * | root_spritegroup |
Root SpriteGroup to use for resolving. | |
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.
|
inline |
Resolver constructor.
grffile | NewGRF file associated with the object (or nullptr if none). |
callback | Callback code being resolved (default value is CBID_NO_CALLBACK). |
callback_param1 | First parameter (var 10) of the callback (only used when callback is also set). |
callback_param2 | Second parameter (var 18) of the callback (only used when callback is also set). |
Definition at line 316 of file newgrf_spritegroup.h.
References ResetState().
|
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().
|
inlinevirtual |
Get the feature number being resolved for.
This function is mainly intended for the callback profiling feature.
Reimplemented in StationResolverObject, RoadTypeResolverObject, RailTypeResolverObject, ObjectResolverObject, IndustryTileResolverObject, IndustriesResolverObject, HouseResolverObject, GenericResolverObject, VehicleResolverObject, CargoResolverObject, CanalResolverObject, AirportTileResolverObject, and AirportResolverObject.
Definition at line 400 of file newgrf_spritegroup.h.
References GSF_INVALID.
Referenced by NewGRFProfiler::BeginResolve().
|
inline |
Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with.
Definition at line 375 of file newgrf_spritegroup.h.
|
virtual |
Get a resolver for the scope.
Reimplemented in TownResolverObject, StationResolverObject, RoadTypeResolverObject, RoadStopResolverObject, RailTypeResolverObject, ObjectResolverObject, IndustryTileResolverObject, IndustriesResolverObject, HouseResolverObject, GenericResolverObject, VehicleResolverObject, CanalResolverObject, AirportTileResolverObject, and AirportResolverObject.
Definition at line 135 of file newgrf_spritegroup.cpp.
References default_scope.
Referenced by AirportResolverObject::GetScope(), AirportTileResolverObject::GetScope(), CanalResolverObject::GetScope(), GenericResolverObject::GetScope(), HouseResolverObject::GetScope(), IndustriesResolverObject::GetScope(), IndustryTileResolverObject::GetScope(), ObjectResolverObject::GetScope(), RailTypeResolverObject::GetScope(), RoadStopResolverObject::GetScope(), RoadTypeResolverObject::GetScope(), StationResolverObject::GetScope(), and TownResolverObject::GetScope().
|
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().
|
inline |
Resolve SpriteGroup.
Definition at line 343 of file newgrf_spritegroup.h.
References SpriteGroup::Resolve().
|
inline |
|
virtual |
Get the real sprites of the grf.
group | Group to get. |
Reimplemented in StationResolverObject, RoadStopResolverObject, and VehicleResolverObject.
Definition at line 123 of file newgrf_spritegroup.cpp.
References RealSpriteGroup::loaded, and RealSpriteGroup::loading.