OpenTTD
Public Member Functions | Protected Member Functions
NIHelper Class Referenceabstract

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

Inheritance diagram for NIHelper:
NIHAirportTile NIHHouse NIHIndustry NIHIndustryTile NIHObject NIHRailType NIHStation NIHTown NIHVehicle

Public Member Functions

virtual ~NIHelper ()
 Silence a warning. More...
 
virtual bool IsInspectable (uint index) const =0
 Is the item with the given index inspectable? More...
 
virtual uint GetParent (uint index) const =0
 Get the parent "window_number" of a given instance. More...
 
virtual const void * GetInstance (uint index) const =0
 Get the instance given an index. More...
 
virtual const void * GetSpec (uint index) const =0
 Get (NewGRF) specs given an index. More...
 
virtual void SetStringParameters (uint index) const =0
 Set the string parameters to write the right data for a STRINGn. More...
 
virtual uint32 GetGRFID (uint index) const =0
 Get the GRFID of the file that includes this item. More...
 
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 uint GetPSASize (uint index, uint32 grfid) const
 Allows to know the size of the persistent storage. More...
 
virtual const int32 * GetPSAFirstPosition (uint index, uint32 grfid) const
 Gets the first position of the array containing the persistent storage. More...
 

Protected Member Functions

void SetSimpleStringParameters (StringID string, uint32 index) const
 Helper to make setting the strings easier. More...
 
void SetObjectAtStringParameters (StringID string, uint32 index, TileIndex tile) const
 Helper to make setting the strings easier for objects at a specific tile. More...
 

Detailed Description

Helper class to wrap some functionality/queries in.

Definition at line 115 of file newgrf_debug_gui.cpp.

Constructor & Destructor Documentation

◆ ~NIHelper()

virtual NIHelper::~NIHelper ( )
inlinevirtual

Silence a warning.

Definition at line 118 of file newgrf_debug_gui.cpp.

Member Function Documentation

◆ GetGRFID()

virtual uint32 NIHelper::GetGRFID ( uint  index) const
pure virtual

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.

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

Referenced by NewGRFInspectWindow::OnClick().

◆ GetInstance()

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

Get the instance given an index.

Parameters
indexthe index to get the instance for.
Returns
the instance.

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

◆ GetParent()

virtual uint NIHelper::GetParent ( uint  index) const
pure virtual

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.

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

Referenced by NewGRFInspectWindow::OnClick().

◆ GetPSAFirstPosition()

virtual const int32* NIHelper::GetPSAFirstPosition ( uint  index,
uint32  grfid 
) const
inlinevirtual

Gets the first position of the array containing the persistent storage.

Parameters
indexIndex of the item.
grfidParameter for the PSA. Only required for items with parameters.
Returns
Pointer to the first position of the storage array or NULL if not present.

Reimplemented in NIHTown, and NIHIndustry.

Definition at line 197 of file newgrf_debug_gui.cpp.

◆ GetPSASize()

virtual uint NIHelper::GetPSASize ( uint  index,
uint32  grfid 
) const
inlinevirtual

Allows to know the size of the persistent storage.

Parameters
indexIndex of the item.
grfidParameter for the PSA. Only required for items with parameters.
Returns
Size of the persistent storage in indices.

Reimplemented in NIHTown, and NIHIndustry.

Definition at line 186 of file newgrf_debug_gui.cpp.

◆ GetSpec()

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

Get (NewGRF) specs given an index.

Parameters
indexthe index to get the specs for for.
Returns
the specs.

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

◆ IsInspectable()

virtual bool NIHelper::IsInspectable ( uint  index) const
pure virtual

Is the item with the given index inspectable?

Parameters
indexthe index to check.
Returns
true iff the index is inspectable.

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

Referenced by IsNewGRFInspectable().

◆ 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 175 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
indexThe (instance) index to resolve the variable for.
varThe variable to actually resolve.
paramThe varaction2 0x60+x parameter to pass.
availReturn whether the variable is available.
Returns
The resolved variable's value.

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

◆ SetObjectAtStringParameters()

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

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

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

Definition at line 221 of file newgrf_debug_gui.cpp.

References SetDParam().

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

◆ SetSimpleStringParameters()

void NIHelper::SetSimpleStringParameters ( StringID  string,
uint32  index 
) const
inlineprotected

Helper to make setting the strings easier.

Parameters
stringthe string to actually draw.
indexthe (instance) index for the string.

Definition at line 208 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
indexthe index to get the string parameters for.

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

Referenced by NewGRFInspectWindow::SetStringParameters().


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