Helper class to wrap some functionality/queries in. More...

Inheritance diagram for NIHelper:

Public Member Functions
virtual	~NIHelper ()=default
	Silence a warning.

virtual bool	IsInspectable (uint index) const =0
	Is the item with the given index inspectable?

virtual uint	GetParent (uint index) const =0
	Get the parent "window_number" of a given instance.

virtual const void *	GetInstance (uint index) const =0
	Get the instance given an index.

virtual const void *	GetSpec (uint index) const =0
	Get (NewGRF) specs given an index.

virtual void	SetStringParameters (uint index) const =0
	Set the string parameters to write the right data for a STRINGn.

virtual uint32_t	GetGRFID (uint index) const =0
	Get the GRFID of the file that includes this item.

virtual uint	Resolve (uint index, uint var, uint param, bool &avail) const =0
	Resolve (action2) variable for a given index.

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

virtual const std::span< int32_t >	GetPSA (uint index, uint32_t grfid) const
	Gets the span containing the persistent storage.

Protected Member Functions
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

Helper class to wrap some functionality/queries in.

Definition at line 127 of file newgrf_debug_gui.cpp.

Member Function Documentation

◆ GetGRFID()

virtual uint32_t NIHelper::GetGRFID ( uint index ) const

pure virtual

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.

Implemented in NIHVehicle, NIHStation, NIHHouse, NIHIndustryTile, NIHIndustry, NIHObject, NIHAirportTile, NIHAirport, NIHRoadStop, NIHRailType, NIHTown, and NIHRoadType.

◆ GetInstance()

virtual const void * NIHelper::GetInstance ( uint index ) const

pure virtual

Get the instance given an index.

Parameters

index the index to get the instance for.

Returns: the instance.

Implemented in NIHVehicle, NIHIndustry, NIHObject, NIHAirport, NIHTown, NIHStation, NIHHouse, NIHIndustryTile, NIHRailType, NIHAirportTile, NIHRoadType, and NIHRoadStop.

Referenced by NewGRFInspectWindow::DrawMainPanelWidget().

◆ GetParent()

virtual uint NIHelper::GetParent ( uint index ) const

pure virtual

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.

Implemented in NIHVehicle, NIHStation, NIHHouse, NIHIndustryTile, NIHIndustry, NIHObject, NIHAirportTile, NIHAirport, NIHRoadStop, NIHRailType, NIHTown, and NIHRoadType.

◆ GetPSA()

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

inlinevirtual

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 in NIHTown, NIHIndustry, and NIHAirport.

Definition at line 198 of file newgrf_debug_gui.cpp.

◆ GetSpec()

virtual const void * NIHelper::GetSpec ( uint index ) const

pure virtual

Get (NewGRF) specs given an index.

Parameters

index the index to get the specs for for.

Returns: the specs.

Implemented in NIHVehicle, NIHStation, NIHHouse, NIHIndustryTile, NIHIndustry, NIHObject, NIHAirportTile, NIHAirport, NIHRoadStop, NIHRailType, NIHTown, and NIHRoadType.

◆ IsInspectable()

virtual bool NIHelper::IsInspectable ( uint index ) const

pure virtual

Is the item with the given index inspectable?

Parameters

index the index to check.

Returns: true iff the index is inspectable.

Implemented in NIHVehicle, NIHStation, NIHHouse, NIHIndustryTile, NIHIndustry, NIHObject, NIHAirportTile, NIHAirport, NIHTown, NIHRoadStop, NIHRailType, and NIHRoadType.

◆ PSAWithParameter()

virtual bool NIHelper::PSAWithParameter ( ) const

inlinevirtual

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

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

Reimplemented in NIHTown.

Definition at line 187 of file newgrf_debug_gui.cpp.

◆ Resolve()

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

pure virtual

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.

Implemented in NIHVehicle, NIHStation, NIHHouse, NIHIndustryTile, NIHIndustry, NIHObject, NIHRailType, NIHAirportTile, NIHAirport, NIHTown, and NIHRoadType.

◆ SetObjectAtStringParameters()

void NIHelper::SetObjectAtStringParameters	(	StringID	string,
		uint32_t	index,
		TileIndex	tile
	)		const

inlineprotected

Helper to make setting the strings easier for objects at a specific tile.

Parameters

string	the string to draw the object's name
index	the (instance) index for the string.
tile	the tile the object is at

Definition at line 222 of file newgrf_debug_gui.cpp.

References SetDParam().

Referenced by NIHStation::SetStringParameters(), NIHHouse::SetStringParameters(), NIHIndustryTile::SetStringParameters(), NIHObject::SetStringParameters(), NIHRailType::SetStringParameters(), NIHAirportTile::SetStringParameters(), NIHAirport::SetStringParameters(), NIHRoadType::SetStringParameters(), and NIHRoadStop::SetStringParameters().

◆ SetSimpleStringParameters()

void NIHelper::SetSimpleStringParameters	(	StringID	string,
		uint32_t	index
	)		const

inlineprotected

Helper to make setting the strings easier.

Parameters

string	the string to actually draw.
index	the (instance) index for the string.

Definition at line 209 of file newgrf_debug_gui.cpp.

References SetDParam().

Referenced by NIHVehicle::SetStringParameters(), NIHIndustry::SetStringParameters(), and NIHTown::SetStringParameters().

◆ SetStringParameters()

virtual void NIHelper::SetStringParameters ( uint index ) const

pure virtual

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

Parameters

index the index to get the string parameters for.

Implemented in NIHVehicle, NIHStation, NIHHouse, NIHIndustryTile, NIHIndustry, NIHObject, NIHRailType, NIHAirportTile, NIHAirport, NIHTown, NIHRoadType, and NIHRoadStop.

Referenced by NewGRFInspectWindow::SetStringParameters().

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

src/newgrf_debug_gui.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ GetGRFID()

◆ GetInstance()

◆ GetParent()

◆ GetPSA()

◆ GetSpec()

◆ IsInspectable()

◆ PSAWithParameter()

◆ Resolve()

◆ SetObjectAtStringParameters()

◆ SetSimpleStringParameters()

◆ SetStringParameters()