Game scripting subsystem using AngelScript. More...

Data Structures
class	RoR::GameScript
	Proxy class that can be called by script functions. More...

class	RoR::LocalStorage
	A class that allows scripts to store data persistently. More...

class	OgreScriptBuilder

struct	RoR::ScriptUnit
	Represents a loaded script and all associated resources/handles. More...

struct	RoR::LoadScriptRequest

struct	RoR::ScriptCallbackArgs

class	RoR::ScriptEngine
	This class represents the angelscript scripting interface. More...

class	RoR::CReadonlyScriptDictView< T >

class	RoR::CReadonlyScriptArrayView< T >

Typedefs
typedef std::map< ScriptUnitID_t, ScriptUnit >	RoR::ScriptUnitMap

typedef BitMask_t	RoR::GetFuncFlags_t
	Flags for `RoR::ScriptEngine::getFunctionByDeclAndLogCandidates()` More...

Enumerations
enum	RoR::ScriptCategory { RoR::ScriptCategory::INVALID, RoR::ScriptCategory::ACTOR, RoR::ScriptCategory::TERRAIN, RoR::ScriptCategory::GADGET, RoR::ScriptCategory::CUSTOM }
	Note: Either of these can be loaded from script using `game.pushMessage(MSG_APP_LOAD_SCRIPT_REQUESTED...)` More...

enum	RoR::ScriptRetCode { RoR::SCRIPTRETCODE_SUCCESS = AngelScript::asSUCCESS, RoR::SCRIPTRETCODE_AS_ERROR = AngelScript::asERROR, RoR::SCRIPTRETCODE_AS_CONTEXT_ACTIVE = AngelScript::asCONTEXT_ACTIVE, RoR::SCRIPTRETCODE_AS_CONTEXT_NOT_FINISHED = AngelScript::asCONTEXT_NOT_FINISHED, RoR::SCRIPTRETCODE_AS_CONTEXT_NOT_PREPARED = AngelScript::asCONTEXT_NOT_PREPARED, RoR::SCRIPTRETCODE_AS_INVALID_ARG = AngelScript::asINVALID_ARG, RoR::SCRIPTRETCODE_AS_NO_FUNCTION = AngelScript::asNO_FUNCTION, RoR::SCRIPTRETCODE_AS_NOT_SUPPORTED = AngelScript::asNOT_SUPPORTED, RoR::SCRIPTRETCODE_AS_INVALID_NAME = AngelScript::asINVALID_NAME, RoR::SCRIPTRETCODE_AS_NAME_TAKEN = AngelScript::asNAME_TAKEN, RoR::SCRIPTRETCODE_AS_INVALID_DECLARATION = AngelScript::asINVALID_DECLARATION, RoR::SCRIPTRETCODE_AS_INVALID_OBJECT = AngelScript::asINVALID_OBJECT, RoR::SCRIPTRETCODE_AS_INVALID_TYPE = AngelScript::asINVALID_TYPE, RoR::SCRIPTRETCODE_AS_ALREADY_REGISTERED = AngelScript::asALREADY_REGISTERED, RoR::SCRIPTRETCODE_AS_MULTIPLE_FUNCTIONS = AngelScript::asMULTIPLE_FUNCTIONS, RoR::SCRIPTRETCODE_AS_NO_MODULE = AngelScript::asNO_MODULE, RoR::SCRIPTRETCODE_AS_NO_GLOBAL_VAR = AngelScript::asNO_GLOBAL_VAR, RoR::SCRIPTRETCODE_AS_INVALID_CONFIGURATION = AngelScript::asINVALID_CONFIGURATION, RoR::SCRIPTRETCODE_AS_INVALID_INTERFACE = AngelScript::asINVALID_INTERFACE, RoR::SCRIPTRETCODE_AS_CANT_BIND_ALL_FUNCTIONS = AngelScript::asCANT_BIND_ALL_FUNCTIONS, RoR::SCRIPTRETCODE_AS_LOWER_ARRAY_DIMENSION_NOT_REGISTERED = AngelScript::asLOWER_ARRAY_DIMENSION_NOT_REGISTERED, RoR::SCRIPTRETCODE_AS_WRONG_CONFIG_GROUP = AngelScript::asWRONG_CONFIG_GROUP, RoR::SCRIPTRETCODE_AS_CONFIG_GROUP_IS_IN_USE = AngelScript::asCONFIG_GROUP_IS_IN_USE, RoR::SCRIPTRETCODE_AS_ILLEGAL_BEHAVIOUR_FOR_TYPE = AngelScript::asILLEGAL_BEHAVIOUR_FOR_TYPE, RoR::SCRIPTRETCODE_AS_WRONG_CALLING_CONV = AngelScript::asWRONG_CALLING_CONV, RoR::SCRIPTRETCODE_AS_BUILD_IN_PROGRESS = AngelScript::asBUILD_IN_PROGRESS, RoR::SCRIPTRETCODE_AS_INIT_GLOBAL_VARS_FAILED = AngelScript::asINIT_GLOBAL_VARS_FAILED, RoR::SCRIPTRETCODE_AS_OUT_OF_MEMORY = AngelScript::asOUT_OF_MEMORY, RoR::SCRIPTRETCODE_AS_MODULE_IS_IN_USE = AngelScript::asMODULE_IS_IN_USE, RoR::SCRIPTRETCODE_UNSPECIFIED_ERROR = -1001, RoR::SCRIPTRETCODE_ENGINE_NOT_CREATED = -1002, RoR::SCRIPTRETCODE_CONTEXT_NOT_CREATED = -1003, RoR::SCRIPTRETCODE_SCRIPTUNIT_NOT_EXISTS = -1004, RoR::SCRIPTRETCODE_SCRIPTUNIT_NO_MODULE = -1005, RoR::SCRIPTRETCODE_FUNCTION_NOT_EXISTS = -1006 }
	Common return codes for script manipulation funcs (add/get/delete \| funcs/variables) More...

