Created vehicle tuning GUI using new .addonpart mod type

doc/angelscript/Script2Game/GenericDocReaderClass.h → doc/angelscript/Script2Game/GenericDocContextClass.h

@@ -20,13 +20,13 @@ enum TokenType
 };
 
 /**
- * @brief Binding of RoR::GenericDocReader; Traverses document tokens; See 'demo_script.as' for an example.
+ * @brief Binding of RoR::GenericDocContext; Traverses document tokens; See 'demo_script.as' for an example.
  */
-class GenericDocReaderClass
+class GenericDocContextClass
 {
     // PLEASE maintain the same order as in 'GenericFileFormat.h' and 'GenericFileFormatAngelscript.cpp'
 
-    GenericDocReader(GenericDocumentPtr@ d);
+    GenericDocContext(GenericDocumentPtr@ d);
 
     bool moveNext();
     uint getPos();
@@ -46,6 +46,18 @@ class GenericDocReaderClass
     bool isTokBool(int offset = 0);
     bool isTokKeyword(int offset = 0);
     bool isTokComment(int offset = 0);
+
+    // Editing functions:
+
+    bool insertToken(int offset = 0); //!< Inserts `TokenType::NONE`; @return false if offset is beyond EOF
+    bool eraseToken(int offset = 0); //!< @return false if offset is beyond EOF
+
+    bool setTokString(int offset, const string&in str);
+    bool setTokFloat(int offset, float val);
+    bool setTokBool(int offset, bool val);
+    bool setTokKeyword(int offset, const string&in str);
+    bool setTokComment(int offset, const string&in str);
+    bool setTokLineBreak(int offset);
 };
 
 /// @}    //addtogroup Script2Game

doc/angelscript/Script2Game/globals.h

@@ -67,23 +67,27 @@ void print(const string message);
     SE_TRUCK_TELEPORT                  //!< triggered when the user teleports the truck, the argument refers to the Actor Instance ID (use `game.getTruckByNum()`)
     SE_TRUCK_MOUSE_GRAB                //!< triggered when the user uses the mouse to interact with the actor, the argument refers to the Actor Instance ID (use `game.getTruckByNum()`)
 
- 	SE_ANGELSCRIPT_MANIPULATIONS       //!< triggered when the user tries to dynamically use the scripting capabilities (prevent cheating)
+    SE_ANGELSCRIPT_MANIPULATIONS       //!< triggered when the user tries to dynamically use the scripting capabilities (prevent cheating) args: #1 angelScriptManipulationType, #2 ScriptUnitId_t, #3 RoR::ScriptCategory, #4 unused, #5 script file name (*.as), #6 associated file name (i.e. *.mission), #7 associated file resource group (i.e. *.mission).
     SE_ANGELSCRIPT_MSGCALLBACK         //!< The diagnostic info directly from AngelScript engine (see `asSMessageInfo`), args: #1 ScriptUnitID, #2 asEMsgType, #3 row, #4 col, #5 sectionName, #6 message
     SE_ANGELSCRIPT_LINECALLBACK        //!< The diagnostic info directly from AngelScript engine (see `SetLineCallback()`), args: #1 ScriptUnitID, #2 LineNumber, #3 CallstackSize, #4 unused, #5 FunctionName, #6 FunctionObjectTypeName #7 ObjectName
     SE_ANGELSCRIPT_EXCEPTIONCALLBACK   //!< The diagnostic info directly from AngelScript engine (see `SetExceptionCallback()`), args: #1 ScriptUnitID, #2 unused, #3 row (`GetExceptionLineNumber()`), #4 unused, #5 funcName, #6 message (`GetExceptionString()`)
     SE_ANGELSCRIPT_THREAD_STATUS       //!< Sent by background threads (i.e. CURL) when there's something important (like finishing a download). args: #1 type, see `Script2Game::angelScriptThreadStatus`.    
 
  	SE_GENERIC_MESSAGEBOX_CLICK        //!< triggered when the user clicks on a message box button, the argument refers to the button pressed
+    SE_GENERIC_EXCEPTION_CAUGHT        //!< Triggered when C++ exception (usually Ogre::Exception) is thrown; #1 ScriptUnitID, #5 originFuncName, #6 type, #7 message.
+    SE_GENERIC_MODCACHE_ACTIVITY       //!< Triggered when status of modcache changes, args: #1 type, #2 entry number, for other args see `RoR::modCacheActivityType`    
 
  	SE_ALL_EVENTS                      = 0xffffffff,
+    SE_NO_EVENTS                       = 0
 
  };
 
