Added check for whether or not an object's scripts have been initialized and used that to stop attached attachables from running scripts if their parents' scripts aren't initialized. Also did a little renaming.

Author: garethyr

Entities/Actor.cpp

@@ -1290,7 +1290,7 @@ bool Actor::UpdateAIScripted() {
     }
 
     int status = !g_LuaMan.ExpressionIsTrue(m_ScriptPresetName, false) ? ReloadScripts() : 0;
-    status = (status >= 0 && m_ScriptObjectName.empty()) ? SetupScriptObjectNameAndRunLuaCreateFunctions() : status;
+    status = (status >= 0 && !ObjectScriptsInitialized()) ? InitializeObjectScripts() : status;
     g_FrameMan.StartPerformanceMeasurement(FrameMan::PERF_ACTORS_AI);
     status = (status >= 0) ? RunScriptedFunctionInAppropriateScripts("UpdateAI", false, true) : status;
     g_FrameMan.StopPerformanceMeasurement(FrameMan::PERF_ACTORS_AI);

Entities/Attachable.cpp

@@ -274,7 +274,7 @@ 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) {
+    if (m_pParent != NULL && m_pParent->ObjectScriptsInitialized()) {
         RunScriptedFunctionInAppropriateScripts("OnAttach", false, false, {m_pParent});
     }
 }

Entities/MovableObject.cpp

