Added methods to Add and Remove scripts (primarily for lua purposes) and to Enable and Disable scripts, and check if a script is Enabled. Enabling and Disabling preserves script ordering and is faster to do than reloading the full script. All scripts, enabled or disabled, will always run their create function when they're added (if other create functions have been run already) or when create functions are normally run.

Added lua bindings for these methods, and helper luaman method for running script functions.

Author: garethyr

Entities/MovableObject.cpp

@@ -14,6 +14,7 @@
 #include "MovableObject.h"
 #include "PresetMan.h"
 #include "SceneMan.h"
+#include "ConsoleMan.h"
 #include "SettingsMan.h"
 #include "LuaMan.h"
 #include "Atom.h"
@@ -556,11 +557,79 @@ int MovableObject::ReloadScripts() {
 
     return status;
 }
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+bool MovableObject::AddScript(std::string const &scriptPath) {
+    switch (LoadScript(scriptPath)) {
+        case 0:
+            // If we have a ScriptObjectName that means Create has already been run for pre-existing scripts. Run it right away for this one.
+            if (!m_ScriptObjectName.empty() &&g_LuaMan.RunFunctionInPresetScript("Create", scriptPath, m_ScriptPresetName, m_ScriptObjectName) < 0) {
+                g_ConsoleMan.PrintString("ERROR: Failed to run Create function for newly added script with path " + scriptPath);
+                return false;
+            }
+            return true;
+        case -1:
+            g_ConsoleMan.PrintString("ERROR: The script path was empty.");
+            break;
+        case -2:
+            g_ConsoleMan.PrintString("ERROR: The script path " + scriptPath + " is already loaded onto this object.");
+            break;
+        case -3:
+            g_ConsoleMan.PrintString("ERROR: Failed to do necessary setup to add scripts while attempting to add the script with path " + scriptPath + ". This has nothing to do with your script, please report it to a developer.");
+            break;
+        default:
+            RTEAbort("Reached default case while adding script. This should never happen!");
+            break;
+    }
+    return false;
+}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+bool MovableObject::RemoveScript(std::string const &scriptPath) {
+    auto scriptEntryIterator = FindScript(scriptPath);
+    if (scriptEntryIterator != m_LoadedScripts.end()) {
+        m_LoadedScripts.erase(scriptEntryIterator);
+        return true;
+    }
+    return false;
+}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+bool MovableObject::EnableScript(std::string const &scriptPath) {
+    auto scriptEntryIterator = FindScript(scriptPath);
+    if (scriptEntryIterator != m_LoadedScripts.end() && scriptEntryIterator->second == false) {
+        scriptEntryIterator->second = true;
+
+        if (g_LuaMan.RunFunctionInPresetScript("OnEnableScript", scriptPath, m_ScriptPresetName, m_ScriptObjectName) < 0) {
+            g_ConsoleMan.PrintString("ERROR: Failed to run OnEnableScript function for newly enabled script with path " + scriptPath);
+            return false;
+        }
+        return true;
     }
+    return false;
+}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+bool MovableObject::DisableScript(std::string const &scriptPath) {
+    auto scriptEntryIterator = FindScript(scriptPath);
+    if (scriptEntryIterator != m_LoadedScripts.end() && scriptEntryIterator->second == true) {
+        scriptEntryIterator->second = false;
 
-    return error;
+        if (g_LuaMan.RunFunctionInPresetScript("OnDisableScript", scriptPath, m_ScriptPresetName, m_ScriptObjectName) < 0) {
+            g_ConsoleMan.PrintString("ERROR: Failed to run OnDisableScript function for newly disabled script with path " + scriptPath);
+            return false;
+        }
+        return true;
+    }
+    return false;
 }
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
 /*
 //////////////////////////////////////////////////////////////////////////////////////////
 // Constructor:     MovableObject

Entities/MovableObject.h

@@ -206,8 +206,40 @@ ENTITYALLOCATION(MovableObject)
     /// <returns>Whether or not the script is on this MO.</returns>
     virtual bool const HasScript(std::string const &scriptPath) { return FindScript(scriptPath) != m_LoadedScripts.end(); }
 
+    /// <summary>
+    /// Adds the script at the given path as one of the scripts on this MO.
+    /// </summary>
+    /// <param name="scriptPath">The path to the script to add.</param>
+    /// <returns>Whether or not the script was successfully added.</returns>
+    virtual bool AddScript(std::string const &scriptPath);
 
+    /// <summary>
+    /// Removes the script at the given path so it will no longer be one of the scripts on this MO.
+    /// </summary>
+    /// <param name="scriptPath">The path to the script to remove.</param>
+    /// <returns>Whether or not the script was successfully removed.</returns>
+    virtual bool RemoveScript(std::string const &scriptPath);
 
+    /// <summary>
+    /// Checks if the script at the given path is one of the enabled scripts on this MO.
+    /// </summary>
+    /// <param name="scriptPath">The path to the script to check.</param>
+    /// <returns>Whether or not the script is enabled on this MO.</returns>
+    virtual bool const ScriptEnabled(std::string const &scriptPath) { auto scriptIterator = FindScript(scriptPath); return scriptIterator != m_LoadedScripts.end() && scriptIterator->second == true; }
+
+    /// <summary>
+    /// Enable the script at the given path on this MO.
+    /// </summary>
+    /// <param name="scriptPath">The path to the script to enable.</param>
+    /// <returns>Whether or not the script was succesfully enabled.</returns>
+    virtual bool EnableScript(std::string const &scriptPath);
+
+    /// <summary>
+    /// Disables the script at the given path for this MO.
+    /// </summary>
+    /// <param name="scriptPath">The path to the script to disable.</param>
+    /// <returns>Whether or not the script was succesfully disabled..</returns>
+    virtual bool DisableScript(std::string const &scriptPath);
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Virtual method:  GetClass

Managers/LuaMan.cpp

@@ -584,6 +584,12 @@ int LuaMan::Create()
         ABSTRACTLUABINDING(MovableObject, SceneObject)
 			.property("Material", &MovableObject::GetMaterial)
 			.def("ReloadScripts", &MovableObject::ReloadScripts)
+            .def("HasScript", &MovableObject::HasScript)
+            .def("AddScript", &MovableObject::AddScript)
+            .def("RemoveScript", &MovableObject::RemoveScript)
+            .def("ScriptEnabled", &MovableObject::ScriptEnabled)
+            .def("EnableScript", &MovableObject::EnableScript)
+            .def("DisableScript", &MovableObject::DisableScript)
             .property("Mass", &MovableObject::GetMass, &MovableObject::SetMass)
             .property("Pos", &MovableObject::GetPos, &MovableObject::SetPos)
             .property("Vel", &MovableObject::GetVel, &MovableObject::SetVel)
@@ -2413,6 +2419,18 @@ bool LuaMan::ExpressionIsTrue(string expression, bool consoleErrors)
     return result;
 }
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+int LuaMan::RunFunctionInPresetScript(std::string const &functionName, std::string const &scriptPath, std::string const &presetLuaInstanceName, std::string const &objectLuaInstanceName) {
+    std::string presetAndFunctionName = presetLuaInstanceName + "." + functionName;
+    return RunScriptString(
+        "if " + presetAndFunctionName + " and " + objectLuaInstanceName + " then " +
+            presetAndFunctionName + "[\""+scriptPath+"\"](" + objectLuaInstanceName + "); " +
+        "end"
+    );
+}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Method:          RunScriptString