+/// Argument #2 of script event `SE_ANGELSCRIPT_MANIPULATIONS`
 enum angelScriptManipulationType
 {
-    MANIP_CONSOLE_SNIPPET_EXECUTED = 0, // Backwards compat
-    MANIP_SCRIPT_LOADED,
-    MANIP_SCRIPT_UNLOADED
+    ASMANIP_CONSOLE_SNIPPET_EXECUTED = 0, // 0 for Backwards compatibility.
+    ASMANIP_SCRIPT_LOADED,                //!< Triggered after the script's `main()` completed; may trigger additional processing (for example, it delivers the *.mission file to mission system script).
+    ASMANIP_SCRIPT_UNLOADING              //!< Triggered before unloading the script to let it clean up (important for missions).
 };
 
 enum angelScriptThreadStatus
@@ -94,6 +98,19 @@ enum angelScriptThreadStatus
     ASTHREADSTATUS_CURLSTRING_FAILURE,  //!< Args of `RoR::SE_ANGELSCRIPT_THREAD_STATUS`: arg#1 type, arg#2 HTTP code, arg#3 CURLcode, arg#4 unused, arg#5 message from `curl_easy_strerror()`
 };
 
+/// Argument #2 of script event `RoR::SE_GENERIC_MODCACHE_ACTIVITY`
+enum modCacheActivityType
+{
+    MODCACHEACTIVITY_NONE,
+
+    MODCACHEACTIVITY_ENTRY_ADDED,      //!< Args of `RoR::SE_GENERIC_MODCACHE_NOTIFICATION`: #1 type, #2 entry number, --, --, #5 fname, #6 fext
+    MODCACHEACTIVITY_ENTRY_DELETED,    //!< Flagged as `deleted`, remains in memory until shared pointers expire; Args of `RoR::SE_GENERIC_MODCACHE_NOTIFICATION`: #1 type, #2 entry number, --, --, #5 fname, #6 fext
+
+    MODCACHEACTIVITY_BUNDLE_LOADED,    //!< Args of `RoR::SE_GENERIC_MODCACHE_NOTIFICATION`: #1 type, #2 entry number, --, --, #5 rg name
+    MODCACHEACTIVITY_BUNDLE_RELOADED,  //!< Args of `RoR::SE_GENERIC_MODCACHE_NOTIFICATION`: #1 type, #2 entry number, --, --, #5 rg name
+    MODCACHEACTIVITY_BUNDLE_UNLOADED   //!< Args of `RoR::SE_GENERIC_MODCACHE_NOTIFICATION`: #1 type, #2 entry number
+};
+
 enum inputEvents
 {
     EV_AIRPLANE_AIRBRAKES_FULL=0,
@@ -639,7 +656,10 @@ enum MsgType
     MSG_EDI_MODIFY_GROUNDMODEL_REQUESTED,      //!< Used by Friction UI, DO NOT PUSH MANUALLY.
     MSG_EDI_ENTER_TERRN_EDITOR_REQUESTED,      //!< No params.
     MSG_EDI_LEAVE_TERRN_EDITOR_REQUESTED,      //!< No params.
-    MSG_EDI_RELOAD_BUNDLE_REQUESTED,           //!< Used internally for full reload of terrain/actor from disk, DO NOT PUSH MANUALLY.
+    MSG_EDI_LOAD_BUNDLE_REQUESTED,             //!< Load a resource bundle (= ZIP or directory) for a given cache entry. Params: 'cache_entry' (CacheEntryClass@)
+    MSG_EDI_RELOAD_BUNDLE_REQUESTED,           //!< This deletes all actors using that bundle (= ZIP or directory)! Params: 'cache_entry' (CacheEntryClass@)
+    MSG_EDI_UNLOAD_BUNDLE_REQUESTED,           //!< This deletes all actors using that bundle (= ZIP or directory)! Params: 'cache_entry' (CacheEntryClass@)
+    MSG_EDI_CREATE_PROJECT_REQUESTED,          //!< Creates a subdir under 'projects/', pre-populates it and adds to modcache. Params: 'name' (string), 'ext' (string, optional), 'source_entry' (CacheEntryClass@)
 };
 
 } // namespace Script2Game

resources/scripts/demo_script.as

@@ -263,7 +263,7 @@ void drawTerrainButtons()
                 // Fetch TOBJ filenames
                 if (g_terrain_tobj_files.length() == 0)
                 {
-                    GenericDocReaderClass@ reader = GenericDocReaderClass(doc);
+                    GenericDocContextClass@ reader = GenericDocContextClass(doc);
                     bool in_section_objects = false;
                     while (!reader.endOfFile())
                     {
@@ -338,7 +338,7 @@ void drawDocumentWindow()
     string caption = "Document view (" + g_displayed_doc_filename + ")";
     ImGui::Begin(caption, /*open:*/true, /*flags:*/0);
 
-    GenericDocReaderClass reader(g_displayed_document);
+    GenericDocContextClass reader(g_displayed_document);
     while (!reader.endOfFile())
     {
         switch (reader.tokenType())