Merge branch 'onUpdate' into 'master'

Run onUpdate when the game is paused

Closes #8012

See merge request OpenMW/openmw!4487

apps/openmw/mwlua/luamanagerimp.cpp

@@ -203,13 +203,12 @@ namespace MWLua
 
         // Run engine handlers
         mEngineEvents.callEngineHandlers();
-        if (!timeManager.isPaused())
+        bool isPaused = timeManager.isPaused();
-        {
+
-            float frameDuration = MWBase::Environment::get().getFrameDuration();
+        float frameDuration = MWBase::Environment::get().getFrameDuration();
-            for (LocalScripts* scripts : mActiveLocalScripts)
+        for (LocalScripts* scripts : mActiveLocalScripts)
-                scripts->update(frameDuration);
+            scripts->update(isPaused ? 0 : frameDuration);
-            mGlobalScripts.update(frameDuration);
+        mGlobalScripts.update(isPaused ? 0 : frameDuration);
-        }
 
         mLua.protectedCall([&](LuaUtil::LuaView& lua) { mScriptTracker.unloadInactiveScripts(lua); });
     }

docs/source/reference/lua-scripting/engine_handlers.rst

@@ -24,7 +24,7 @@ Engine handler is a function defined by a script, that can be called by the engi
       | `assigned to a script in openmw-cs (not yet implemented).`
       | ``onInterfaceOverride`` can be called before ``onInit``.
   * - onUpdate(dt)
-    - | Called every frame if the game is not paused. `dt` is
+    - | Called every frame in the Lua thread (even if the game is paused). `dt` is
       | the simulation time from the last update in seconds.
   * - onSave() -> savedData
     - | Called when the game is saving. May be called in inactive state,

files/data/scripts/omw/camera/camera.lua

@@ -182,6 +182,10 @@ local function updateCrosshair()
 end
 
 local function onUpdate(dt)
+    if dt <=0 then
+        return
+    end
+
     camera.setExtraPitch(0)
     camera.setExtraYaw(0)
     camera.setExtraRoll(0)

files/data/scripts/omw/mechanics/animationcontroller.lua

@@ -41,6 +41,10 @@ end
 local initialized = false
 
 local function onUpdate(dt)
+    if dt <= 0 then
+        return
+    end
+
     -- The script is loaded before the actor's CharacterController object is initialized, therefore
     -- we have to delay this initialization step or the call won't have any effect.
     if not initialized then

files/data/scripts/omw/mechanics/playercontroller.lua

@@ -96,7 +96,11 @@ local function skillUsedHandler(skillid, params)
     end
 end
 
-local function onUpdate()
+local function onUpdate(dt)
+    if dt <=0 then
+        return
+    end
+
     if self.cell ~= cell then
         cell = self.cell
         onCellChange()

files/data/scripts/omw/music/actor.lua

@@ -11,7 +11,7 @@ local function emitTargetsChanged()
     end
 end
 
-local function onUpdate()
+local function onUpdate(dt)
     if types.Actor.isDeathFinished(self) or not types.Actor.isInActorsProcessingRange(self) then
         if next(targets) ~= nil then
             targets = {}
@@ -21,10 +21,10 @@ local function onUpdate()
         return
     end
 
-    -- Early-out for actors without targets and without combat state
+    -- Early-out for actors without targets and without combat state when the game is not paused
     -- TODO: use events or engine handlers to detect when targets change
     local isStanceNothing = types.Actor.getStance(self) == types.Actor.STANCE.Nothing
-    if isStanceNothing and next(targets) == nil and not AI.isFleeing() then
+    if isStanceNothing and next(targets) == nil and not AI.isFleeing() and dt > 0 then
         return
     end
 

files/lua_api/openmw/core.lua

@@ -42,7 +42,7 @@
 -- @return #number
 
 ---
--- Whether the world is paused (onUpdate doesn't work when the world is paused).
+-- Whether the world is paused.
 -- @function [parent=#core] isWorldPaused
 -- @return #boolean
 

files/lua_api/openmw/world.lua

@@ -119,7 +119,7 @@
 -- @param #number ratio
 
 ---
--- Whether the world is paused (onUpdate doesn't work when the world is paused).
+-- Whether the world is paused.
 -- @function [parent=#world] isWorldPaused
 -- @return #boolean