Inheritance diagram for NIHObject:

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 index) 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, uint param, bool &avail) const override
	Resolve (action2) variable for a given index. More...

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

Member Function Documentation

◆ GetGRFID()

uint32_t NIHObject::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 435 of file newgrf_debug_data.h.

References ObjectSpec::GetByTile(), ObjectSpec::grf_prop, GRFFilePropsBase< Tcnt >::grffile, and IsInspectable().

◆ GetInstance()

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

References Object::GetByTile().

◆ GetParent()

uint NIHObject::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 431 of file newgrf_debug_data.h.

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

◆ GetSpec()

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

References ObjectSpec::GetByTile().

◆ IsInspectable()

bool NIHObject::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 430 of file newgrf_debug_data.h.

References ObjectSpec::GetByTile(), ObjectSpec::grf_prop, and GRFFilePropsBase< Tcnt >::grffile.

Referenced by GetGRFID().

◆ Resolve()

uint NIHObject::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 437 of file newgrf_debug_data.h.

References Object::GetByTile(), ObjectSpec::GetByTile(), ObjectResolverObject::GetScope(), ScopeResolver::GetVariable(), and VSG_SCOPE_SELF.

◆ SetStringParameters()

void NIHObject::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 434 of file newgrf_debug_data.h.

References INVALID_STRING_ID, and NIHelper::SetObjectAtStringParameters().

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()

◆ GetSpec()

◆ IsInspectable()

◆ Resolve()

◆ SetStringParameters()