OpenTTD Source 20241224-master-gee860a5c8e
NIHAirport Class Reference
Inheritance diagram for NIHAirport:
NIHelper

Private Member Functions

bool IsInspectable (uint index) const override
 Is the item with the given index inspectable?
 
uint GetParent (uint index) const override
 Get the parent "window_number" of a given instance.
 
const void * GetInstance (uint index) const override
 Get the instance given an index.
 
const void * GetSpec (uint index) const override
 Get (NewGRF) specs given an index.
 
void SetStringParameters (uint index) const override
 Set the string parameters to write the right data for a STRINGn.
 
uint32_t GetGRFID (uint index) const override
 Get the GRFID of the file that includes this item.
 
uint Resolve (uint index, uint var, uint param, bool &avail) const override
 Resolve (action2) variable for a given index.
 
const std::span< int32_t > GetPSA (uint index, uint32_t) const override
 Gets the span containing the persistent storage.
 

Additional Inherited Members

- Public Member Functions inherited from NIHelper
virtual ~NIHelper ()=default
 Silence a warning.
 
virtual bool PSAWithParameter () const
 Used to decide if the PSA needs a parameter or not.
 
- Protected Member Functions inherited from NIHelper
void SetSimpleStringParameters (StringID string, uint32_t index) const
 Helper to make setting the strings easier.
 
void SetObjectAtStringParameters (StringID string, uint32_t index, TileIndex tile) const
 Helper to make setting the strings easier for objects at a specific tile.
 

Detailed Description

Definition at line 540 of file newgrf_debug_data.h.

Member Function Documentation

◆ GetGRFID()

uint32_t NIHAirport::GetGRFID ( uint  index) const
inlineoverrideprivatevirtual

Get the GRFID of the file that includes this item.

Parameters
indexindex to check.
Returns
GRFID of the item. 0 means that the item is not inspectable.

Implements NIHelper.

Definition at line 546 of file newgrf_debug_data.h.

References SpecializedStation< Station, false >::Get(), AirportSpec::Get(), AirportSpec::grf_prop, GRFFilePropsBase< Tcnt >::grfid, and IsInspectable().

◆ GetInstance()

const void * NIHAirport::GetInstance ( uint  index) const
inlineoverrideprivatevirtual

Get the instance given an index.

Parameters
indexthe index to get the instance for.
Returns
the instance.

Implements NIHelper.

Definition at line 543 of file newgrf_debug_data.h.

References SpecializedStation< Station, false >::Get().

Referenced by GetPSA().

◆ GetParent()

uint NIHAirport::GetParent ( uint  index) const
inlineoverrideprivatevirtual

Get the parent "window_number" of a given instance.

Parameters
indexthe instance to get the parent for.
Returns
the parent's window_number or UINT32_MAX if there is none.

Implements NIHelper.

Definition at line 542 of file newgrf_debug_data.h.

References SpecializedStation< Station, false >::Get(), GetInspectWindowNumber(), GSF_FAKE_TOWNS, and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index.

◆ GetPSA()

const std::span< int32_t > NIHAirport::GetPSA ( uint  index,
uint32_t  grfid 
) const
inlineoverrideprivatevirtual

Gets the span containing the persistent storage.

Parameters
indexIndex of the item.
grfidParameter for the PSA. Only required for items with parameters.
Returns
Span of the storage array or an empty span when not present.

Reimplemented from NIHelper.

Definition at line 555 of file newgrf_debug_data.h.

References Station::airport, GetInstance(), Airport::psa, and PersistentStorageArray< TYPE, SIZE >::storage.

◆ GetSpec()

const void * NIHAirport::GetSpec ( uint  index) const
inlineoverrideprivatevirtual

Get (NewGRF) specs given an index.

Parameters
indexthe index to get the specs for for.
Returns
the specs.

Implements NIHelper.

Definition at line 544 of file newgrf_debug_data.h.

References SpecializedStation< Station, false >::Get(), and AirportSpec::Get().

◆ IsInspectable()

bool NIHAirport::IsInspectable ( uint  index) const
inlineoverrideprivatevirtual

Is the item with the given index inspectable?

Parameters
indexthe index to check.
Returns
true iff the index is inspectable.

Implements NIHelper.

Definition at line 541 of file newgrf_debug_data.h.

References SpecializedStation< Station, false >::Get(), AirportSpec::Get(), AirportSpec::grf_prop, and GRFFilePropsBase< Tcnt >::HasGrfFile().

Referenced by GetGRFID().

◆ Resolve()

uint NIHAirport::Resolve ( uint  index,
uint  var,
uint  param,
bool &  avail 
) const
inlineoverrideprivatevirtual

Resolve (action2) variable for a given index.

Parameters
indexThe (instance) index to resolve the variable for.
varThe variable to actually resolve.
paramThe varaction2 0x60+x parameter to pass.
availReturn whether the variable is available.
Returns
The resolved variable's value.

Implements NIHelper.

Definition at line 548 of file newgrf_debug_data.h.

References Station::airport, SpecializedStation< Station, false >::Get(), AirportSpec::Get(), AirportResolverObject::GetScope(), ScopeResolver::GetVariable(), Airport::layout, OrthogonalTileArea::tile, Airport::type, and VSG_SCOPE_SELF.

◆ SetStringParameters()

void NIHAirport::SetStringParameters ( uint  index) const
inlineoverrideprivatevirtual

Set the string parameters to write the right data for a STRINGn.

Parameters
indexthe index to get the string parameters for.

Implements NIHelper.

Definition at line 545 of file newgrf_debug_data.h.

References SpecializedStation< Station, false >::Get(), and NIHelper::SetObjectAtStringParameters().


The documentation for this class was generated from the following file: