OpenTTD Source  20241121-master-g67a0fccfad
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 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. More...
 
virtual uint32_t GetTriggers () const
 Get the triggers. More...
 
virtual uint32_t GetVariable (uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const
 Get a variable value. More...
 
virtual void StorePSA (uint reg, int32_t value)
 Store a value into the persistent storage area (PSA). More...
 

Data Fields

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

Member Function Documentation

◆ GetRandomBits()

uint32_t ScopeResolver::GetRandomBits ( ) const
virtual

◆ GetTriggers()

uint32_t ScopeResolver::GetTriggers ( ) const
virtual

Get the triggers.

Base class returns 0 to prevent trouble.

Returns
The triggers.

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

Definition at line 94 of file newgrf_spritegroup.cpp.

◆ GetVariable()

uint32_t ScopeResolver::GetVariable ( uint8_t  variable,
[[maybe_unused] ] 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 TownScopeResolver, StationScopeResolver, RoadTypeScopeResolver, RoadStopScopeResolver, RailTypeScopeResolver, ObjectScopeResolver, IndustryTileScopeResolver, IndustriesScopeResolver, HouseScopeResolver, GenericScopeResolver, VehicleScopeResolver, CanalScopeResolver, AirportTileScopeResolver, and AirportScopeResolver.

Definition at line 106 of file newgrf_spritegroup.cpp.

References Debug.

Referenced by FillNewGRFVehicleCache(), NIHVehicle::Resolve(), NIHHouse::Resolve(), NIHIndustryTile::Resolve(), NIHIndustry::Resolve(), NIHObject::Resolve(), NIHAirportTile::Resolve(), NIHAirport::Resolve(), and NIHTown::Resolve().

◆ StorePSA()

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

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

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

Reimplemented in TownScopeResolver, IndustriesScopeResolver, and AirportScopeResolver.

Definition at line 116 of file newgrf_spritegroup.cpp.


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