OpenTTD Source
20241108-master-g80f628063a
|
Helper class to wrap some functionality/queries in. More...
Public Member Functions | |
virtual | ~NIHelper ()=default |
Silence a warning. | |
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_t | 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 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 | |
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... | |
Helper class to wrap some functionality/queries in.
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 NIHRoadType, NIHTown, NIHRailType, NIHRoadStop, NIHAirport, NIHAirportTile, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
|
pure virtual |
Get the instance given an index.
index | the index to get the instance for. |
Implemented in NIHRoadStop, NIHRoadType, NIHAirportTile, NIHRailType, NIHIndustryTile, NIHHouse, NIHStation, NIHTown, NIHAirport, NIHObject, NIHIndustry, and NIHVehicle.
Referenced by NewGRFInspectWindow::DrawMainPanelWidget().
|
pure virtual |
Get the parent "window_number" of a given instance.
index | the instance to get the parent for. |
Implemented in NIHRoadType, NIHTown, NIHRailType, NIHRoadStop, NIHAirport, NIHAirportTile, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
|
inlinevirtual |
Gets the span containing the persistent storage.
index | Index of the item. |
grfid | Parameter for the PSA. Only required for items with parameters. |
Definition at line 189 of file newgrf_debug_gui.cpp.
Referenced by NewGRFInspectWindow::DrawMainPanelWidget().
|
pure virtual |
Get (NewGRF) specs given an index.
index | the index to get the specs for for. |
Implemented in NIHRoadType, NIHTown, NIHRailType, NIHRoadStop, NIHAirport, NIHAirportTile, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
Referenced by NewGRFInspectWindow::DrawMainPanelWidget().
|
pure virtual |
Is the item with the given index inspectable?
index | the index to check. |
Implemented in NIHRoadType, NIHRailType, NIHRoadStop, NIHTown, NIHAirport, NIHAirportTile, 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 178 of file newgrf_debug_gui.cpp.
Referenced by NewGRFInspectWindow::DrawMainPanelWidget().
|
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 NIHRoadType, NIHTown, NIHAirport, NIHAirportTile, NIHRailType, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.
Referenced by NewGRFInspectWindow::DrawMainPanelWidget().
|
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 213 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().
|
inlineprotected |
Helper to make setting the strings easier.
string | the string to actually draw. |
index | the (instance) index for the string. |
Definition at line 200 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 NIHRoadStop, NIHRoadType, NIHTown, NIHAirport, NIHAirportTile, NIHRailType, NIHObject, NIHIndustry, NIHIndustryTile, NIHHouse, NIHStation, and NIHVehicle.