tweak(fps): Decouple non-network logic update from render update (#1451)

Author: xezon

Core/GameEngine/Include/Common/FrameRateLimit.h

@@ -29,3 +29,42 @@ class FrameRateLimit
 	LARGE_INTEGER m_freq;
 	LARGE_INTEGER m_start;
 };
+
+
+enum FpsValueChange
+{
+	FpsValueChange_Increase,
+	FpsValueChange_Decrease,
+};
+
+
+class RenderFpsPreset
+{
+public:
+	enum CPP_11(: UnsignedInt)
+	{
+		UncappedFpsValue = 1000000,
+	};
+
+	static UnsignedInt getNextFpsValue(UnsignedInt value);
+	static UnsignedInt getPrevFpsValue(UnsignedInt value);
+	static UnsignedInt changeFpsValue(UnsignedInt value, FpsValueChange change);
+
+private:
+	static const UnsignedInt s_fpsValues[];
+};
+
+
+class LogicTimeScaleFpsPreset
+{
+public:
+	enum CPP_11(: UnsignedInt)
+	{
+		StepFpsValue = 5,
+	};
+
+	static UnsignedInt getNextFpsValue(UnsignedInt value);
+	static UnsignedInt getPrevFpsValue(UnsignedInt value);
+	static UnsignedInt changeFpsValue(UnsignedInt value, FpsValueChange change);
+};
+

Core/GameEngine/Source/Common/FrameRateLimit.cpp

@@ -52,3 +52,75 @@ Real FrameRateLimit::wait(UnsignedInt maxFps)
 	m_start = tick;
 	return (Real)elapsedSeconds;
 }
+
+
+const UnsignedInt RenderFpsPreset::s_fpsValues[] = {
+	30, 50, 56, 60, 65, 70, 72, 75, 80, 85, 90, 100, 110, 120, 144, 240, 480, UncappedFpsValue };
+
+static_assert(LOGICFRAMES_PER_SECOND <= 30, "Min FPS values need to be revisited!");
+
+UnsignedInt RenderFpsPreset::getNextFpsValue(UnsignedInt value)
+{
+	const Int first = 0;
+	const Int last = ARRAY_SIZE(s_fpsValues) - 1;
+	for (Int i = first; i < last; ++i)
+	{
+		if (value >= s_fpsValues[i] && value < s_fpsValues[i + 1])
+		{
+			return s_fpsValues[i + 1];
+		}
+	}
+	return s_fpsValues[last];
+}
+
+UnsignedInt RenderFpsPreset::getPrevFpsValue(UnsignedInt value)
+{
+	const Int first = 0;
+	const Int last = ARRAY_SIZE(s_fpsValues) - 1;
+	for (Int i = last; i > first; --i)
+	{
+		if (value <= s_fpsValues[i] && value > s_fpsValues[i - 1])
+		{
+			return s_fpsValues[i - 1];
+		}
+	}
+	return s_fpsValues[first];
+}
+
+UnsignedInt RenderFpsPreset::changeFpsValue(UnsignedInt value, FpsValueChange change)
+{
+	switch (change)
+	{
+	default:
+	case FpsValueChange_Increase: return getNextFpsValue(value);
+	case FpsValueChange_Decrease: return getPrevFpsValue(value);
+	}
+}
+
+
+UnsignedInt LogicTimeScaleFpsPreset::getNextFpsValue(UnsignedInt value)
+{
+	return value + StepFpsValue;
+}
+
+UnsignedInt LogicTimeScaleFpsPreset::getPrevFpsValue(UnsignedInt value)
+{
+	if (value - StepFpsValue < LOGICFRAMES_PER_SECOND)
+	{
+		return LOGICFRAMES_PER_SECOND;
+	}
+	else
+	{
+		return value - StepFpsValue;
+	}
+}
+
+UnsignedInt LogicTimeScaleFpsPreset::changeFpsValue(UnsignedInt value, FpsValueChange change)
+{
+	switch (change)
+	{
+	default:
+	case FpsValueChange_Increase: return getNextFpsValue(value);
+	case FpsValueChange_Decrease: return getPrevFpsValue(value);
+	}
+}

Generals/Code/GameEngine/Include/Common/GameCommon.h

@@ -65,6 +65,7 @@
 // ----------------------------------------------------------------------------------------------
 enum
 {
+	BaseFps = 30, // The historic base frame rate for this game. This value must never change.
 	LOGICFRAMES_PER_SECOND = 30,
 	MSEC_PER_SECOND = 1000
 };

Generals/Code/GameEngine/Include/Common/GameEngine.h

@@ -34,8 +34,6 @@
 #include "Common/SubsystemInterface.h"
 #include "Common/GameType.h"
 
-#define DEFAULT_MAX_FPS		45
-
 // forward declarations
 class AudioManager;
 class GameLogic;