Functions
void	RoR::RegisterActor (AngelScript::asIScriptEngine *engine)
	defined in ActorAngelscript.cpp More...

void	RoR::RegisterVehicleAi (AngelScript::asIScriptEngine *engine)
	defined in VehicleAiAngelscript.cpp More...

void	RoR::RegisterInputEngine (AngelScript::asIScriptEngine *engine)
	Registers RoR::InputEngine, defined in InputEngineAngelscript.cpp. More...

void	RoR::RegisterConsole (AngelScript::asIScriptEngine *engine)
	Registers RoR::Console, defined in ConsoleAngelscript.cpp. More...

void	RoR::RegisterLocalStorage (AngelScript::asIScriptEngine *engine)
	Registers RoR::LocalStorage, defined in LocalStorageAngelscript.cpp. More...

void	RoR::RegisterGameScript (AngelScript::asIScriptEngine *engine)
	Registers RoR::GameScript, defined in GameScriptAngelscript.cpp. More...

void	RoR::RegisterScriptEvents (AngelScript::asIScriptEngine *engine)
	Registers enum scriptEvents, defined in ScriptEventsAngelscript.cpp. More...

void	RoR::RegisterImGuiBindings (AngelScript::asIScriptEngine *engine)
	defined in ImGuiAngelscript.cpp More...

void	RoR::RegisterOgreObjects (AngelScript::asIScriptEngine *engine)
	defined in OgreAngelscript.cpp More...

void	RoR::RegisterTerrain (AngelScript::asIScriptEngine *engine)
	Registers RoR::Terrain, defined in TerrainAngelscript.cpp. More...

void	RoR::RegisterProceduralRoad (AngelScript::asIScriptEngine *engine)
	defined in ProceduralRoadAngelscript.cpp More...

void	RoR::RegisterGenericFileFormat (AngelScript::asIScriptEngine *engine)
	defined in GenericFileFormatAngelscript.cpp More...

