Added requested synced updates

Author: Causeless

Entities/MovableObject.cpp

@@ -124,6 +124,7 @@ void MovableObject::Clear()
 
 	m_SimUpdatesBetweenScriptedUpdates = 1;
     m_SimUpdatesSinceLastScriptedUpdate = 0;
+    m_RequestedSyncedUpdate = false;
 }
 
 LuaStateWrapper & MovableObject::GetAndLockStateForScript(const std::string &scriptPath, const LuaFunction *function) {

Entities/MovableObject.h

@@ -1895,6 +1895,22 @@ enum MOType
 	/// </summary>
 	virtual void OnSave() { RunScriptedFunctionInAppropriateScripts("OnSave"); }
 
+    /// <summary>
+    /// Requests a synced update for the MO this frame.
+    /// </summary>
+    virtual void RequestSyncedUpdate() { m_RequestedSyncedUpdate = true; }
+
+    /// <summary>
+    /// Resets the requested update flag.
+    /// </summary>
+    virtual void ResetRequestedSyncedUpdateFlag() { m_RequestedSyncedUpdate = false; }
+
+    /// <summary>
+    /// Returns whether this MO has requested a synced update this frame.
+    /// </summary>
+    /// <returns>Whether this MO has requested a synced update this frame.</returns>
+    virtual bool HasRequestedSyncedUpdate() { return m_RequestedSyncedUpdate; }
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // Protected member variable and method declarations
 
@@ -2054,6 +2070,8 @@ enum MOType
     std::unordered_map<std::string, bool> m_AllLoadedScripts; //!< A map of script paths to the enabled state of the given script.
     std::unordered_map<std::string, std::vector<LuaFunction>> m_FunctionsAndScripts; //!< A map of function names to vectors of Lua functions. Used to maintain script execution order and avoid extraneous Lua calls.
 
+    bool m_RequestedSyncedUpdate; //!< For optimisation purposes, multithreaded scripts explicitly request a synced update if they want one.
+
     std::unordered_map<std::string, std::string> m_StringValueMap; //<! Map to store any generic strings available from script
     std::unordered_map<std::string, double> m_NumberValueMap; //<! Map to store any generic numbers available from script
     std::unordered_map<std::string, Entity*> m_ObjectValueMap; //<! Map to store any generic object pointers available from script

Lua/LuaBindingsEntities.cpp

@@ -1084,7 +1084,8 @@ namespace RTE {
 		.def("MoveOutOfTerrain", &MovableObject::MoveOutOfTerrain)
 		.def("RotateOffset", &MovableObject::RotateOffset)
 		.def("SendMessage", &LuaAdaptersMovableObject::SendMessage1)
-		.def("SendMessage", &LuaAdaptersMovableObject::SendMessage2);
+		.def("SendMessage", &LuaAdaptersMovableObject::SendMessage2)
+		.def("RequestSyncedUpdate", &MovableObject::RequestSyncedUpdate);
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

Managers/MovableMan.cpp

@@ -1759,7 +1759,10 @@ void MovableMan::Update()
             g_LuaMan.SetThreadLuaStateOverride(&luaState);
 
             for (MovableObject* mo : luaState.GetRegisteredMOs()) {
-                mo->RunScriptedFunctionInAppropriateScripts(syncedUpdate, false, false, {}, {}, {}, ThreadScriptsToRun::MultiThreaded);
+                if (mo->HasRequestedSyncedUpdate()) {
+                    mo->RunScriptedFunctionInAppropriateScripts(syncedUpdate, false, false, {}, {}, {}, ThreadScriptsToRun::MultiThreaded);
+                    mo->ResetRequestedSyncedUpdateFlag();
+                }
             }
 
             g_LuaMan.SetThreadLuaStateOverride(nullptr);