OpenTTD Source 20260206-master-g4d4e37dbf1
ScopeResolver Struct Reference

Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope). More...

#include <newgrf_spritegroup.h>

Inheritance diagram for ScopeResolver:
AirportScopeResolver AirportTileScopeResolver BadgeScopeResolver CanalScopeResolver GenericScopeResolver HouseScopeResolver IndustriesScopeResolver IndustryTileScopeResolver ObjectScopeResolver RailTypeScopeResolver RoadStopScopeResolver RoadTypeScopeResolver StationScopeResolver TownScopeResolver VehicleScopeResolver

Public Member Functions

 ScopeResolver (ResolverObject &ro)
virtual uint32_t GetRandomBits () const
 Get a few random bits.
virtual uint32_t GetRandomTriggers () 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 295 of file newgrf_spritegroup.h.

Constructor & Destructor Documentation

◆ ScopeResolver()

ScopeResolver::ScopeResolver ( ResolverObject & ro)
inline

Definition at line 298 of file newgrf_spritegroup.h.

Member Function Documentation

◆ GetRandomBits()

uint32_t ScopeResolver::GetRandomBits ( ) const
virtual

Get a few random bits.

Default implementation has no random bits.

Returns
Random bits.

Reimplemented in AirportScopeResolver, AirportTileScopeResolver, CanalScopeResolver, HouseScopeResolver, IndustriesScopeResolver, IndustryTileScopeResolver, ObjectScopeResolver, RailTypeScopeResolver, RoadStopScopeResolver, RoadTypeScopeResolver, StationScopeResolver, and VehicleScopeResolver.

Definition at line 83 of file newgrf_spritegroup.cpp.

Referenced by RandomizedSpriteGroup::Resolve().

◆ GetRandomTriggers()

uint32_t ScopeResolver::GetRandomTriggers ( ) const
virtual

Get the triggers.

Base class returns 0 to prevent trouble.

Returns
The triggers.

Reimplemented in HouseScopeResolver, IndustriesScopeResolver, IndustryTileScopeResolver, RoadStopScopeResolver, StationScopeResolver, and VehicleScopeResolver.

Definition at line 92 of file newgrf_spritegroup.cpp.

◆ GetVariable()

uint32_t ScopeResolver::GetVariable ( uint8_t variable,
uint32_t parameter,
bool & available ) const
virtual

Get a variable value.

Default implementation has no available variables.

Parameters
variableVariable to read
parameterParameter for 60+x variables
[out]availableSet to false, in case the variable does not exist.
Returns
Value

Reimplemented in AirportScopeResolver, AirportTileScopeResolver, BadgeScopeResolver, CanalScopeResolver, GenericScopeResolver, HouseScopeResolver, IndustriesScopeResolver, IndustryTileScopeResolver, ObjectScopeResolver, RailTypeScopeResolver, RoadStopScopeResolver, RoadTypeScopeResolver, StationScopeResolver, TownScopeResolver, and VehicleScopeResolver.

Definition at line 104 of file newgrf_spritegroup.cpp.

References Debug.

Referenced by FillNewGRFVehicleCache(), NIHAirport::Resolve(), NIHAirportTile::Resolve(), NIHHouse::Resolve(), NIHIndustry::Resolve(), NIHIndustryTile::Resolve(), NIHObject::Resolve(), NIHRailType::Resolve(), NIHRoadType< TRoadTramType >::Resolve(), NIHStation::Resolve(), NIHTown::Resolve(), and NIHVehicle::Resolve().

◆ StorePSA()

void ScopeResolver::StorePSA ( uint pos,
int32_t value )
virtual

Store a value into the persistent storage area (PSA).

Default implementation does nothing (for newgrf classes without storage).

Parameters
posThe position into the storage area.
valueThe new value to store.

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 296 of file newgrf_spritegroup.h.

Referenced by AirportScopeResolver::AirportScopeResolver(), AirportTileScopeResolver::AirportTileScopeResolver(), BadgeScopeResolver::BadgeScopeResolver(), GenericScopeResolver::GenericScopeResolver(), AirportScopeResolver::GetVariable(), AirportTileScopeResolver::GetVariable(), GenericScopeResolver::GetVariable(), HouseScopeResolver::GetVariable(), IndustriesScopeResolver::GetVariable(), IndustryTileScopeResolver::GetVariable(), ObjectScopeResolver::GetVariable(), RailTypeScopeResolver::GetVariable(), RoadStopScopeResolver::GetVariable(), RoadTypeScopeResolver::GetVariable(), StationScopeResolver::GetVariable(), TownScopeResolver::GetVariable(), VehicleScopeResolver::GetVariable(), HouseScopeResolver::HouseScopeResolver(), IndustriesScopeResolver::IndustriesScopeResolver(), IndustryTileScopeResolver::IndustryTileScopeResolver(), ObjectScopeResolver::ObjectScopeResolver(), RailTypeScopeResolver::RailTypeScopeResolver(), RoadTypeScopeResolver::RoadTypeScopeResolver(), StationScopeResolver::StationScopeResolver(), AirportScopeResolver::StorePSA(), TownScopeResolver::StorePSA(), TownScopeResolver::TownScopeResolver(), and VehicleScopeResolver::VehicleScopeResolver().

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