Campaign code improvements and fixes

engine/Core.lua

@@ -10,8 +10,8 @@
 ---@class VectorBase
 ---@field [1] number    # x
 ---@field [2] number    # y
----@field x number
----@field y number
+---@field x number Read only value. Changing it has no effect on the vector. Set `[1]` instead.
+---@field y number Read only value. Changing it has no effect on the vector. Set `[2]` instead.
 
 ---@class Quaternion : VectorBase
 ---@operator mul(Quaternion): Quaternion
@@ -28,7 +28,7 @@
 ---@operator mul(number): Vector
 ---@operator unm: Vector
 ---@field [3] number    # z
----@field z number
+---@field z number Read only value. Changing it has no effect on the vector. Set `[3]` instead.
 
 ---@class Vector2 : VectorBase
 ---@operator add(Vector2): Vector2

engine/Sim.lua

@@ -855,11 +855,12 @@ function IssueFormMove(units, position, formation, degrees)
 end
 
 --- Orders a group of units to patrol to a position in formation
+---
+--- Does NOT return `SimCommand`
 --- @param units Unit[]
 --- @param position Vector
 --- @param formation UnitFormations     # Unit formation to use as defined in `formations.lua`
 --- @param degrees number               # Orientation the platoon takes when it reaches the position. South is 0 degrees, east is 90 degrees, etc.
---- @return SimCommand
 function IssueFormPatrol(units, position, formation, degrees)
 end
 

engine/Sim/CAiBrain.lua

@@ -58,9 +58,9 @@ end
 
 --- Filteres factories that can build the platoon and returns them.
 -- Usually passed table with only one factory as AI picks the highest tech factory as a primary and others are assisting.
----@param template table # Platoon's template.
----@param factories table # containing units-factories.
----@return table tblUnits # containing units-factories.
+---@param template PlatoonTemplate # Platoon's template.
+---@param factories FactoryUnit[] # containing units-factories.
+---@return FactoryUnit[] tblUnits # containing units-factories.
 function CAiBrain:CanBuildPlatoon(template, factories)
 end
 

engine/Sim/Unit.lua

@@ -235,6 +235,7 @@ end
 
 --- Returns number of factory/engineer build orders that fit in the specified category
 ---@param category EntityCategory
+---@return integer
 function Unit:GetNumBuildOrders(category)
 end