OpenTTD
Public Member Functions | Static Public Member Functions | Private Attributes
AIInfo Class Reference

All static information from an AI like name, version, etc. More...

#include <ai_info.hpp>

Inheritance diagram for AIInfo:
ScriptInfo SimpleCountedObject

Public Member Functions

bool CanLoadFromVersion (int version) const
 Check if we can start this AI.
 
bool UseAsRandomAI () const
 Use this AI as a random AI.
 
const char * GetAPIVersion () const
 Get the API version this AI is written for.
 
- Public Member Functions inherited from ScriptInfo
const char * GetAuthor () const
 Get the Author of the script.
 
const char * GetName () const
 Get the Name of the script.
 
const char * GetShortName () const
 Get the 4 character long short name of the script.
 
const char * GetDescription () const
 Get the description of the script.
 
int GetVersion () const
 Get the version of the script.
 
const char * GetDate () const
 Get the last-modified date of the script.
 
const char * GetInstanceName () const
 Get the name of the instance of the script to create.
 
const char * GetURL () const
 Get the website for this script.
 
const char * GetMainScript () const
 Get the filename of the main.nut script.
 
const char * GetTarFile () const
 Get the filename of the tar the script is in.
 
bool CheckMethod (const char *name) const
 Check if a given method exists.
 
virtual class ScriptScannerGetScanner ()
 Get the scanner which has found this ScriptInfo.
 
bool GetSettings ()
 Get the settings of the Script.
 
const ScriptConfigItemListGetConfigList () const
 Get the config list for this Script.
 
const ScriptConfigItemGetConfigItem (const char *name) const
 Get the description of a certain Script config option.
 
SQInteger AddSetting (HSQUIRRELVM vm)
 Set a setting.
 
SQInteger AddLabels (HSQUIRRELVM vm)
 Add labels for a setting.
 
int GetSettingDefaultValue (const char *name) const
 Get the default value for a setting.
 
virtual bool IsDeveloperOnly () const
 Can this script be selected by developers only?
 
- Public Member Functions inherited from SimpleCountedObject
virtual int32 AddRef ()
 
virtual int32 Release ()
 
virtual void FinalRelease ()
 

Static Public Member Functions

static void RegisterAPI (Squirrel *engine)
 Register the functions of this class.
 
static SQInteger Constructor (HSQUIRRELVM vm)
 Create an AI, using this AIInfo as start-template.
 
static SQInteger DummyConstructor (HSQUIRRELVM vm)
 Create a dummy-AI.
 
- Static Public Member Functions inherited from ScriptInfo
static SQInteger Constructor (HSQUIRRELVM vm, ScriptInfo *info)
 Process the creation of a FileInfo object.
 

Private Attributes

int min_loadable_version
 The AI can load savegame data if the version is equal or greater than this.
 
bool use_as_random
 Should this AI be used when the user wants a "random AI"?
 
const char * api_version
 API version used by this AI.
 

Additional Inherited Members

- Data Fields inherited from SimpleCountedObject
int32 m_ref_cnt
 
- Protected Attributes inherited from ScriptInfo
class Squirrelengine
 Engine used to register for Squirrel.
 
HSQOBJECT * SQ_instance
 The Squirrel instance created for this info.
 
ScriptConfigItemList config_list
 List of settings from this Script.
 

Detailed Description

All static information from an AI like name, version, etc.

Definition at line 18 of file ai_info.hpp.


The documentation for this class was generated from the following files: