Add TransportSpeedReduction to unit blueprint documentation (#6598)

FAForever · Dec 25, 2024 · 8946edc · 8946edc
1 parent cce7a7d
commit 8946edc
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/changelog/snippets/other.6598.md b/changelog/snippets/other.6598.md
@@ -0,0 +1 @@
+- (#6598) Add documentation for the recently added `TransportSpeedReduction` unit blueprint value.
diff --git a/engine/Core/Blueprints/UnitBlueprint.lua b/engine/Core/Blueprints/UnitBlueprint.lua
@@ -1169,6 +1169,9 @@
 ---@field StandUpright boolean
 --- used by XSB3202 when the vertical layer changes from top to sub
 ---@field SubSpeedMultiplier? number
+--- How much this unit slows down transports it is loaded in.  
+--- Defaults to 0.15 (Tech 1), 0.3 (Tech 2), 0.6 (Tech 3), and 1 (ACU/SACU/Experimentals).
+---@field TransportSpeedReduction number
 --- turn facing damping for the unit, usually used for hover units only
 ---@field TurnFacingRate number
 --- turn radius for the unit, in world units. Used when the nav waypoint is further than `TurnRadius` distance,

diff --git a/lua/sim/units/AirTransportUnit.lua b/lua/sim/units/AirTransportUnit.lua
@@ -76,8 +76,6 @@ AirTransport = ClassUnit(AirUnit, BaseTransport) {
     end,
 
     ---@param self AirTransport
-    ---@param totalweight CargoWeight
-    ---@param unit Unit
     ReduceTransportSpeed = function(self)
         local transportspeed = self.Blueprint.Air.MaxAirspeed
         local totalweight = 0
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		- (#6598) Add documentation for the recently added `TransportSpeedReduction` unit blueprint value.