Updated Phantom tutorial to show the maximum number of respawns they have, if that setting is enabled

Author: Malivil

RELEASE.md

@@ -10,6 +10,7 @@ Includes beta updates [2.3.1](#231-beta) to [2.3.5](#235-beta).
 
 ### Changes
 - Changed Taskmaster's "Stay Hidden" task to be a bit less lenient
+- Updated Phantom tutorial to show the maximum number of respawns they have, if that setting is enabled
 - Ported "TTT: Reduce Healing sound repetition count in Radio"
 - Ported "TTT: Do not stack round start popups"
   - There is no change in functionality, we just adjusted our implementation of this feature to match the base

gamemodes/terrortown/gamemode/roles/phantom/cl_phantom.lua

@@ -16,6 +16,7 @@ local phantom_weaker_each_respawn = GetConVar("ttt_phantom_weaker_each_respawn")
 local phantom_announce_death = GetConVar("ttt_phantom_announce_death")
 local phantom_killer_footstep_time = GetConVar("ttt_phantom_killer_footstep_time")
 local phantom_respawn = GetConVar("ttt_phantom_respawn")
+local phantom_respawn_limit = GetConVar("ttt_phantom_respawn_limit")
 
 ------------------
 -- TRANSLATIONS --
@@ -230,7 +231,15 @@ hook.Add("TTTTutorialRoleText", "Phantom_TTTTutorialRoleText", function(role, ti
 
         -- Respawn
         if phantom_respawn:GetBool() then
-            html = html .. "<span style='display: block; margin-top: 10px;'>If the " .. ROLE_STRINGS[ROLE_PHANTOM] .. " is killed, they will <span style='color: rgb(" .. roleColor.r .. ", " .. roleColor.g .. ", " .. roleColor.b .. ")'>be resurrected</span> if the person that killed them then dies.</span>"
+            local respawn_limit = phantom_respawn_limit:GetInt()
+
+            html = html .. "<span style='display: block; margin-top: 10px;'>If the " .. ROLE_STRINGS[ROLE_PHANTOM] .. " is killed, they will <span style='color: rgb(" .. roleColor.r .. ", " .. roleColor.g .. ", " .. roleColor.b .. ")'>be resurrected</span> if the person that killed them then dies"
+            if respawn_limit > 1 then
+                html = html .. ", up to " .. respawn_limit .. " times"
+            elseif respawn_limit == 1 then
+                html = html .. ", but only once"
+            end
+            html = html .. ".</span>"
 
             -- Weaker each respawn
             if phantom_weaker_each_respawn:GetBool() then

gamemodes/terrortown/gamemode/roles/phantom/phantom.lua

@@ -28,9 +28,9 @@ local phantom_weaker_each_respawn = GetConVar("ttt_phantom_weaker_each_respawn")
 local phantom_announce_death = GetConVar("ttt_phantom_announce_death")
 local phantom_killer_footstep_time = GetConVar("ttt_phantom_killer_footstep_time")
 local phantom_respawn = GetConVar("ttt_phantom_respawn")
+local phantom_respawn_limit = GetConVar("ttt_phantom_respawn_limit")
 
 local phantom_respawn_health = CreateConVar("ttt_phantom_respawn_health", "50", FCVAR_NONE, "The amount of health a phantom will respawn with", 1, 100)
-local phantom_respawn_limit = CreateConVar("ttt_phantom_respawn_limit", "0", FCVAR_NONE, "The amount of times a phantom can respawn. Set to 0 to have no limit", 0, 20)
 local phantom_killer_haunt_power_rate = CreateConVar("ttt_phantom_killer_haunt_power_rate", "10", FCVAR_NONE, "The amount of power to regain per second when a phantom is haunting their killer", 1, 25)
 local phantom_killer_haunt_power_starting = CreateConVar("ttt_phantom_killer_haunt_power_starting", "0", FCVAR_NONE, "The amount of power to the phantom starts with", 0, 200)
 local phantom_killer_haunt_without_body = CreateConVar("ttt_phantom_killer_haunt_without_body", "1")

gamemodes/terrortown/gamemode/roles/phantom/shared.lua

@@ -24,6 +24,7 @@ CreateConVar("ttt_phantom_weaker_each_respawn", "0", FCVAR_REPLICATED)
 CreateConVar("ttt_phantom_announce_death", "0", FCVAR_REPLICATED)
 CreateConVar("ttt_phantom_killer_footstep_time", "0", FCVAR_REPLICATED, "The amount of time a phantom's killer's footsteps should show before fading. Set to 0 to disable", 0, 60)
 CreateConVar("ttt_phantom_respawn", "1", FCVAR_REPLICATED, "Whether the phantom should respawn when their killer is killed", 0, 1)
+CreateConVar("ttt_phantom_respawn_limit", "0", FCVAR_REPLICATED, "The amount of times a phantom can respawn. Set to 0 to have no limit", 0, 20)
 
 ROLE_CONVARS[ROLE_PHANTOM] = {}
 table.insert(ROLE_CONVARS[ROLE_PHANTOM], {