void	RoR::RegisterMessageQueue (AngelScript::asIScriptEngine *engine)
	Registers enum MsgType, defined in MsgQueueAngelscript.cpp. More...

void	RoR::RegisterSoundScript (AngelScript::asIScriptEngine *engine)
	defined in SoundScriptAngelscript.cpp More...

void	RoR::RegisterCacheSystem (AngelScript::asIScriptEngine *engine)
	defined in CacheSystemAngelscript.cpp More...

void	RoR::RegisterEngine (AngelScript::asIScriptEngine *engine)
	Register class Engine and related enums, defined in EngineAngelscript.cpp. More...

void	RoR::TRIGGER_EVENT_ASYNC (scriptEvents type, int arg1, int arg2ex=0, int arg3ex=0, int arg4ex=0, std::string arg5ex="", std::string arg6ex="", std::string arg7ex="", std::string arg8ex="")
	Asynchronously (via `MSG_SIM_SCRIPT_EVENT_TRIGGERED`) invoke script function `eventCallbackEx()`, if registered, otherwise fall back to `eventCallback()` More...

const char *	RoR::ScriptCategoryToString (ScriptCategory c)

template<typename T >
AngelScript::CScriptArray *	RoR::VectorToScriptArray (const std::vector< T > &vec, const std::string &decl)

template<typename T , typename U >
AngelScript::CScriptArray *	RoR::MapToScriptArray (std::map< T, U > &map, const std::string &decl)

template<typename ItorT >
AngelScript::CScriptArray *	RoR::IterableMapToScriptArray (ItorT begin, ItorT end, const std::string &decl)

template<typename ItorT >
AngelScript::CScriptArray *	RoR::IterableListToScriptArray (ItorT begin, ItorT end, const std::string &decl)

template<typename T >
bool	RoR::GetValueFromScriptDict (const std::string &log_msg, AngelScript::CScriptDictionary dict, bool required, std::string const &key, const char decl, T &out_value)

template<class A , class B >
B *	RoR::ScriptRefCast (A *a)

template<class A , class B >
B *	RoR::ScriptRefCastNoCount (A *a)

Variables
const GetFuncFlags_t	RoR::GETFUNCFLAG_OPTIONAL = 0
	Only logs warning if candidate is found, to help modder find a typo. More...

const GetFuncFlags_t	RoR::GETFUNCFLAG_REQUIRED = BITMASK(1)
	Always logs warning that function was not found. More...

const GetFuncFlags_t	RoR::GETFUNCFLAG_SILENT = BITMASK(2)
	Never logs. More...

const std::string	RoR::GETFUNC_DEFAULTEVENTCALLBACK_SIGFMT = "void {}(int, string, string, int)"

const std::string	RoR::GETFUNC_DEFAULTEVENTCALLBACK_NAME = "defaultEventCallback"

Detailed Description

Game scripting subsystem using AngelScript.

Typedef Documentation

◆ GetFuncFlags_t

typedef BitMask_t RoR::GetFuncFlags_t

Flags for RoR::ScriptEngine::getFunctionByDeclAndLogCandidates()

Definition at line 108 of file ScriptEngine.h.

◆ ScriptUnitMap

typedef std::map<ScriptUnitID_t, ScriptUnit> RoR::ScriptUnitMap

Definition at line 90 of file ScriptEngine.h.

Enumeration Type Documentation

◆ ScriptCategory

enum RoR::ScriptCategory

strong

Note: Either of these can be loaded from script using game.pushMessage(MSG_APP_LOAD_SCRIPT_REQUESTED...)

Enumerator
INVALID
ACTOR	Defined in truck file under 'scripts', contains global variable `BeamClass@ thisActor`.
TERRAIN	Defined in terrn2 file under '[Scripts]', receives terrain eventbox notifications.
GADGET	Associated with a .gadget mod file, launched via UI or any method given below for CUSTOM scripts (use .gadget suffix - game will fix up category to `GADGET`).
CUSTOM	Loaded by user via either: A) ingame console 'loadscript'; B) RoR.cfg 'app_custom_scripts'; C) commandline '-runscript'; If used with .gadget file, game will fix up category to `GADGET`.

