# Docu fixes

This commit is contained in:
Applevangelist
2023-06-22 12:16:03 +02:00
parent 24c58acf85
commit abf694aa81
110 changed files with 587 additions and 571 deletions

View File

@@ -405,7 +405,7 @@
do -- TASK_CARGO
--- @type TASK_CARGO
-- @type TASK_CARGO
-- @extends Tasking.Task#TASK
--- Model tasks for players to transport Cargo.
@@ -616,7 +616,7 @@ do -- TASK_CARGO
Fsm:AddTransition( "Rejected", "Reject", "Aborted" )
Fsm:AddTransition( "Failed", "Fail", "Failed" )
---- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param #TASK_CARGO Task
function Fsm:OnAfterAssigned( TaskUnit, Task )
@@ -639,7 +639,7 @@ do -- TASK_CARGO
Task.SetCargo:ForEachCargo(
--- @param Cargo.Cargo#CARGO Cargo
-- @param Cargo.Cargo#CARGO Cargo
function( Cargo )
if Cargo:IsAlive() then
@@ -833,7 +833,7 @@ do -- TASK_CARGO
--#Wrapper.Unit#UNIT
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
-- @param From
@@ -853,7 +853,7 @@ do -- TASK_CARGO
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterArriveAtPickup( TaskUnit, Task )
@@ -869,7 +869,7 @@ do -- TASK_CARGO
end
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterCancelRouteToPickup( TaskUnit, Task )
@@ -880,7 +880,7 @@ do -- TASK_CARGO
end
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
function Fsm:onafterRouteToDeploy( TaskUnit, Task, From, Event, To, DeployZone )
self:F( { TaskUnit = TaskUnit, Task = Task and Task:GetClassNameAndID() } )
@@ -892,7 +892,7 @@ do -- TASK_CARGO
end
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterArriveAtDeploy( TaskUnit, Task )
@@ -907,7 +907,7 @@ do -- TASK_CARGO
end
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterCancelRouteToDeploy( TaskUnit, Task )
@@ -919,7 +919,7 @@ do -- TASK_CARGO
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterLand( TaskUnit, Task, From, Event, To, Action )
@@ -954,7 +954,7 @@ do -- TASK_CARGO
end
end
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterLanded( TaskUnit, Task, From, Event, To, Action )
@@ -987,7 +987,7 @@ do -- TASK_CARGO
end
end
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterPrepareBoarding( TaskUnit, Task, From, Event, To, Cargo )
@@ -999,7 +999,7 @@ do -- TASK_CARGO
end
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterBoard( TaskUnit, Task, From, Event, To, Cargo )
@@ -1027,7 +1027,7 @@ do -- TASK_CARGO
end
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterBoarded( TaskUnit, Task, From, Event, To, Cargo )
@@ -1042,7 +1042,7 @@ do -- TASK_CARGO
end
--- @param #FSM_PROCESS self
-- @param #FSM_PROCESS self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @param Tasking.Task_Cargo#TASK_CARGO Task
function Fsm:onafterLoad( TaskUnit, Task, From, Event, To, Cargo )
@@ -1191,26 +1191,26 @@ do -- TASK_CARGO
return self.SmokeColor
end
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
function TASK_CARGO:GetPlannedMenuText()
return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.TargetSetUnit:GetUnitTypesText() .. " )"
end
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
-- @return Core.Set#SET_CARGO The Cargo Set.
function TASK_CARGO:GetCargoSet()
return self.SetCargo
end
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
-- @return #list<Core.Zone#ZONE_BASE> The Deployment Zones.
function TASK_CARGO:GetDeployZones()
return self.DeployZones
end
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
-- @param AI.AI_Cargo#AI_CARGO Cargo The cargo.
-- @param Wrapper.Unit#UNIT TaskUnit
-- @return #TASK_CARGO
@@ -1233,7 +1233,7 @@ do -- TASK_CARGO
end
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
-- @param Core.Zone#ZONE DeployZone
-- @param Wrapper.Unit#UNIT TaskUnit
-- @return #TASK_CARGO
@@ -1254,7 +1254,7 @@ do -- TASK_CARGO
end
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
-- @param Core.Zone#ZONE DeployZone
-- @param Wrapper.Unit#UNIT TaskUnit
-- @return #TASK_CARGO
@@ -1265,7 +1265,7 @@ do -- TASK_CARGO
return self
end
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
-- @param Core.Zone#ZONE DeployZone
-- @param Wrapper.Unit#UNIT TaskUnit
-- @return #TASK_CARGO
@@ -1276,7 +1276,7 @@ do -- TASK_CARGO
return self
end
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
-- @param #list<Core.Zone#ZONE> DeployZones
-- @param Wrapper.Unit#UNIT TaskUnit
-- @return #TASK_CARGO
@@ -1291,7 +1291,7 @@ do -- TASK_CARGO
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
-- @param Wrapper.Unit#UNIT TaskUnit
-- @return Core.Zone#ZONE_BASE The Zone object where the Target is located on the map.
function TASK_CARGO:GetTargetZone( TaskUnit )
@@ -1360,7 +1360,7 @@ do -- TASK_CARGO
return self.GoalTotal
end
--- @param #TASK_CARGO self
-- @param #TASK_CARGO self
function TASK_CARGO:UpdateTaskInfo()
if self:IsStatePlanned() or self:IsStateAssigned() then