OpenTTD Source  20240919-master-gdf0233f4c2
NIHRoadStop Class Reference
Inheritance diagram for NIHRoadStop:
NIHelper

Private Member Functions

bool IsInspectable (uint index) const override
 Is the item with the given index inspectable? More...
 
uint GetParent (uint index) const override
 Get the parent "window_number" of a given instance. More...
 
const void * GetInstance (uint) const override
 Get the instance given an index. More...
 
const void * GetSpec (uint index) const override
 Get (NewGRF) specs given an index. More...
 
void SetStringParameters (uint index) const override
 Set the string parameters to write the right data for a STRINGn. More...
 
uint32_t GetGRFID (uint index) const override
 Get the GRFID of the file that includes this item. More...
 
uint Resolve (uint index, uint var, uint32_t param, bool &avail) const override
 

Additional Inherited Members

- Public Member Functions inherited from NIHelper
virtual ~NIHelper ()=default
 Silence a warning.
 
virtual uint Resolve (uint index, uint var, uint param, bool &avail) const =0
 Resolve (action2) variable for a given index. More...
 
virtual bool PSAWithParameter () const
 Used to decide if the PSA needs a parameter or not. More...
 
virtual const std::span< int32_t > GetPSA ([[maybe_unused]] uint index, [[maybe_unused]] uint32_t grfid) const
 Gets the span containing the persistent storage. More...
 
- Protected Member Functions inherited from NIHelper
void SetSimpleStringParameters (StringID string, uint32_t index) const
 Helper to make setting the strings easier. More...
 
void SetObjectAtStringParameters (StringID string, uint32_t index, TileIndex tile) const
 Helper to make setting the strings easier for objects at a specific tile. More...
 

Detailed Description

Definition at line 697 of file newgrf_debug_data.h.

Member Function Documentation

◆ GetGRFID()

uint32_t NIHRoadStop::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 703 of file newgrf_debug_data.h.

References IsInspectable().

◆ GetInstance()

const void* NIHRoadStop::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 700 of file newgrf_debug_data.h.

◆ GetParent()

uint NIHRoadStop::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 699 of file newgrf_debug_data.h.

References BaseStation::GetByTile(), GetInspectWindowNumber(), GSF_FAKE_TOWNS, and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index.

◆ GetSpec()

const void* NIHRoadStop::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 701 of file newgrf_debug_data.h.

◆ IsInspectable()

bool NIHRoadStop::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 698 of file newgrf_debug_data.h.

Referenced by GetGRFID().

◆ SetStringParameters()

void NIHRoadStop::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 702 of file newgrf_debug_data.h.

References GetStationIndex(), and NIHelper::SetObjectAtStringParameters().


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