Fixed adding more supported script function names in Actor, and added OnAttach and OnDetach in attachable

Added TempEntityVector to LuaMan, which is used to cleverly pass arguments from cpp to lua for these new MO functions. Also made LuaMan::TempEntity readonly from lua

Author: garethyr

Entities/Actor.cpp

@@ -1285,18 +1285,20 @@ bool Actor::UpdateMovePath()
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 bool Actor::UpdateAIScripted() {
-    if (!m_ScriptedAIUpdate || (m_LoadedScripts.empty()) || m_ScriptPresetName.empty()) {
+    if (!m_ScriptedAIUpdate || m_LoadedScripts.empty() || m_ScriptPresetName.empty()) {
         return false;
     }
 
     // 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(); //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.
+        RTEAbort("Trying to run UpdateAIScripted with no ScriptPresetName. This shouldn't happen, please let a dev know.")
+        //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.
     }
 
     // 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.
+        RTEAbort("Trying to run UpdateAIScripted with no ScriptObjectName. This shouldn't happen, please let a dev know.")
+        /*//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 Lua access to this object, then use that access to set up the object's Lua representation
@@ -1309,17 +1311,11 @@ bool Actor::UpdateAIScripted() {
             if (g_LuaMan.RunFunctionInPresetScript("Create", scriptEntry.first, m_ScriptPresetName, m_ScriptObjectName) < 0) {
                 return -3;
             }
-        }
+        }*/
     }
 
 	g_FrameMan.StartPerformanceMeasurement(FrameMan::PERF_ACTORS_AI);
-    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; }
-    }
+    bool aiUpdateSucceeded = RunScriptedFunctionInAppropriateScripts("UpdateAI", false, true) < 0;
 	g_FrameMan.StopPerformanceMeasurement(FrameMan::PERF_ACTORS_AI);
 
     return aiUpdateSucceeded;

Entities/Actor.h

@@ -1327,12 +1327,6 @@ 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;
 
@@ -1540,6 +1534,12 @@ ENTITYALLOCATION(Actor)
     // Timer for measuring interval between height checks
     Timer m_FallTimer;
 
+    /// <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.insert(functionNames.end(), {"UpdateAI"}); return functionNames; }
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // Private member variable and method declarations
 

Entities/Attachable.cpp

@@ -273,6 +273,10 @@ void Attachable::Attach(MOSRotating *pParent)
 
     // Reset the attachables timers so things that have been sitting in inventory don't make backed up emissions
     ResetAllTimers();
+
+    if (m_pParent != NULL) {
+        RunScriptedFunctionInAppropriateScripts("OnAttach", false, false, {m_pParent});
+    }
 }
 
 
@@ -290,6 +294,7 @@ void Attachable::Detach()
     }
 
     m_Team = -1;
+    MOSRotating *temporaryParent = m_pParent;
     m_pParent = 0;
 	// Since it's no longer atteched it should belong to itself
 	m_RootMOID = m_MOID;
@@ -300,6 +305,10 @@ void Attachable::Detach()
 #endif
 
     m_RestTimer.Reset();
+
+    if (temporaryParent != NULL) {
+        RunScriptedFunctionInAppropriateScripts("OnDetach", false, false, {temporaryParent});
+    }
 }
 
 

Entities/Attachable.h

@@ -700,6 +700,12 @@ ENTITYALLOCATION(Attachable)
 	// Whether this attachable currently has terrain collisions enabled while it's attached to a parent.
 	bool m_IsCollidingWithTerrainWhileAttached;
 
+    /// <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.insert(functionNames.end(), {"OnAttach", "OnDetach"}); return functionNames; }
+
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Private member variable and method declarations

Managers/LuaMan.cpp

@@ -2197,7 +2197,8 @@ int LuaMan::Create()
 			.property("ScreenSize", &ConsoleMan::GetConsoleScreenSize, &ConsoleMan::SetConsoleScreenSize),
 
         class_<LuaMan>("LuaManager")
-            .property("TempEntity", &LuaMan::GetTempEntity, &LuaMan::SetTempEntity)
+            .property("TempEntity", &LuaMan::GetTempEntity)
+            .def_readonly("TempEntities", &LuaMan::m_TempEntityVector, return_stl_iterator)
             .def("FileOpen", &LuaMan::FileOpen)
             .def("FileClose", &LuaMan::FileClose)
             .def("FileReadLine", &LuaMan::FileReadLine)

Managers/LuaMan.h

@@ -295,6 +295,11 @@ enum ServerResult
 
     Entity * GetTempEntity() const { return m_pTempEntity; }
 
+    /// <summary>
+    /// Sets a temporary vector of entities that can be accessed in the Lua state
+    /// </summary>
+    /// <param name="entityVector">The temporary vector of entities. Ownership is NOT transferred.</param>
+    void SetTempEntityVector(std::vector<Entity *> entityVector) { m_TempEntityVector = entityVector; }
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Method:          Update
@@ -398,6 +403,8 @@ enum ServerResult
     long m_NextObjectID;
     // Temporary holder for an Entity object that we want to pass into the Lua state without fuss
     Entity *m_pTempEntity;
+    // Temporary holder for a vector of Entities that we want to pass into the Lua state without a fuss. Usually used to pass arguments to special Lua functions.
+    std::vector<Entity *> m_TempEntityVector;
 
 
 //////////////////////////////////////////////////////////////////////////////////////////