Annotate auto assist in InitialAutoMode and SetAutoMode (#6218)

FAForever · May 30, 2024 · fb6fe4a · fb6fe4a
1 parent 6625471
commit fb6fe4a
Show file tree

Hide file tree

Showing 12 changed files with 11 additions and 11 deletions.
diff --git a/changelog/snippets/other.6218.md b/changelog/snippets/other.6218.md
@@ -0,0 +1 @@
+- (#6218) Annotate auto-assist toggling in `InitialAutoMode` and `SetAutoMode`.
diff --git a/engine/Core/Blueprints/UnitBlueprint.lua b/engine/Core/Blueprints/UnitBlueprint.lua
@@ -141,7 +141,8 @@
 ---@field GuardReturnRadius number
 --- guard range for the unit, automatically added if absent
 ---@field GuardScanRadius number
---- initial auto mode behaviour for the unit
+--- initial toggle of automatic behaviors (silo building and auto-assist)
+---@see SetAutoMode
 ---@field InitialAutoMode boolean
 --- unit should unpack before firing weapon
 ---@field NeedUnpack boolean

diff --git a/engine/Sim/Unit.lua b/engine/Sim/Unit.lua
@@ -479,7 +479,7 @@ end
 function Unit:SetAccMult(accelMult)
 end
 
---- sets silo auto-build mode
+--- enable silo auto-build or unit auto-assist
 ---@param mode boolean
 function Unit:SetAutoMode(mode)
 end

diff --git a/engine/User.lua b/engine/User.lua
@@ -1057,7 +1057,7 @@ end
 function SetActiveBuildTemplate(template)
 end
 
---- Set if anyone in the list is auto building
+--- Set if anyone in the list is auto building or auto assisting
 ---@param units UserUnit[]
 ---@param mode boolean
 function SetAutoMode(units, mode)

diff --git a/units/UAL0111/UAL0111_unit.bp b/units/UAL0111/UAL0111_unit.bp
@@ -1,6 +1,6 @@
 UnitBlueprint{
     Description = "<LOC ual0111_desc>Mobile Missile Launcher",
-    AI = { InitialAutoMode = true },
+    AI = { },
     Audio = {
         AmbientMove = Sound { Bank = 'UAL',        Cue = 'UAL0111_Move_Loop',   LodCutoff = 'UnitMove_LodCutoff' },
         Destroyed   = Sound { Bank = 'UALDestroy', Cue = 'UAL_Destroy_Land',    LodCutoff = 'UnitMove_LodCutoff' },

diff --git a/units/UEA0001/UEA0001_unit.bp b/units/UEA0001/UEA0001_unit.bp
@@ -1,4 +1,5 @@
 UnitBlueprint {
+    Description = '<LOC uea0001_desc>Engineering Drone',
     AI = {
         InitialAutoMode = true,
     },
@@ -100,7 +101,6 @@ UnitBlueprint {
         SubThreatLevel = 0,
         SurfaceThreatLevel = 0,
     },
-    Description = '<LOC uea0001_desc>Engineering Drone',
     Display = {
         Abilities = {
             '<LOC ability_engineeringsuite>Engineering Suite',

diff --git a/units/UEA0003/UEA0003_unit.bp b/units/UEA0003/UEA0003_unit.bp
@@ -1,4 +1,5 @@
 UnitBlueprint {
+    Description = '<LOC uea0003_desc>Engineering Drone',
     AI = {
         InitialAutoMode = true,
     },
@@ -100,7 +101,6 @@ UnitBlueprint {
         SubThreatLevel = 0,
         SurfaceThreatLevel = 0,
     },
-    Description = '<LOC uea0003_desc>Engineering Drone',
     Display = {
         Abilities = {
             '<LOC ability_engineeringsuite>Engineering Suite',

diff --git a/units/UEL0111/UEL0111_unit.bp b/units/UEL0111/UEL0111_unit.bp
@@ -1,6 +1,6 @@
 UnitBlueprint{
     Description = "<LOC uel0111_desc>Mobile Missile Launcher",
-    AI = { InitialAutoMode = true },
+    AI = { },
     Audio = {
         AmbientMove = Sound { Bank = 'UEL',        Cue = 'UEL0111_Move_Loop',    LodCutoff = 'UnitMove_LodCutoff' },
         Destroyed   = Sound { Bank = 'UELDestroy', Cue = 'UEL_Destroy_Med_Land', LodCutoff = 'UnitMove_LodCutoff' },

diff --git a/units/UES0202/UES0202_unit.bp b/units/UES0202/UES0202_unit.bp
@@ -3,7 +3,6 @@ UnitBlueprint{
     AI = {
         AttackAngle = 90,
         GuardReturnRadius = 30,
-        InitialAutoMode = true,
         TargetBones = {
             "UES0202",
             "Back_Wake",

diff --git a/units/URL0111/URL0111_unit.bp b/units/URL0111/URL0111_unit.bp
@@ -1,7 +1,6 @@
 UnitBlueprint{
     Description = "<LOC url0111_desc>Mobile Missile Launcher",
     AI = {
-        InitialAutoMode = true,
         TargetBones = { "Launcher" },
     },
     Audio = {

diff --git a/units/XEL0306/XEL0306_unit.bp b/units/XEL0306/XEL0306_unit.bp
@@ -1,6 +1,6 @@
 UnitBlueprint{
     Description = "<LOC xel0306_desc>Mobile Missile Platform",
-    AI = { InitialAutoMode = true },
+    AI = { },
     Audio = {
         AmbientMove = Sound { Bank = 'XEL',        Cue = 'XEL0306_Move_Loop',    LodCutoff = 'UnitMove_LodCutoff' },
         Destroyed   = Sound { Bank = 'UELDestroy', Cue = 'UEL_Destroy_Med_Land', LodCutoff = 'UnitMove_LodCutoff' },

diff --git a/units/XSL0111/XSL0111_unit.bp b/units/XSL0111/XSL0111_unit.bp
@@ -1,6 +1,6 @@
 UnitBlueprint{
     Description = "<LOC xsl0111_desc>Mobile Missile Launcher",
-    AI = { InitialAutoMode = true },
+    AI = { },
     Audio = {
         AmbientMove = Sound { Bank = 'XSL',            Cue = 'XSL0111_Move_Loop',    LodCutoff = 'UnitMove_LodCutoff' },
         Destroyed   = Sound { Bank = 'XSL_Destroy',    Cue = 'XSL_Destroy_Land_Med', LodCutoff = 'UnitMove_LodCutoff' },