NIHHouse Class Reference

Inheritance diagram for NIHHouse:

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

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.
virtual const std::span< int32_t >	GetPSA (uint index, uint32_t grfid) const
	Gets the span containing the persistent storage.
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 203 of file newgrf_debug_data.h.

Member Function Documentation

GetGRFID()

uint32_t NIHHouse::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 209 of file newgrf_debug_data.h.

References HouseSpec::Get(), GetHouseType(), HouseSpec::grf_prop, GRFFilePropsBase< Tcnt >::grfid, and IsInspectable().

GetInstance()

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

GetParent()

uint NIHHouse::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 205 of file newgrf_debug_data.h.

References GetInspectWindowNumber(), GetTownIndex(), and GSF_FAKE_TOWNS.

GetSpec()

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

References HouseSpec::Get(), and GetHouseType().

IsInspectable()

bool NIHHouse::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 204 of file newgrf_debug_data.h.

References HouseSpec::Get(), GetHouseType(), HouseSpec::grf_prop, and GRFFilePropsBase< Tcnt >::HasGrfFile().

Referenced by GetGRFID().

Resolve()

uint NIHHouse::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 211 of file newgrf_debug_data.h.

References GetHouseType(), HouseResolverObject::GetScope(), ScopeResolver::GetVariable(), and VSG_SCOPE_SELF.

SetStringParameters()

void NIHHouse::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 208 of file newgrf_debug_data.h.

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

---

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

• src/table/newgrf_debug_data.h