Sprinting tweaks, 2 new sprint settings (#1794)

`ttt2_sprint_stamina_cooldown 0.8` : time in seconds before stamina
begins regenerating after sprinting
`ttt2_sprint_forwards_only 1` : require forward key to be held to be
able to sprint, prevents sprinting backwards or side to side, still
allows sprinting diagonally with W+A or W+D

not sure if these should be enabled by default, but feels closer to how
sprint/stamina in other games work

Author: wgetJane

CHANGELOG.md

@@ -13,6 +13,9 @@ All notable changes to TTT2 will be documented here. Inspired by [keep a changel
 - Added server option for body armor to protect against crowbar damage (by @wgetJane)
 - Added `GM:TTTLastWordsMsg` hook from base TTT (Facepunch/garrysmod/pull/2227, by @wgetJane)
 - Port new TTT entity ttt_filter_role to TTT2 (Facepunch/garrysmod/pull/2225 by @figardo, ported by @wgetJane)
+- Added 2 new sprint settings (by @wgetJane)
+  - Stamina cooldown time before stamina begins regenerating after sprinting, 0.8 seconds by default
+  - Option to require forward key to be held to sprint, enabled by default
 
 ### Changed
 

gamemodes/terrortown/gamemode/shared/sh_player_ext.lua

@@ -28,18 +28,19 @@ end
 function plymeta:SetupDataTables()
     -- This has to be transferred, because we need the value when predicting the player movement
     -- It turned out that this is the only reliable way to fix all prediction errors.
-    self:NetworkVar("Float", 0, "SprintStamina")
+    self:NetworkVar("Float", "SprintStamina")
+    self:NetworkVar("Float", "SprintCooldownTime")
 
     if SERVER then
         self:SetSprintStamina(1)
     end
 
     -- these are networked variables for the custom FOV handling
-    self:NetworkVar("Float", 1, "FOVTime")
-    self:NetworkVar("Float", 2, "FOVTransitionTime")
-    self:NetworkVar("Float", 3, "FOVValue")
-    self:NetworkVar("Float", 4, "FOVLastValue")
-    self:NetworkVar("Bool", 0, "FOVIsFixed")
+    self:NetworkVar("Float", "FOVTime")
+    self:NetworkVar("Float", "FOVTransitionTime")
+    self:NetworkVar("Float", "FOVValue")
+    self:NetworkVar("Float", "FOVLastValue")
+    self:NetworkVar("Bool", "FOVIsFixed")
 end
 
 ---

gamemodes/terrortown/gamemode/shared/sh_sprint.lua

@@ -31,6 +31,20 @@ SPRINT = {
             { FCVAR_ARCHIVE, FCVAR_NOTIFY, FCVAR_REPLICATED },
             "The regeneration time of the stamina (per second; Def: 0.3)"
         ),
+        -- @realm shared
+        cooldown = CreateConVar(
+            "ttt2_sprint_stamina_cooldown",
+            "0.8",
+            { FCVAR_ARCHIVE, FCVAR_NOTIFY, FCVAR_REPLICATED },
+            "Time before stamina begins regenerating after sprinting (in seconds; Def: 0.8)"
+        ),
+        -- @realm shared
+        forwards_only = CreateConVar(
+            "ttt2_sprint_forwards_only",
+            "1",
+            { FCVAR_ARCHIVE, FCVAR_NOTIFY, FCVAR_REPLICATED },
+            "Disallow sprinting backwards or laterally (Def: 1)"
+        ),
     },
 }
 
@@ -41,10 +55,17 @@ SPRINT = {
 -- @realm shared
 function SPRINT:PlayerWantsToSprint(ply)
     local inSprint = ply:KeyDown(IN_SPEED)
-    local inMovement = ply:KeyDown(IN_FORWARD)
-        or ply:KeyDown(IN_BACK)
-        or ply:KeyDown(IN_MOVERIGHT)
-        or ply:KeyDown(IN_MOVELEFT)
+
+    local inMovement
+
+    if self.convars.forwards_only:GetBool() then
+        inMovement = ply:KeyDown(IN_FORWARD) and not ply:KeyDown(IN_BACK)
+    else
+        inMovement = ply:KeyDown(IN_FORWARD)
+            or ply:KeyDown(IN_BACK)
+            or ply:KeyDown(IN_MOVERIGHT)
+            or ply:KeyDown(IN_MOVELEFT)
+    end
 
     return inSprint and inMovement
 end
@@ -68,6 +89,7 @@ end
 function SPRINT:HandleStaminaCalculation(ply)
     local staminaRegeneratonRate = self.convars.regeneration:GetFloat()
     local staminaConsumptionRate = self.convars.consumption:GetFloat()
+    local staminaCooldownTime = self.convars.cooldown:GetFloat()
 
     local sprintStamina = ply:GetSprintStamina()
     local playerWantsToSprint = self:PlayerWantsToSprint(ply) and not ply:IsInIronsights()
@@ -81,7 +103,7 @@ function SPRINT:HandleStaminaCalculation(ply)
 
     -- Note: This is a table, because it is passed by reference and multiple addons can adjust the value.
     local rateModifier = { 1 }
-    local newStamina = 0
+    local newStamina = sprintStamina
 
     if playerWantsToSprint then
         ---
@@ -90,7 +112,11 @@ function SPRINT:HandleStaminaCalculation(ply)
 
         newStamina =
             math.max(sprintStamina - FrameTime() * rateModifier[1] * staminaConsumptionRate, 0)
-    else
+
+        if staminaCooldownTime > 0 then
+            ply:SetSprintCooldownTime(CurTime() + staminaCooldownTime)
+        end
+    elseif staminaCooldownTime <= 0 or CurTime() > ply:GetSprintCooldownTime() then
         ---
         -- @realm shared
         hook.Run("TTT2StaminaRegen", ply, rateModifier)

lua/terrortown/lang/en.lua

@@ -2832,3 +2832,7 @@ L.choice_distance_unit_3 = "Feet"
 
 -- 2025-03-06
 L.label_armor_block_clubdmg = "Enable armor blocking crowbar damage"
+
+-- 2025-03-10
+L.label_sprint_stamina_cooldown = "Stamina cooldown time"
+L.label_sprint_stamina_forwards_only = "Disallow sprinting backwards or laterally"

lua/terrortown/menus/gamemode/administration/sprint.lua

@@ -39,4 +39,19 @@ function CLGAMEMODESUBMENU:Populate(parent)
         decimal = 2,
         master = enbSprint,
     })
+
+    form:MakeSlider({
+        serverConvar = "ttt2_sprint_stamina_cooldown",
+        label = "label_sprint_stamina_cooldown",
+        min = 0,
+        max = 2,
+        decimal = 2,
+        master = enbSprint,
+    })
+
+    form:MakeCheckBox({
+        serverConvar = "ttt2_sprint_forwards_only",
+        label = "label_sprint_stamina_forwards_only",
+        master = enbSprint,
+    })
 end