Definition at line 58 of file ScriptEngine.h.

◆ ScriptRetCode

enum RoR::ScriptRetCode

Common return codes for script manipulation funcs (add/get/delete | funcs/variables)

Enumerator
SCRIPTRETCODE_SUCCESS
SCRIPTRETCODE_AS_ERROR
SCRIPTRETCODE_AS_CONTEXT_ACTIVE
SCRIPTRETCODE_AS_CONTEXT_NOT_FINISHED
SCRIPTRETCODE_AS_CONTEXT_NOT_PREPARED
SCRIPTRETCODE_AS_INVALID_ARG
SCRIPTRETCODE_AS_NO_FUNCTION
SCRIPTRETCODE_AS_NOT_SUPPORTED
SCRIPTRETCODE_AS_INVALID_NAME
SCRIPTRETCODE_AS_NAME_TAKEN
SCRIPTRETCODE_AS_INVALID_DECLARATION
SCRIPTRETCODE_AS_INVALID_OBJECT
SCRIPTRETCODE_AS_INVALID_TYPE
SCRIPTRETCODE_AS_ALREADY_REGISTERED
SCRIPTRETCODE_AS_MULTIPLE_FUNCTIONS
SCRIPTRETCODE_AS_NO_MODULE
SCRIPTRETCODE_AS_NO_GLOBAL_VAR
SCRIPTRETCODE_AS_INVALID_CONFIGURATION
SCRIPTRETCODE_AS_INVALID_INTERFACE
SCRIPTRETCODE_AS_CANT_BIND_ALL_FUNCTIONS
SCRIPTRETCODE_AS_LOWER_ARRAY_DIMENSION_NOT_REGISTERED
SCRIPTRETCODE_AS_WRONG_CONFIG_GROUP
SCRIPTRETCODE_AS_CONFIG_GROUP_IS_IN_USE
SCRIPTRETCODE_AS_ILLEGAL_BEHAVIOUR_FOR_TYPE
SCRIPTRETCODE_AS_WRONG_CALLING_CONV
SCRIPTRETCODE_AS_BUILD_IN_PROGRESS
SCRIPTRETCODE_AS_INIT_GLOBAL_VARS_FAILED
SCRIPTRETCODE_AS_OUT_OF_MEMORY
SCRIPTRETCODE_AS_MODULE_IS_IN_USE
SCRIPTRETCODE_UNSPECIFIED_ERROR
SCRIPTRETCODE_ENGINE_NOT_CREATED
SCRIPTRETCODE_CONTEXT_NOT_CREATED
SCRIPTRETCODE_SCRIPTUNIT_NOT_EXISTS
SCRIPTRETCODE_SCRIPTUNIT_NO_MODULE
SCRIPTRETCODE_FUNCTION_NOT_EXISTS

Definition at line 118 of file ScriptEngine.h.

Function Documentation

◆ GetValueFromScriptDict()

template<typename T >

bool RoR::GetValueFromScriptDict	(	const std::string &	log_msg,
		AngelScript::CScriptDictionary *	dict,
		bool	required,
		std::string const &	key,
		const char *	decl,
		T &	out_value
	)

Definition at line 109 of file ScriptUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IterableListToScriptArray()

template<typename ItorT >

AngelScript::CScriptArray* RoR::IterableListToScriptArray	(	ItorT	begin,
		ItorT	end,
		const std::string &	decl
	)

Definition at line 94 of file ScriptUtils.h.

Here is the call graph for this function:

◆ IterableMapToScriptArray()

template<typename ItorT >

AngelScript::CScriptArray* RoR::IterableMapToScriptArray	(	ItorT	begin,
		ItorT	end,
		const std::string &	decl
	)

Definition at line 79 of file ScriptUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MapToScriptArray()