@@ -452,7 +452,7 @@ int MovableObject::Save(Writer &writer) const
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 void MovableObject::Destroy(bool notInherited) {
-    if (!m_ScriptObjectName.empty()) {
+    if (ObjectScriptsInitialized()) {
         RunScriptedFunctionInAppropriateScripts("Destroy");
         g_LuaMan.RunScriptString(m_ScriptObjectName + " = nil;");
     }
@@ -465,17 +465,19 @@ void MovableObject::Destroy(bool notInherited) {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-int MovableObject::SetupScriptObjectNameAndRunLuaCreateFunctions() {
+int MovableObject::InitializeObjectScripts() {
     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
     g_LuaMan.SetTempEntity(this);
 
     if (g_LuaMan.RunScriptString(m_ScriptObjectName + " = To" + GetClassName() + "(LuaMan.TempEntity);") < 0) {
+        m_ScriptObjectName = "ERROR";
         return -2;
     }
 
     if (RunScriptedFunctionInAppropriateScripts("Create", true, true) < 0) {
+        m_ScriptObjectName = "ERROR";
         return -3;
     }
     return 0;
@@ -576,7 +578,7 @@ bool MovableObject::AddScript(const std::string &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()) {
+            if (ObjectScriptsInitialized()) {
                 RunScriptedFunction(scriptPath, "Create");
                 return false;
             }
@@ -607,7 +609,7 @@ bool MovableObject::RemoveScript(const std::string &scriptPath) {
     auto scriptEntryIterator = FindScript(scriptPath);
     if (scriptEntryIterator != m_LoadedScripts.end()) {
         m_LoadedScripts.erase(scriptEntryIterator);
-        if (!m_ScriptObjectName.empty() && RunScriptedFunction(scriptPath, "OnScriptRemoveOrDisable", {}, {"true"}) < 0) {
+        if (ObjectScriptsInitialized() && RunScriptedFunction(scriptPath, "OnScriptRemoveOrDisable", {}, {"true"}) < 0) {
             g_ConsoleMan.PrintString("NOTE: The script has been removed despite this error.");
             return false;
         }
@@ -625,7 +627,7 @@ bool MovableObject::EnableScript(const std::string &scriptPath) {
 
     auto scriptEntryIterator = FindScript(scriptPath);
     if (scriptEntryIterator != m_LoadedScripts.end() && scriptEntryIterator->second == false) {
-        if (!m_ScriptObjectName.empty() && RunScriptedFunction(scriptPath, "OnScriptEnable") < 0) {
+        if (ObjectScriptsInitialized() && RunScriptedFunction(scriptPath, "OnScriptEnable") < 0) {
             return false;
         }
         scriptEntryIterator->second = true;
@@ -643,7 +645,7 @@ bool MovableObject::DisableScript(const std::string &scriptPath) {
 
     auto scriptEntryIterator = FindScript(scriptPath);
     if (scriptEntryIterator != m_LoadedScripts.end() && scriptEntryIterator->second == true) {
-        if (!m_ScriptObjectName.empty() && RunScriptedFunction(scriptPath, "OnScriptRemoveOrDisable", {}, {"false"}) < 0) {
+        if (ObjectScriptsInitialized() && RunScriptedFunction(scriptPath, "OnScriptRemoveOrDisable", {}, {"false"}) < 0) {
             return false;
         }
         scriptEntryIterator->second = false;
@@ -655,7 +657,7 @@ bool MovableObject::DisableScript(const std::string &scriptPath) {
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 int MovableObject::RunScriptedFunction(const std::string &scriptPath, const std::string &functionName, std::vector<Entity *> functionEntityArguments, std::vector<std::string> functionLiteralArguments) {
-    if (m_LoadedScripts.empty() || m_ScriptPresetName.empty() || m_ScriptObjectName.empty()) {
+    if (m_LoadedScripts.empty() || m_ScriptPresetName.empty() || !ObjectScriptsInitialized()) {
         return -1;
     }
 
@@ -677,7 +679,7 @@ int MovableObject::RunScriptedFunction(const std::string &scriptPath, const std:
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 int MovableObject::RunScriptedFunctionInAppropriateScripts(const std::string &functionName, bool runOnDisabledScripts, bool stopOnError, std::vector<Entity *> functionEntityArguments, std::vector<std::string> functionLiteralArguments) {
-    if (m_LoadedScripts.empty() || m_ScriptPresetName.empty() || m_ScriptObjectName.empty()) {
+    if (m_LoadedScripts.empty() || m_ScriptPresetName.empty() || !ObjectScriptsInitialized()) {
         return -1;
     }
 
@@ -958,7 +960,7 @@ int MovableObject::UpdateScripts() {
     }
 
     int status = !g_LuaMan.ExpressionIsTrue(m_ScriptPresetName, false) ? ReloadScripts() : 0;
-    status = (status >= 0 && m_ScriptObjectName.empty()) ? SetupScriptObjectNameAndRunLuaCreateFunctions() : status;
+    status = (status >= 0 && !ObjectScriptsInitialized()) ? InitializeObjectScripts() : status;
     status = (status >= 0) ? RunScriptedFunctionInAppropriateScripts("Update", false, true) : status;
 
     return status;
@@ -967,7 +969,7 @@ int MovableObject::UpdateScripts() {
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 int MovableObject::OnPieMenu(Actor *pieMenuActor) {
-    if (!pieMenuActor || m_LoadedScripts.empty() || m_ScriptPresetName.empty() || m_ScriptObjectName.empty()) {
+    if (!pieMenuActor || m_LoadedScripts.empty() || m_ScriptPresetName.empty() || !ObjectScriptsInitialized()) {
         return -1;
     }
 

Entities/MovableObject.h

@@ -264,6 +264,12 @@ ENTITYALLOCATION(MovableObject)
     /// <returns>An error return value signaling sucess or any particular failure. Anything below 0 is an error signal.</returns>
     int RunScriptedFunctionInAppropriateScripts(const std::string &functionName, bool runOnDisabledScripts = false, bool stopOnError = false, std::vector<Entity *> functionEntityArguments = std::vector<Entity *>(), std::vector<std::string> functionLiteralArguments = std::vector<std::string>());
 
+    /// <summary>
+    /// Gets whether or not the object has a script name, and there were no errors when initializing its Lua scripts. If there were, the object would need to be reloaded.
+    /// </summary>
+    /// <returns>Whether or not the object's scripts have been succesfully initialized.</returns>
+    bool ObjectScriptsInitialized() { return !m_ScriptObjectName.empty() && m_ScriptObjectName != "ERROR"; }
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // Virtual method:  GetClass
 //////////////////////////////////////////////////////////////////////////////////////////
@@ -1776,7 +1782,7 @@ ENTITYALLOCATION(MovableObject)
     /// Does necessary work to setup a script object name for this object, allowing it to be accessed in Lua, then runs all of the MO's scripts' Create functions in Lua.
     /// </summary>
     /// <returns>0 on success, -2 if it fails to setup the script object in Lua, and -3 if it fails to run any Create function.</returns>
-    int SetupScriptObjectNameAndRunLuaCreateFunctions();
+    int InitializeObjectScripts();
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Virtual method:  UpdateChildMOIDs