Updated Actor::LoadScript and UpdateAIScripted so they work with multiscripts

Added SupportedScriptFunctionNames with extra special one for for Actor so UpdateAI is handled
Missed LuaMan header change in last commit

Author: garethyr

Entities/Actor.cpp

@@ -487,41 +487,22 @@ void Actor::Destroy(bool notInherited)
     Clear();
 }
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-//////////////////////////////////////////////////////////////////////////////////////////
-// Virtual method:  LoadScripts
-//////////////////////////////////////////////////////////////////////////////////////////
-// Description:     Loads the preset scripts of this object, from a specified path.
-
-int Actor::LoadScripts(string scriptPath)
-{
-    if (scriptPath.empty())
-        return -1;
-
-    int error = 0;
-
-    // Clear the temporary variable names that will hold the functions read in from the file
-    if ((error = g_LuaMan.RunScriptString("UpdateAI = nil;")) < 0)
-        return error;
-
-    // Read in the Lua script function definitions for this preset
-    if ((error = MovableObject::LoadScripts(scriptPath)) < 0)
-        return error;
-
-    // Add the UpdateAI function, if it exists.. if it doesn't, that's not a problem! We'll just be using the old C++ implementation
-    if (g_LuaMan.GlobalIsDefined("UpdateAI"))
-    {
-        // Mark that we have a Lua override for the UpdateAI function
-        m_ScriptedAIUpdate = true;
-        if ((error = g_LuaMan.RunScriptString("if UpdateAI then " + m_ScriptPresetName + ".UpdateAI = UpdateAI; end;")) < 0)
-            return error;
+int Actor::LoadScript(std::string const &scriptPath, bool loadAsEnabledScript) {
+    int status = MOSRotating::LoadScript(scriptPath, loadAsEnabledScript);
+    if (status < 0) {
+        return status;
     }
-    else
-        m_ScriptedAIUpdate = false;
 
-    return error;
+    // If UpdateAI existed it'll be in the lua global namespace, so we can check that to know whether or not to use Lua AI
+    m_ScriptedAIUpdate = g_LuaMan.GlobalIsDefined("UpdateAI");
+
+    return status;
 }
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Virtual method:  GetMass
@@ -1301,52 +1282,47 @@ bool Actor::UpdateMovePath()
     return true;
 }
 
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-//////////////////////////////////////////////////////////////////////////////////////////
-// Virtual method:  UpdateAIScripted
-//////////////////////////////////////////////////////////////////////////////////////////
-// Description:     Updates this' AI state with the provided scripted AI Update function.
-
-bool Actor::UpdateAIScripted()
-{
-    // This preset doesn't seem to have any script file defined, so then just report we couldn't run scripted AI
-    if (!m_ScriptedAIUpdate || m_ScriptPath.empty() || m_ScriptPresetName.empty())
+bool Actor::UpdateAIScripted() {
+    if (!m_ScriptedAIUpdate || (m_LoadedScripts.empty()) || m_ScriptPresetName.empty()) {
         return false;
-
-    int error = 0;
+    }
 
     // Check to make sure the preset of this is still defined in the Lua state. If not, re-create it and recover gracefully
-    if (!g_LuaMan.ExpressionIsTrue(m_ScriptPresetName, false))
-        ReloadScripts();
+    if (!g_LuaMan.ExpressionIsTrue(m_ScriptPresetName, false)) {
+        ReloadScripts(); //TODO test if this should be here, I think it's junk cause for any cases where there's AI, update will always be called first. If it shouldn't, change the early return above.
+    }
 
-    // First see if we even have a representation stored in the Lua state, and if not, create one
-    if (m_ScriptObjectName.empty())
-    {
-        // Get the unique object identifier for this object and construct the object isntance name in Lua that points to this object so we can pass it into the preset functions
+    // If we don't have a Lua representation for this object instance, create one and call the Lua Create function on it
+    if (m_ScriptObjectName.empty()) {
+        //TODO test if this should be here, I think it's junk cause for any cases where there's AI, update will always be called first. If it shouldn't, change the early return above.
         m_ScriptObjectName = GetClassName() + "s." + g_LuaMan.GetNewObjectID();
 
-        // Give access to this in the Lua state
+        // Give Lua access to this object, then use that access to set up the object's Lua representation
         g_MovableMan.SetScriptedEntity(this);
-        // Create the Lua variable which will hold the object instance of this instance for as long as it exists
-        if ((error = g_LuaMan.RunScriptString(m_ScriptObjectName + " = To" + GetClassName() + "(MovableMan.ScriptedEntity);")) < 0)
+        if (g_LuaMan.RunScriptString(m_ScriptObjectName + " = To" + GetClassName() + "(MovableMan.ScriptedEntity);") < 0) {
             return false;
+        }
 
-        // Call the scripted creation function, but only after first checking if it and this instance's Lua representation really exists
-        if ((error = g_LuaMan.RunScriptString("if " + m_ScriptPresetName + ".Create and " + m_ScriptObjectName + " then " + m_ScriptPresetName + ".Create(" + m_ScriptObjectName + "); end")) < 0)
-            return false;
+        for (std::pair<std::string, bool> scriptEntry : m_LoadedScripts) {
+            if (g_LuaMan.RunFunctionInPresetScript("Create", scriptEntry.first, m_ScriptPresetName, m_ScriptObjectName) < 0) {
+                return -3;
+            }
+        }
     }
 
-    // Call the defined function, but only after first checking if it and this instance's Lua representation exists
-
 	g_FrameMan.StartPerformanceMeasurement(FrameMan::PERF_ACTORS_AI);
-	error = g_LuaMan.RunScriptString("if " + m_ScriptPresetName + ".UpdateAI and " + m_ScriptObjectName + " then " + m_ScriptPresetName + ".UpdateAI(" + m_ScriptObjectName + "); end");
+    bool aiUpdateSucceeded = true;
+    for (std::pair<std::string, bool> scriptEntry : m_LoadedScripts) {
+        if (scriptEntry.second == true) {
+            aiUpdateSucceeded = g_LuaMan.RunFunctionInPresetScript("UpdateAI", scriptEntry.first, m_ScriptPresetName, m_ScriptObjectName) >= 0;
+        }
+        if (!aiUpdateSucceeded) { break; }
+    }
 	g_FrameMan.StopPerformanceMeasurement(FrameMan::PERF_ACTORS_AI);
 
-    if (error < 0)
-        return false;
-
-    // We made a successful scripted AI update!
-    return true;
+    return aiUpdateSucceeded;
 }
 
 

Entities/Actor.h

@@ -192,16 +192,13 @@ ENTITYALLOCATION(Actor)
 
     virtual void Destroy(bool notInherited = false);
 
-
-//////////////////////////////////////////////////////////////////////////////////////////
-// Virtual method:  LoadScripts
-//////////////////////////////////////////////////////////////////////////////////////////
-// Description:     Loads the preset scripts of this object, from a specified path.
-// Arguments:       None.
-// Return value:    An error return value signaling sucess or any particular failure.
-//                  Anything below 0 is an error signal.
-
-    virtual int LoadScripts(std::string scriptPath);
+    /// <summary>
+    /// Loads the script at the given script path onto the object, checking for appropriately named functions within it.
+    /// </summary>
+    /// <param name="scriptPath">The path to the script to load.</param>
+    /// <param name="loadAsEnabledScript">Whether or not the script should load as enabled. Defaults to true.</param>
+    /// <returns>An error return value signaling sucess or any particular failure. Anything below 0 is an error signal.</returns>
+    virtual int LoadScript(std::string const &scriptPath, bool loadAsEnabledScript = false);
 
 
 //////////////////////////////////////////////////////////////////////////////////////////
@@ -1330,6 +1327,11 @@ ENTITYALLOCATION(Actor)
 
 protected:
 
+    /// <summary>
+    /// Gets a vector containing the script function names this class supports.
+    /// </summary>
+    /// <returns>A vector containing the script function names this class supports.</returns>
+    virtual const std::vector<std::string> GetSupportedScriptFunctionNames() override { auto functionNames = MOSRotating::GetSupportedScriptFunctionNames(); functionNames.push_back("UpdateAI"); return functionNames; }
 
     // Member variables
     static Entity::ClassInfo m_sClass;

Entities/MovableObject.h

@@ -1741,6 +1741,11 @@ ENTITYALLOCATION(MovableObject)
 
 protected:
 
+    /// <summary>
+    /// Gets a vector containing the script function names this class supports.
+    /// </summary>
+    /// <returns>A vector containing the script function names this class supports.</returns>
+    virtual const std::vector<std::string> GetSupportedScriptFunctionNames() { return std::vector<std::string> {"Create", "Destroy", "Update", "OnPieMenu", "OnEnableScript", "OnDisableScript"}; }
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Virtual method:  UpdateChildMOIDs

Managers/LuaMan.h

@@ -227,6 +227,16 @@ enum ServerResult
 
     bool ExpressionIsTrue(std::string expression, bool consoleErrors);
 
+    /// <summary>
+    /// Helper method to run the given function in all of the given preset instance's scripts on the given object instance. Note that this method does not do any safety checks.
+    /// </summary>
+    /// <param name="functionName">The name of the function to run.</param>
+    /// <param name="scriptPath">The path to the script whose function is being run. Used as an identifier in Lua.</param>
+    /// <param name="presetLuaInstanceName">The name of the lua variable that holds the representation of the preset instance whose function is being run.</param>
+    /// <param name="objectLuaInstanceName">The name of the lua variable that holds the representation of the object instance the function is being run on.</param>
+    /// <returns>Returns less than zero if any errors encountered when running this script. To get the actual error string, call GetLastError.</returns>
+    int LuaMan::RunFunctionInPresetScript(std::string const &functionName, std::string const &scriptPath, std::string const &presetLuaInstanceName, std::string const &objectLuaInstanceName);
+
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Method:          RunScriptString