OpenTTD GameScript API 20241015-master-gd5b57a56f4
|
'Abstract' class of the GSs use to register themselves. More...
#include <script_info_docs.hpp>
Public Types | |
enum | GSConfigFlags { CONFIG_NONE , CONFIG_BOOLEAN , CONFIG_INGAME , CONFIG_DEVELOPER } |
Miscellaneous flags for GS settings. More... | |
Public Member Functions | |
string | GetAuthor () |
Gets the author name to be shown in the 'Available GSs' window. | |
string | GetName () |
Gets the GSs name. | |
string | GetShortName () |
Gets a 4 ASCII character short name of the GS to uniquely identify it from other GSs. | |
string | GetDescription () |
Gets the description to be shown in the 'Available GSs' window. | |
int | GetVersion () |
Gets the version of the GS. | |
int | MinVersionToLoad () |
Gets the lowest version of the GS that OpenTTD can still load the savegame of. | |
string | GetDate () |
Gets the development/release date of the GS. | |
bool | IsDeveloperOnly () |
Can a non-developer select GS for a new game. | |
string | CreateInstance () |
Gets the name of main class of the GS so OpenTTD knows what class to instantiate. | |
string | GetAPIVersion () |
Gets the API version this GS is written for. | |
string | GetURL () |
Gets the URL to be shown in the 'this GS has crashed' message and in the 'Available GSs' window. | |
void | GetSettings () |
Gets the settings that OpenTTD shows in the "GS Parameters" window so the user can customize the GS. | |
void | AddSetting (table setting_description) |
Add a user configurable setting for this GS. | |
void | AddLabels (string setting_name, table value_names) |
Add labels for the values of a setting. | |
'Abstract' class of the GSs use to register themselves.
Miscellaneous flags for GS settings.
void GSInfo::AddLabels | ( | string | setting_name, |
table | value_names | ||
) |
Add labels for the values of a setting.
Instead of a number the user will see the corresponding name.
setting_name | The name of the setting. |
value_names | A table that maps values to names. The first character of every identifier is ignored, the second character could be '_' to indicate the value is negative, and the rest should be an integer of the value you define a name for. The value is a short description of that value. To define labels for a setting named "competition_level" you could for example call it like this: AddLabels("competition_level", {_0 = "no competition", _1 = "some competition", _2 = "a lot of competition"}); Another example, for a setting with a negative value: AddLabels("amount", {__1 = "less than one", _0 = "none", _1 = "more than one"}); |
void GSInfo::AddSetting | ( | table | setting_description | ) |
Add a user configurable setting for this GS.
You can call this as many times as you have settings.
setting_description | A table with all information about a single setting. The table should have the following name/value pairs:
|
string GSInfo::CreateInstance | ( | ) |
Gets the name of main class of the GS so OpenTTD knows what class to instantiate.
For libraries, this name is also used when other scripts import it using GSController::Import.
string GSInfo::GetAPIVersion | ( | ) |
Gets the API version this GS is written for.
If this function does not exist API compatibility with version 0.7 is assumed. If the function returns something OpenTTD does not understand, for example a newer version or a string that is not a version, the GS will not be loaded.
Although in the future we might need to make a separate compatibility 'wrapper' for a specific version of OpenTTD, for example '0.7.1', we will use only the major and minor number and not the bugfix number as valid return for this function.
Valid return values are:
string GSInfo::GetAuthor | ( | ) |
Gets the author name to be shown in the 'Available GSs' window.
string GSInfo::GetDate | ( | ) |
Gets the development/release date of the GS.
The intention of this is to give the user an idea how old the GS is and whether there might be a newer version.
string GSInfo::GetDescription | ( | ) |
Gets the description to be shown in the 'Available GSs' window.
string GSInfo::GetName | ( | ) |
Gets the GSs name.
This is shown in the 'Available GSs' window and at all other places where the GS is mentioned, like the debug window or OpenTTD's help message. The name is used to uniquely identify an GS within OpenTTD and this name is used in savegames and the configuration file.
void GSInfo::GetSettings | ( | ) |
Gets the settings that OpenTTD shows in the "GS Parameters" window so the user can customize the GS.
This is a special function that doesn't need to return anything. Instead you can call AddSetting and AddLabels here.
string GSInfo::GetShortName | ( | ) |
Gets a 4 ASCII character short name of the GS to uniquely identify it from other GSs.
The short name is primarily used as unique identifier for the content system. The content system uses besides the short name also the MD5 checksum of all the source files to uniquely identify a specific version of the GS.
The short name must consist of precisely four ASCII characters, or more precisely four non-zero bytes.
string GSInfo::GetURL | ( | ) |
Gets the URL to be shown in the 'this GS has crashed' message and in the 'Available GSs' window.
If this function does not exist no URL will be shown.
This function purely exists to redirect users of the GS to the right place on the internet to discuss the GS and report bugs of this GS.
int GSInfo::GetVersion | ( | ) |
Gets the version of the GS.
This is a number to (in theory) uniquely identify the versions of an GS. Generally the 'instance' of an GS with the highest version is chosen to be loaded.
When OpenTTD finds, during starting, a duplicate GS with the same version number one is randomly chosen. So it is important that this number is regularly updated/incremented.
bool GSInfo::IsDeveloperOnly | ( | ) |
Can a non-developer select GS for a new game.
The idea behind this function is to 'forbid' using your script with a new game if you for example specifically wrote it for a certain scenario.
int GSInfo::MinVersionToLoad | ( | ) |
Gets the lowest version of the GS that OpenTTD can still load the savegame of.
In other words, from which version until this version can the GS load the savegames.
If this function does not exist OpenTTD assumes it can only load savegames of this version. As such it will not upgrade to this version upon load.