From: DrSmugleaf <10968691+DrSmugleaf@users.noreply.github.com>
Date: Sat, 11 May 2024 12:11:20 +0000 (-0700)
Subject: Fix shuttle cvars comments (#27923)
X-Git-Url: https://git.smokeofanarchy.ru/gitweb.cgi?a=commitdiff_plain;h=9a04170e8667052716a73acffbb4a1c33d6273d5;p=space-station-14.git

Fix shuttle cvars comments (#27923)

* Fix shuttle cvars comments

* Add another line to ftl mass limit
---

diff --git a/Content.Shared/CCVar/CCVars.cs b/Content.Shared/CCVar/CCVars.cs
index 912e52c71b..67122463ac 100644
--- a/Content.Shared/CCVar/CCVars.cs
+++ b/Content.Shared/CCVar/CCVars.cs
@@ -1,6 +1,7 @@
 using Content.Shared.Maps;
 using Robust.Shared;
 using Robust.Shared.Configuration;
+using Robust.Shared.Physics.Components;
 
 namespace Content.Shared.CCVar
 {
@@ -1382,37 +1383,38 @@ namespace Content.Shared.CCVar
             CVarDef.Create("shuttle.preload_grids", true, CVar.SERVERONLY);
 
         /// <summary>
-        /// Whether to automatically spawn escape shuttles.
+        /// How long the warmup time before FTL start should be.
         /// </summary>
         public static readonly CVarDef<float> FTLStartupTime =
             CVarDef.Create("shuttle.startup_time", 5.5f, CVar.SERVERONLY);
 
         /// <summary>
-        /// Whether to automatically spawn escape shuttles.
+        /// How long a shuttle spends in FTL.
         /// </summary>
         public static readonly CVarDef<float> FTLTravelTime =
             CVarDef.Create("shuttle.travel_time", 20f, CVar.SERVERONLY);
 
         /// <summary>
-        /// Whether to automatically spawn escape shuttles.
+        /// How long the final stage of FTL before arrival should be.
         /// </summary>
         public static readonly CVarDef<float> FTLArrivalTime =
             CVarDef.Create("shuttle.arrival_time", 5f, CVar.SERVERONLY);
 
         /// <summary>
-        /// Whether to automatically spawn escape shuttles.
+        /// How much time needs to pass before a shuttle can FTL again.
         /// </summary>
         public static readonly CVarDef<float> FTLCooldown =
             CVarDef.Create("shuttle.cooldown", 10f, CVar.SERVERONLY);
 
         /// <summary>
-        /// Whether to automatically spawn escape shuttles.
+        /// The maximum <see cref="PhysicsComponent.Mass"/> a grid can have before it becomes unable to FTL.
+        /// Any value equal to or less than zero will disable this check.
         /// </summary>
         public static readonly CVarDef<float> FTLMassLimit =
             CVarDef.Create("shuttle.mass_limit", 300f, CVar.SERVERONLY);
 
         /// <summary>
-        /// Whether to automatically spawn escape shuttles.
+        /// How long to knock down entities for if they aren't buckled when FTL starts and stops.
         /// </summary>
         public static readonly CVarDef<float> HyperspaceKnockdownTime =
             CVarDef.Create("shuttle.hyperspace_knockdown_time", 5f, CVar.SERVERONLY);