@@ -72,8 +70,20 @@ class GameEngine : public SubsystemInterface
 
 	virtual void execute( void );											/**< The "main loop" of the game engine.
 																								 It will not return until the game exits. */
-	virtual void setFramesPerSecondLimit( Int fps );	///< Set the maximum rate engine updates are allowed to occur
-	virtual Int  getFramesPerSecondLimit( void );			///< Get maxFPS.  Not inline since it is called from another lib.
+
+	virtual void setFramesPerSecondLimit( Int fps ); ///< Set the max render and engine update fps.
+	virtual Int getFramesPerSecondLimit( void ); ///< Get the max render and engine update fps.
+	Real getUpdateTime(); ///< Get the last engine update delta time.
+	Real getUpdateFps(); ///< Get the last engine update fps.
+
+	virtual void setLogicTimeScaleFps( Int fps ); ///< Set the logic time scale fps and therefore scale the simulation time. Is capped by the max render fps and does not apply to network matches.
+	virtual Int getLogicTimeScaleFps(); ///< Get the raw logic time scale fps value.
+	virtual void enableLogicTimeScale( Bool enable ); ///< Enable the logic time scale setup. If disabled, the simulation time scale is bound to the render frame time or network update time.
+	virtual Bool isLogicTimeScaleEnabled(); ///< Check whether the logic time scale setup is enabled.
+	Int  getActualLogicTimeScaleFps(); ///< Get the real logic time scale fps, depending on the max render fps, network state and enabled state.
+	Real getActualLogicTimeScaleRatio(); ///< Get the real logic time scale ratio, depending on the max render fps, network state and enabled state.
+	Real getActualLogicTimeScaleOverFpsRatio(); ///< Get the real logic time scale over render fps ratio, used to scale down steps in render updates to match logic updates.
+
 	virtual void setQuitting( Bool quitting );				///< set quitting status
 	virtual Bool getQuitting(void);						///< is app getting ready to quit.
 
@@ -101,9 +111,15 @@ class GameEngine : public SubsystemInterface
 	virtual ParticleSystemManager* createParticleSystemManager( void ) = 0;
 	virtual AudioManager *createAudioManager( void ) = 0;				///< Factory for Audio Manager
 
-	Int m_maxFPS;																									///< Maximum frames per second allowed
+	Int m_maxFPS; ///< Maximum frames per second for rendering
+	Int m_logicTimeScaleFPS; ///< Maximum frames per second for logic time scale
+
+	Real m_updateTime; ///< Last engine update delta time
+	Real m_logicTimeAccumulator; ///< Frame time accumulated towards submitting a new logic frame
+
   Bool m_quitting;  ///< true when we need to quit the game
 	Bool m_isActive;	///< app has OS focus.
+	Bool m_enableLogicTimeScale;
 
 };
 inline void GameEngine::setQuitting( Bool quitting ) { m_quitting = quitting; }

Generals/Code/GameEngine/Include/Common/MessageStream.h

@@ -241,6 +241,10 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_HELP,															///< bring up help screen
 #endif
 
+		MSG_META_INCREASE_MAX_RENDER_FPS,						///< TheSuperHackers @feature Increase the max render fps
+		MSG_META_DECREASE_MAX_RENDER_FPS,						///< TheSuperHackers @feature Decrease the max render fps
+		MSG_META_INCREASE_LOGIC_TIME_SCALE,					///< TheSuperHackers @feature Increase the logic time scale
+		MSG_META_DECREASE_LOGIC_TIME_SCALE,					///< TheSuperHackers @feature Decrease the logic time scale
 		MSG_META_TOGGLE_LOWER_DETAILS,							///< toggles graphics options to crappy mode instantly
 		MSG_META_TOGGLE_CONTROL_BAR,								///< show/hide controlbar
 

Generals/Code/GameEngine/Include/GameClient/MetaEvent.h

