|
OpenTTD Source 20261112-master-gbcbec5e63f
|
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. | |
| virtual | ~ResolverObject ()=default |
| Ensure the destructor of the sub classes are called as well. | |
| ResolverResult | DoResolve () |
| int32_t | GetRegister (uint i) const |
| Gets the value of a so-called newgrf "register". | |
| void | SetRegister (uint i, int32_t value) |
| Sets the value of a so-called newgrf "register". | |
| template<class TSpriteGroup> | |
| const TSpriteGroup * | Resolve () |
| Resolve SpriteGroup. | |
| void | ResolveRerandomisation () |
| Resolve bits to be rerandomised. | |
| CallbackResult | ResolveCallback (std::span< int32_t > regs100) |
| Resolve callback. | |
| virtual const SpriteGroup * | ResolveReal (const RealSpriteGroup &group) const |
| Get the real sprites of the grf. | |
| virtual ScopeResolver * | GetScope (VarSpriteGroupScope scope=VarSpriteGroupScope::Self, uint8_t relative=0) |
| Get a resolver for the scope. | |
| uint32_t | GetWaitingRandomTriggers () const |
| Used by RandomizedSpriteGroup: Triggers for rerandomisation. | |
| void | AddUsedRandomTriggers (uint32_t triggers) |
| Used by RandomizedSpriteGroup: Consume triggers. | |
| uint32_t | GetReseedSum () const |
| Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with. | |
| virtual GrfSpecFeature | GetFeature () const |
| Get the feature number being resolved for. | |
| virtual uint32_t | GetDebugID () const |
| Get an identifier for the item being resolved. | |
| void | UnhandledVariable (uint8_t variable) const |
| Log a message for an unhandled NewGRF variable. | |
Data Fields | |
| ScopeResolver | default_scope |
| Default implementation of the grf scope. | |
| CallbackID | callback {} |
| Callback being resolved. | |
| uint32_t | callback_param1 = 0 |
| First parameter (var 10) of the callback. | |
| uint32_t | callback_param2 = 0 |
| Second parameter (var 18) of the callback. | |
| uint32_t | last_value = 0 |
| Result of most recent DeterministicSpriteGroup (including procedure calls). | |
| EnumIndexArray< uint32_t, VarSpriteGroupScope, VarSpriteGroupScope::End > | reseed |
| Collects bits to rerandomise while triggering triggers. | |
| const GRFFile * | grffile = nullptr |
| GRFFile the resolved SpriteGroup belongs to. | |
| const SpriteGroup * | root_spritegroup = nullptr |
| Root SpriteGroup to use for resolving. | |
Protected Attributes | |
| uint32_t | waiting_random_triggers = 0 |
| Waiting triggers to be used by any rerandomisation. (scope independent). | |
| uint32_t | used_random_triggers = 0 |
| Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent). | |
Static Private Attributes | |
| static TemporaryStorageArray< int32_t, 0x110 > | temp_store |
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 322 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 334 of file newgrf_spritegroup.h.
References callback, callback_param1, callback_param2, CBID_NO_CALLBACK, default_scope, grffile, and root_spritegroup.
Referenced by AirportResolverObject::AirportResolverObject(), AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), GenericResolverObject::GenericResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), ObjectResolverObject::ObjectResolverObject(), RailTypeResolverObject::RailTypeResolverObject(), RoadTypeResolverObject::RoadTypeResolverObject(), and TownResolverObject::TownResolverObject().
|
inline |
Used by RandomizedSpriteGroup: Consume triggers.
| triggers | The triggers t0 set as having used random triggers. |
Definition at line 451 of file newgrf_spritegroup.h.
|
inline |
Definition at line 342 of file newgrf_spritegroup.h.
|
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 AirportResolverObject, AirportTileResolverObject, BadgeResolverObject, CanalResolverObject, CargoResolverObject, GenericResolverObject, HouseResolverObject, IndustriesResolverObject, IndustryTileResolverObject, ObjectResolverObject, RailTypeResolverObject, RoadTypeResolverObject, StationResolverObject, and VehicleResolverObject.
Definition at line 482 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 AirportResolverObject, AirportTileResolverObject, BadgeResolverObject, CanalResolverObject, CargoResolverObject, GenericResolverObject, HouseResolverObject, IndustriesResolverObject, IndustryTileResolverObject, ObjectResolverObject, RailTypeResolverObject, RoadTypeResolverObject, StationResolverObject, and VehicleResolverObject.
Definition at line 475 of file newgrf_spritegroup.h.
References Invalid.
Referenced by NewGRFProfiler::BeginResolve().
|
inline |
Gets the value of a so-called newgrf "register".
| i | index of the register |
Definition at line 359 of file newgrf_spritegroup.h.
Referenced by VehicleResolverObject::GetScope(), and ResolveCallback().
|
inline |
Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with.
Definition at line 461 of file newgrf_spritegroup.h.
References End.
|
virtual |
Get a resolver for the scope.
| scope | The scope to resolve. |
| relative | The relative in case of a VarSpriteGroupScope::Relative. |
Reimplemented in AirportResolverObject, AirportTileResolverObject, BadgeResolverObject, CanalResolverObject, GenericResolverObject, HouseResolverObject, IndustriesResolverObject, IndustryTileResolverObject, ObjectResolverObject, RailTypeResolverObject, RoadStopResolverObject, RoadTypeResolverObject, StationResolverObject, TownResolverObject, and VehicleResolverObject.
Definition at line 137 of file newgrf_spritegroup.cpp.
References default_scope.
Referenced by AirportResolverObject::GetScope(), AirportTileResolverObject::GetScope(), BadgeResolverObject::GetScope(), CanalResolverObject::GetScope(), GenericResolverObject::GetScope(), HouseResolverObject::GetScope(), IndustriesResolverObject::GetScope(), IndustryTileResolverObject::GetScope(), ObjectResolverObject::GetScope(), RailTypeResolverObject::GetScope(), RoadStopResolverObject::GetScope(), RoadTypeResolverObject::GetScope(), StationResolverObject::GetScope(), TownResolverObject::GetScope(), and VehicleResolverObject::GetScope().
|
inline |
Used by RandomizedSpriteGroup: Triggers for rerandomisation.
Definition at line 442 of file newgrf_spritegroup.h.
|
inline |
Resolve SpriteGroup.
| TSpriteGroup | Sprite group type |
Definition at line 396 of file newgrf_spritegroup.h.
|
inline |
Resolve callback.
| [out] | regs100 | Additional result values from registers 100+ |
Definition at line 423 of file newgrf_spritegroup.h.
References CALLBACK_FAILED, and GetRegister().
|
virtual |
Get the real sprites of the grf.
| group | Group to get. |
Reimplemented in StationResolverObject, and VehicleResolverObject.
Definition at line 123 of file newgrf_spritegroup.cpp.
References RealSpriteGroup::loaded, and RealSpriteGroup::loading.
|
inline |
Resolve bits to be rerandomised.
Access results via:
Definition at line 411 of file newgrf_spritegroup.h.
|
inline |
Sets the value of a so-called newgrf "register".
| i | index of the register |
| value | the value of the register |
Definition at line 370 of file newgrf_spritegroup.h.
| void ResolverObject::UnhandledVariable | ( | uint8_t | variable | ) | const |
Log a message for an unhandled NewGRF variable.
| variable | The variable that is not handled. |
Definition at line 171 of file newgrf_spritegroup.cpp.
References _unhandled_variables, Debug, Error, Grf, grffile, and IsVisibleSeverity().
Referenced by Waypoint::GetNewGRFVariable().
| CallbackID ResolverObject::callback {} |
Callback being resolved.
Definition at line 375 of file newgrf_spritegroup.h.
Referenced by AirportResolverObject::AirportResolverObject(), AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), NewGRFProfiler::BeginResolve(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), GenericResolverObject::GenericResolverObject(), HouseResolverObject::HouseResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), IndustryTileResolverObject::IndustryTileResolverObject(), ObjectResolverObject::ObjectResolverObject(), ResolverObject(), StationResolverObject::StationResolverObject(), and VehicleResolverObject::VehicleResolverObject().
| uint32_t ResolverObject::callback_param1 = 0 |
First parameter (var 10) of the callback.
Definition at line 376 of file newgrf_spritegroup.h.
Referenced by AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), IndustryTileResolverObject::IndustryTileResolverObject(), ResolverObject(), StationResolverObject::StationResolverObject(), and VehicleResolverObject::VehicleResolverObject().
| uint32_t ResolverObject::callback_param2 = 0 |
Second parameter (var 18) of the callback.
Definition at line 377 of file newgrf_spritegroup.h.
Referenced by AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), IndustryTileResolverObject::IndustryTileResolverObject(), ResolverObject(), StationResolverObject::StationResolverObject(), and VehicleResolverObject::VehicleResolverObject().
| ScopeResolver ResolverObject::default_scope |
Default implementation of the grf scope.
Definition at line 351 of file newgrf_spritegroup.h.
Referenced by GetScope(), and ResolverObject().
| const GRFFile* ResolverObject::grffile = nullptr |
GRFFile the resolved SpriteGroup belongs to.
Definition at line 387 of file newgrf_spritegroup.h.
Referenced by AirportResolverObject::AirportResolverObject(), AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), ObjectResolverObject::ObjectResolverObject(), RailTypeResolverObject::RailTypeResolverObject(), ResolverObject(), RoadTypeResolverObject::RoadTypeResolverObject(), StationResolverObject::StationResolverObject(), TownResolverObject::TownResolverObject(), and UnhandledVariable().
| uint32_t ResolverObject::last_value = 0 |
Result of most recent DeterministicSpriteGroup (including procedure calls).
Definition at line 379 of file newgrf_spritegroup.h.
Referenced by ~ResolverObject().
| EnumIndexArray<uint32_t, VarSpriteGroupScope, VarSpriteGroupScope::End> ResolverObject::reseed |
Collects bits to rerandomise while triggering triggers.
Definition at line 385 of file newgrf_spritegroup.h.
Referenced by ~ResolverObject().
| const SpriteGroup* ResolverObject::root_spritegroup = nullptr |
Root SpriteGroup to use for resolving.
Definition at line 388 of file newgrf_spritegroup.h.
Referenced by AirportResolverObject::AirportResolverObject(), AirportTileResolverObject::AirportTileResolverObject(), BadgeResolverObject::BadgeResolverObject(), NewGRFProfiler::BeginResolve(), CanalResolverObject::CanalResolverObject(), CargoResolverObject::CargoResolverObject(), HouseResolverObject::HouseResolverObject(), IndustriesResolverObject::IndustriesResolverObject(), IndustryTileResolverObject::IndustryTileResolverObject(), ObjectResolverObject::ObjectResolverObject(), RailTypeResolverObject::RailTypeResolverObject(), ResolverObject(), RoadTypeResolverObject::RoadTypeResolverObject(), VehicleResolverObject::VehicleResolverObject(), and ~ResolverObject().
|
staticprivate |
Definition at line 324 of file newgrf_spritegroup.h.
|
protected |
Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent).
Definition at line 383 of file newgrf_spritegroup.h.
Referenced by SpecializedResolverObject< RandomTriggers >::GetUsedRandomTriggers(), and ~ResolverObject().
|
protected |
Waiting triggers to be used by any rerandomisation. (scope independent).
Definition at line 382 of file newgrf_spritegroup.h.
Referenced by SpecializedResolverObject< RandomTriggers >::SetWaitingRandomTriggers().