OpenTTD Source  20241108-master-g80f628063a
AirportResolverObject Struct Reference

Resolver object for airports. More...

#include <newgrf_airport.h>

Inheritance diagram for AirportResolverObject:
ResolverObject

Public Member Functions

 AirportResolverObject (TileIndex tile, Station *st, const AirportSpec *spec, uint8_t layout, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
 Constructor of the airport resolver. More...
 
TownScopeResolverGetTown ()
 Get the town scope associated with a station, if it exists. More...
 
ScopeResolverGetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
 Get a resolver for the scope. More...
 
GrfSpecFeature GetFeature () const override
 Get the feature number being resolved for. More...
 
uint32_t GetDebugID () const override
 Get an identifier for the item being resolved. More...
 
- Public Member Functions inherited from ResolverObject
 ResolverObject (const GRFFile *grffile, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
 Resolver constructor. More...
 
const SpriteGroupResolve ()
 Resolve SpriteGroup. More...
 
uint16_t ResolveCallback ()
 Resolve callback. More...
 
virtual const SpriteGroupResolveReal (const RealSpriteGroup *group) const
 Get the real sprites of the grf. 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...
 

Data Fields

AirportScopeResolver airport_scope
 
std::optional< TownScopeResolvertown_scope = std::nullopt
 The town scope resolver (created on the first call).
 
- Data Fields inherited from ResolverObject
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 GRFFilegrffile
 GRFFile the resolved SpriteGroup belongs to.
 
const SpriteGrouproot_spritegroup
 Root SpriteGroup to use for resolving.
 

Detailed Description

Resolver object for airports.

Definition at line 176 of file newgrf_airport.h.

Constructor & Destructor Documentation

◆ AirportResolverObject()

AirportResolverObject::AirportResolverObject ( TileIndex  tile,
Station st,
const AirportSpec spec,
uint8_t  layout,
CallbackID  callback = CBID_NO_CALLBACK,
uint32_t  param1 = 0,
uint32_t  param2 = 0 
)

Constructor of the airport resolver.

Parameters
tileTile for the callback, only valid for airporttile callbacks.
stStation of the airport for which the callback is run, or nullptr for build gui.
specAirportSpec for which the callback is run.
layoutLayout of the airport to build.
callbackCallback ID.
param1First parameter (var 10) of the callback.
param2Second parameter (var 18) of the callback.

Definition at line 245 of file newgrf_airport.cpp.

References AirportSpec::grf_prop, ResolverObject::root_spritegroup, and GRFFilePropsBase< Tcnt >::spritegroup.

Member Function Documentation

◆ GetDebugID()

uint32_t AirportResolverObject::GetDebugID ( ) const
overridevirtual

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 from ResolverObject.

Definition at line 184 of file newgrf_airport.cpp.

References AirportSpec::grf_prop, GRFFilePropsBase< Tcnt >::local_id, and AirportScopeResolver::spec.

◆ GetFeature()

GrfSpecFeature AirportResolverObject::GetFeature ( ) const
overridevirtual

Get the feature number being resolved for.

This function is mainly intended for the callback profiling feature.

Reimplemented from ResolverObject.

Definition at line 179 of file newgrf_airport.cpp.

◆ GetScope()

ScopeResolver* AirportResolverObject::GetScope ( VarSpriteGroupScope  scope = VSG_SCOPE_SELF,
uint8_t  relative = 0 
)
inlineoverridevirtual

Get a resolver for the scope.

Returns
The resolver for the requested scope.

Reimplemented from ResolverObject.

Definition at line 185 of file newgrf_airport.h.

References ResolverObject::GetScope(), GetTown(), VSG_SCOPE_PARENT, and VSG_SCOPE_SELF.

Referenced by NIHAirport::Resolve().

◆ GetTown()

TownScopeResolver * AirportResolverObject::GetTown ( )

Get the town scope associated with a station, if it exists.

On the first call, the town scope is created (if possible).

Returns
Town scope, if available.

Definition at line 220 of file newgrf_airport.cpp.

References ClosestTownFromTile(), INVALID_TILE, AirportScopeResolver::st, AirportScopeResolver::tile, BaseStation::town, and town_scope.

Referenced by GetScope().


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