From d0b40fae4b3972c131b41970811a9f3e2d7dd9b3 Mon Sep 17 00:00:00 2001
From: pointer-to-null <91910481+pointer-to-null@users.noreply.github.com>
Date: Tue, 30 Nov 2021 14:31:13 +0300
Subject: [PATCH] Implemented toggleable FPS counter. (#5409)

Co-authored-by: metalgearsloth <comedian_vs_clown@hotmail.com>
---
 Content.Client/EscapeMenu/UI/Tabs/GraphicsTab.xaml   |  1 +
 .../EscapeMenu/UI/Tabs/GraphicsTab.xaml.cs           |  7 ++++++-
 Content.Client/Viewport/GameScreen.cs                | 12 ++++++++++++
 Content.Shared/CCVar/CCVars.cs                       |  2 ++
 .../Locale/en-US/escape-menu/ui/options-menu.ftl     |  1 +
 5 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/Content.Client/EscapeMenu/UI/Tabs/GraphicsTab.xaml b/Content.Client/EscapeMenu/UI/Tabs/GraphicsTab.xaml
index 7d22e1ef52..5011839ffa 100644
--- a/Content.Client/EscapeMenu/UI/Tabs/GraphicsTab.xaml
+++ b/Content.Client/EscapeMenu/UI/Tabs/GraphicsTab.xaml
@@ -35,6 +35,7 @@
                       Text="{Loc 'ui-options-vp-integer-scaling'}"
                       ToolTip="{Loc 'ui-options-vp-integer-scaling-tooltip'}" />
             <CheckBox Name="ViewportLowResCheckBox" Text="{Loc 'ui-options-vp-low-res'}" />
+            <CheckBox Name="FpsCounterCheckBox" Text="{Loc 'ui-options-fps-counter'}" />
         </BoxContainer>
         <hudUi:StripeBack HasBottomEdge="False" HasMargins="False">
             <Button Name="ApplyButton"
diff --git a/Content.Client/EscapeMenu/UI/Tabs/GraphicsTab.xaml.cs b/Content.Client/EscapeMenu/UI/Tabs/GraphicsTab.xaml.cs
index 112be58634..91caadf4e2 100644
--- a/Content.Client/EscapeMenu/UI/Tabs/GraphicsTab.xaml.cs
+++ b/Content.Client/EscapeMenu/UI/Tabs/GraphicsTab.xaml.cs
@@ -76,6 +76,7 @@ namespace Content.Client.EscapeMenu.UI.Tabs
             ShowHeldItemCheckBox.OnToggled += OnCheckBoxToggled;
             IntegerScalingCheckBox.OnToggled += OnCheckBoxToggled;
             ViewportLowResCheckBox.OnToggled += OnCheckBoxToggled;
+            FpsCounterCheckBox.OnToggled += OnCheckBoxToggled;
             ApplyButton.OnPressed += OnApplyButtonPressed;
             VSyncCheckBox.Pressed = _cfg.GetCVar(CVars.DisplayVSync);
             FullscreenCheckBox.Pressed = ConfigIsFullscreen;
@@ -86,6 +87,7 @@ namespace Content.Client.EscapeMenu.UI.Tabs
             ViewportStretchCheckBox.Pressed = _cfg.GetCVar(CCVars.ViewportStretch);
             IntegerScalingCheckBox.Pressed = _cfg.GetCVar(CCVars.ViewportSnapToleranceMargin) != 0;
             ViewportLowResCheckBox.Pressed = !_cfg.GetCVar(CCVars.ViewportScaleRender);
+            FpsCounterCheckBox.Pressed = _cfg.GetCVar(CCVars.HudFpsCounterVisible);
             ShowHeldItemCheckBox.Pressed = _cfg.GetCVar(CCVars.HudHeldItemShow);
 
             UpdateViewportScale();
@@ -122,6 +124,7 @@ namespace Content.Client.EscapeMenu.UI.Tabs
                          IntegerScalingCheckBox.Pressed ? CCVars.ViewportSnapToleranceMargin.DefaultValue : 0);
             _cfg.SetCVar(CCVars.ViewportScaleRender, !ViewportLowResCheckBox.Pressed);
             _cfg.SetCVar(CCVars.HudHeldItemShow, ShowHeldItemCheckBox.Pressed);
+            _cfg.SetCVar(CCVars.HudFpsCounterVisible, FpsCounterCheckBox.Pressed);
             _cfg.SaveToFile();
             UpdateApplyButton();
         }
@@ -149,6 +152,7 @@ namespace Content.Client.EscapeMenu.UI.Tabs
             var isIntegerScalingSame = IntegerScalingCheckBox.Pressed == (_cfg.GetCVar(CCVars.ViewportSnapToleranceMargin) != 0);
             var isVPResSame = ViewportLowResCheckBox.Pressed == !_cfg.GetCVar(CCVars.ViewportScaleRender);
             var isShowHeldItemSame = ShowHeldItemCheckBox.Pressed == _cfg.GetCVar(CCVars.HudHeldItemShow);
