OpenTTD
|
Helper class to wrap some functionality/queries in. More...
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... | |
Helper class to wrap some functionality/queries in.
Definition at line 115 of file newgrf_debug_gui.cpp.
|
inlinevirtual |
Silence a warning.
Definition at line 118 of file newgrf_debug_gui.cpp.
|
pure virtual |
Get the GRFID of the file that includes this item.
index | index to check. |
Implemented in NIHTown, NIHAirportTile, NIHRailType, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
Referenced by NewGRFInspectWindow::OnClick().
|
pure virtual |
Get the instance given an index.
index | the index to get the instance for. |
Implemented in NIHTown, NIHAirportTile, NIHRailType, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
|
pure virtual |
Get the parent "window_number" of a given instance.
index | the instance to get the parent for. |
Implemented in NIHTown, NIHAirportTile, NIHRailType, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
Referenced by NewGRFInspectWindow::OnClick().
|
inlinevirtual |
Gets the first position of the array containing the persistent storage.
index | Index of the item. |
grfid | Parameter for the PSA. Only required for items with parameters. |
Reimplemented in NIHTown, and NIHIndustry.
Definition at line 197 of file newgrf_debug_gui.cpp.
|
inlinevirtual |
Allows to know the size of the persistent storage.
index | Index of the item. |
grfid | Parameter for the PSA. Only required for items with parameters. |
Reimplemented in NIHTown, and NIHIndustry.
Definition at line 186 of file newgrf_debug_gui.cpp.
|
pure virtual |
Get (NewGRF) specs given an index.
index | the index to get the specs for for. |
Implemented in NIHTown, NIHAirportTile, NIHRailType, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
|
pure virtual |
Is the item with the given index inspectable?
index | the index to check. |
Implemented in NIHTown, NIHAirportTile, NIHRailType, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
Referenced by IsNewGRFInspectable().
|
inlinevirtual |
Used to decide if the PSA needs a parameter or not.
Reimplemented in NIHTown.
Definition at line 175 of file newgrf_debug_gui.cpp.
|
pure virtual |
Resolve (action2) variable for a given index.
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. |
Implemented in NIHTown, NIHAirportTile, NIHRailType, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
|
inlineprotected |
Helper to make setting the strings easier for objects at a specific tile.
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 221 of file newgrf_debug_gui.cpp.
References SetDParam().
Referenced by NIHStation::SetStringParameters(), NIHHouse::SetStringParameters(), NIHIndustryTile::SetStringParameters(), NIHObject::SetStringParameters(), NIHRailType::SetStringParameters(), and NIHAirportTile::SetStringParameters().
|
inlineprotected |
Helper to make setting the strings easier.
string | the string to actually draw. |
index | the (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().
|
pure virtual |
Set the string parameters to write the right data for a STRINGn.
index | the index to get the string parameters for. |
Implemented in NIHTown, NIHAirportTile, NIHRailType, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
Referenced by NewGRFInspectWindow::SetStringParameters().