Skip to content

Commit

Permalink
Update documentation to remove any confusion for.
Browse files Browse the repository at this point in the history
  • Loading branch information
relent0r committed Dec 28, 2024
1 parent c6cb844 commit 2dfed02
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions engine/Sim/CPlatoon.lua
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ end

--- TODO.
-- Example: local formIt = poolPlatoon:CanFormPlatoon(template, personality:GetPlatoonSize(), self.Location, radius)
---@param template table
---@param size number
---@param location Vector
---@param radius number
function CPlatoon:CanFormPlatoon(template, size, location, radius)
---@param template table The template table for the faction, see platoontemplates for more details.
---@param count number The number of platoons that should be formed.
---@param location Vector The position vector to search for units from.
---@param radius number The radius to search for units.
function CPlatoon:CanFormPlatoon(template, count, location, radius)
end

--- Destroys the platoon including all its units.
Expand Down Expand Up @@ -121,8 +121,12 @@ end

--- TODO.
-- Example: local hndl = poolPlatoon:FormPlatoon(template, personality:GetPlatoonSize(), self.Location, radius)
---@param template table The template table for the faction, see platoontemplates for more details.
---@param count number The number of platoons that should be formed.
---@param position Vector The position vector to search for units from.
---@param radius number The radius to search for units.
-- @return Formed platoon
function CPlatoon:FormPlatoon()
function CPlatoon:FormPlatoon(template, count, position, radius)
end

--- TODO.
Expand Down

0 comments on commit 2dfed02

Please sign in to comment.