OpenTTD Source  20241121-master-g67a0fccfad
Public Member Functions | Static Public Member Functions | Private Attributes
AILibrary Class Reference

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

#include <ai_info.hpp>

Inheritance diagram for AILibrary:
ScriptInfo

Public Member Functions

const std::string & GetCategory () const
 Get the category this library is in.
 
- Public Member Functions inherited from ScriptInfo
const std::string & GetAuthor () const
 Get the Author of the script.
 
const std::string & GetName () const
 Get the Name of the script.
 
const std::string & GetShortName () const
 Get the 4 character long short name of the script.
 
const std::string & GetDescription () const
 Get the description of the script.
 
int GetVersion () const
 Get the version of the script.
 
const std::string & GetDate () const
 Get the last-modified date of the script.
 
const std::string & GetInstanceName () const
 Get the name of the instance of the script to create.
 
const std::string & GetURL () const
 Get the website for this script.
 
const std::string & GetMainScript () const
 Get the filename of the main.nut script.
 
const std::string & 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 ScriptScanner * GetScanner ()
 Get the scanner which has found this ScriptInfo.
 
bool GetSettings ()
 Get the settings of the Script.
 
const ScriptConfigItemList * GetConfigList () const
 Get the config list for this Script.
 
const ScriptConfigItem * GetConfigItem (const std::string_view 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 std::string &name) const
 Get the default value for a setting.
 
virtual bool IsDeveloperOnly () const
 Can this script be selected by developers only?
 

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 Public Member Functions inherited from ScriptInfo
static SQInteger Constructor (HSQUIRRELVM vm, ScriptInfo *info)
 Process the creation of a FileInfo object.
 

Private Attributes

std::string category
 The category this library is in.
 

Additional Inherited Members

- Protected Attributes inherited from ScriptInfo
class Squirrel * engine
 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 library like name, version, etc.

Definition at line 57 of file ai_info.hpp.

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