template<typename T , typename U >

AngelScript::CScriptArray* RoR::MapToScriptArray	(	std::map< T, U > &	map,
		const std::string &	decl
	)

Definition at line 60 of file ScriptUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterActor()

void RoR::RegisterActor ( AngelScript::asIScriptEngine * engine )

defined in ActorAngelscript.cpp

Here is the caller graph for this function:

◆ RegisterCacheSystem()

void RoR::RegisterCacheSystem ( AngelScript::asIScriptEngine * engine )

defined in CacheSystemAngelscript.cpp

Here is the caller graph for this function:

◆ RegisterConsole()

void RoR::RegisterConsole ( AngelScript::asIScriptEngine * engine )

Registers RoR::Console, defined in ConsoleAngelscript.cpp.

Here is the caller graph for this function:

◆ RegisterEngine()

void RoR::RegisterEngine ( AngelScript::asIScriptEngine * engine )

Register class Engine and related enums, defined in EngineAngelscript.cpp.

Here is the caller graph for this function:

◆ RegisterGameScript()

void RoR::RegisterGameScript ( AngelScript::asIScriptEngine * engine )

Registers RoR::GameScript, defined in GameScriptAngelscript.cpp.

Here is the caller graph for this function:

◆ RegisterGenericFileFormat()

void RoR::RegisterGenericFileFormat ( AngelScript::asIScriptEngine * engine )

defined in GenericFileFormatAngelscript.cpp

Here is the caller graph for this function:

◆ RegisterImGuiBindings()

void RoR::RegisterImGuiBindings ( AngelScript::asIScriptEngine * engine )

defined in ImGuiAngelscript.cpp

Definition at line 53 of file ImGuiAngelscript.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterInputEngine()

void RoR::RegisterInputEngine ( AngelScript::asIScriptEngine * engine )

Registers RoR::InputEngine, defined in InputEngineAngelscript.cpp.

Here is the caller graph for this function:

◆ RegisterLocalStorage()

void RoR::RegisterLocalStorage ( AngelScript::asIScriptEngine * engine )

Registers RoR::LocalStorage, defined in LocalStorageAngelscript.cpp.

Here is the caller graph for this function:

◆ RegisterMessageQueue()

void RoR::RegisterMessageQueue ( AngelScript::asIScriptEngine * engine )

Registers enum MsgType, defined in MsgQueueAngelscript.cpp.

Here is the caller graph for this function:

◆ RegisterOgreObjects()

void RoR::RegisterOgreObjects ( AngelScript::asIScriptEngine * engine )

defined in OgreAngelscript.cpp

Definition at line 683 of file OgreAngelscript.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterProceduralRoad()

void RoR::RegisterProceduralRoad ( AngelScript::asIScriptEngine * engine )

defined in ProceduralRoadAngelscript.cpp

Here is the caller graph for this function:

◆ RegisterScriptEvents()

void RoR::RegisterScriptEvents ( AngelScript::asIScriptEngine * engine )

Registers enum scriptEvents, defined in ScriptEventsAngelscript.cpp.

Here is the caller graph for this function:

◆ RegisterSoundScript()

void RoR::RegisterSoundScript ( AngelScript::asIScriptEngine * engine )

defined in SoundScriptAngelscript.cpp

Definition at line 30 of file SoundScriptAngelscript.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterTerrain()

void RoR::RegisterTerrain ( AngelScript::asIScriptEngine * engine )

Registers RoR::Terrain, defined in TerrainAngelscript.cpp.

Here is the caller graph for this function:

◆ RegisterVehicleAi()

void RoR::RegisterVehicleAi ( AngelScript::asIScriptEngine * engine )

defined in VehicleAiAngelscript.cpp

Here is the caller graph for this function:

◆ ScriptCategoryToString()

const char * RoR::ScriptCategoryToString ( ScriptCategory c )

Definition at line 66 of file ScriptEngine.cpp.

Here is the caller graph for this function:

