OpenTTD AI API 20241015-master-gd5b57a56f4
Static Public Member Functions
AINewGRF Class Reference

Class that handles all NewGRF related functions. More...

#include <script_newgrf.hpp>

Inheritance diagram for AINewGRF:

Static Public Member Functions

static bool IsLoaded (int grfid)
 Check if a NewGRF with a given grfid is loaded.
 
static int GetVersion (int grfid)
 Get the version of a loaded NewGRF.
 
static string GetName (int grfid)
 Get the name of a loaded NewGRF.
 

Detailed Description

Class that handles all NewGRF related functions.

Member Function Documentation

◆ GetName()

static string AINewGRF::GetName ( int  grfid)
static

Get the name of a loaded NewGRF.

Parameters
grfidThe NewGRF to query.
Precondition
AINewGRF::IsLoaded(grfid).
Returns
The name of the NewGRF or null if no name is defined.

◆ GetVersion()

static int AINewGRF::GetVersion ( int  grfid)
static

Get the version of a loaded NewGRF.

Parameters
grfidThe NewGRF to query.
Precondition
AINewGRF::IsLoaded(grfid).
Returns
Version of the NewGRF or 0 if the NewGRF specifies no version.

◆ IsLoaded()

static bool AINewGRF::IsLoaded ( int  grfid)
static

Check if a NewGRF with a given grfid is loaded.

Parameters
grfidThe grfid to check.
Returns
True if and only if a NewGRF with the given grfid is loaded in the game.