GSNewGRF Class Reference

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

#include <script_newgrf.hpp>

Inheritance diagram for GSNewGRF:

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 GSNewGRF::GetName ( int  grfid )

static

Get the name of a loaded NewGRF.

Parameters

grfid

The NewGRF to query.

Precondition

GSNewGRF::IsLoaded(grfid).

Returns

The name of the NewGRF or null if no name is defined.

GetVersion()

static int GSNewGRF::GetVersion ( int  grfid )

static

Get the version of a loaded NewGRF.

Parameters

grfid

The NewGRF to query.

Precondition

GSNewGRF::IsLoaded(grfid).

Returns

Version of the NewGRF or 0 if the NewGRF specifies no version.

IsLoaded()

static bool GSNewGRF::IsLoaded ( int  grfid )

static

Check if a NewGRF with a given grfid is loaded.

Parameters

grfid

The grfid to check.

Returns

True if and only if a NewGRF with the given grfid is loaded in the game.