Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope). More...
#include <newgrf_spritegroup.h>
Public Member Functions | |
| ScopeResolver (ResolverObject &ro) | |
| virtual uint32_t | GetRandomBits () const |
| Get a few random bits. | |
| virtual uint32_t | GetTriggers () const |
| Get the triggers. | |
| virtual uint32_t | GetVariable (uint8_t variable, uint32_t parameter, bool &available) const |
| Get a variable value. | |
| virtual void | StorePSA (uint reg, int32_t value) |
| Store a value into the persistent storage area (PSA). | |
Data Fields | |
| ResolverObject & | ro |
| Surrounding resolver object. | |
Detailed Description
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Multiple of these interfaces are combined into a ResolverObject to allow access to different game entities from a SpriteGroup-chain (action 1-2-3 chain).
Definition at line 277 of file newgrf_spritegroup.h.
Constructor & Destructor Documentation
◆ ScopeResolver()
|
inline |
Definition at line 280 of file newgrf_spritegroup.h.
Member Function Documentation
◆ GetRandomBits()
|
virtual |
Get a few random bits.
Default implementation has no random bits.
- Returns
- Random bits.
Reimplemented in AirportScopeResolver, AirportTileScopeResolver, CanalScopeResolver, VehicleScopeResolver, HouseScopeResolver, IndustriesScopeResolver, IndustryTileScopeResolver, ObjectScopeResolver, RailTypeScopeResolver, RoadStopScopeResolver, RoadTypeScopeResolver, and StationScopeResolver.
Definition at line 85 of file newgrf_spritegroup.cpp.
Referenced by RandomizedSpriteGroup::Resolve().
◆ GetTriggers()
|
virtual |
Get the triggers.
Base class returns 0 to prevent trouble.
- Returns
- The triggers.
Reimplemented in VehicleScopeResolver, HouseScopeResolver, IndustriesScopeResolver, IndustryTileScopeResolver, RoadStopScopeResolver, and StationScopeResolver.
Definition at line 94 of file newgrf_spritegroup.cpp.
◆ GetVariable()
|
virtual |
Get a variable value.
Default implementation has no available variables.
- Parameters
-
variable Variable to read parameter Parameter for 60+x variables [out] available Set to false, in case the variable does not exist.
- Returns
- Value
Reimplemented in AirportScopeResolver, AirportTileScopeResolver, CanalScopeResolver, VehicleScopeResolver, GenericScopeResolver, HouseScopeResolver, IndustriesScopeResolver, IndustryTileScopeResolver, ObjectScopeResolver, RailTypeScopeResolver, RoadStopScopeResolver, RoadTypeScopeResolver, StationScopeResolver, and TownScopeResolver.
Definition at line 106 of file newgrf_spritegroup.cpp.
References Debug.
Referenced by FillNewGRFVehicleCache(), NIHVehicle::Resolve(), NIHStation::Resolve(), NIHHouse::Resolve(), NIHIndustryTile::Resolve(), NIHIndustry::Resolve(), NIHObject::Resolve(), NIHRailType::Resolve(), NIHAirportTile::Resolve(), NIHAirport::Resolve(), NIHTown::Resolve(), and NIHRoadType::Resolve().
◆ StorePSA()
|
virtual |
Store a value into the persistent storage area (PSA).
Default implementation does nothing (for newgrf classes without storage).
Reimplemented in AirportScopeResolver, IndustriesScopeResolver, and TownScopeResolver.
Definition at line 116 of file newgrf_spritegroup.cpp.
Field Documentation
◆ ro
| ResolverObject& ScopeResolver::ro |
Surrounding resolver object.
Definition at line 278 of file newgrf_spritegroup.h.
Referenced by AirportScopeResolver::GetVariable(), AirportTileScopeResolver::GetVariable(), VehicleScopeResolver::GetVariable(), GenericScopeResolver::GetVariable(), HouseScopeResolver::GetVariable(), IndustriesScopeResolver::GetVariable(), IndustryTileScopeResolver::GetVariable(), ObjectScopeResolver::GetVariable(), RoadStopScopeResolver::GetVariable(), StationScopeResolver::GetVariable(), TownScopeResolver::GetVariable(), AirportScopeResolver::StorePSA(), and TownScopeResolver::StorePSA().
The documentation for this struct was generated from the following files:
