Inheritance diagram for NIHTown:

Private Member Functions
bool	IsInspectable (uint index) const override
	Is the item with the given index inspectable?

uint	GetParent (uint) 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) 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) const override
	Get the GRFID of the file that includes this item.

bool	PSAWithParameter () const override
	Used to decide if the PSA needs a parameter or not.

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 grfid) const override
	Gets the span containing the persistent storage.

Additional Inherited Members
Public Member Functions inherited from NIHelper
virtual	~NIHelper ()=default
	Silence a warning.

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 586 of file newgrf_debug_data.h.

Member Function Documentation

◆ GetGRFID()

uint32_t NIHTown::GetGRFID ( uint index ) const

inlineoverrideprivatevirtual

Get the GRFID of the file that includes this item.

Parameters

index index to check.

Returns: GRFID of the item. 0 means that the item is not inspectable.

Implements NIHelper.

Definition at line 592 of file newgrf_debug_data.h.

◆ GetInstance()

const void * NIHTown::GetInstance ( uint index ) const

inlineoverrideprivatevirtual

Get the instance given an index.

Parameters

index the index to get the instance for.

Returns: the instance.

Implements NIHelper.

Definition at line 589 of file newgrf_debug_data.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_town_pool >::Get().

◆ GetParent()

uint NIHTown::GetParent ( uint index ) const

inlineoverrideprivatevirtual

Get the parent "window_number" of a given instance.

Parameters

index the instance to get the parent for.

Returns: the parent's window_number or UINT32_MAX if there is none.

Implements NIHelper.

Definition at line 588 of file newgrf_debug_data.h.

◆ GetPSA()

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

inlineoverrideprivatevirtual

Gets the span containing the persistent storage.

Parameters

index	Index of the item.
grfid	Parameter 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 601 of file newgrf_debug_data.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_town_pool >::Get().

◆ GetSpec()

const void * NIHTown::GetSpec ( uint index ) const

inlineoverrideprivatevirtual

Get (NewGRF) specs given an index.

Parameters

index the index to get the specs for for.

Returns: the specs.

Implements NIHelper.

Definition at line 590 of file newgrf_debug_data.h.

◆ IsInspectable()

bool NIHTown::IsInspectable ( uint index ) const

inlineoverrideprivatevirtual

Is the item with the given index inspectable?

Parameters

index the index to check.

Returns: true iff the index is inspectable.

Implements NIHelper.

Definition at line 587 of file newgrf_debug_data.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_town_pool >::IsValidID().

◆ PSAWithParameter()

bool NIHTown::PSAWithParameter ( ) const

inlineoverrideprivatevirtual

Used to decide if the PSA needs a parameter or not.

Returns: True iff this item has a PSA that requires a parameter.

Reimplemented from NIHelper.

Definition at line 593 of file newgrf_debug_data.h.

◆ Resolve()

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

inlineoverrideprivatevirtual

Resolve (action2) variable for a given index.

Parameters

index	The (instance) index to resolve the variable for.
var	The variable to actually resolve.
param	The varaction2 0x60+x parameter to pass.
avail	Return whether the variable is available.

Returns: The resolved variable's value.

Implements NIHelper.

Definition at line 595 of file newgrf_debug_data.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_town_pool >::Get(), TownResolverObject::GetScope(), ScopeResolver::GetVariable(), and VSG_SCOPE_SELF.

◆ SetStringParameters()

void NIHTown::SetStringParameters ( uint index ) const

inlineoverrideprivatevirtual

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

Parameters

index the index to get the string parameters for.

Implements NIHelper.

Definition at line 591 of file newgrf_debug_data.h.

References NIHelper::SetSimpleStringParameters().

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

src/table/newgrf_debug_data.h

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetGRFID()

◆ GetInstance()

◆ GetParent()

◆ GetPSA()

◆ GetSpec()

◆ IsInspectable()

◆ PSAWithParameter()

◆ Resolve()

◆ SetStringParameters()