![]() |
Rigs of Rods 2026.01
Soft-body Physics Simulation
|
Game scripting subsystem using AngelScript.
Data Structures | |
| class | RoR::GameScript |
| class | RoR::LocalStorage |
| class | OgreScriptBuilder |
| struct | RoR::ScriptUnit |
| struct | RoR::LoadScriptRequest |
| struct | RoR::ScriptCallbackArgs |
| class | RoR::ScriptEngine |
| class | RoR::CReadonlyScriptDictView< T > |
| class | RoR::CReadonlyScriptArrayView< T > |
Typedefs | |
| typedef std::map< ScriptUnitID_t, ScriptUnit > | RoR::ScriptUnitMap |
| typedef BitMask_t | RoR::GetFuncFlags_t |
Enumerations | |
| enum class | RoR::ScriptCategory |
| enum | RoR::ScriptRetCode |
Functions | |
| void | RoR::RegisterActorCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterActorNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterActorGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterActor (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterVehicleAiCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterVehicleAiNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterVehicleAiGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterVehicleAi (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterInputEngineCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterInputEngineNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterInputEngineGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterInputEngine (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterConsoleCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterConsoleNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterConsoleGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterConsole (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterLocalStorageNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterLocalStorageGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterLocalStorage (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterGameScriptCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterGameScriptNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterGameScriptGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterGameScript (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterScriptEventsCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterScriptEvents (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterImGuiCommonBindings (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterImGuiNativeBindings (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterImGuiGenericBindings (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterImGuiBindings (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterOgreObjectsCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterOgreObjectsNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterOgreObjectsGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterOgreObjects (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTerrainCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTerrainNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTerrainGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTerrain (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterProceduralRoadCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterProceduralRoadNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterProceduralRoadGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterProceduralRoad (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterGenericFileFormatCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterGenericFileFormatNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterGenericFileFormatGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterGenericFileFormat (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterMessageQueueCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterMessageQueue (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterSoundScriptCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterSoundScriptNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterSoundScriptGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterSoundScript (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterCacheSystemCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterCacheSystemNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterCacheSystemGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterCacheSystem (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterEngineCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterEngineNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterEngineGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterEngine (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterDashBoardManagerCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterDashBoardManagerNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterDashBoardManagerGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterDashBoardManager (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterAircraftEngineCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterAircraftEngineNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterAircraftEngineGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterAircraftEngine (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTurbopropNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTurbopropGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTurboprop (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTurbojetNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTurbojetGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterTurbojet (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterAutopilotCommon (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterAutopilotNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterAutopilotGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterAutopilot (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterScrewpropNative (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterScrewpropGeneric (AngelScript::asIScriptEngine *engine) |
| void | RoR::RegisterScrewprop (AngelScript::asIScriptEngine *engine) |
| 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="") |
| 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 |
| const GetFuncFlags_t | RoR::GETFUNCFLAG_REQUIRED = BITMASK(1) |
| const GetFuncFlags_t | RoR::GETFUNCFLAG_SILENT = BITMASK(2) |
| const std::string | RoR::GETFUNC_DEFAULTEVENTCALLBACK_SIGFMT = "void {}(int, string, string, int)" |
| const std::string | RoR::GETFUNC_DEFAULTEVENTCALLBACK_NAME = "defaultEventCallback" |
| typedef BitMask_t RoR::GetFuncFlags_t |
Flags for RoR::ScriptEngine::getFunctionByDeclAndLogCandidates()
Definition at line 110 of file ScriptEngine.h.
| typedef std::map<ScriptUnitID_t, ScriptUnit> RoR::ScriptUnitMap |
Definition at line 92 of file ScriptEngine.h.
|
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 |
| 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 |
| AI_BOT | Only valid under |
| 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 |
Definition at line 58 of file ScriptEngine.h.
| enum RoR::ScriptRetCode |
Common return codes for script manipulation funcs (add/get/delete | funcs/variables)
Definition at line 120 of file ScriptEngine.h.
| 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 110 of file ScriptUtils.h.
| AngelScript::CScriptArray * RoR::IterableListToScriptArray | ( | ItorT | begin, |
| ItorT | end, | ||
| const std::string & | decl | ||
| ) |
Definition at line 95 of file ScriptUtils.h.
| AngelScript::CScriptArray * RoR::IterableMapToScriptArray | ( | ItorT | begin, |
| ItorT | end, | ||
| const std::string & | decl | ||
| ) |
Definition at line 80 of file ScriptUtils.h.
| AngelScript::CScriptArray * RoR::MapToScriptArray | ( | std::map< T, U > & | map, |
| const std::string & | decl | ||
| ) |
Definition at line 61 of file ScriptUtils.h.
|
inline |
Definition at line 52 of file AngelScriptBindings.h.
| void RoR::RegisterActorCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
defined in ActorAngelscript.cpp
| void RoR::RegisterActorGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterActorNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 223 of file AngelScriptBindings.h.
| void RoR::RegisterAircraftEngineCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterAircraftEngineGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterAircraftEngineNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 249 of file AngelScriptBindings.h.
| void RoR::RegisterAutopilotCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterAutopilotGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterAutopilotNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 193 of file AngelScriptBindings.h.
| void RoR::RegisterCacheSystemCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
defined in CacheSystemAngelscript.cpp
| void RoR::RegisterCacheSystemGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterCacheSystemNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 82 of file AngelScriptBindings.h.
| void RoR::RegisterConsoleCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
Registers RoR::Console, defined in ConsoleAngelscript.cpp.
| void RoR::RegisterConsoleGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterConsoleNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 213 of file AngelScriptBindings.h.
| void RoR::RegisterDashBoardManagerCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterDashBoardManagerGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterDashBoardManagerNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 203 of file AngelScriptBindings.h.
| void RoR::RegisterEngineCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
Register class Engine and related enums, defined in EngineAngelscript.cpp.
| void RoR::RegisterEngineGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterEngineNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 100 of file AngelScriptBindings.h.
| void RoR::RegisterGameScriptCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
Registers RoR::GameScript, defined in GameScriptAngelscript.cpp.
| void RoR::RegisterGameScriptGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterGameScriptNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 165 of file AngelScriptBindings.h.
| void RoR::RegisterGenericFileFormatCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
defined in GenericFileFormatAngelscript.cpp
| void RoR::RegisterGenericFileFormatGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterGenericFileFormatNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 118 of file AngelScriptBindings.h.
| void RoR::RegisterImGuiCommonBindings | ( | AngelScript::asIScriptEngine * | engine | ) |
defined in ImGuiAngelscript.cpp
Definition at line 32 of file ImGuiAngelscriptCommon.cpp.
| void RoR::RegisterImGuiGenericBindings | ( | AngelScript::asIScriptEngine * | engine | ) |
Definition at line 39 of file ImGuiAngelscriptGeneric.cpp.
| void RoR::RegisterImGuiNativeBindings | ( | AngelScript::asIScriptEngine * | engine | ) |
Definition at line 42 of file ImGuiAngelscript.cpp.
|
inline |
Definition at line 72 of file AngelScriptBindings.h.
| void RoR::RegisterInputEngineCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
Registers RoR::InputEngine, defined in InputEngineAngelscript.cpp.
| void RoR::RegisterInputEngineGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterInputEngineNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 91 of file AngelScriptBindings.h.
| void RoR::RegisterLocalStorageGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterLocalStorageNative | ( | AngelScript::asIScriptEngine * | engine | ) |
Registers RoR::LocalStorage, defined in LocalStorageAngelscript.cpp.
|
inline |
Definition at line 174 of file AngelScriptBindings.h.
| void RoR::RegisterMessageQueueCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
Registers enums MsgType and FreeForceType, defined in MsgQueueAngelscriptCommon.cpp NOTE: only enums, nothing depends on calling convention - so there are no native/generic variants.
|
inline |
Definition at line 135 of file AngelScriptBindings.h.
| void RoR::RegisterOgreObjectsCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
defined in OgreAngelscript.cpp
| void RoR::RegisterOgreObjectsGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
Definition at line 183 of file OgreAngelscriptGeneric.cpp.
| void RoR::RegisterOgreObjectsNative | ( | AngelScript::asIScriptEngine * | engine | ) |
Definition at line 92 of file OgreAngelscript.cpp.
|
inline |
Definition at line 155 of file AngelScriptBindings.h.
| void RoR::RegisterProceduralRoadCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
defined in ProceduralRoadAngelscript.cpp
| void RoR::RegisterProceduralRoadGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterProceduralRoadNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 258 of file AngelScriptBindings.h.
| void RoR::RegisterScrewpropGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterScrewpropNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 109 of file AngelScriptBindings.h.
| void RoR::RegisterScriptEventsCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
Registers enum scriptEvents and related enums, defined in ScriptEventsAngelscriptCommon.cpp NOTE: only enums, nothing depends on calling convention - so there are no native/generic variants.
|
inline |
Definition at line 183 of file AngelScriptBindings.h.
| void RoR::RegisterSoundScriptCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
defined in SoundScriptAngelscript.cpp
Definition at line 31 of file SoundScriptAngelscriptCommon.cpp.
| void RoR::RegisterSoundScriptGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
Definition at line 34 of file SoundScriptAngelscriptGeneric.cpp.
| void RoR::RegisterSoundScriptNative | ( | AngelScript::asIScriptEngine * | engine | ) |
Definition at line 33 of file SoundScriptAngelscript.cpp.
|
inline |
Definition at line 145 of file AngelScriptBindings.h.
| void RoR::RegisterTerrainCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
Registers RoR::Terrain, defined in TerrainAngelscript.cpp.
| void RoR::RegisterTerrainGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterTerrainNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 240 of file AngelScriptBindings.h.
| void RoR::RegisterTurbojetGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterTurbojetNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 232 of file AngelScriptBindings.h.
| void RoR::RegisterTurbopropGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterTurbopropNative | ( | AngelScript::asIScriptEngine * | engine | ) |
|
inline |
Definition at line 62 of file AngelScriptBindings.h.
| void RoR::RegisterVehicleAiCommon | ( | AngelScript::asIScriptEngine * | engine | ) |
defined in VehicleAiAngelscript.cpp
| void RoR::RegisterVehicleAiGeneric | ( | AngelScript::asIScriptEngine * | engine | ) |
| void RoR::RegisterVehicleAiNative | ( | AngelScript::asIScriptEngine * | engine | ) |
| const char * RoR::ScriptCategoryToString | ( | ScriptCategory | c | ) |
Definition at line 68 of file ScriptEngine.cpp.
| B * RoR::ScriptRefCast | ( | A * | a | ) |
Definition at line 311 of file ScriptUtils.h.
| B * RoR::ScriptRefCastNoCount | ( | A * | a | ) |
Definition at line 328 of file ScriptUtils.h.
|
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.
| AngelScript::CScriptArray * RoR::VectorToScriptArray | ( | const std::vector< T > & | vec, |
| const std::string & | decl | ||
| ) |
Definition at line 44 of file ScriptUtils.h.
| const std::string RoR::GETFUNC_DEFAULTEVENTCALLBACK_NAME = "defaultEventCallback" |
Definition at line 117 of file ScriptEngine.h.
| const std::string RoR::GETFUNC_DEFAULTEVENTCALLBACK_SIGFMT = "void {}(int, string, string, int)" |
Definition at line 116 of file ScriptEngine.h.
| const GetFuncFlags_t RoR::GETFUNCFLAG_OPTIONAL = 0 |
Only logs warning if candidate is found, to help modder find a typo.
Definition at line 111 of file ScriptEngine.h.
| const GetFuncFlags_t RoR::GETFUNCFLAG_REQUIRED = BITMASK(1) |
Always logs warning that function was not found.
Definition at line 112 of file ScriptEngine.h.
| const GetFuncFlags_t RoR::GETFUNCFLAG_SILENT = BITMASK(2) |
Never logs.
Definition at line 113 of file ScriptEngine.h.