@@ -69,6 +69,24 @@ static const LookupListRec CategoryListName[] =
 // KeyDefType; this is extremely important to maintain!
 enum MappableKeyType CPP_11(: Int)
 {
+	// keypad keys ----------------------------------------------------------------
+	MK_KP0					= KEY_KP0,
+	MK_KP1					= KEY_KP1,
+	MK_KP2					= KEY_KP2,
+	MK_KP3					= KEY_KP3,
+	MK_KP4					= KEY_KP4,
+	MK_KP5					= KEY_KP5,
+	MK_KP6					= KEY_KP6,
+	MK_KP7					= KEY_KP7,
+	MK_KP8					= KEY_KP8,
+	MK_KP9					= KEY_KP9,
+	MK_KPDEL				= KEY_KPDEL,
+	MK_KPSTAR				= KEY_KPSTAR,
+	MK_KPMINUS			= KEY_KPMINUS,
+	MK_KPPLUS				= KEY_KPPLUS,
+	MK_KPENTER			= KEY_KPENTER,
+	MK_KPSLASH			= KEY_KPSLASH,
+
 	MK_ESC					= KEY_ESC,
 	MK_BACKSPACE		= KEY_BACKSPACE,
 	MK_ENTER				= KEY_ENTER,
@@ -122,16 +140,6 @@ enum MappableKeyType CPP_11(: Int)
 	MK_8						= KEY_8,
 	MK_9						= KEY_9,
 	MK_0						= KEY_0,
-	MK_KP1					= KEY_KP1,
-	MK_KP2					= KEY_KP2,
-	MK_KP3					= KEY_KP3,
-	MK_KP4					= KEY_KP4,
-	MK_KP5					= KEY_KP5,
-	MK_KP6					= KEY_KP6,
-	MK_KP7					= KEY_KP7,
-	MK_KP8					= KEY_KP8,
-	MK_KP9					= KEY_KP9,
-	MK_KP0					= KEY_KP0,
 	MK_MINUS				= KEY_MINUS,
 	MK_EQUAL				= KEY_EQUAL,
 	MK_LBRACKET			= KEY_LBRACKET,
@@ -153,13 +161,30 @@ enum MappableKeyType CPP_11(: Int)
 	MK_PGDN					= KEY_PGDN,
 	MK_INS					= KEY_INS,
 	MK_DEL					= KEY_DEL,
-	MK_KPSLASH			= KEY_KPSLASH,
 	MK_NONE					= KEY_NONE
 
 };
 
 static const LookupListRec KeyNames[] =
 {
+	// keypad keys ----------------------------------------------------------------
+	{ "KEY_KP0", MK_KP0 },
+	{ "KEY_KP1", MK_KP1 },
+	{ "KEY_KP2", MK_KP2 },
+	{ "KEY_KP3", MK_KP3 },
+	{ "KEY_KP4", MK_KP4 },
+	{ "KEY_KP5", MK_KP5 },
+	{ "KEY_KP6", MK_KP6 },
+	{ "KEY_KP7", MK_KP7 },
+	{ "KEY_KP8", MK_KP8 },
+	{ "KEY_KP9", MK_KP9 },
+	{ "KEY_KPDEL", MK_KPDEL },
+	{ "KEY_KPSTAR", MK_KPSTAR },
+	{ "KEY_KPMINUS", MK_KPMINUS },
+	{ "KEY_KPPLUS", MK_KPPLUS },
+	{ "KEY_KPENTER", MK_KPENTER },
+	{ "KEY_KPSLASH", MK_KPSLASH },
+
 	{ "KEY_ESC", MK_ESC },
 	{ "KEY_BACKSPACE", MK_BACKSPACE },
 	{ "KEY_ENTER", MK_ENTER },
@@ -213,16 +238,6 @@ static const LookupListRec KeyNames[] =
 	{ "KEY_8", MK_8 },
 	{ "KEY_9", MK_9 },
 	{ "KEY_0", MK_0 },
-	{ "KEY_KP1", MK_KP1 },
-	{ "KEY_KP2", MK_KP2 },
-	{ "KEY_KP3", MK_KP3 },
-	{ "KEY_KP4", MK_KP4 },
-	{ "KEY_KP5", MK_KP5 },
-	{ "KEY_KP6", MK_KP6 },
-	{ "KEY_KP7", MK_KP7 },
-	{ "KEY_KP8", MK_KP8 },
-	{ "KEY_KP9", MK_KP9 },
-	{ "KEY_KP0", MK_KP0 },
 	{ "KEY_MINUS", MK_MINUS },
 	{ "KEY_EQUAL", MK_EQUAL },
 	{ "KEY_LBRACKET", MK_LBRACKET },
@@ -244,7 +259,6 @@ static const LookupListRec KeyNames[] =
 	{ "KEY_PGDN", MK_PGDN },
 	{ "KEY_INS", MK_INS },
 	{ "KEY_DEL", MK_DEL },
-	{ "KEY_KPSLASH", MK_KPSLASH },
 	{ "KEY_NONE", MK_NONE },
 	{ NULL, 0	} // keep this last!
 };
@@ -301,7 +315,9 @@ enum CommandUsableInType CPP_11(: Int)
 	COMMANDUSABLE_NONE				= 0,
 
 	COMMANDUSABLE_SHELL				= (1 << 0),
-	COMMANDUSABLE_GAME				= (1 << 1)
+	COMMANDUSABLE_GAME				= (1 << 1),
+
+	COMMANDUSABLE_EVERYWHERE = COMMANDUSABLE_SHELL | COMMANDUSABLE_GAME,
 };
 
 static const char* TheCommandUsableInNames[] =