mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2026-08-19 05:36:02 +00:00
# Docu fixes
This commit is contained in:
@@ -176,7 +176,7 @@ COMMANDCENTER = {
|
||||
}
|
||||
|
||||
|
||||
--- @type COMMANDCENTER.AutoAssignMethods
|
||||
-- @type COMMANDCENTER.AutoAssignMethods
|
||||
COMMANDCENTER.AutoAssignMethods = {
|
||||
["Random"] = 1,
|
||||
["Distance"] = 2,
|
||||
@@ -205,7 +205,7 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
|
||||
self:SetMessageDuration(10)
|
||||
|
||||
self:HandleEvent( EVENTS.Birth,
|
||||
--- @param #COMMANDCENTER self
|
||||
-- @param #COMMANDCENTER self
|
||||
-- @param Core.Event#EVENTDATA EventData
|
||||
function( self, EventData )
|
||||
if EventData.IniObjectCategory == 1 then
|
||||
@@ -236,7 +236,7 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
|
||||
-- -- - Assign the PlayerUnit to the Task if required.
|
||||
-- -- - Send a message to the other players in the group that this player has joined.
|
||||
-- self:HandleEvent( EVENTS.PlayerEnterUnit,
|
||||
-- --- @param #COMMANDCENTER self
|
||||
-- -- @param #COMMANDCENTER self
|
||||
-- -- @param Core.Event#EVENTDATA EventData
|
||||
-- function( self, EventData )
|
||||
-- local PlayerUnit = EventData.IniUnit
|
||||
@@ -253,7 +253,7 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
|
||||
-- The PlayerUnit will be UnAssigned from the Task.
|
||||
-- When there is no Unit left running the Task, the Task goes into Abort...
|
||||
self:HandleEvent( EVENTS.MissionEnd,
|
||||
--- @param #TASK self
|
||||
-- @param #TASK self
|
||||
-- @param Core.Event#EVENTDATA EventData
|
||||
function( self, EventData )
|
||||
local PlayerUnit = EventData.IniUnit
|
||||
@@ -268,7 +268,7 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
|
||||
-- The PlayerUnit will be UnAssigned from the Task.
|
||||
-- When there is no Unit left running the Task, the Task goes into Abort...
|
||||
self:HandleEvent( EVENTS.PlayerLeaveUnit,
|
||||
--- @param #TASK self
|
||||
-- @param #TASK self
|
||||
-- @param Core.Event#EVENTDATA EventData
|
||||
function( self, EventData )
|
||||
local PlayerUnit = EventData.IniUnit
|
||||
@@ -285,7 +285,7 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
|
||||
-- The PlayerUnit will be UnAssigned from the Task.
|
||||
-- When there is no Unit left running the Task, the Task goes into Abort...
|
||||
self:HandleEvent( EVENTS.Crash,
|
||||
--- @param #TASK self
|
||||
-- @param #TASK self
|
||||
-- @param Core.Event#EVENTDATA EventData
|
||||
function( self, EventData )
|
||||
local PlayerUnit = EventData.IniUnit
|
||||
|
||||
@@ -43,7 +43,7 @@
|
||||
|
||||
do -- DETECTION MANAGER
|
||||
|
||||
--- @type DETECTION_MANAGER
|
||||
-- @type DETECTION_MANAGER
|
||||
-- @field Core.Set#SET_GROUP SetGroup The groups to which the FAC will report to.
|
||||
-- @field Functional.Detection#DETECTION_BASE Detection The DETECTION_BASE object that is used to report the detected objects.
|
||||
-- @field Tasking.CommandCenter#COMMANDCENTER CC The command center that is used to communicate with the players.
|
||||
@@ -57,7 +57,7 @@ do -- DETECTION MANAGER
|
||||
Detection = nil,
|
||||
}
|
||||
|
||||
--- @field Tasking.CommandCenter#COMMANDCENTER
|
||||
-- @field Tasking.CommandCenter#COMMANDCENTER
|
||||
DETECTION_MANAGER.CC = nil
|
||||
|
||||
--- FAC constructor.
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
-- @module Tasking.Mission
|
||||
-- @image Task_Mission.JPG
|
||||
|
||||
--- @type MISSION
|
||||
-- @type MISSION
|
||||
-- @field #MISSION.Clients _Clients
|
||||
-- @field Core.Menu#MENU_COALITION MissionMenu
|
||||
-- @field #string MissionBriefing
|
||||
@@ -785,7 +785,7 @@ function MISSION:HasGroup( TaskGroup )
|
||||
return Has
|
||||
end
|
||||
|
||||
--- @param #MISSION self
|
||||
-- @param #MISSION self
|
||||
-- @return #number
|
||||
function MISSION:GetTasksRemaining()
|
||||
-- Determine how many tasks are remaining.
|
||||
@@ -800,7 +800,7 @@ function MISSION:GetTasksRemaining()
|
||||
return TasksRemaining
|
||||
end
|
||||
|
||||
--- @param #MISSION self
|
||||
-- @param #MISSION self
|
||||
-- @return #number
|
||||
function MISSION:GetTaskTypes()
|
||||
-- Determine how many tasks are remaining.
|
||||
@@ -860,7 +860,7 @@ end
|
||||
---- - <xx> Aborted Tasks (xp)
|
||||
---- - <xx> Failed Tasks (xp)
|
||||
----
|
||||
---- @param #MISSION self
|
||||
-- @param #MISSION self
|
||||
---- @return #string
|
||||
--function MISSION:ReportSummary()
|
||||
--
|
||||
@@ -1170,7 +1170,7 @@ end
|
||||
|
||||
|
||||
|
||||
--- @param #MISSION self
|
||||
-- @param #MISSION self
|
||||
-- @param #string TaskStatus The status
|
||||
-- @param Wrapper.Group#GROUP ReportGroup
|
||||
function MISSION:MenuReportTasksPerStatus( ReportGroup, TaskStatus )
|
||||
@@ -1181,7 +1181,7 @@ function MISSION:MenuReportTasksPerStatus( ReportGroup, TaskStatus )
|
||||
end
|
||||
|
||||
|
||||
--- @param #MISSION self
|
||||
-- @param #MISSION self
|
||||
-- @param Wrapper.Group#GROUP ReportGroup
|
||||
function MISSION:MenuReportPlayersPerTask( ReportGroup )
|
||||
|
||||
@@ -1190,7 +1190,7 @@ function MISSION:MenuReportPlayersPerTask( ReportGroup )
|
||||
self:GetCommandCenter():MessageTypeToGroup( Report, ReportGroup, MESSAGE.Type.Overview )
|
||||
end
|
||||
|
||||
--- @param #MISSION self
|
||||
-- @param #MISSION self
|
||||
-- @param Wrapper.Group#GROUP ReportGroup
|
||||
function MISSION:MenuReportPlayersProgress( ReportGroup )
|
||||
|
||||
|
||||
@@ -215,7 +215,7 @@
|
||||
-- @module Tasking.Task
|
||||
-- @image MOOSE.JPG
|
||||
|
||||
--- @type TASK
|
||||
-- @type TASK
|
||||
-- @field Core.Scheduler#SCHEDULER TaskScheduler
|
||||
-- @field Tasking.Mission#MISSION Mission
|
||||
-- @field Core.Set#SET_GROUP SetGroup The Set of Groups assigned to the Task
|
||||
@@ -721,7 +721,7 @@ function TASK:AddGroups( GroupSet )
|
||||
GroupSet = GroupSet or SET_GROUP:New()
|
||||
|
||||
self.SetGroup:ForEachGroup(
|
||||
--- @param Wrapper.Group#GROUP GroupSet
|
||||
-- @param Wrapper.Group#GROUP GroupSet
|
||||
function( GroupItem )
|
||||
GroupSet:Add( GroupItem:GetName(), GroupItem)
|
||||
end
|
||||
@@ -814,7 +814,7 @@ end
|
||||
|
||||
do -- Group Assignment
|
||||
|
||||
--- @param #TASK self
|
||||
-- @param #TASK self
|
||||
-- @param Actions.Act_Assign#ACT_ASSIGN AcceptClass
|
||||
function TASK:SetAssignMethod( AcceptClass )
|
||||
|
||||
@@ -1194,7 +1194,7 @@ function TASK:RemoveAssignedMenuForGroup( TaskGroup )
|
||||
|
||||
end
|
||||
|
||||
--- @param #TASK self
|
||||
-- @param #TASK self
|
||||
-- @param Wrapper.Group#GROUP TaskGroup
|
||||
function TASK:MenuAssignToGroup( TaskGroup )
|
||||
|
||||
@@ -1203,7 +1203,7 @@ function TASK:MenuAssignToGroup( TaskGroup )
|
||||
self:AssignToGroup( TaskGroup )
|
||||
end
|
||||
|
||||
--- @param #TASK self
|
||||
-- @param #TASK self
|
||||
-- @param Wrapper.Group#GROUP TaskGroup
|
||||
function TASK:MenuMarkToGroup( TaskGroup )
|
||||
self:F()
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
-- @module Tasking.TaskInfo
|
||||
-- @image MOOSE.JPG
|
||||
|
||||
--- @type TASKINFO
|
||||
-- @type TASKINFO
|
||||
-- @extends Core.Base#BASE
|
||||
|
||||
---
|
||||
@@ -24,7 +24,7 @@ TASKINFO = {
|
||||
ClassName = "TASKINFO",
|
||||
}
|
||||
|
||||
--- @type TASKINFO.Detail #string A string that flags to document which level of detail needs to be shown in the report.
|
||||
-- @type TASKINFO.Detail #string A string that flags to document which level of detail needs to be shown in the report.
|
||||
--
|
||||
-- - "M" for Markings on the Map (F10).
|
||||
-- - "S" for Summary Reports.
|
||||
@@ -274,7 +274,7 @@ function TASKINFO:AddCargoSet( SetCargo, Order, Detail, Keep )
|
||||
local CargoReport = REPORT:New()
|
||||
CargoReport:Add( "" )
|
||||
SetCargo:ForEachCargo(
|
||||
--- @param Cargo.Cargo#CARGO Cargo
|
||||
-- @param Cargo.Cargo#CARGO Cargo
|
||||
function( Cargo )
|
||||
CargoReport:Add( string.format( ' - %s (%s) %s - status %s ', Cargo:GetName(), Cargo:GetType(), Cargo:GetTransportationMethod(), Cargo:GetCurrentState() ) )
|
||||
end
|
||||
|
||||
@@ -168,19 +168,19 @@ do -- TASK_A2A
|
||||
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
-- @param Core.Set#SET_UNIT TargetSetUnit The set of targets.
|
||||
function TASK_A2A:SetTargetSetUnit( TargetSetUnit )
|
||||
|
||||
self.TargetSetUnit = TargetSetUnit
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
function TASK_A2A:GetPlannedMenuText()
|
||||
return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.TargetSetUnit:GetUnitTypesText() .. " )"
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
-- @param Core.Point#COORDINATE RendezVousCoordinate The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.
|
||||
-- @param #number RendezVousRange The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
@@ -193,7 +193,7 @@ do -- TASK_A2A
|
||||
ActRouteRendezVous:SetRange( RendezVousRange )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
-- @return Core.Point#COORDINATE The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.
|
||||
-- @return #number The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
|
||||
@@ -205,7 +205,7 @@ do -- TASK_A2A
|
||||
return ActRouteRendezVous:GetCoordinate(), ActRouteRendezVous:GetRange()
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
-- @param Core.Zone#ZONE_BASE RendezVousZone The Zone object where the RendezVous is located on the map.
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
function TASK_A2A:SetRendezVousZone( RendezVousZone, TaskUnit )
|
||||
@@ -216,7 +216,7 @@ do -- TASK_A2A
|
||||
ActRouteRendezVous:SetZone( RendezVousZone )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
-- @return Core.Zone#ZONE_BASE The Zone object where the RendezVous is located on the map.
|
||||
function TASK_A2A:GetRendezVousZone( TaskUnit )
|
||||
@@ -227,7 +227,7 @@ do -- TASK_A2A
|
||||
return ActRouteRendezVous:GetZone()
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
-- @param Core.Point#COORDINATE TargetCoordinate The Coordinate object where the Target is located on the map.
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
function TASK_A2A:SetTargetCoordinate( TargetCoordinate, TaskUnit )
|
||||
@@ -238,7 +238,7 @@ do -- TASK_A2A
|
||||
ActRouteTarget:SetCoordinate( TargetCoordinate )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
-- @return Core.Point#COORDINATE The Coordinate object where the Target is located on the map.
|
||||
function TASK_A2A:GetTargetCoordinate( TaskUnit )
|
||||
@@ -249,7 +249,7 @@ do -- TASK_A2A
|
||||
return ActRouteTarget:GetCoordinate()
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
-- @param Core.Zone#ZONE_BASE TargetZone The Zone object where the Target is located on the map.
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
function TASK_A2A:SetTargetZone( TargetZone, Altitude, Heading, TaskUnit )
|
||||
@@ -260,7 +260,7 @@ do -- TASK_A2A
|
||||
ActRouteTarget:SetZone( TargetZone, Altitude, Heading )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
-- @return Core.Zone#ZONE_BASE The Zone object where the Target is located on the map.
|
||||
function TASK_A2A:GetTargetZone( TaskUnit )
|
||||
@@ -304,7 +304,7 @@ do -- TASK_A2A
|
||||
self:__Goal( -10 )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A self
|
||||
-- @param #TASK_A2A self
|
||||
function TASK_A2A:UpdateTaskInfo( DetectedItem )
|
||||
|
||||
if self:IsStatePlanned() or self:IsStateAssigned() then
|
||||
@@ -496,7 +496,7 @@ do -- TASK_A2A_SWEEP
|
||||
return self
|
||||
end
|
||||
|
||||
--- @param #TASK_A2A_SWEEP self
|
||||
-- @param #TASK_A2A_SWEEP self
|
||||
function TASK_A2A_SWEEP:onafterGoal( TaskUnit, From, Event, To )
|
||||
local TargetSetUnit = self.TargetSetUnit -- Core.Set#SET_UNIT
|
||||
|
||||
|
||||
@@ -148,7 +148,7 @@ do -- TASK_A2A_DISPATCHER
|
||||
--
|
||||
-- TaskDispatcher = TASK_A2A_DISPATCHER:New( ... )
|
||||
--
|
||||
-- --- @param #TaskDispatcher self
|
||||
-- -- @param #TaskDispatcher self
|
||||
-- -- @param #string From Contains the name of the state from where the Event was triggered.
|
||||
-- -- @param #string Event Contains the name of the event that was triggered. In this case Assign.
|
||||
-- -- @param #string To Contains the name of the state that will be transitioned to.
|
||||
|
||||
@@ -170,19 +170,19 @@ do -- TASK_A2G
|
||||
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
-- @param Core.Set#SET_UNIT TargetSetUnit The set of targets.
|
||||
function TASK_A2G:SetTargetSetUnit( TargetSetUnit )
|
||||
|
||||
self.TargetSetUnit = TargetSetUnit
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
function TASK_A2G:GetPlannedMenuText()
|
||||
return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.TargetSetUnit:GetUnitTypesText() .. " )"
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
-- @param Core.Point#COORDINATE RendezVousCoordinate The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.
|
||||
-- @param #number RendezVousRange The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
@@ -195,7 +195,7 @@ do -- TASK_A2G
|
||||
ActRouteRendezVous:SetRange( RendezVousRange )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
-- @return Core.Point#COORDINATE The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.
|
||||
-- @return #number The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
|
||||
@@ -207,7 +207,7 @@ do -- TASK_A2G
|
||||
return ActRouteRendezVous:GetCoordinate(), ActRouteRendezVous:GetRange()
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
-- @param Core.Zone#ZONE_BASE RendezVousZone The Zone object where the RendezVous is located on the map.
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
function TASK_A2G:SetRendezVousZone( RendezVousZone, TaskUnit )
|
||||
@@ -218,7 +218,7 @@ do -- TASK_A2G
|
||||
ActRouteRendezVous:SetZone( RendezVousZone )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
-- @return Core.Zone#ZONE_BASE The Zone object where the RendezVous is located on the map.
|
||||
function TASK_A2G:GetRendezVousZone( TaskUnit )
|
||||
@@ -229,7 +229,7 @@ do -- TASK_A2G
|
||||
return ActRouteRendezVous:GetZone()
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
-- @param Core.Point#COORDINATE TargetCoordinate The Coordinate object where the Target is located on the map.
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
function TASK_A2G:SetTargetCoordinate( TargetCoordinate, TaskUnit )
|
||||
@@ -240,7 +240,7 @@ do -- TASK_A2G
|
||||
ActRouteTarget:SetCoordinate( TargetCoordinate )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
-- @return Core.Point#COORDINATE The Coordinate object where the Target is located on the map.
|
||||
function TASK_A2G:GetTargetCoordinate( TaskUnit )
|
||||
@@ -251,7 +251,7 @@ do -- TASK_A2G
|
||||
return ActRouteTarget:GetCoordinate()
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
-- @param Core.Zone#ZONE_BASE TargetZone The Zone object where the Target is located on the map.
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
function TASK_A2G:SetTargetZone( TargetZone, TaskUnit )
|
||||
@@ -262,7 +262,7 @@ do -- TASK_A2G
|
||||
ActRouteTarget:SetZone( TargetZone )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
-- @return Core.Zone#ZONE_BASE The Zone object where the Target is located on the map.
|
||||
function TASK_A2G:GetTargetZone( TaskUnit )
|
||||
@@ -306,7 +306,7 @@ do -- TASK_A2G
|
||||
self:__Goal( -10 )
|
||||
end
|
||||
|
||||
--- @param #TASK_A2G self
|
||||
-- @param #TASK_A2G self
|
||||
function TASK_A2G:UpdateTaskInfo( DetectedItem )
|
||||
|
||||
if self:IsStatePlanned() or self:IsStateAssigned() then
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -64,7 +64,7 @@ do -- TASK_CAPTURE_DISPATCHER
|
||||
-- @extends Tasking.Task_Manager#TASK_MANAGER
|
||||
-- @field TASK_CAPTURE_DISPATCHER.ZONE ZONE
|
||||
|
||||
--- @type TASK_CAPTURE_DISPATCHER.CSAR
|
||||
-- @type TASK_CAPTURE_DISPATCHER.CSAR
|
||||
-- @field Wrapper.Unit#UNIT PilotUnit
|
||||
-- @field Tasking.Task#TASK Task
|
||||
|
||||
|
||||
@@ -114,7 +114,7 @@ do -- TASK_ZONE_GOAL
|
||||
|
||||
end
|
||||
|
||||
--- @param #TASK_ZONE_GOAL self
|
||||
-- @param #TASK_ZONE_GOAL self
|
||||
-- @param Functional.ZoneGoal#ZONE_GOAL ZoneGoal The ZoneGoal Engine.
|
||||
function TASK_ZONE_GOAL:SetProtect( ZoneGoal )
|
||||
|
||||
@@ -123,13 +123,13 @@ do -- TASK_ZONE_GOAL
|
||||
|
||||
|
||||
|
||||
--- @param #TASK_ZONE_GOAL self
|
||||
-- @param #TASK_ZONE_GOAL self
|
||||
function TASK_ZONE_GOAL:GetPlannedMenuText()
|
||||
return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.ZoneGoal:GetZoneName() .. " )"
|
||||
end
|
||||
|
||||
|
||||
--- @param #TASK_ZONE_GOAL self
|
||||
-- @param #TASK_ZONE_GOAL self
|
||||
-- @param Core.Zone#ZONE_BASE TargetZone The Zone object where the Target is located on the map.
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
function TASK_ZONE_GOAL:SetTargetZone( TargetZone, TaskUnit )
|
||||
@@ -141,7 +141,7 @@ do -- TASK_ZONE_GOAL
|
||||
end
|
||||
|
||||
|
||||
--- @param #TASK_ZONE_GOAL self
|
||||
-- @param #TASK_ZONE_GOAL self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
-- @return Core.Zone#ZONE_BASE The Zone object where the Target is located on the map.
|
||||
function TASK_ZONE_GOAL:GetTargetZone( TaskUnit )
|
||||
@@ -281,7 +281,7 @@ do -- TASK_CAPTURE_ZONE
|
||||
end
|
||||
|
||||
|
||||
--- @param #TASK_CAPTURE_ZONE self
|
||||
-- @param #TASK_CAPTURE_ZONE self
|
||||
-- @param Wrapper.Unit#UNIT TaskUnit
|
||||
function TASK_CAPTURE_ZONE:OnAfterGoal( From, Event, To, PlayerUnit, PlayerName )
|
||||
|
||||
|
||||
@@ -67,7 +67,7 @@
|
||||
|
||||
do -- TASK_CARGO_CSAR
|
||||
|
||||
--- @type TASK_CARGO_CSAR
|
||||
-- @type TASK_CARGO_CSAR
|
||||
-- @extends Tasking.Task_Cargo#TASK_CARGO
|
||||
|
||||
--- Orchestrates the task for players to execute CSAR for downed pilots.
|
||||
@@ -313,7 +313,7 @@ do -- TASK_CARGO_CSAR
|
||||
local CargoReport = REPORT:New( "Rescue a downed pilot from the following position:")
|
||||
|
||||
SetCargo:ForEachCargo(
|
||||
--- @param Core.Cargo#CARGO Cargo
|
||||
-- @param Core.Cargo#CARGO Cargo
|
||||
function( Cargo )
|
||||
local CargoType = Cargo:GetType()
|
||||
local CargoName = Cargo:GetName()
|
||||
@@ -378,7 +378,7 @@ do -- TASK_CARGO_CSAR
|
||||
return CargoDeployed
|
||||
end
|
||||
|
||||
--- @param #TASK_CARGO_CSAR self
|
||||
-- @param #TASK_CARGO_CSAR self
|
||||
function TASK_CARGO_CSAR:onafterGoal( TaskUnit, From, Event, To )
|
||||
local CargoSet = self.CargoSet
|
||||
|
||||
|
||||
@@ -72,7 +72,7 @@ do -- TASK_CARGO_DISPATCHER
|
||||
-- @field TASK_CARGO_DISPATCHER.CSAR CSAR
|
||||
-- @field Core.Set#SET_ZONE SetZonesCSAR
|
||||
|
||||
--- @type TASK_CARGO_DISPATCHER.CSAR
|
||||
-- @type TASK_CARGO_DISPATCHER.CSAR
|
||||
-- @field Wrapper.Unit#UNIT PilotUnit
|
||||
-- @field Tasking.Task#TASK Task
|
||||
|
||||
|
||||
@@ -280,7 +280,7 @@ do -- TASK_CARGO_TRANSPORT
|
||||
local CargoReport = REPORT:New( "Transport Cargo. The following cargo needs to be transported including initial positions:")
|
||||
|
||||
SetCargo:ForEachCargo(
|
||||
--- @param Core.Cargo#CARGO Cargo
|
||||
-- @param Core.Cargo#CARGO Cargo
|
||||
function( Cargo )
|
||||
local CargoType = Cargo:GetType()
|
||||
local CargoName = Cargo:GetName()
|
||||
@@ -343,7 +343,7 @@ do -- TASK_CARGO_TRANSPORT
|
||||
return CargoDeployed
|
||||
end
|
||||
|
||||
--- @param #TASK_CARGO_TRANSPORT self
|
||||
-- @param #TASK_CARGO_TRANSPORT self
|
||||
function TASK_CARGO_TRANSPORT:onafterGoal( TaskUnit, From, Event, To )
|
||||
local CargoSet = self.CargoSet
|
||||
|
||||
|
||||
Reference in New Issue
Block a user