◆ ScriptRefCast()

template<class A , class B >

B* RoR::ScriptRefCast ( A * a )

Definition at line 270 of file ScriptUtils.h.

◆ ScriptRefCastNoCount()

template<class A , class B >

B* RoR::ScriptRefCastNoCount ( A * a )

Definition at line 287 of file ScriptUtils.h.

◆ TRIGGER_EVENT_ASYNC()

void RoR::TRIGGER_EVENT_ASYNC	(	scriptEvents	type,
		int	arg1,
		int	arg2ex = `0`,
		int	arg3ex = `0`,
		int	arg4ex = `0`,
		std::string	arg5ex = `""`,
		std::string	arg6ex = `""`,
		std::string	arg7ex = `""`,
		std::string	arg8ex = `""`
	)

inline

Asynchronously (via MSG_SIM_SCRIPT_EVENT_TRIGGERED) invoke script function eventCallbackEx(), if registered, otherwise fall back to eventCallback()

Definition at line 51 of file ScriptEngine.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VectorToScriptArray()

template<typename T >

AngelScript::CScriptArray* RoR::VectorToScriptArray	(	const std::vector< T > &	vec,
		const std::string &	decl
	)

Definition at line 43 of file ScriptUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ GETFUNC_DEFAULTEVENTCALLBACK_NAME

const std::string RoR::GETFUNC_DEFAULTEVENTCALLBACK_NAME = "defaultEventCallback"

Definition at line 115 of file ScriptEngine.h.

◆ GETFUNC_DEFAULTEVENTCALLBACK_SIGFMT

const std::string RoR::GETFUNC_DEFAULTEVENTCALLBACK_SIGFMT = "void {}(int, string, string, int)"

Definition at line 114 of file ScriptEngine.h.

◆ GETFUNCFLAG_OPTIONAL

const GetFuncFlags_t RoR::GETFUNCFLAG_OPTIONAL = 0

Only logs warning if candidate is found, to help modder find a typo.

Definition at line 109 of file ScriptEngine.h.

◆ GETFUNCFLAG_REQUIRED

const GetFuncFlags_t RoR::GETFUNCFLAG_REQUIRED = BITMASK(1)

Always logs warning that function was not found.

Definition at line 110 of file ScriptEngine.h.

◆ GETFUNCFLAG_SILENT

const GetFuncFlags_t RoR::GETFUNCFLAG_SILENT = BITMASK(2)

Never logs.

Definition at line 111 of file ScriptEngine.h.

Data Structures

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ GetFuncFlags_t

◆ ScriptUnitMap

Enumeration Type Documentation

◆ ScriptCategory

◆ ScriptRetCode

Function Documentation

◆ GetValueFromScriptDict()

◆ IterableListToScriptArray()

◆ IterableMapToScriptArray()

◆ MapToScriptArray()

◆ RegisterActor()

◆ RegisterCacheSystem()

◆ RegisterConsole()

◆ RegisterEngine()

◆ RegisterGameScript()

◆ RegisterGenericFileFormat()

◆ RegisterImGuiBindings()

◆ RegisterInputEngine()

◆ RegisterLocalStorage()

◆ RegisterMessageQueue()

◆ RegisterOgreObjects()

◆ RegisterProceduralRoad()

◆ RegisterScriptEvents()

◆ RegisterSoundScript()

◆ RegisterTerrain()

◆ RegisterVehicleAi()

◆ ScriptCategoryToString()

◆ ScriptRefCast()

◆ ScriptRefCastNoCount()

◆ TRIGGER_EVENT_ASYNC()

◆ VectorToScriptArray()

Variable Documentation

◆ GETFUNC_DEFAULTEVENTCALLBACK_NAME

◆ GETFUNC_DEFAULTEVENTCALLBACK_SIGFMT

◆ GETFUNCFLAG_OPTIONAL

◆ GETFUNCFLAG_REQUIRED

◆ GETFUNCFLAG_SILENT