+            var isFpsCounterVisibleSame = FpsCounterCheckBox.Pressed == _cfg.GetCVar(CCVars.HudFpsCounterVisible);
 
             ApplyButton.Disabled = isVSyncSame &&
                                    isFullscreenSame &&
@@ -159,7 +163,8 @@ namespace Content.Client.EscapeMenu.UI.Tabs
                                    isIntegerScalingSame &&
                                    isVPResSame &&
                                    isHudThemeSame &&
-                                   isShowHeldItemSame;
+                                   isShowHeldItemSame &&
+                                   isFpsCounterVisibleSame;
         }
 
         private bool ConfigIsFullscreen =>
diff --git a/Content.Client/Viewport/GameScreen.cs b/Content.Client/Viewport/GameScreen.cs
index 97335ff30a..c58a7de94c 100644
--- a/Content.Client/Viewport/GameScreen.cs
+++ b/Content.Client/Viewport/GameScreen.cs
@@ -8,10 +8,12 @@ using Content.Client.HUD;
 using Content.Client.HUD.UI;
 using Content.Client.Voting;
 using Content.Shared.Chat;
+using Content.Shared.CCVar;
 using Robust.Client.Graphics;
 using Robust.Client.Input;
 using Robust.Client.UserInterface;
 using Robust.Client.UserInterface.Controls;
+using Robust.Client.UserInterface.CustomControls;
 using Robust.Shared.Configuration;
 using Robust.Shared.IoC;
 using Robust.Shared.Maths;
@@ -31,10 +33,14 @@ namespace Content.Client.Viewport
         [Dependency] private readonly IVoteManager _voteManager = default!;
         [Dependency] private readonly IEyeManager _eyeManager = default!;
         [Dependency] private readonly IOverlayManager _overlayManager = default!;
+        [Dependency] private readonly IGameTiming _gameTiming = default!;
+        [Dependency] private readonly IConfigurationManager _configurationManager = default!;
 
         [ViewVariables] private ChatBox? _gameChat;
         private ConstructionMenuPresenter? _constructionMenu;
 
+        private FpsCounter _fpsCounter = default!;
+
         public MainViewport Viewport { get; private set; } = default!;
 
         public override void Startup()
@@ -74,6 +80,11 @@ namespace Content.Client.Viewport
             _eyeManager.MainViewport = Viewport.Viewport;
 
             _overlayManager.AddOverlay(new ShowHandItemOverlay());
+
+            _fpsCounter = new FpsCounter(_gameTiming);
+            _userInterfaceManager.StateRoot.AddChild(_fpsCounter);
+            _fpsCounter.Visible = _configurationManager.GetCVar(CCVars.HudFpsCounterVisible);
+            _configurationManager.OnValueChanged(CCVars.HudFpsCounterVisible, (show) => { _fpsCounter.Visible = show; });
         }
 
         public override void Shutdown()
@@ -88,6 +99,7 @@ namespace Content.Client.Viewport
             _gameHud.RootControl.Orphan();
             // Clear viewport to some fallback, whatever.
             _eyeManager.MainViewport = _userInterfaceManager.MainViewport;
+            _fpsCounter.Dispose();
         }
 
         /// <summary>
diff --git a/Content.Shared/CCVar/CCVars.cs b/Content.Shared/CCVar/CCVars.cs
index d187fa6158..a74b664112 100644
--- a/Content.Shared/CCVar/CCVars.cs
+++ b/Content.Shared/CCVar/CCVars.cs
@@ -262,6 +262,8 @@ namespace Content.Shared.CCVar
         public static readonly CVarDef<float> HudHeldItemOffset =
             CVarDef.Create("hud.held_item_offset", 28f, CVar.ARCHIVE | CVar.CLIENTONLY);
 
+        public static readonly CVarDef<bool> HudFpsCounterVisible =
+            CVarDef.Create("hud.fps_counter_visible", false, CVar.CLIENTONLY | CVar.ARCHIVE);
 
         /*
          * AI
diff --git a/Resources/Locale/en-US/escape-menu/ui/options-menu.ftl b/Resources/Locale/en-US/escape-menu/ui/options-menu.ftl
index 680668c3a9..72852287a9 100644
--- a/Resources/Locale/en-US/escape-menu/ui/options-menu.ftl
+++ b/Resources/Locale/en-US/escape-menu/ui/options-menu.ftl
@@ -47,6 +47,7 @@ ui-options-vp-integer-scaling-tooltip = If this option is enabled, the viewport
                                         means that black bars appear at the top/bottom of the screen or that part
                                         of the viewport is not visible.
 ui-options-vp-low-res = Low-resolution viewport
+ui-options-fps-counter = Show FPS counter
 
 ## Controls menu