Add Director::setMaxDeltaTime to cap the global maximum delta time (#3258)

Author: halx99

core/base/Director.cpp

@@ -32,6 +32,7 @@ THE SOFTWARE.
 
 // standard includes
 #include <string>
+#include <algorithm>
 
 #include "2d/SpriteFrameCache.h"
 #include "platform/FileUtils.h"
@@ -380,16 +381,8 @@ void Director::calculateDeltaTime()
             _deltaTime  = std::chrono::duration_cast<std::chrono::microseconds>(now - _lastUpdate).count() / 1000000.0f;
             _lastUpdate = now;
         }
-        _deltaTime = MAX(0, _deltaTime);
+        _deltaTime = std::clamp(_deltaTime, 0.0f, _maxDeltaTime);
     }
-
-#if _AX_DEBUG
-    // If we are debugging our code, prevent big delta time
-    if (_deltaTime > 0.2f)
-    {
-        _deltaTime = 1 / 60.0f;
-    }
-#endif
 }
 
 float Director::getDeltaTime() const
@@ -463,6 +456,11 @@ void Director::setNextDeltaTimeZero(bool nextDeltaTimeZero)
     _nextDeltaTimeZero = nextDeltaTimeZero;
 }
 
+void Director::setMaxDeltaTime(float maxDeltaTime)
+{
+    _maxDeltaTime = MAX(maxDeltaTime, 1.0f / 60);
+}
+
 //
 // FIXME TODO
 // Matrix code MUST NOT be part of the Director

core/base/Director.h

@@ -194,6 +194,12 @@ class AX_DLL Director
      */
     void setNextDeltaTimeZero(bool nextDeltaTimeZero);
 
+    /** Gets the maximum delta time allowed per frame. */
+    float getMaxDeltaTime() const { return _maxDeltaTime; }
+
+    /** Sets the maximum delta time allowed per frame. Default is 1/3 second, minimum is 1/60 second. */
+    void setMaxDeltaTime(float maxDeltaTime);
+
     /** Whether or not the Director is paused. */
     bool isPaused() { return _paused; }
 
@@ -593,6 +599,8 @@ class AX_DLL Director
     EventCustom* _beforeSetNextScene     = nullptr;
     EventCustom* _afterSetNextScene      = nullptr;
 
+    /* maximum delta time allowed per frame, default is 1/3 second */
+    float _maxDeltaTime           = 1.0f / 3;
     /* delta time since last tick to main loop */
     float _deltaTime              = 0.0f;
     bool _deltaTimePassedByCaller = false;

extensions/scripting/lua-bindings/auto/axlua_base_auto.cpp

@@ -15200,6 +15200,103 @@ int lua_ax_base_Director_setNextDeltaTimeZero(lua_State* tolua_S)
 
     return 0;
 }
+int lua_ax_base_Director_getMaxDeltaTime(lua_State* tolua_S)
+{
+    int argc = 0;
+    ax::Director* obj = nullptr;
+    bool ok  = true;
+
+#if _AX_DEBUG >= 1
+    tolua_Error tolua_err;
+#endif
+
+
+#if _AX_DEBUG >= 1
+    if (!tolua_isusertype(tolua_S,1,"ax.Director",0,&tolua_err)) goto tolua_lerror;
+#endif
+
+    obj = (ax::Director*)tolua_tousertype(tolua_S,1,0);
+
+#if _AX_DEBUG >= 1
+    if (!obj)
+    {
+        tolua_error(tolua_S,"invalid 'obj' in function 'lua_ax_base_Director_getMaxDeltaTime'", nullptr);
+        return 0;
+    }
+#endif
+
+    argc = lua_gettop(tolua_S)-1;
+    if (argc == 0)
+    {
+        if(!ok)
+        {
+            tolua_error(tolua_S,"invalid arguments in function 'lua_ax_base_Director_getMaxDeltaTime'", nullptr);
+            return 0;
+        }
+        auto&& ret = obj->getMaxDeltaTime();
+        tolua_pushnumber(tolua_S,(lua_Number)ret);
+        return 1;
+    }
+    luaL_error(tolua_S, "%s has wrong number of arguments: %d, was expecting %d \n", "ax.Director:getMaxDeltaTime",argc, 0);
+    return 0;
+
+#if _AX_DEBUG >= 1
+    tolua_lerror:
+    tolua_error(tolua_S,"#ferror in function 'lua_ax_base_Director_getMaxDeltaTime'.",&tolua_err);
+#endif
+
+    return 0;
+}
+int lua_ax_base_Director_setMaxDeltaTime(lua_State* tolua_S)
+{
+    int argc = 0;
+    ax::Director* obj = nullptr;
+    bool ok  = true;
+
+#if _AX_DEBUG >= 1
+    tolua_Error tolua_err;
+#endif
+
+
+#if _AX_DEBUG >= 1
+    if (!tolua_isusertype(tolua_S,1,"ax.Director",0,&tolua_err)) goto tolua_lerror;
+#endif
+
+    obj = (ax::Director*)tolua_tousertype(tolua_S,1,0);
+
+#if _AX_DEBUG >= 1
+    if (!obj)
+    {
+        tolua_error(tolua_S,"invalid 'obj' in function 'lua_ax_base_Director_setMaxDeltaTime'", nullptr);
+        return 0;
+    }
+#endif
+
+    argc = lua_gettop(tolua_S)-1;
+    if (argc == 1)
+    {
+        double arg0;
+
+        ok &= luaval_to_number(tolua_S, 2,&arg0, "ax.Director:setMaxDeltaTime");
+        if(!ok)
+        {
+            tolua_error(tolua_S,"invalid arguments in function 'lua_ax_base_Director_setMaxDeltaTime'", nullptr);
+            return 0;
+        }
+        obj->setMaxDeltaTime(arg0);
+        lua_settop(tolua_S, 1);
+        return 1;
+    }
+    luaL_error(tolua_S, "%s has wrong number of arguments: %d, was expecting %d \n", "ax.Director:setMaxDeltaTime",argc, 1);
+    return 0;
+
+#if _AX_DEBUG >= 1
+    tolua_lerror:
+    tolua_error(tolua_S,"#ferror in function 'lua_ax_base_Director_setMaxDeltaTime'.",&tolua_err);
+#endif
+
+    return 0;
+}
 int lua_ax_base_Director_isPaused(lua_State* tolua_S)
 {
     int argc = 0;
@@ -17996,6 +18093,8 @@ int lua_register_ax_base_Director(lua_State* tolua_S)
         tolua_function(tolua_S,"getTextureCache",lua_ax_base_Director_getTextureCache);
         tolua_function(tolua_S,"isNextDeltaTimeZero",lua_ax_base_Director_isNextDeltaTimeZero);
         tolua_function(tolua_S,"setNextDeltaTimeZero",lua_ax_base_Director_setNextDeltaTimeZero);
+        tolua_function(tolua_S,"getMaxDeltaTime",lua_ax_base_Director_getMaxDeltaTime);
+        tolua_function(tolua_S,"setMaxDeltaTime",lua_ax_base_Director_setMaxDeltaTime);
         tolua_function(tolua_S,"isPaused",lua_ax_base_Director_isPaused);
         tolua_function(tolua_S,"getTotalFrames",lua_ax_base_Director_getTotalFrames);
         tolua_function(tolua_S,"setProjection",lua_ax_base_Director_setProjection);