From abf694aa81989b5be90b13763e642c1ed6376133 Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Thu, 22 Jun 2023 12:16:03 +0200 Subject: [PATCH] # Docu fixes --- Moose Development/Moose/.vscode/settings.json | 9 ++- Moose Development/Moose/AI/AI_A2A_Cap.lua | 2 +- .../Moose/AI/AI_A2A_Dispatcher.lua | 8 +- Moose Development/Moose/AI/AI_A2A_Gci.lua | 2 +- Moose Development/Moose/AI/AI_A2A_Patrol.lua | 2 +- Moose Development/Moose/AI/AI_A2G_BAI.lua | 2 +- Moose Development/Moose/AI/AI_A2G_CAS.lua | 2 +- .../Moose/AI/AI_A2G_Dispatcher.lua | 44 +++++----- Moose Development/Moose/AI/AI_A2G_SEAD.lua | 2 +- Moose Development/Moose/AI/AI_Air.lua | 30 +++---- .../Moose/AI/AI_Air_Dispatcher.lua | 38 ++++----- Moose Development/Moose/AI/AI_Air_Engage.lua | 18 ++--- Moose Development/Moose/AI/AI_Air_Patrol.lua | 2 +- .../Moose/AI/AI_Air_Squadron.lua | 2 +- Moose Development/Moose/AI/AI_BAI.lua | 16 ++-- Moose Development/Moose/AI/AI_Balancer.lua | 14 ++-- Moose Development/Moose/AI/AI_CAP.lua | 18 ++--- Moose Development/Moose/AI/AI_CAS.lua | 16 ++-- Moose Development/Moose/AI/AI_Cargo.lua | 2 +- Moose Development/Moose/AI/AI_Cargo_APC.lua | 2 +- .../Moose/AI/AI_Cargo_Airplane.lua | 2 +- .../Moose/AI/AI_Cargo_Dispatcher.lua | 6 +- .../Moose/AI/AI_Cargo_Dispatcher_APC.lua | 2 +- .../Moose/AI/AI_Cargo_Dispatcher_Airplane.lua | 2 +- .../AI/AI_Cargo_Dispatcher_Helicopter.lua | 2 +- .../Moose/AI/AI_Cargo_Dispatcher_Ship.lua | 2 +- .../Moose/AI/AI_Cargo_Helicopter.lua | 8 +- Moose Development/Moose/AI/AI_Cargo_Ship.lua | 2 +- Moose Development/Moose/AI/AI_Escort.lua | 72 ++++++++--------- .../Moose/AI/AI_Escort_Dispatcher.lua | 8 +- .../Moose/AI/AI_Escort_Dispatcher_Request.lua | 8 +- .../Moose/AI/AI_Escort_Request.lua | 12 +-- Moose Development/Moose/AI/AI_Formation.lua | 16 ++-- Moose Development/Moose/AI/AI_Patrol.lua | 24 +++--- .../Moose/Actions/Act_Account.lua | 6 +- .../Moose/Actions/Act_Assist.lua | 2 +- Moose Development/Moose/Cargo/Cargo.lua | 10 +-- Moose Development/Moose/Cargo/CargoCrate.lua | 2 +- Moose Development/Moose/Cargo/CargoGroup.lua | 6 +- .../Moose/Cargo/CargoSlingload.lua | 2 +- Moose Development/Moose/Core/Base.lua | 6 +- Moose Development/Moose/Core/Database.lua | 4 +- Moose Development/Moose/Core/Event.lua | 2 +- Moose Development/Moose/Core/Fsm.lua | 6 +- Moose Development/Moose/Core/Goal.lua | 8 +- Moose Development/Moose/Core/Menu.lua | 22 ++--- Moose Development/Moose/Core/Point.lua | 4 +- Moose Development/Moose/Core/Report.lua | 2 +- Moose Development/Moose/Core/Set.lua | 80 +++++++++---------- Moose Development/Moose/Core/Settings.lua | 30 +++---- Moose Development/Moose/Core/Spawn.lua | 8 +- Moose Development/Moose/Core/SpawnStatic.lua | 2 +- Moose Development/Moose/Core/Spot.lua | 8 +- Moose Development/Moose/Core/UserFlag.lua | 2 +- Moose Development/Moose/Core/Velocity.lua | 4 +- Moose Development/Moose/Core/Zone.lua | 16 ++-- .../Moose/Core/Zone_Detection.lua | 2 +- Moose Development/Moose/DCS.lua | 78 +++++++++--------- .../Moose/Functional/ATC_Ground.lua | 36 ++++----- .../Moose/Functional/CleanUp.lua | 9 ++- .../Moose/Functional/Designate.lua | 16 ++-- .../Moose/Functional/Detection.lua | 30 +++---- .../Moose/Functional/DetectionZones.lua | 10 +-- Moose Development/Moose/Functional/Escort.lua | 36 ++++----- Moose Development/Moose/Functional/Fox.lua | 2 +- .../Moose/Functional/MissileTrainer.lua | 4 +- .../Moose/Functional/Movement.lua | 2 +- .../Moose/Functional/Scoring.lua | 2 +- Moose Development/Moose/Functional/Sead.lua | 4 +- Moose Development/Moose/Functional/Shorad.lua | 4 +- .../Moose/Functional/Warehouse.lua | 2 +- .../Moose/Functional/ZoneCaptureCoalition.lua | 16 ++-- .../Moose/Functional/ZoneGoal.lua | 4 +- .../Moose/Functional/ZoneGoalCargo.lua | 4 +- .../Moose/Functional/ZoneGoalCoalition.lua | 4 +- Moose Development/Moose/Ops/ATIS.lua | 5 +- Moose Development/Moose/Ops/Auftrag.lua | 3 +- Moose Development/Moose/Ops/Awacs.lua | 19 +++-- Moose Development/Moose/Ops/CSAR.lua | 17 ++-- Moose Development/Moose/Ops/CTLD.lua | 2 +- Moose Development/Moose/Ops/Cohort.lua | 2 +- Moose Development/Moose/Ops/PlayerRecce.lua | 4 +- Moose Development/Moose/Ops/PlayerTask.lua | 2 +- Moose Development/Moose/Sound/SoundOutput.lua | 6 +- Moose Development/Moose/Sound/UserSound.lua | 2 +- .../Moose/Tasking/CommandCenter.lua | 12 +-- .../Moose/Tasking/DetectionManager.lua | 4 +- Moose Development/Moose/Tasking/Mission.lua | 14 ++-- Moose Development/Moose/Tasking/Task.lua | 10 +-- Moose Development/Moose/Tasking/TaskInfo.lua | 6 +- Moose Development/Moose/Tasking/Task_A2A.lua | 24 +++--- .../Moose/Tasking/Task_A2A_Dispatcher.lua | 2 +- Moose Development/Moose/Tasking/Task_A2G.lua | 22 ++--- .../Moose/Tasking/Task_CARGO.lua | 50 ++++++------ .../Moose/Tasking/Task_Capture_Dispatcher.lua | 2 +- .../Moose/Tasking/Task_Capture_Zone.lua | 10 +-- .../Moose/Tasking/Task_Cargo_CSAR.lua | 6 +- .../Moose/Tasking/Task_Cargo_Dispatcher.lua | 2 +- .../Moose/Tasking/Task_Cargo_Transport.lua | 4 +- .../Moose/Utilities/Routines.lua | 2 +- Moose Development/Moose/Utilities/Utils.lua | 4 +- Moose Development/Moose/Wrapper/Airbase.lua | 2 +- Moose Development/Moose/Wrapper/Client.lua | 2 +- .../Moose/Wrapper/Controllable.lua | 4 +- Moose Development/Moose/Wrapper/Group.lua | 4 +- .../Moose/Wrapper/Identifiable.lua | 2 +- Moose Development/Moose/Wrapper/Object.lua | 2 +- .../Moose/Wrapper/Positionable.lua | 8 +- Moose Development/Moose/Wrapper/Static.lua | 2 +- Moose Development/Moose/Wrapper/Unit.lua | 2 +- 110 files changed, 587 insertions(+), 571 deletions(-) diff --git a/Moose Development/Moose/.vscode/settings.json b/Moose Development/Moose/.vscode/settings.json index 13211d027..a8201d6ad 100644 --- a/Moose Development/Moose/.vscode/settings.json +++ b/Moose Development/Moose/.vscode/settings.json @@ -1,7 +1,14 @@ { "Lua.workspace.preloadFileSize": 1000, "Lua.diagnostics.disable": [ - "undefined-doc-name" + "undefined-doc-name", + "duplicate-set-field", + "trailing-space", + "need-check-nil", + "ambiguity-1", + "undefined-doc-param", + "redundant-parameter", + "param-type-mismatch" ], "Lua.diagnostics.globals": [ "BASE", diff --git a/Moose Development/Moose/AI/AI_A2A_Cap.lua b/Moose Development/Moose/AI/AI_A2A_Cap.lua index 61b82e19e..011022576 100644 --- a/Moose Development/Moose/AI/AI_A2A_Cap.lua +++ b/Moose Development/Moose/AI/AI_A2A_Cap.lua @@ -11,7 +11,7 @@ -- @module AI.AI_A2A_Cap -- @image AI_Combat_Air_Patrol.JPG ---- @type AI_A2A_CAP +-- @type AI_A2A_CAP -- @extends AI.AI_Air_Patrol#AI_AIR_PATROL -- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE diff --git a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua index 504d39985..9875352f2 100644 --- a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua @@ -3252,7 +3252,7 @@ do -- AI_A2A_DISPATCHER end end - --- @param #AI_A2A_DISPATCHER self + -- @param #AI_A2A_DISPATCHER self function AI_A2A_Fsm:onafterHome( Defender, From, Event, To, Action ) if Defender and Defender:IsAlive() then self:F( { "CAP Home", Defender:GetName() } ) @@ -3500,7 +3500,7 @@ do -- AI_A2A_DISPATCHER Dispatcher:ClearDefenderTaskTarget( DefenderGroup ) end - --- @param #AI_A2A_DISPATCHER self + -- @param #AI_A2A_DISPATCHER self function Fsm:onafterLostControl( Defender, From, Event, To ) self:F( { "GCI LostControl", Defender:GetName() } ) self:GetParent( self ).onafterHome( self, Defender, From, Event, To ) @@ -3513,7 +3513,7 @@ do -- AI_A2A_DISPATCHER end end - --- @param #AI_A2A_DISPATCHER self + -- @param #AI_A2A_DISPATCHER self function Fsm:onafterHome( DefenderGroup, From, Event, To, Action ) self:F( { "GCI Home", DefenderGroup:GetName() } ) self:GetParent( self ).onafterHome( self, DefenderGroup, From, Event, To ) @@ -3944,7 +3944,7 @@ end do - --- @type AI_A2A_GCICAP + -- @type AI_A2A_GCICAP -- @extends #AI_A2A_DISPATCHER --- Create an automatic air defence system for a coalition setting up GCI and CAP air defenses. diff --git a/Moose Development/Moose/AI/AI_A2A_Gci.lua b/Moose Development/Moose/AI/AI_A2A_Gci.lua index 567ff55c2..0d099f5a1 100644 --- a/Moose Development/Moose/AI/AI_A2A_Gci.lua +++ b/Moose Development/Moose/AI/AI_A2A_Gci.lua @@ -13,7 +13,7 @@ ---- @type AI_A2A_GCI +-- @type AI_A2A_GCI -- @extends AI.AI_A2A#AI_A2A diff --git a/Moose Development/Moose/AI/AI_A2A_Patrol.lua b/Moose Development/Moose/AI/AI_A2A_Patrol.lua index 07fdd43c1..1bb2452c9 100644 --- a/Moose Development/Moose/AI/AI_A2A_Patrol.lua +++ b/Moose Development/Moose/AI/AI_A2A_Patrol.lua @@ -10,7 +10,7 @@ -- @image AI_Air_Patrolling.JPG ---- @type AI_A2A_PATROL +-- @type AI_A2A_PATROL -- @extends AI.AI_A2A#AI_A2A --- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group}. diff --git a/Moose Development/Moose/AI/AI_A2G_BAI.lua b/Moose Development/Moose/AI/AI_A2G_BAI.lua index 4f00f7635..04ac52fe2 100644 --- a/Moose Development/Moose/AI/AI_A2G_BAI.lua +++ b/Moose Development/Moose/AI/AI_A2G_BAI.lua @@ -11,7 +11,7 @@ -- @module AI.AI_A2G_BAI -- @image AI_Air_To_Ground_Engage.JPG ---- @type AI_A2G_BAI +-- @type AI_A2G_BAI -- @extends AI.AI_A2A_Engage#AI_A2A_Engage -- TODO: Documentation. This class does not exist, unable to determine what it extends. --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders. diff --git a/Moose Development/Moose/AI/AI_A2G_CAS.lua b/Moose Development/Moose/AI/AI_A2G_CAS.lua index a1a31414f..0a3cdb5bd 100644 --- a/Moose Development/Moose/AI/AI_A2G_CAS.lua +++ b/Moose Development/Moose/AI/AI_A2G_CAS.lua @@ -11,7 +11,7 @@ -- @module AI.AI_A2G_CAS -- @image AI_Air_To_Ground_Engage.JPG ---- @type AI_A2G_CAS +-- @type AI_A2G_CAS -- @extends AI.AI_A2G_Patrol#AI_AIR_PATROL TODO: Documentation. This class does not exist, unable to determine what it extends. --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders. diff --git a/Moose Development/Moose/AI/AI_A2G_Dispatcher.lua b/Moose Development/Moose/AI/AI_A2G_Dispatcher.lua index cccbdbddc..7a7b9ff3f 100644 --- a/Moose Development/Moose/AI/AI_A2G_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_A2G_Dispatcher.lua @@ -909,14 +909,14 @@ do -- AI_A2G_DISPATCHER -- @type AI_A2G_DISPATCHER.DefenseCoordinates -- @map <#string,Core.Point#COORDINATE> A list of all defense coordinates mapped per defense coordinate name. - --- @field #AI_A2G_DISPATCHER.DefenseCoordinates DefenseCoordinates + -- @field #AI_A2G_DISPATCHER.DefenseCoordinates DefenseCoordinates AI_A2G_DISPATCHER.DefenseCoordinates = {} --- Enumerator for spawns at airbases. -- @type AI_A2G_DISPATCHER.Takeoff -- @extends Wrapper.Group#GROUP.Takeoff - --- @field #AI_A2G_DISPATCHER.Takeoff Takeoff + -- @field #AI_A2G_DISPATCHER.Takeoff Takeoff AI_A2G_DISPATCHER.Takeoff = GROUP.Takeoff --- Defines Landing location. @@ -947,7 +947,7 @@ do -- AI_A2G_DISPATCHER -- @type AI_A2G_DISPATCHER.DefenseQueue -- @list<#AI_A2G_DISPATCHER.DefenseQueueItem> DefenseQueueItem A list of all defenses being queued ... - --- @field #AI_A2G_DISPATCHER.DefenseQueue DefenseQueue + -- @field #AI_A2G_DISPATCHER.DefenseQueue DefenseQueue AI_A2G_DISPATCHER.DefenseQueue = {} --- Defense approach types. @@ -1141,7 +1141,7 @@ do -- AI_A2G_DISPATCHER end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_DISPATCHER:onafterStart( From, Event, To ) self:GetParent( self ).onafterStart( self, From, Event, To ) @@ -1206,7 +1206,7 @@ do -- AI_A2G_DISPATCHER end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_DISPATCHER:ResourcePark( DefenderSquadron ) local TemplateID = math.random( 1, #DefenderSquadron.Spawn ) local Spawn = DefenderSquadron.Spawn[ TemplateID ] -- Core.Spawn#SPAWN @@ -1223,7 +1223,7 @@ do -- AI_A2G_DISPATCHER end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_A2G_DISPATCHER:OnEventBaseCaptured( EventData ) @@ -1242,14 +1242,14 @@ do -- AI_A2G_DISPATCHER end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_A2G_DISPATCHER:OnEventCrashOrDead( EventData ) self.Detection:ForgetDetectedUnit( EventData.IniUnitName ) end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_A2G_DISPATCHER:OnEventLand( EventData ) self:F( "Landed" ) @@ -1266,7 +1266,7 @@ do -- AI_A2G_DISPATCHER self:RemoveDefenderFromSquadron( Squadron, Defender ) end DefenderUnit:Destroy() - self:ResourcePark( Squadron, Defender ) + self:ResourcePark( Squadron ) return end if DefenderUnit:GetLife() ~= DefenderUnit:GetLife0() then @@ -1278,7 +1278,7 @@ do -- AI_A2G_DISPATCHER end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_A2G_DISPATCHER:OnEventEngineShutdown( EventData ) local DefenderUnit = EventData.IniUnit @@ -1294,7 +1294,7 @@ do -- AI_A2G_DISPATCHER self:RemoveDefenderFromSquadron( Squadron, Defender ) end DefenderUnit:Destroy() - self:ResourcePark( Squadron, Defender ) + self:ResourcePark( Squadron ) end end end @@ -1302,7 +1302,7 @@ do -- AI_A2G_DISPATCHER do -- Manage the defensive behaviour - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self -- @param #string DefenseCoordinateName The name of the coordinate to be defended by A2G defenses. -- @param Core.Point#COORDINATE DefenseCoordinate The coordinate to be defended by A2G defenses. function AI_A2G_DISPATCHER:AddDefenseCoordinate( DefenseCoordinateName, DefenseCoordinate ) @@ -1310,19 +1310,19 @@ do -- AI_A2G_DISPATCHER end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_DISPATCHER:SetDefenseReactivityLow() self.DefenseReactivity = 0.05 end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_DISPATCHER:SetDefenseReactivityMedium() self.DefenseReactivity = 0.15 end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_DISPATCHER:SetDefenseReactivityHigh() self.DefenseReactivity = 0.5 end @@ -1873,7 +1873,7 @@ do -- AI_A2G_DISPATCHER end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self -- @param #string SquadronName The squadron name. -- @param #number TakeoffInterval Only Takeoff new units each specified interval in seconds in 10 seconds steps. -- @usage @@ -3374,7 +3374,7 @@ do -- AI_A2G_DISPATCHER end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_DISPATCHER:AddDefenderToSquadron( Squadron, Defender, Size ) self.Defenders = self.Defenders or {} local DefenderName = Defender:GetName() @@ -3385,7 +3385,7 @@ do -- AI_A2G_DISPATCHER self:F( { DefenderName = DefenderName, SquadronResourceCount = Squadron.ResourceCount } ) end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_DISPATCHER:RemoveDefenderFromSquadron( Squadron, Defender ) self.Defenders = self.Defenders or {} local DefenderName = Defender:GetName() @@ -3801,7 +3801,7 @@ do -- AI_A2G_DISPATCHER Dispatcher:ClearDefenderTaskTarget( DefenderGroup ) end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_Fsm:onafterLostControl( DefenderGroup, From, Event, To ) self:F({"LostControl", DefenderGroup:GetName()}) self:GetParent(self).onafterHome( self, DefenderGroup, From, Event, To ) @@ -3818,7 +3818,7 @@ do -- AI_A2G_DISPATCHER end end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_Fsm:onafterHome( DefenderGroup, From, Event, To, Action ) self:F({"Home", DefenderGroup:GetName()}) self:GetParent(self).onafterHome( self, DefenderGroup, From, Event, To ) @@ -3938,7 +3938,7 @@ do -- AI_A2G_DISPATCHER Dispatcher:ClearDefenderTaskTarget( DefenderGroup ) end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_Fsm:onafterLostControl( DefenderGroup, From, Event, To ) self:F({"Defender LostControl", DefenderGroup:GetName()}) self:GetParent(self).onafterHome( self, DefenderGroup, From, Event, To ) @@ -3955,7 +3955,7 @@ do -- AI_A2G_DISPATCHER end end - --- @param #AI_A2G_DISPATCHER self + -- @param #AI_A2G_DISPATCHER self function AI_A2G_Fsm:onafterHome( DefenderGroup, From, Event, To, Action ) self:F({"Defender Home", DefenderGroup:GetName()}) self:GetParent(self).onafterHome( self, DefenderGroup, From, Event, To ) diff --git a/Moose Development/Moose/AI/AI_A2G_SEAD.lua b/Moose Development/Moose/AI/AI_A2G_SEAD.lua index d98c40ee8..55583d270 100644 --- a/Moose Development/Moose/AI/AI_A2G_SEAD.lua +++ b/Moose Development/Moose/AI/AI_A2G_SEAD.lua @@ -13,7 +13,7 @@ ---- @type AI_A2G_SEAD +-- @type AI_A2G_SEAD -- @extends AI.AI_A2G_Patrol#AI_AIR_PATROL diff --git a/Moose Development/Moose/AI/AI_Air.lua b/Moose Development/Moose/AI/AI_Air.lua index dea3ee2a8..9650bfee5 100644 --- a/Moose Development/Moose/AI/AI_Air.lua +++ b/Moose Development/Moose/AI/AI_Air.lua @@ -9,7 +9,7 @@ -- @module AI.AI_Air -- @image MOOSE.JPG ---- @type AI_AIR +-- @type AI_AIR -- @extends Core.Fsm#FSM_CONTROLLABLE --- The AI_AIR class implements the core functions to operate an AI @{Wrapper.Group}. @@ -259,7 +259,7 @@ function AI_AIR:New( AIGroup ) return self end ---- @param Wrapper.Group#GROUP self +-- @param Wrapper.Group#GROUP self -- @param Core.Event#EVENTDATA EventData function GROUP:OnEventTakeoff( EventData, Fsm ) Fsm:Takeoff() @@ -441,13 +441,13 @@ function AI_AIR:onafterReturn( Controllable, From, Event, To ) end ---- @param #AI_AIR self +-- @param #AI_AIR self function AI_AIR:onbeforeStatus() return self.CheckStatus end ---- @param #AI_AIR self +-- @param #AI_AIR self function AI_AIR:onafterStatus() if self.Controllable and self.Controllable:IsAlive() then @@ -555,7 +555,7 @@ function AI_AIR:onafterStatus() end ---- @param Wrapper.Group#GROUP AIGroup +-- @param Wrapper.Group#GROUP AIGroup function AI_AIR.RTBRoute( AIGroup, Fsm ) AIGroup:F( { "AI_AIR.RTBRoute:", AIGroup:GetName() } ) @@ -566,7 +566,7 @@ function AI_AIR.RTBRoute( AIGroup, Fsm ) end ---- @param Wrapper.Group#GROUP AIGroup +-- @param Wrapper.Group#GROUP AIGroup function AI_AIR.RTBHold( AIGroup, Fsm ) AIGroup:F( { "AI_AIR.RTBHold:", AIGroup:GetName() } ) @@ -593,7 +593,7 @@ function AI_AIR:SetRTBSpeedFactors(MinFactor,MaxFactor) end ---- @param #AI_AIR self +-- @param #AI_AIR self -- @param Wrapper.Group#GROUP AIGroup function AI_AIR:onafterRTB( AIGroup, From, Event, To ) self:F( { AIGroup, From, Event, To } ) @@ -681,7 +681,7 @@ function AI_AIR:onafterRTB( AIGroup, From, Event, To ) end ---- @param #AI_AIR self +-- @param #AI_AIR self -- @param Wrapper.Group#GROUP AIGroup function AI_AIR:onafterHome( AIGroup, From, Event, To ) self:F( { AIGroup, From, Event, To } ) @@ -695,7 +695,7 @@ end ---- @param #AI_AIR self +-- @param #AI_AIR self -- @param Wrapper.Group#GROUP AIGroup function AI_AIR:onafterHold( AIGroup, From, Event, To, HoldTime ) self:F( { AIGroup, From, Event, To } ) @@ -717,7 +717,7 @@ function AI_AIR:onafterHold( AIGroup, From, Event, To, HoldTime ) end ---- @param Wrapper.Group#GROUP AIGroup +-- @param Wrapper.Group#GROUP AIGroup function AI_AIR.Resume( AIGroup, Fsm ) AIGroup:I( { "AI_AIR.Resume:", AIGroup:GetName() } ) @@ -727,7 +727,7 @@ function AI_AIR.Resume( AIGroup, Fsm ) end ---- @param #AI_AIR self +-- @param #AI_AIR self -- @param Wrapper.Group#GROUP AIGroup function AI_AIR:onafterRefuel( AIGroup, From, Event, To ) self:F( { AIGroup, From, Event, To } ) @@ -793,13 +793,13 @@ end ---- @param #AI_AIR self +-- @param #AI_AIR self function AI_AIR:onafterDead() self:SetStatusOff() end ---- @param #AI_AIR self +-- @param #AI_AIR self -- @param Core.Event#EVENTDATA EventData function AI_AIR:OnCrash( EventData ) @@ -810,7 +810,7 @@ function AI_AIR:OnCrash( EventData ) end end ---- @param #AI_AIR self +-- @param #AI_AIR self -- @param Core.Event#EVENTDATA EventData function AI_AIR:OnEjection( EventData ) @@ -819,7 +819,7 @@ function AI_AIR:OnEjection( EventData ) end end ---- @param #AI_AIR self +-- @param #AI_AIR self -- @param Core.Event#EVENTDATA EventData function AI_AIR:OnPilotDead( EventData ) diff --git a/Moose Development/Moose/AI/AI_Air_Dispatcher.lua b/Moose Development/Moose/AI/AI_Air_Dispatcher.lua index 7c9c735b5..284c1482d 100644 --- a/Moose Development/Moose/AI/AI_Air_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_Air_Dispatcher.lua @@ -905,14 +905,14 @@ do -- AI_AIR_DISPATCHER -- @type AI_AIR_DISPATCHER.DefenseCoordinates -- @map <#string,Core.Point#COORDINATE> A list of all defense coordinates mapped per defense coordinate name. - --- @field #AI_AIR_DISPATCHER.DefenseCoordinates DefenseCoordinates + -- @field #AI_AIR_DISPATCHER.DefenseCoordinates DefenseCoordinates AI_AIR_DISPATCHER.DefenseCoordinates = {} --- Enumerator for spawns at airbases -- @type AI_AIR_DISPATCHER.Takeoff -- @extends Wrapper.Group#GROUP.Takeoff - --- @field #AI_AIR_DISPATCHER.Takeoff Takeoff + -- @field #AI_AIR_DISPATCHER.Takeoff Takeoff AI_AIR_DISPATCHER.Takeoff = GROUP.Takeoff --- Defnes Landing location. @@ -943,7 +943,7 @@ do -- AI_AIR_DISPATCHER -- @type AI_AIR_DISPATCHER.DefenseQueue -- @list<#AI_AIR_DISPATCHER.DefenseQueueItem> DefenseQueueItem A list of all defenses being queued ... - --- @field #AI_AIR_DISPATCHER.DefenseQueue DefenseQueue + -- @field #AI_AIR_DISPATCHER.DefenseQueue DefenseQueue AI_AIR_DISPATCHER.DefenseQueue = {} --- Defense approach types @@ -1135,7 +1135,7 @@ do -- AI_AIR_DISPATCHER end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self function AI_AIR_DISPATCHER:onafterStart( From, Event, To ) self:GetParent( self ).onafterStart( self, From, Event, To ) @@ -1199,7 +1199,7 @@ do -- AI_AIR_DISPATCHER end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self function AI_AIR_DISPATCHER:ResourcePark( DefenderSquadron ) local TemplateID = math.random( 1, #DefenderSquadron.Spawn ) local Spawn = DefenderSquadron.Spawn[ TemplateID ] -- Core.Spawn#SPAWN @@ -1216,7 +1216,7 @@ do -- AI_AIR_DISPATCHER end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_AIR_DISPATCHER:OnEventBaseCaptured( EventData ) @@ -1234,13 +1234,13 @@ do -- AI_AIR_DISPATCHER end end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_AIR_DISPATCHER:OnEventCrashOrDead( EventData ) self.Detection:ForgetDetectedUnit( EventData.IniUnitName ) end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_AIR_DISPATCHER:OnEventLand( EventData ) self:F( "Landed" ) @@ -1257,7 +1257,7 @@ do -- AI_AIR_DISPATCHER self:RemoveDefenderFromSquadron( Squadron, Defender ) end DefenderUnit:Destroy() - self:ResourcePark( Squadron, Defender ) + self:ResourcePark( Squadron ) return end if DefenderUnit:GetLife() ~= DefenderUnit:GetLife0() then @@ -1268,7 +1268,7 @@ do -- AI_AIR_DISPATCHER end end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_AIR_DISPATCHER:OnEventEngineShutdown( EventData ) local DefenderUnit = EventData.IniUnit @@ -1284,31 +1284,31 @@ do -- AI_AIR_DISPATCHER self:RemoveDefenderFromSquadron( Squadron, Defender ) end DefenderUnit:Destroy() - self:ResourcePark( Squadron, Defender ) + self:ResourcePark( Squadron ) end end end do -- Manage the defensive behaviour - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self -- @param #string DefenseCoordinateName The name of the coordinate to be defended by AIR defenses. -- @param Core.Point#COORDINATE DefenseCoordinate The coordinate to be defended by AIR defenses. function AI_AIR_DISPATCHER:AddDefenseCoordinate( DefenseCoordinateName, DefenseCoordinate ) self.DefenseCoordinates[DefenseCoordinateName] = DefenseCoordinate end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self function AI_AIR_DISPATCHER:SetDefenseReactivityLow() self.DefenseReactivity = 0.05 end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self function AI_AIR_DISPATCHER:SetDefenseReactivityMedium() self.DefenseReactivity = 0.15 end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self function AI_AIR_DISPATCHER:SetDefenseReactivityHigh() self.DefenseReactivity = 0.5 end @@ -1872,7 +1872,7 @@ do -- AI_AIR_DISPATCHER end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self -- @param #string SquadronName The squadron name. -- @param #number TakeoffInterval Only Takeoff new units each specified interval in seconds in 10 seconds steps. -- @usage @@ -2774,7 +2774,7 @@ do -- AI_AIR_DISPATCHER -- TODO: Need to model the resources in a squadron. - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self -- @param AI.AI_Air_Squadron#AI_AIR_SQUADRON Squadron function AI_AIR_DISPATCHER:AddDefenderToSquadron( Squadron, Defender, Size ) self.Defenders = self.Defenders or {} @@ -2787,7 +2787,7 @@ do -- AI_AIR_DISPATCHER self:F( { DefenderName = DefenderName, SquadronResourceCount = Squadron.ResourceCount } ) end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self -- @param AI.AI_Air_Squadron#AI_AIR_SQUADRON Squadron function AI_AIR_DISPATCHER:RemoveDefenderFromSquadron( Squadron, Defender ) self.Defenders = self.Defenders or {} @@ -2800,7 +2800,7 @@ do -- AI_AIR_DISPATCHER self:F( { DefenderName = DefenderName, SquadronResourceCount = SquadronResourceCount } ) end - --- @param #AI_AIR_DISPATCHER self + -- @param #AI_AIR_DISPATCHER self -- @param Wrapper.Group#GROUP Defender -- @return AI.AI_Air_Squadron#AI_AIR_SQUADRON The Squadron. function AI_AIR_DISPATCHER:GetSquadronFromDefender( Defender ) diff --git a/Moose Development/Moose/AI/AI_Air_Engage.lua b/Moose Development/Moose/AI/AI_Air_Engage.lua index 40438daba..12f7a71fc 100644 --- a/Moose Development/Moose/AI/AI_Air_Engage.lua +++ b/Moose Development/Moose/AI/AI_Air_Engage.lua @@ -13,7 +13,7 @@ ---- @type AI_AIR_ENGAGE +-- @type AI_AIR_ENGAGE -- @extends AI.AI_AIR#AI_AIR @@ -367,7 +367,7 @@ function AI_AIR_ENGAGE:onafterAbort( AIGroup, From, Event, To ) end ---- @param #AI_AIR_ENGAGE self +-- @param #AI_AIR_ENGAGE self -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -377,7 +377,7 @@ function AI_AIR_ENGAGE:onafterAccomplish( AIGroup, From, Event, To ) --self:SetDetectionOff() end ---- @param #AI_AIR_ENGAGE self +-- @param #AI_AIR_ENGAGE self -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -390,7 +390,7 @@ function AI_AIR_ENGAGE:onafterDestroy( AIGroup, From, Event, To, EventData ) end end ---- @param #AI_AIR_ENGAGE self +-- @param #AI_AIR_ENGAGE self -- @param Core.Event#EVENTDATA EventData function AI_AIR_ENGAGE:OnEventDead( EventData ) self:F( { "EventDead", EventData } ) @@ -403,7 +403,7 @@ function AI_AIR_ENGAGE:OnEventDead( EventData ) end ---- @param Wrapper.Group#GROUP AIControllable +-- @param Wrapper.Group#GROUP AIControllable function AI_AIR_ENGAGE.___EngageRoute( AIGroup, Fsm, AttackSetUnit ) Fsm:I(string.format("AI_AIR_ENGAGE.___EngageRoute: %s", tostring(AIGroup:GetName()))) @@ -413,7 +413,7 @@ function AI_AIR_ENGAGE.___EngageRoute( AIGroup, Fsm, AttackSetUnit ) end ---- @param #AI_AIR_ENGAGE self +-- @param #AI_AIR_ENGAGE self -- @param Wrapper.Group#GROUP DefenderGroup The GroupGroup managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -494,7 +494,7 @@ function AI_AIR_ENGAGE:onafterEngageRoute( DefenderGroup, From, Event, To, Attac end ---- @param Wrapper.Group#GROUP AIControllable +-- @param Wrapper.Group#GROUP AIControllable function AI_AIR_ENGAGE.___Engage( AIGroup, Fsm, AttackSetUnit ) Fsm:I(string.format("AI_AIR_ENGAGE.___Engage: %s", tostring(AIGroup:GetName()))) @@ -506,7 +506,7 @@ function AI_AIR_ENGAGE.___Engage( AIGroup, Fsm, AttackSetUnit ) end ---- @param #AI_AIR_ENGAGE self +-- @param #AI_AIR_ENGAGE self -- @param Wrapper.Group#GROUP DefenderGroup The GroupGroup managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -591,7 +591,7 @@ function AI_AIR_ENGAGE:onafterEngage( DefenderGroup, From, Event, To, AttackSetU end end ---- @param Wrapper.Group#GROUP AIEngage +-- @param Wrapper.Group#GROUP AIEngage function AI_AIR_ENGAGE.Resume( AIEngage, Fsm ) AIEngage:F( { "Resume:", AIEngage:GetName() } ) diff --git a/Moose Development/Moose/AI/AI_Air_Patrol.lua b/Moose Development/Moose/AI/AI_Air_Patrol.lua index d354ded6f..6b1562817 100644 --- a/Moose Development/Moose/AI/AI_Air_Patrol.lua +++ b/Moose Development/Moose/AI/AI_Air_Patrol.lua @@ -9,7 +9,7 @@ -- @module AI.AI_Air_Patrol -- @image AI_Air_To_Ground_Patrol.JPG ---- @type AI_AIR_PATROL +-- @type AI_AIR_PATROL -- @extends AI.AI_Air#AI_AIR --- The AI_AIR_PATROL class implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Group} diff --git a/Moose Development/Moose/AI/AI_Air_Squadron.lua b/Moose Development/Moose/AI/AI_Air_Squadron.lua index 40585187b..f1a74fecc 100644 --- a/Moose Development/Moose/AI/AI_Air_Squadron.lua +++ b/Moose Development/Moose/AI/AI_Air_Squadron.lua @@ -13,7 +13,7 @@ ---- @type AI_AIR_SQUADRON +-- @type AI_AIR_SQUADRON -- @extends Core.Base#BASE diff --git a/Moose Development/Moose/AI/AI_BAI.lua b/Moose Development/Moose/AI/AI_BAI.lua index 32a6616e9..e2e329d3c 100644 --- a/Moose Development/Moose/AI/AI_BAI.lua +++ b/Moose Development/Moose/AI/AI_BAI.lua @@ -403,7 +403,7 @@ function AI_BAI_ZONE:onafterStart( Controllable, From, Event, To ) self:SetDetectionDeactivated() -- When not engaging, set the detection off. end ---- @param Wrapper.Controllable#CONTROLLABLE AIControllable +-- @param Wrapper.Controllable#CONTROLLABLE AIControllable function _NewEngageRoute( AIControllable ) AIControllable:T( "NewEngageRoute" ) @@ -412,7 +412,7 @@ function _NewEngageRoute( AIControllable ) end ---- @param #AI_BAI_ZONE self +-- @param #AI_BAI_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -424,7 +424,7 @@ function AI_BAI_ZONE:onbeforeEngage( Controllable, From, Event, To ) end end ---- @param #AI_BAI_ZONE self +-- @param #AI_BAI_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -473,7 +473,7 @@ function AI_BAI_ZONE:onafterTarget( Controllable, From, Event, To ) end ---- @param #AI_BAI_ZONE self +-- @param #AI_BAI_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -483,7 +483,7 @@ function AI_BAI_ZONE:onafterAbort( Controllable, From, Event, To ) self:__Route( 1 ) end ---- @param #AI_BAI_ZONE self +-- @param #AI_BAI_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -607,7 +607,7 @@ function AI_BAI_ZONE:onafterEngage( Controllable, From, Event, To, end ---- @param #AI_BAI_ZONE self +-- @param #AI_BAI_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -618,7 +618,7 @@ function AI_BAI_ZONE:onafterAccomplish( Controllable, From, Event, To ) end ---- @param #AI_BAI_ZONE self +-- @param #AI_BAI_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -632,7 +632,7 @@ function AI_BAI_ZONE:onafterDestroy( Controllable, From, Event, To, EventData ) end ---- @param #AI_BAI_ZONE self +-- @param #AI_BAI_ZONE self -- @param Core.Event#EVENTDATA EventData function AI_BAI_ZONE:OnEventDead( EventData ) self:F( { "EventDead", EventData } ) diff --git a/Moose Development/Moose/AI/AI_Balancer.lua b/Moose Development/Moose/AI/AI_Balancer.lua index 047135fb1..6ef9e13f1 100644 --- a/Moose Development/Moose/AI/AI_Balancer.lua +++ b/Moose Development/Moose/AI/AI_Balancer.lua @@ -27,7 +27,7 @@ -- @module AI.AI_Balancer -- @image AI_Balancing.JPG ---- @type AI_BALANCER +-- @type AI_BALANCER -- @field Core.Set#SET_CLIENT SetClient -- @field Core.Spawn#SPAWN SpawnAI -- @field Wrapper.Group#GROUP Test @@ -163,7 +163,7 @@ function AI_BALANCER:ReturnToHomeAirbase( ReturnThresholdRange ) self.ReturnThresholdRange = ReturnThresholdRange end ---- @param #AI_BALANCER self +-- @param #AI_BALANCER self -- @param Core.Set#SET_GROUP SetGroup -- @param #string ClientName -- @param Wrapper.Group#GROUP AIGroup @@ -185,7 +185,7 @@ function AI_BALANCER:onenterSpawning( SetGroup, From, Event, To, ClientName ) end end ---- @param #AI_BALANCER self +-- @param #AI_BALANCER self -- @param Core.Set#SET_GROUP SetGroup -- @param Wrapper.Group#GROUP AIGroup function AI_BALANCER:onenterDestroying( SetGroup, From, Event, To, ClientName, AIGroup ) @@ -229,14 +229,14 @@ function AI_BALANCER:onenterReturning( SetGroup, From, Event, To, AIGroup ) end ---- @param #AI_BALANCER self +-- @param #AI_BALANCER self function AI_BALANCER:onenterMonitoring( SetGroup ) self:T2( { self.SetClient:Count() } ) --self.SetClient:Flush() self.SetClient:ForEachClient( - --- @param Wrapper.Client#CLIENT Client + -- @param Wrapper.Client#CLIENT Client function( Client ) self:T3(Client.ClientName) @@ -259,7 +259,7 @@ function AI_BALANCER:onenterMonitoring( SetGroup ) self:T2( RangeZone ) _DATABASE:ForEachPlayerUnit( - --- @param Wrapper.Unit#UNIT RangeTestUnit + -- @param Wrapper.Unit#UNIT RangeTestUnit function( RangeTestUnit, RangeZone, AIGroup, PlayerInRange ) self:T2( { PlayerInRange, RangeTestUnit.UnitName, RangeZone.ZoneName } ) if RangeTestUnit:IsInZone( RangeZone ) == true then @@ -271,7 +271,7 @@ function AI_BALANCER:onenterMonitoring( SetGroup ) end end, - --- @param Core.Zone#ZONE_RADIUS RangeZone + -- @param Core.Zone#ZONE_RADIUS RangeZone -- @param Wrapper.Group#GROUP AIGroup function( RangeZone, AIGroup, PlayerInRange ) if PlayerInRange.Value == false then diff --git a/Moose Development/Moose/AI/AI_CAP.lua b/Moose Development/Moose/AI/AI_CAP.lua index f767a52cd..252c86297 100644 --- a/Moose Development/Moose/AI/AI_CAP.lua +++ b/Moose Development/Moose/AI/AI_CAP.lua @@ -31,7 +31,7 @@ -- @module AI.AI_CAP -- @image AI_Combat_Air_Patrol.JPG ---- @type AI_CAP_ZONE +-- @type AI_CAP_ZONE -- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling. -- @field Core.Zone#ZONE_BASE TargetZone The @{Core.Zone} where the patrol needs to be executed. -- @extends AI.AI_Patrol#AI_PATROL_ZONE @@ -339,7 +339,7 @@ function AI_CAP_ZONE:onafterStart( Controllable, From, Event, To ) end ---- @param AI.AI_CAP#AI_CAP_ZONE +-- @param AI.AI_CAP#AI_CAP_ZONE -- @param Wrapper.Group#GROUP EngageGroup function AI_CAP_ZONE.EngageRoute( EngageGroup, Fsm ) @@ -350,7 +350,7 @@ function AI_CAP_ZONE.EngageRoute( EngageGroup, Fsm ) end end ---- @param #AI_CAP_ZONE self +-- @param #AI_CAP_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -362,7 +362,7 @@ function AI_CAP_ZONE:onbeforeEngage( Controllable, From, Event, To ) end end ---- @param #AI_CAP_ZONE self +-- @param #AI_CAP_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -390,7 +390,7 @@ function AI_CAP_ZONE:onafterDetected( Controllable, From, Event, To ) end end ---- @param #AI_CAP_ZONE self +-- @param #AI_CAP_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -400,7 +400,7 @@ function AI_CAP_ZONE:onafterAbort( Controllable, From, Event, To ) self:__Route( 1 ) end ---- @param #AI_CAP_ZONE self +-- @param #AI_CAP_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -500,7 +500,7 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To ) end end ---- @param #AI_CAP_ZONE self +-- @param #AI_CAP_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -510,7 +510,7 @@ function AI_CAP_ZONE:onafterAccomplish( Controllable, From, Event, To ) self:SetDetectionOff() end ---- @param #AI_CAP_ZONE self +-- @param #AI_CAP_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -523,7 +523,7 @@ function AI_CAP_ZONE:onafterDestroy( Controllable, From, Event, To, EventData ) end end ---- @param #AI_CAP_ZONE self +-- @param #AI_CAP_ZONE self -- @param Core.Event#EVENTDATA EventData function AI_CAP_ZONE:OnEventDead( EventData ) self:F( { "EventDead", EventData } ) diff --git a/Moose Development/Moose/AI/AI_CAS.lua b/Moose Development/Moose/AI/AI_CAS.lua index d92c6baa4..97348e69c 100644 --- a/Moose Development/Moose/AI/AI_CAS.lua +++ b/Moose Development/Moose/AI/AI_CAS.lua @@ -358,7 +358,7 @@ function AI_CAS_ZONE:onafterStart( Controllable, From, Event, To ) self:SetDetectionDeactivated() -- When not engaging, set the detection off. end ---- @param AI.AI_CAS#AI_CAS_ZONE +-- @param AI.AI_CAS#AI_CAS_ZONE -- @param Wrapper.Group#GROUP EngageGroup function AI_CAS_ZONE.EngageRoute( EngageGroup, Fsm ) @@ -370,7 +370,7 @@ function AI_CAS_ZONE.EngageRoute( EngageGroup, Fsm ) end ---- @param #AI_CAS_ZONE self +-- @param #AI_CAS_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -382,7 +382,7 @@ function AI_CAS_ZONE:onbeforeEngage( Controllable, From, Event, To ) end end ---- @param #AI_CAS_ZONE self +-- @param #AI_CAS_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -415,7 +415,7 @@ function AI_CAS_ZONE:onafterTarget( Controllable, From, Event, To ) end ---- @param #AI_CAS_ZONE self +-- @param #AI_CAS_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -425,7 +425,7 @@ function AI_CAS_ZONE:onafterAbort( Controllable, From, Event, To ) self:__Route( 1 ) end ---- @param #AI_CAS_ZONE self +-- @param #AI_CAS_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -525,7 +525,7 @@ function AI_CAS_ZONE:onafterEngage( Controllable, From, Event, To, end ---- @param #AI_CAS_ZONE self +-- @param #AI_CAS_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -536,7 +536,7 @@ function AI_CAS_ZONE:onafterAccomplish( Controllable, From, Event, To ) end ---- @param #AI_CAS_ZONE self +-- @param #AI_CAS_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. -- @param #string Event The Event string. @@ -550,7 +550,7 @@ function AI_CAS_ZONE:onafterDestroy( Controllable, From, Event, To, EventData ) end ---- @param #AI_CAS_ZONE self +-- @param #AI_CAS_ZONE self -- @param Core.Event#EVENTDATA EventData function AI_CAS_ZONE:OnEventDead( EventData ) self:F( { "EventDead", EventData } ) diff --git a/Moose Development/Moose/AI/AI_Cargo.lua b/Moose Development/Moose/AI/AI_Cargo.lua index 43d5eb358..8d6fef8ed 100644 --- a/Moose Development/Moose/AI/AI_Cargo.lua +++ b/Moose Development/Moose/AI/AI_Cargo.lua @@ -9,7 +9,7 @@ -- @module AI.AI_Cargo -- @image Cargo.JPG ---- @type AI_CARGO +-- @type AI_CARGO -- @extends Core.Fsm#FSM_CONTROLLABLE diff --git a/Moose Development/Moose/AI/AI_Cargo_APC.lua b/Moose Development/Moose/AI/AI_Cargo_APC.lua index 6bc78debb..f5f25f8a7 100644 --- a/Moose Development/Moose/AI/AI_Cargo_APC.lua +++ b/Moose Development/Moose/AI/AI_Cargo_APC.lua @@ -9,7 +9,7 @@ -- @module AI.AI_Cargo_APC -- @image AI_Cargo_Dispatching_For_APC.JPG ---- @type AI_CARGO_APC +-- @type AI_CARGO_APC -- @extends AI.AI_Cargo#AI_CARGO diff --git a/Moose Development/Moose/AI/AI_Cargo_Airplane.lua b/Moose Development/Moose/AI/AI_Cargo_Airplane.lua index ede3d20bd..9275c62be 100644 --- a/Moose Development/Moose/AI/AI_Cargo_Airplane.lua +++ b/Moose Development/Moose/AI/AI_Cargo_Airplane.lua @@ -9,7 +9,7 @@ -- @module AI.AI_Cargo_Airplane -- @image AI_Cargo_Dispatching_For_Airplanes.JPG ---- @type AI_CARGO_AIRPLANE +-- @type AI_CARGO_AIRPLANE -- @extends Core.Fsm#FSM_CONTROLLABLE diff --git a/Moose Development/Moose/AI/AI_Cargo_Dispatcher.lua b/Moose Development/Moose/AI/AI_Cargo_Dispatcher.lua index ec725d5f8..9929b5d4c 100644 --- a/Moose Development/Moose/AI/AI_Cargo_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_Cargo_Dispatcher.lua @@ -111,7 +111,7 @@ -- @image AI_Cargo_Dispatcher.JPG ---- @type AI_CARGO_DISPATCHER +-- @type AI_CARGO_DISPATCHER -- @field Core.Set#SET_GROUP CarrierSet The set of @{Wrapper.Group#GROUP} objects of carriers that will transport the cargo. -- @field Core.Set#SET_CARGO CargoSet The set of @{Cargo.Cargo#CARGO} objects, which can be CARGO_GROUP, CARGO_CRATE, CARGO_SLINGLOAD objects. -- @field Core.Zone#SET_ZONE PickupZoneSet The set of pickup zones, which are used to where the cargo can be picked up by the carriers. If nil, then cargo can be picked up everywhere. @@ -578,10 +578,10 @@ AI_CARGO_DISPATCHER = { PickupCargo = {} } ---- @field #list +-- @field #list AI_CARGO_DISPATCHER.AI_Cargo = {} ---- @field #list +-- @field #list AI_CARGO_DISPATCHER.PickupCargo = {} diff --git a/Moose Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua b/Moose Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua index cd530ab24..e25725394 100644 --- a/Moose Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua +++ b/Moose Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua @@ -30,7 +30,7 @@ -- @module AI.AI_Cargo_Dispatcher_APC -- @image AI_Cargo_Dispatching_For_APC.JPG ---- @type AI_CARGO_DISPATCHER_APC +-- @type AI_CARGO_DISPATCHER_APC -- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER diff --git a/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua b/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua index 81121e357..bc5deaa42 100644 --- a/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua +++ b/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua @@ -24,7 +24,7 @@ -- @image AI_Cargo_Dispatching_For_Airplanes.JPG ---- @type AI_CARGO_DISPATCHER_AIRPLANE +-- @type AI_CARGO_DISPATCHER_AIRPLANE -- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER diff --git a/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua b/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua index 33e6ca0d1..89c9cb771 100644 --- a/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua +++ b/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua @@ -25,7 +25,7 @@ -- @module AI.AI_Cargo_Dispatcher_Helicopter -- @image AI_Cargo_Dispatching_For_Helicopters.JPG ---- @type AI_CARGO_DISPATCHER_HELICOPTER +-- @type AI_CARGO_DISPATCHER_HELICOPTER -- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER diff --git a/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Ship.lua b/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Ship.lua index 36604f30b..dfb445680 100644 --- a/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Ship.lua +++ b/Moose Development/Moose/AI/AI_Cargo_Dispatcher_Ship.lua @@ -23,7 +23,7 @@ -- @module AI.AI_Cargo_Dispatcher_Ship -- @image AI_Cargo_Dispatcher.JPG ---- @type AI_CARGO_DISPATCHER_SHIP +-- @type AI_CARGO_DISPATCHER_SHIP -- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER diff --git a/Moose Development/Moose/AI/AI_Cargo_Helicopter.lua b/Moose Development/Moose/AI/AI_Cargo_Helicopter.lua index 2c1d5c028..20fb3e7e5 100644 --- a/Moose Development/Moose/AI/AI_Cargo_Helicopter.lua +++ b/Moose Development/Moose/AI/AI_Cargo_Helicopter.lua @@ -9,7 +9,7 @@ -- @module AI.AI_Cargo_Helicopter -- @image AI_Cargo_Dispatching_For_Helicopters.JPG ---- @type AI_CARGO_HELICOPTER +-- @type AI_CARGO_HELICOPTER -- @extends Core.Fsm#FSM_CONTROLLABLE @@ -282,7 +282,7 @@ function AI_CARGO_HELICOPTER:SetLandingSpeedAndHeight(speed, height) return self end ---- @param #AI_CARGO_HELICOPTER self +-- @param #AI_CARGO_HELICOPTER self -- @param Wrapper.Group#GROUP Helicopter -- @param From -- @param Event @@ -321,7 +321,7 @@ function AI_CARGO_HELICOPTER:onafterLanded( Helicopter, From, Event, To ) end ---- @param #AI_CARGO_HELICOPTER self +-- @param #AI_CARGO_HELICOPTER self -- @param Wrapper.Group#GROUP Helicopter -- @param From -- @param Event @@ -404,7 +404,7 @@ function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordina end ---- @param #AI_CARGO_HELICOPTER self +-- @param #AI_CARGO_HELICOPTER self -- @param Wrapper.Group#GROUP Helicopter -- @param From -- @param Event diff --git a/Moose Development/Moose/AI/AI_Cargo_Ship.lua b/Moose Development/Moose/AI/AI_Cargo_Ship.lua index 8722e5026..f902f153f 100644 --- a/Moose Development/Moose/AI/AI_Cargo_Ship.lua +++ b/Moose Development/Moose/AI/AI_Cargo_Ship.lua @@ -9,7 +9,7 @@ -- @module AI.AI_Cargo_Ship -- @image AI_Cargo_Dispatcher.JPG ---- @type AI_CARGO_SHIP +-- @type AI_CARGO_SHIP -- @extends AI.AI_Cargo#AI_CARGO --- Brings a dynamic cargo handling capability for an AI naval group. diff --git a/Moose Development/Moose/AI/AI_Escort.lua b/Moose Development/Moose/AI/AI_Escort.lua index e18948790..ee84d118f 100644 --- a/Moose Development/Moose/AI/AI_Escort.lua +++ b/Moose Development/Moose/AI/AI_Escort.lua @@ -148,7 +148,7 @@ ---- @type AI_ESCORT +-- @type AI_ESCORT -- @extends AI.AI_Formation#AI_FORMATION @@ -189,7 +189,7 @@ AI_ESCORT = { TaskPoints = {} } ---- @field Functional.Detection#DETECTION_AREAS +-- @field Functional.Detection#DETECTION_AREAS AI_ESCORT.Detection = nil --- MENUPARAM type @@ -250,7 +250,7 @@ function AI_ESCORT:New( EscortUnit, EscortGroupSet, EscortName, EscortBriefing ) EscortGroupSet:ForEachGroup( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) -- Set EscortGroup known at EscortUnit. if not self.PlayerUnit._EscortGroups then @@ -325,14 +325,14 @@ function AI_ESCORT:_InitEscortRoute( EscortGroup ) end ---- @param #AI_ESCORT self +-- @param #AI_ESCORT self -- @param Core.Set#SET_GROUP EscortGroupSet function AI_ESCORT:onafterStart( EscortGroupSet ) self:F() EscortGroupSet:ForEachGroup( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) EscortGroup:WayPointInitialize() @@ -370,7 +370,7 @@ function AI_ESCORT:onafterStart( EscortGroupSet ) self:_InitFlightMenus() self.EscortGroupSet:ForSomeGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) self:_InitEscortMenus( EscortGroup ) @@ -378,7 +378,7 @@ function AI_ESCORT:onafterStart( EscortGroupSet ) self:SetFlightModeFormation( EscortGroup ) - --- @param #AI_ESCORT self + -- @param #AI_ESCORT self -- @param Core.Event#EVENTDATA EventData function EscortGroup:OnEventDeadOrCrash( EventData ) self:F( { "EventDead", EventData } ) @@ -394,14 +394,14 @@ function AI_ESCORT:onafterStart( EscortGroupSet ) end ---- @param #AI_ESCORT self +-- @param #AI_ESCORT self -- @param Core.Set#SET_GROUP EscortGroupSet function AI_ESCORT:onafterStop( EscortGroupSet ) self:F() EscortGroupSet:ForEachGroup( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) EscortGroup:WayPointInitialize() @@ -550,7 +550,7 @@ function AI_ESCORT:SetFlightMenuFormation( Formation ) local MenuFlightFormationID = MENU_GROUP_COMMAND:New( self.PlayerGroup, Formation, FlightMenuFormation, function ( self, Formation, ... ) self.EscortGroupSet:ForSomeGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup, self, Formation, Arguments ) if EscortGroup:IsAir() then self:E({FormationID=FormationID}) @@ -1231,7 +1231,7 @@ function AI_ESCORT:MenuAssistedAttack() self:F() self.EscortGroupSet:ForSomeGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) if not EscortGroup:IsAir() then -- Request assistance from other escorts. @@ -1375,7 +1375,7 @@ function AI_ESCORT:SetEscortMenuResumeMission( EscortGroup ) end ---- @param #AI_ESCORT self +-- @param #AI_ESCORT self -- @param Wrapper.Group#GROUP OrbitGroup -- @param Wrapper.Group#GROUP EscortGroup -- @param #number OrbitHeight @@ -1419,7 +1419,7 @@ function AI_ESCORT:_HoldPosition( OrbitGroup, EscortGroup, OrbitHeight, OrbitSec end ---- @param #AI_ESCORT self +-- @param #AI_ESCORT self -- @param Wrapper.Group#GROUP OrbitGroup -- @param #number OrbitHeight -- @param #number OrbitSeconds @@ -1428,7 +1428,7 @@ function AI_ESCORT:_FlightHoldPosition( OrbitGroup, OrbitHeight, OrbitSeconds ) local EscortUnit = self.PlayerUnit self.EscortGroupSet:ForEachGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup, OrbitGroup ) if EscortGroup:IsAir() then if OrbitGroup == nil then @@ -1456,7 +1456,7 @@ end function AI_ESCORT:_FlightJoinUp() self.EscortGroupSet:ForEachGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) if EscortGroup:IsAir() then self:_JoinUp( EscortGroup ) @@ -1483,7 +1483,7 @@ end function AI_ESCORT:_FlightFormationTrail( XStart, XSpace, YStart ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) if EscortGroup:IsAir() then self:_EscortFormationTrail( EscortGroup, XStart, XSpace, YStart ) @@ -1510,7 +1510,7 @@ end function AI_ESCORT:_FlightFormationStack( XStart, XSpace, YStart, YSpace ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) if EscortGroup:IsAir() then self:_EscortFormationStack( EscortGroup, XStart, XSpace, YStart, YSpace ) @@ -1533,7 +1533,7 @@ end function AI_ESCORT:_FlightFlare( Color, Message ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) if EscortGroup:IsAir() then self:_Flare( EscortGroup, Color, Message ) @@ -1556,7 +1556,7 @@ end function AI_ESCORT:_FlightSmoke( Color, Message ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) if EscortGroup:IsAir() then self:_Smoke( EscortGroup, Color, Message ) @@ -1587,7 +1587,7 @@ end function AI_ESCORT:_FlightSwitchReportNearbyTargets( ReportTargets ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) if EscortGroup:IsAir() then self:_EscortSwitchReportNearbyTargets( EscortGroup, ReportTargets ) @@ -1679,7 +1679,7 @@ function AI_ESCORT:_ScanTargets( ScanDuration ) end ---- @param Wrapper.Group#GROUP EscortGroup +-- @param Wrapper.Group#GROUP EscortGroup -- @param #AI_ESCORT self function AI_ESCORT.___Resume( EscortGroup, self ) @@ -1701,7 +1701,7 @@ function AI_ESCORT.___Resume( EscortGroup, self ) end ---- @param #AI_ESCORT self +-- @param #AI_ESCORT self -- @param Wrapper.Group#GROUP EscortGroup -- @param #number WayPoint function AI_ESCORT:_ResumeMission( EscortGroup, WayPoint ) @@ -1723,7 +1723,7 @@ function AI_ESCORT:_ResumeMission( EscortGroup, WayPoint ) end ---- @param #AI_ESCORT self +-- @param #AI_ESCORT self -- @param Wrapper.Group#GROUP EscortGroup The escort group that will attack the detected item. -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem function AI_ESCORT:_AttackTarget( EscortGroup, DetectedItem ) @@ -1743,7 +1743,7 @@ function AI_ESCORT:_AttackTarget( EscortGroup, DetectedItem ) local AttackUnitTasks = {} DetectedSet:ForEachUnit( - --- @param Wrapper.Unit#UNIT DetectedUnit + -- @param Wrapper.Unit#UNIT DetectedUnit function( DetectedUnit, Tasks ) if DetectedUnit:IsAlive() then AttackUnitTasks[#AttackUnitTasks+1] = EscortGroup:TaskAttackUnit( DetectedUnit ) @@ -1767,7 +1767,7 @@ function AI_ESCORT:_AttackTarget( EscortGroup, DetectedItem ) local Tasks = {} DetectedSet:ForEachUnit( - --- @param Wrapper.Unit#UNIT DetectedUnit + -- @param Wrapper.Unit#UNIT DetectedUnit function( DetectedUnit, Tasks ) if DetectedUnit:IsAlive() then Tasks[#Tasks+1] = EscortGroup:TaskFireAtPoint( DetectedUnit:GetVec2(), 50 ) @@ -1795,7 +1795,7 @@ end function AI_ESCORT:_FlightAttackTarget( DetectedItem ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup, DetectedItem ) if EscortGroup:IsAir() then self:_AttackTarget( EscortGroup, DetectedItem ) @@ -1842,7 +1842,7 @@ end --- ---- @param #AI_ESCORT self +-- @param #AI_ESCORT self -- @param Wrapper.Group#GROUP EscortGroup The escort group that will attack the detected item. -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem function AI_ESCORT:_AssistTarget( EscortGroup, DetectedItem ) @@ -1854,7 +1854,7 @@ function AI_ESCORT:_AssistTarget( EscortGroup, DetectedItem ) local Tasks = {} DetectedSet:ForEachUnit( - --- @param Wrapper.Unit#UNIT DetectedUnit + -- @param Wrapper.Unit#UNIT DetectedUnit function( DetectedUnit, Tasks ) if DetectedUnit:IsAlive() then Tasks[#Tasks+1] = EscortGroup:TaskFireAtPoint( DetectedUnit:GetVec2(), 50 ) @@ -1881,7 +1881,7 @@ end function AI_ESCORT:_FlightROEHoldFire( EscortROEMessage ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP EscortGroup + -- @param Wrapper.Group#GROUP EscortGroup function( EscortGroup ) self:_ROE( EscortGroup, EscortGroup.OptionROEHoldFire, EscortROEMessage ) end @@ -1890,7 +1890,7 @@ end function AI_ESCORT:_FlightROEOpenFire( EscortROEMessage ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP EscortGroup + -- @param Wrapper.Group#GROUP EscortGroup function( EscortGroup ) self:_ROE( EscortGroup, EscortGroup.OptionROEOpenFire, EscortROEMessage ) end @@ -1899,7 +1899,7 @@ end function AI_ESCORT:_FlightROEReturnFire( EscortROEMessage ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP EscortGroup + -- @param Wrapper.Group#GROUP EscortGroup function( EscortGroup ) self:_ROE( EscortGroup, EscortGroup.OptionROEReturnFire, EscortROEMessage ) end @@ -1908,7 +1908,7 @@ end function AI_ESCORT:_FlightROEWeaponFree( EscortROEMessage ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP EscortGroup + -- @param Wrapper.Group#GROUP EscortGroup function( EscortGroup ) self:_ROE( EscortGroup, EscortGroup.OptionROEWeaponFree, EscortROEMessage ) end @@ -1924,7 +1924,7 @@ end function AI_ESCORT:_FlightROTNoReaction( EscortROTMessage ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP EscortGroup + -- @param Wrapper.Group#GROUP EscortGroup function( EscortGroup ) self:_ROT( EscortGroup, EscortGroup.OptionROTNoReaction, EscortROTMessage ) end @@ -1933,7 +1933,7 @@ end function AI_ESCORT:_FlightROTPassiveDefense( EscortROTMessage ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP EscortGroup + -- @param Wrapper.Group#GROUP EscortGroup function( EscortGroup ) self:_ROT( EscortGroup, EscortGroup.OptionROTPassiveDefense, EscortROTMessage ) end @@ -1942,7 +1942,7 @@ end function AI_ESCORT:_FlightROTEvadeFire( EscortROTMessage ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP EscortGroup + -- @param Wrapper.Group#GROUP EscortGroup function( EscortGroup ) self:_ROT( EscortGroup, EscortGroup.OptionROTEvadeFire, EscortROTMessage ) end @@ -1951,7 +1951,7 @@ end function AI_ESCORT:_FlightROTVertical( EscortROTMessage ) self.EscortGroupSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP EscortGroup + -- @param Wrapper.Group#GROUP EscortGroup function( EscortGroup ) self:_ROT( EscortGroup, EscortGroup.OptionROTVertical, EscortROTMessage ) end diff --git a/Moose Development/Moose/AI/AI_Escort_Dispatcher.lua b/Moose Development/Moose/AI/AI_Escort_Dispatcher.lua index 26e89a728..7af67f5f0 100644 --- a/Moose Development/Moose/AI/AI_Escort_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_Escort_Dispatcher.lua @@ -15,7 +15,7 @@ -- @image MOOSE.JPG ---- @type AI_ESCORT_DISPATCHER +-- @type AI_ESCORT_DISPATCHER -- @extends Core.Fsm#FSM @@ -28,7 +28,7 @@ AI_ESCORT_DISPATCHER = { ClassName = "AI_ESCORT_DISPATCHER", } ---- @field #list +-- @field #list AI_ESCORT_DISPATCHER.AI_Escorts = {} @@ -97,7 +97,7 @@ function AI_ESCORT_DISPATCHER:onafterStart( From, Event, To ) end ---- @param #AI_ESCORT_DISPATCHER self +-- @param #AI_ESCORT_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_ESCORT_DISPATCHER:OnEventExit( EventData ) @@ -120,7 +120,7 @@ function AI_ESCORT_DISPATCHER:OnEventExit( EventData ) end ---- @param #AI_ESCORT_DISPATCHER self +-- @param #AI_ESCORT_DISPATCHER self -- @param Core.Event#EVENTDATA EventData function AI_ESCORT_DISPATCHER:OnEventBirth( EventData ) diff --git a/Moose Development/Moose/AI/AI_Escort_Dispatcher_Request.lua b/Moose Development/Moose/AI/AI_Escort_Dispatcher_Request.lua index 25d29b7e5..8b671c368 100644 --- a/Moose Development/Moose/AI/AI_Escort_Dispatcher_Request.lua +++ b/Moose Development/Moose/AI/AI_Escort_Dispatcher_Request.lua @@ -15,7 +15,7 @@ -- @image MOOSE.JPG ---- @type AI_ESCORT_DISPATCHER_REQUEST +-- @type AI_ESCORT_DISPATCHER_REQUEST -- @extends Core.Fsm#FSM @@ -28,7 +28,7 @@ AI_ESCORT_DISPATCHER_REQUEST = { ClassName = "AI_ESCORT_DISPATCHER_REQUEST", } ---- @field #list +-- @field #list AI_ESCORT_DISPATCHER_REQUEST.AI_Escorts = {} @@ -75,7 +75,7 @@ function AI_ESCORT_DISPATCHER_REQUEST:onafterStart( From, Event, To ) end ---- @param #AI_ESCORT_DISPATCHER_REQUEST self +-- @param #AI_ESCORT_DISPATCHER_REQUEST self -- @param Core.Event#EVENTDATA EventData function AI_ESCORT_DISPATCHER_REQUEST:OnEventExit( EventData ) @@ -92,7 +92,7 @@ function AI_ESCORT_DISPATCHER_REQUEST:OnEventExit( EventData ) end ---- @param #AI_ESCORT_DISPATCHER_REQUEST self +-- @param #AI_ESCORT_DISPATCHER_REQUEST self -- @param Core.Event#EVENTDATA EventData function AI_ESCORT_DISPATCHER_REQUEST:OnEventBirth( EventData ) diff --git a/Moose Development/Moose/AI/AI_Escort_Request.lua b/Moose Development/Moose/AI/AI_Escort_Request.lua index c7d109fff..b56e7d1c7 100644 --- a/Moose Development/Moose/AI/AI_Escort_Request.lua +++ b/Moose Development/Moose/AI/AI_Escort_Request.lua @@ -148,7 +148,7 @@ ---- @type AI_ESCORT_REQUEST +-- @type AI_ESCORT_REQUEST -- @extends AI.AI_Escort#AI_ESCORT --- AI_ESCORT_REQUEST class @@ -223,7 +223,7 @@ function AI_ESCORT_REQUEST:New( EscortUnit, EscortSpawn, EscortAirbase, EscortNa return self end ---- @param #AI_ESCORT_REQUEST self +-- @param #AI_ESCORT_REQUEST self function AI_ESCORT_REQUEST:SpawnEscort() local EscortGroup = self.EscortSpawn:SpawnAtAirbase( self.EscortAirbase, SPAWN.Takeoff.Hot ) @@ -248,7 +248,7 @@ function AI_ESCORT_REQUEST:SpawnEscort() self:_InitEscortMenus( EscortGroup ) self:_InitEscortRoute( EscortGroup ) - --- @param #AI_ESCORT self + -- @param #AI_ESCORT self -- @param Core.Event#EVENTDATA EventData function EscortGroup:OnEventDeadOrCrash( EventData ) self:F( { "EventDead", EventData } ) @@ -263,7 +263,7 @@ function AI_ESCORT_REQUEST:SpawnEscort() end ---- @param #AI_ESCORT_REQUEST self +-- @param #AI_ESCORT_REQUEST self -- @param Core.Set#SET_GROUP EscortGroupSet function AI_ESCORT_REQUEST:onafterStart( EscortGroupSet ) @@ -285,14 +285,14 @@ function AI_ESCORT_REQUEST:onafterStart( EscortGroupSet ) end ---- @param #AI_ESCORT_REQUEST self +-- @param #AI_ESCORT_REQUEST self -- @param Core.Set#SET_GROUP EscortGroupSet function AI_ESCORT_REQUEST:onafterStop( EscortGroupSet ) self:F() EscortGroupSet:ForEachGroup( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( EscortGroup ) EscortGroup:WayPointInitialize() diff --git a/Moose Development/Moose/AI/AI_Formation.lua b/Moose Development/Moose/AI/AI_Formation.lua index 657f8aa2a..9b593b358 100644 --- a/Moose Development/Moose/AI/AI_Formation.lua +++ b/Moose Development/Moose/AI/AI_Formation.lua @@ -112,7 +112,7 @@ AI_FORMATION = { AI_FORMATION.__Enum = {} ---- @type AI_FORMATION.__Enum.Formation +-- @type AI_FORMATION.__Enum.Formation -- @field #number None -- @field #number Line -- @field #number Trail @@ -137,7 +137,7 @@ AI_FORMATION.__Enum.Formation = { Box = 10, } ---- @type AI_FORMATION.__Enum.Mode +-- @type AI_FORMATION.__Enum.Mode -- @field #number Mission -- @field #number Formation AI_FORMATION.__Enum.Mode = { @@ -147,13 +147,13 @@ AI_FORMATION.__Enum.Mode = { Reconnaissance = "R", } ---- @type AI_FORMATION.__Enum.ReportType +-- @type AI_FORMATION.__Enum.ReportType -- @field #number All -- @field #number Airborne -- @field #number GroundRadar -- @field #number Ground AI_FORMATION.__Enum.ReportType = { - Airborne = "*", + All = "*", Airborne = "A", GroundRadar = "R", Ground = "G", @@ -1000,7 +1000,7 @@ function AI_FORMATION:SetFlightModeMission( FollowGroup ) FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Mission ) else self.FollowGroupSet:ForSomeGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( FollowGroup ) FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) ) FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Mission ) @@ -1024,7 +1024,7 @@ function AI_FORMATION:SetFlightModeAttack( FollowGroup ) FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Attack ) else self.FollowGroupSet:ForSomeGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( FollowGroup ) FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) ) FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Attack ) @@ -1048,7 +1048,7 @@ function AI_FORMATION:SetFlightModeFormation( FollowGroup ) FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Formation ) else self.FollowGroupSet:ForSomeGroupAlive( - --- @param Core.Group#GROUP EscortGroup + -- @param Core.Group#GROUP EscortGroup function( FollowGroup ) FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) ) FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Formation ) @@ -1226,7 +1226,7 @@ function AI_FORMATION:FollowMe(FollowGroup, ClientUnit, CT1, CV1, CT2, CV2) local CVI = { x = CV2.x + CS * 10 * math.sin(Ca), y = GH2.y + Inclination, -- + FollowFormation.y, - y = GH2.y, + --y = GH2.y, z = CV2.z + CS * 10 * math.cos(Ca), } diff --git a/Moose Development/Moose/AI/AI_Patrol.lua b/Moose Development/Moose/AI/AI_Patrol.lua index beba94951..12572b209 100644 --- a/Moose Development/Moose/AI/AI_Patrol.lua +++ b/Moose Development/Moose/AI/AI_Patrol.lua @@ -647,15 +647,15 @@ function AI_PATROL_ZONE:onafterStart( Controllable, From, Event, To ) end ---- @param #AI_PATROL_ZONE self ---- @param Wrapper.Controllable#CONTROLLABLE Controllable +-- @param #AI_PATROL_ZONE self +-- @param Wrapper.Controllable#CONTROLLABLE Controllable+ function AI_PATROL_ZONE:onbeforeDetect( Controllable, From, Event, To ) return self.DetectOn and self.DetectActivated end ---- @param #AI_PATROL_ZONE self ---- @param Wrapper.Controllable#CONTROLLABLE Controllable +-- @param #AI_PATROL_ZONE self +-- @param Wrapper.Controllable#CONTROLLABLE Controllable function AI_PATROL_ZONE:onafterDetect( Controllable, From, Event, To ) local Detected = false @@ -700,7 +700,7 @@ function AI_PATROL_ZONE:onafterDetect( Controllable, From, Event, To ) end ---- @param Wrapper.Controllable#CONTROLLABLE AIControllable +-- @param Wrapper.Controllable#CONTROLLABLE AIControllable -- This static method is called from the route path within the last task at the last waypoint of the Controllable. -- Note that this method is required, as triggers the next route when patrolling for the Controllable. function AI_PATROL_ZONE:_NewPatrolRoute( AIControllable ) @@ -817,13 +817,13 @@ function AI_PATROL_ZONE:onafterRoute( Controllable, From, Event, To ) end ---- @param #AI_PATROL_ZONE self +-- @param #AI_PATROL_ZONE self function AI_PATROL_ZONE:onbeforeStatus() return self.CheckStatus end ---- @param #AI_PATROL_ZONE self +-- @param #AI_PATROL_ZONE self function AI_PATROL_ZONE:onafterStatus() self:F2() @@ -859,7 +859,7 @@ function AI_PATROL_ZONE:onafterStatus() end end ---- @param #AI_PATROL_ZONE self +-- @param #AI_PATROL_ZONE self function AI_PATROL_ZONE:onafterRTB() self:F2() @@ -898,13 +898,13 @@ function AI_PATROL_ZONE:onafterRTB() end ---- @param #AI_PATROL_ZONE self +-- @param #AI_PATROL_ZONE self function AI_PATROL_ZONE:onafterDead() self:SetDetectionOff() self:SetStatusOff() end ---- @param #AI_PATROL_ZONE self +-- @param #AI_PATROL_ZONE self -- @param Core.Event#EVENTDATA EventData function AI_PATROL_ZONE:OnCrash( EventData ) @@ -915,7 +915,7 @@ function AI_PATROL_ZONE:OnCrash( EventData ) end end ---- @param #AI_PATROL_ZONE self +-- @param #AI_PATROL_ZONE self -- @param Core.Event#EVENTDATA EventData function AI_PATROL_ZONE:OnEjection( EventData ) @@ -924,7 +924,7 @@ function AI_PATROL_ZONE:OnEjection( EventData ) end end ---- @param #AI_PATROL_ZONE self +-- @param #AI_PATROL_ZONE self -- @param Core.Event#EVENTDATA EventData function AI_PATROL_ZONE:OnPilotDead( EventData ) diff --git a/Moose Development/Moose/Actions/Act_Account.lua b/Moose Development/Moose/Actions/Act_Account.lua index ef2e6d15d..4cca719da 100644 --- a/Moose Development/Moose/Actions/Act_Account.lua +++ b/Moose Development/Moose/Actions/Act_Account.lua @@ -269,7 +269,7 @@ do -- ACT_ACCOUNT_DEADS --- DCS Events - --- @param #ACT_ACCOUNT_DEADS self + -- @param #ACT_ACCOUNT_DEADS self -- @param Core.Event#EVENTDATA EventData function ACT_ACCOUNT_DEADS:OnEventHit( EventData ) self:T( { "EventDead", EventData } ) @@ -280,7 +280,7 @@ do -- ACT_ACCOUNT_DEADS end end - --- @param #ACT_ACCOUNT_DEADS self + -- @param #ACT_ACCOUNT_DEADS self -- @param Core.Event#EVENTDATA EventData function ACT_ACCOUNT_DEADS:onfuncEventDead( EventData ) self:T( { "EventDead", EventData } ) @@ -292,7 +292,7 @@ do -- ACT_ACCOUNT_DEADS --- DCS Events - --- @param #ACT_ACCOUNT_DEADS self + -- @param #ACT_ACCOUNT_DEADS self -- @param Core.Event#EVENTDATA EventData function ACT_ACCOUNT_DEADS:onfuncEventCrash( EventData ) self:T( { "EventDead", EventData } ) diff --git a/Moose Development/Moose/Actions/Act_Assist.lua b/Moose Development/Moose/Actions/Act_Assist.lua index 07d990fb3..78fb5b9f5 100644 --- a/Moose Development/Moose/Actions/Act_Assist.lua +++ b/Moose Development/Moose/Actions/Act_Assist.lua @@ -195,7 +195,7 @@ do -- ACT_ASSIST_SMOKE_TARGETS_ZONE function ACT_ASSIST_SMOKE_TARGETS_ZONE:onenterSmoking( ProcessUnit, From, Event, To ) self.TargetSetUnit:ForEachUnit( - --- @param Wrapper.Unit#UNIT SmokeUnit + -- @param Wrapper.Unit#UNIT SmokeUnit function( SmokeUnit ) if math.random( 1, ( 100 * self.TargetSetUnit:Count() ) / 4 ) <= 100 then SCHEDULER:New( self, diff --git a/Moose Development/Moose/Cargo/Cargo.lua b/Moose Development/Moose/Cargo/Cargo.lua index 0d2d53ef8..c58b9ed6c 100644 --- a/Moose Development/Moose/Cargo/Cargo.lua +++ b/Moose Development/Moose/Cargo/Cargo.lua @@ -365,7 +365,7 @@ CARGOS = {} do -- CARGO - --- @type CARGO + -- @type CARGO -- @extends Core.Fsm#FSM_PROCESS -- @field #string Type A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers. -- @field #string Name A string defining the name of the cargo. The name is the unique identifier of the cargo. @@ -428,7 +428,7 @@ do -- CARGO Reported = {}, } - --- @type CARGO.CargoObjects + -- @type CARGO.CargoObjects -- @map < #string, Wrapper.Positionable#POSITIONABLE > The alive POSITIONABLE objects representing the the cargo. --- CARGO Constructor. This class is an abstract class and should not be instantiated. @@ -1029,7 +1029,7 @@ end -- CARGO do -- CARGO_REPRESENTABLE - --- @type CARGO_REPRESENTABLE + -- @type CARGO_REPRESENTABLE -- @extends #CARGO -- @field test @@ -1137,7 +1137,7 @@ end -- CARGO_REPRESENTABLE do -- CARGO_REPORTABLE - --- @type CARGO_REPORTABLE + -- @type CARGO_REPORTABLE -- @extends #CARGO CARGO_REPORTABLE = { ClassName = "CARGO_REPORTABLE" @@ -1173,7 +1173,7 @@ end do -- CARGO_PACKAGE - --- @type CARGO_PACKAGE + -- @type CARGO_PACKAGE -- @extends #CARGO_REPRESENTABLE CARGO_PACKAGE = { ClassName = "CARGO_PACKAGE" diff --git a/Moose Development/Moose/Cargo/CargoCrate.lua b/Moose Development/Moose/Cargo/CargoCrate.lua index 81bc7ca6a..cbb105f7f 100644 --- a/Moose Development/Moose/Cargo/CargoCrate.lua +++ b/Moose Development/Moose/Cargo/CargoCrate.lua @@ -73,7 +73,7 @@ do -- CARGO_CRATE return self end - --- @param #CARGO_CRATE self + -- @param #CARGO_CRATE self -- @param Core.Event#EVENTDATA EventData function CARGO_CRATE:OnEventCargoDead( EventData ) diff --git a/Moose Development/Moose/Cargo/CargoGroup.lua b/Moose Development/Moose/Cargo/CargoGroup.lua index deb46b7d1..82b6f0339 100644 --- a/Moose Development/Moose/Cargo/CargoGroup.lua +++ b/Moose Development/Moose/Cargo/CargoGroup.lua @@ -19,7 +19,7 @@ do -- CARGO_GROUP - --- @type CARGO_GROUP + -- @type CARGO_GROUP -- @field Core.Set#SET_CARGO CargoSet The collection of derived CARGO objects. -- @field #string GroupName The name of the CargoGroup. -- @extends Cargo.Cargo#CARGO_REPORTABLE @@ -262,7 +262,7 @@ do -- CARGO_GROUP end - --- @param #CARGO_GROUP self + -- @param #CARGO_GROUP self -- @param Core.Event#EVENTDATA EventData function CARGO_GROUP:OnEventCargoDead( EventData ) @@ -422,7 +422,7 @@ do -- CARGO_GROUP -- For each Cargo object within the CARGO_GROUP, route each object to the CargoLoadPointVec2 self.CargoSet:ForEach( - --- @param Cargo.Cargo#CARGO Cargo + -- @param Cargo.Cargo#CARGO Cargo function( Cargo, NearRadius ) if not Cargo:IsDestroyed() then local ToVec=nil diff --git a/Moose Development/Moose/Cargo/CargoSlingload.lua b/Moose Development/Moose/Cargo/CargoSlingload.lua index ba3d8bb0b..07855325a 100644 --- a/Moose Development/Moose/Cargo/CargoSlingload.lua +++ b/Moose Development/Moose/Cargo/CargoSlingload.lua @@ -67,7 +67,7 @@ do -- CARGO_SLINGLOAD end - --- @param #CARGO_SLINGLOAD self + -- @param #CARGO_SLINGLOAD self -- @param Core.Event#EVENTDATA EventData function CARGO_SLINGLOAD:OnEventCargoDead( EventData ) diff --git a/Moose Development/Moose/Core/Base.lua b/Moose Development/Moose/Core/Base.lua index c94aee4cd..74cd76ca1 100644 --- a/Moose Development/Moose/Core/Base.lua +++ b/Moose Development/Moose/Core/Base.lua @@ -34,7 +34,7 @@ local _TraceClassMethod = {} local _ClassID = 0 ---- @type BASE +-- @type BASE -- @field ClassName The name of the class. -- @field ClassID The ID number of the class. -- @field ClassNameAndID The name of the class concatenated with the ID number of the class. @@ -201,10 +201,10 @@ BASE = { Scheduler = nil, } ---- @field #BASE.__ +-- @field #BASE.__ BASE.__ = {} ---- @field #BASE._ +-- @field #BASE._ BASE._ = { Schedules = {}, --- Contains the Schedulers Active } diff --git a/Moose Development/Moose/Core/Database.lua b/Moose Development/Moose/Core/Database.lua index 4ad7f9e50..3029b605b 100644 --- a/Moose Development/Moose/Core/Database.lua +++ b/Moose Development/Moose/Core/Database.lua @@ -32,7 +32,7 @@ -- @image Core_Database.JPG ---- @type DATABASE +-- @type DATABASE -- @field #string ClassName Name of the class. -- @field #table Templates Templates: Units, Groups, Statics, ClientsByName, ClientsByID. -- @field #table CLIENTS Clients. @@ -1813,7 +1813,7 @@ function DATABASE:GetFlightControl(airbasename) return self.FLIGHTCONTROLS[airbasename] end ---- @param #DATABASE self +-- @param #DATABASE self function DATABASE:_RegisterTemplates() self:F2() diff --git a/Moose Development/Moose/Core/Event.lua b/Moose Development/Moose/Core/Event.lua index 95c4f6a35..e88bbc892 100644 --- a/Moose Development/Moose/Core/Event.lua +++ b/Moose Development/Moose/Core/Event.lua @@ -173,7 +173,7 @@ -- @image Core_Event.JPG ---- @type EVENT +-- @type EVENT -- @field #EVENT.Events Events -- @extends Core.Base#BASE diff --git a/Moose Development/Moose/Core/Fsm.lua b/Moose Development/Moose/Core/Fsm.lua index 2b5f499e5..7e434e127 100644 --- a/Moose Development/Moose/Core/Fsm.lua +++ b/Moose Development/Moose/Core/Fsm.lua @@ -79,7 +79,7 @@ do -- FSM - --- @type FSM + -- @type FSM -- @field #string ClassName Name of the class. -- @field Core.Scheduler#SCHEDULER CallScheduler Call scheduler. -- @field #table options Options. @@ -949,7 +949,7 @@ end do -- FSM_CONTROLLABLE - --- @type FSM_CONTROLLABLE + -- @type FSM_CONTROLLABLE -- @field Wrapper.Controllable#CONTROLLABLE Controllable -- @extends Core.Fsm#FSM @@ -1082,7 +1082,7 @@ end do -- FSM_PROCESS - --- @type FSM_PROCESS + -- @type FSM_PROCESS -- @field Tasking.Task#TASK Task -- @extends Core.Fsm#FSM_CONTROLLABLE diff --git a/Moose Development/Moose/Core/Goal.lua b/Moose Development/Moose/Core/Goal.lua index bc33246f6..cff272dbd 100644 --- a/Moose Development/Moose/Core/Goal.lua +++ b/Moose Development/Moose/Core/Goal.lua @@ -24,7 +24,7 @@ do -- Goal - --- @type GOAL + -- @type GOAL -- @extends Core.Fsm#FSM --- Models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized. @@ -71,10 +71,10 @@ do -- Goal ClassName = "GOAL", } - --- @field #table GOAL.Players + -- @field #table GOAL.Players GOAL.Players = {} - --- @field #number GOAL.TotalContributions + -- @field #number GOAL.TotalContributions GOAL.TotalContributions = 0 --- GOAL Constructor. @@ -145,7 +145,7 @@ do -- Goal self.TotalContributions = self.TotalContributions + 1 end - --- @param #GOAL self + -- @param #GOAL self -- @param #number Player contribution. function GOAL:GetPlayerContribution( PlayerName ) return self.Players[PlayerName] or 0 diff --git a/Moose Development/Moose/Core/Menu.lua b/Moose Development/Moose/Core/Menu.lua index 8a6edf657..1d0f1b1d9 100644 --- a/Moose Development/Moose/Core/Menu.lua +++ b/Moose Development/Moose/Core/Menu.lua @@ -166,7 +166,7 @@ function MENU_INDEX:Refresh( Group ) end do -- MENU_BASE - --- @type MENU_BASE + -- @type MENU_BASE -- @extends Core.Base#BASE --- Defines the main MENU class where other MENU classes are derived from. -- This is an abstract class, so don't use it. @@ -278,7 +278,7 @@ do -- MENU_BASE end do -- MENU_COMMAND_BASE - --- @type MENU_COMMAND_BASE + -- @type MENU_COMMAND_BASE -- @field #function MenuCallHandler -- @extends Core.Menu#MENU_BASE @@ -344,7 +344,7 @@ do -- MENU_COMMAND_BASE end do -- MENU_MISSION - --- @type MENU_MISSION + -- @type MENU_MISSION -- @extends Core.Menu#MENU_BASE --- Manages the main menus for a complete mission. -- @@ -433,7 +433,7 @@ do -- MENU_MISSION end do -- MENU_MISSION_COMMAND - --- @type MENU_MISSION_COMMAND + -- @type MENU_MISSION_COMMAND -- @extends Core.Menu#MENU_COMMAND_BASE --- Manages the command menus for a complete mission, which allow players to execute functions during mission execution. @@ -510,7 +510,7 @@ do -- MENU_MISSION_COMMAND end end do -- MENU_COALITION - --- @type MENU_COALITION + -- @type MENU_COALITION -- @extends Core.Menu#MENU_BASE --- Manages the main menus for @{DCS.coalition}s. @@ -637,7 +637,7 @@ do -- MENU_COALITION end do -- MENU_COALITION_COMMAND - --- @type MENU_COALITION_COMMAND + -- @type MENU_COALITION_COMMAND -- @extends Core.Menu#MENU_COMMAND_BASE --- Manages the command menus for coalitions, which allow players to execute functions during mission execution. @@ -726,7 +726,7 @@ do -- the same menus twice during initialization logic. -- These menu classes are handling this logic with this variable. local _MENUGROUPS = {} - --- @type MENU_GROUP + -- @type MENU_GROUP -- @extends Core.Menu#MENU_BASE @@ -757,7 +757,7 @@ do -- MenuStatus[MenuGroupName]:Remove() -- end -- - -- --- @param Wrapper.Group#GROUP MenuGroup + -- -- @param Wrapper.Group#GROUP MenuGroup -- local function AddStatusMenu( MenuGroup ) -- local MenuGroupName = MenuGroup:GetName() -- -- This would create a menu for the red coalition under the MenuCoalitionRed menu object. @@ -900,7 +900,7 @@ do end - --- @type MENU_GROUP_COMMAND + -- @type MENU_GROUP_COMMAND -- @extends Core.Menu#MENU_COMMAND_BASE --- The @{Core.Menu#MENU_GROUP_COMMAND} class manages the command menus for coalitions, which allow players to execute functions during mission execution. @@ -983,7 +983,7 @@ do end --- MENU_GROUP_DELAYED do - --- @type MENU_GROUP_DELAYED + -- @type MENU_GROUP_DELAYED -- @extends Core.Menu#MENU_BASE @@ -1107,7 +1107,7 @@ do end - --- @type MENU_GROUP_COMMAND_DELAYED + -- @type MENU_GROUP_COMMAND_DELAYED -- @extends Core.Menu#MENU_COMMAND_BASE --- Manages the command menus for coalitions, which allow players to execute functions during mission execution. diff --git a/Moose Development/Moose/Core/Point.lua b/Moose Development/Moose/Core/Point.lua index d942e49ba..91287229c 100644 --- a/Moose Development/Moose/Core/Point.lua +++ b/Moose Development/Moose/Core/Point.lua @@ -41,7 +41,7 @@ do -- COORDINATE - --- @type COORDINATE + -- @type COORDINATE -- @field #string ClassName Name of the class -- @field #number x Component of the 3D vector. -- @field #number y Component of the 3D vector. @@ -3592,7 +3592,7 @@ end do -- POINT_VEC2 - --- @type POINT_VEC2 + -- @type POINT_VEC2 -- @field DCS#Distance x The x coordinate in meters. -- @field DCS#Distance y the y coordinate in meters. -- @extends Core.Point#COORDINATE diff --git a/Moose Development/Moose/Core/Report.lua b/Moose Development/Moose/Core/Report.lua index d8225adcc..7b592f42d 100644 --- a/Moose Development/Moose/Core/Report.lua +++ b/Moose Development/Moose/Core/Report.lua @@ -15,7 +15,7 @@ -- @module Core.Report -- @image Core_Report.JPG ---- @type REPORT +-- @type REPORT -- @extends Core.Base#BASE --- Provides a handy means to create messages and reports. diff --git a/Moose Development/Moose/Core/Set.lua b/Moose Development/Moose/Core/Set.lua index 1d06739f9..d7e7b6f97 100644 --- a/Moose Development/Moose/Core/Set.lua +++ b/Moose Development/Moose/Core/Set.lua @@ -47,7 +47,7 @@ do -- SET_BASE - --- @type SET_BASE + -- @type SET_BASE -- @field #table Filter Table of filters. -- @field #table Set Table of objects. -- @field #table Index Table of indices. @@ -578,8 +578,8 @@ do -- SET_BASE end ----- Private method that registers all alive players in the mission. - ---- @param #SET_BASE self - ---- @return #SET_BASE self + -- @param #SET_BASE self + -- @return #SET_BASE self -- function SET_BASE:_RegisterPlayers() -- -- local CoalitionsData = { AlivePlayersRed = coalition.getPlayers( coalition.side.RED ), AlivePlayersBlue = coalition.getPlayers( coalition.side.BLUE ) } @@ -796,8 +796,8 @@ do -- SET_BASE ----- Iterate the SET_BASE and call an iterator function for each **alive** unit, providing the Unit and optional parameters. - ---- @param #SET_BASE self - ---- @param #function IteratorFunction The function that will be called when there is an alive unit in the SET_BASE. The function needs to accept a UNIT parameter. + -- @param #SET_BASE self + -- @param #function IteratorFunction The function that will be called when there is an alive unit in the SET_BASE. The function needs to accept a UNIT parameter. ---- @return #SET_BASE self -- function SET_BASE:ForEachDCSUnitAlive( IteratorFunction, ... ) -- self:F3( arg ) @@ -808,8 +808,8 @@ do -- SET_BASE -- end -- ----- Iterate the SET_BASE and call an iterator function for each **alive** player, providing the Unit of the player and optional parameters. - ---- @param #SET_BASE self - ---- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_BASE. The function needs to accept a UNIT parameter. + -- @param #SET_BASE self + -- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_BASE. The function needs to accept a UNIT parameter. ---- @return #SET_BASE self -- function SET_BASE:ForEachPlayer( IteratorFunction, ... ) -- self:F3( arg ) @@ -821,8 +821,8 @@ do -- SET_BASE -- -- ----- Iterate the SET_BASE and call an iterator function for each client, providing the Client to the function and optional parameters. - ---- @param #SET_BASE self - ---- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_BASE. The function needs to accept a CLIENT parameter. + -- @param #SET_BASE self + -- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_BASE. The function needs to accept a CLIENT parameter. ---- @return #SET_BASE self -- function SET_BASE:ForEachClient( IteratorFunction, ... ) -- self:F3( arg ) @@ -903,7 +903,7 @@ end do -- SET_GROUP - --- @type SET_GROUP #SET_GROUP + -- @type SET_GROUP #SET_GROUP -- @field Core.Timer#TIMER ZoneTimer -- @field #number ZoneTimerInterval -- @extends Core.Set#SET_BASE @@ -1568,7 +1568,7 @@ do -- SET_GROUP self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Group#GROUP GroupObject function( ZoneObject, GroupObject ) if GroupObject:IsCompletelyInZone( ZoneObject ) then @@ -1590,7 +1590,7 @@ do -- SET_GROUP self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Group#GROUP GroupObject function( ZoneObject, GroupObject ) if GroupObject:IsPartlyInZone( ZoneObject ) then @@ -1612,7 +1612,7 @@ do -- SET_GROUP self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Group#GROUP GroupObject function( ZoneObject, GroupObject ) if GroupObject:IsNotInZone( ZoneObject ) then @@ -1659,7 +1659,7 @@ do -- SET_GROUP self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Group#GROUP GroupObject function( ZoneObject, GroupObject ) if GroupObject:IsAnyInZone( ZoneObject ) then @@ -1857,8 +1857,8 @@ do -- SET_GROUP end ----- Iterate the SET_GROUP and call an iterator function for each **alive** player, providing the Group of the player and optional parameters. - ---- @param #SET_GROUP self - ---- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_GROUP. The function needs to accept a GROUP parameter. + -- @param #SET_GROUP self + -- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_GROUP. The function needs to accept a GROUP parameter. ---- @return #SET_GROUP self -- function SET_GROUP:ForEachPlayer( IteratorFunction, ... ) -- self:F2( arg ) @@ -1870,8 +1870,8 @@ do -- SET_GROUP -- -- ----- Iterate the SET_GROUP and call an iterator function for each client, providing the Client to the function and optional parameters. - ---- @param #SET_GROUP self - ---- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_GROUP. The function needs to accept a CLIENT parameter. + -- @param #SET_GROUP self + -- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_GROUP. The function needs to accept a CLIENT parameter. ---- @return #SET_GROUP self -- function SET_GROUP:ForEachClient( IteratorFunction, ... ) -- self:F2( arg ) @@ -2012,7 +2012,7 @@ end do -- SET_UNIT - --- @type SET_UNIT + -- @type SET_UNIT -- @field Core.Timer#TIMER ZoneTimer -- @field #number ZoneTimerInterval -- @extends Core.Set#SET_BASE @@ -2672,7 +2672,7 @@ do -- SET_UNIT self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Unit#UNIT UnitObject function( ZoneObject, UnitObject ) if UnitObject:IsInZone( ZoneObject ) then @@ -2694,7 +2694,7 @@ do -- SET_UNIT self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Unit#UNIT UnitObject function( ZoneObject, UnitObject ) if UnitObject:IsNotInZone( ZoneObject ) then @@ -3011,8 +3011,8 @@ do -- SET_UNIT ----- Iterate the SET_UNIT and call an iterator function for each **alive** player, providing the Unit of the player and optional parameters. - ---- @param #SET_UNIT self - ---- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_UNIT. The function needs to accept a UNIT parameter. + -- @param #SET_UNIT self + -- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_UNIT. The function needs to accept a UNIT parameter. ---- @return #SET_UNIT self -- function SET_UNIT:ForEachPlayer( IteratorFunction, ... ) -- self:F2( arg ) @@ -3024,8 +3024,8 @@ do -- SET_UNIT -- -- ----- Iterate the SET_UNIT and call an iterator function for each client, providing the Client to the function and optional parameters. - ---- @param #SET_UNIT self - ---- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_UNIT. The function needs to accept a CLIENT parameter. + -- @param #SET_UNIT self + -- @param #function IteratorFunction The function that will be called when there is an alive player in the SET_UNIT. The function needs to accept a CLIENT parameter. ---- @return #SET_UNIT self -- function SET_UNIT:ForEachClient( IteratorFunction, ... ) -- self:F2( arg ) @@ -3192,7 +3192,7 @@ end do -- SET_STATIC - --- @type SET_STATIC + -- @type SET_STATIC -- @extends Core.Set#SET_BASE --- Mission designers can use the SET_STATIC class to build sets of Statics belonging to certain: @@ -3612,7 +3612,7 @@ do -- SET_STATIC self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Static#STATIC StaticObject function( ZoneObject, StaticObject ) if StaticObject:IsInZone( ZoneObject ) then @@ -3634,7 +3634,7 @@ do -- SET_STATIC self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Static#STATIC StaticObject function( ZoneObject, StaticObject ) if StaticObject:IsNotInZone( ZoneObject ) then @@ -3946,7 +3946,7 @@ end do -- SET_CLIENT - --- @type SET_CLIENT + -- @type SET_CLIENT -- @field Core.Timer#TIMER ZoneTimer -- @field #number ZoneTimerInterval -- @extends Core.Set#SET_BASE @@ -4369,7 +4369,7 @@ do -- SET_CLIENT self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Client#CLIENT ClientObject function( ZoneObject, ClientObject ) if ClientObject:IsInZone( ZoneObject ) then @@ -4391,7 +4391,7 @@ do -- SET_CLIENT self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Client#CLIENT ClientObject function( ZoneObject, ClientObject ) if ClientObject:IsNotInZone( ZoneObject ) then @@ -4573,7 +4573,7 @@ end do -- SET_PLAYER - --- @type SET_PLAYER + -- @type SET_PLAYER -- @extends Core.Set#SET_BASE --- Mission designers can use the @{Core.Set#SET_PLAYER} class to build sets of units belonging to alive players: @@ -4868,7 +4868,7 @@ do -- SET_PLAYER self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Client#CLIENT ClientObject function( ZoneObject, ClientObject ) if ClientObject:IsInZone( ZoneObject ) then @@ -4890,7 +4890,7 @@ do -- SET_PLAYER self:F2( arg ) self:ForEach( IteratorFunction, arg, self:GetSet(), - --- @param Core.Zone#ZONE_BASE ZoneObject + -- @param Core.Zone#ZONE_BASE ZoneObject -- @param Wrapper.Client#CLIENT ClientObject function( ZoneObject, ClientObject ) if ClientObject:IsNotInZone( ZoneObject ) then @@ -4999,7 +4999,7 @@ end do -- SET_AIRBASE - --- @type SET_AIRBASE + -- @type SET_AIRBASE -- @extends Core.Set#SET_BASE --- Mission designers can use the @{Core.Set#SET_AIRBASE} class to build sets of airbases optionally belonging to certain: @@ -5342,7 +5342,7 @@ end do -- SET_CARGO - --- @type SET_CARGO + -- @type SET_CARGO -- @extends Core.Set#SET_BASE --- Mission designers can use the @{Core.Set#SET_CARGO} class to build sets of cargos optionally belonging to certain: @@ -5768,7 +5768,7 @@ end do -- SET_ZONE - --- @type SET_ZONE + -- @type SET_ZONE -- @extends Core.Set#SET_BASE --- Mission designers can use the @{Core.Set#SET_ZONE} class to build sets of zones of various types. @@ -6136,7 +6136,7 @@ end do -- SET_ZONE_GOAL - --- @type SET_ZONE_GOAL + -- @type SET_ZONE_GOAL -- @extends Core.Set#SET_BASE --- Mission designers can use the @{Core.Set#SET_ZONE_GOAL} class to build sets of zones of various types. @@ -6447,7 +6447,7 @@ end do -- SET_OPSZONE - --- @type SET_OPSZONE + -- @type SET_OPSZONE -- @extends Core.Set#SET_BASE --- Mission designers can use the @{Core.Set#SET_OPSZONE} class to build sets of zones of various types. @@ -6904,7 +6904,7 @@ end do -- SET_OPSGROUP - --- @type SET_OPSGROUP + -- @type SET_OPSGROUP -- @extends Core.Set#SET_BASE --- Mission designers can use the @{Core.Set#SET_OPSGROUP} class to build sets of OPS groups belonging to certain: diff --git a/Moose Development/Moose/Core/Settings.lua b/Moose Development/Moose/Core/Settings.lua index 671b4cfb0..73cbd2a98 100644 --- a/Moose Development/Moose/Core/Settings.lua +++ b/Moose Development/Moose/Core/Settings.lua @@ -29,7 +29,7 @@ -- @module Core.Settings -- @image Core_Settings.JPG ---- @type SETTINGS +-- @type SETTINGS -- @extends Core.Base#BASE --- Takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework. @@ -218,7 +218,7 @@ SETTINGS = { SETTINGS.__Enum = {} ---- @type SETTINGS.__Enum.Era +-- @type SETTINGS.__Enum.Era -- @field #number WWII -- @field #number Korea -- @field #number Cold @@ -491,7 +491,7 @@ do -- SETTINGS return (self.A2ASystem and self.A2ASystem == "MGRS") or (not self.A2ASystem and _SETTINGS:IsA2A_MGRS()) end - --- @param #SETTINGS self + -- @param #SETTINGS self -- @param Wrapper.Group#GROUP MenuGroup Group for which to add menus. -- @param #table RootMenu Root menu table -- @return #SETTINGS @@ -945,49 +945,49 @@ do -- SETTINGS return self end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:A2GMenuSystem( MenuGroup, RootMenu, A2GSystem ) self.A2GSystem = A2GSystem MESSAGE:New( string.format( "Settings: Default A2G coordinate system set to %s for all players!", A2GSystem ), 5 ):ToAll() self:SetSystemMenu( MenuGroup, RootMenu ) end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:A2AMenuSystem( MenuGroup, RootMenu, A2ASystem ) self.A2ASystem = A2ASystem MESSAGE:New( string.format( "Settings: Default A2A coordinate system set to %s for all players!", A2ASystem ), 5 ):ToAll() self:SetSystemMenu( MenuGroup, RootMenu ) end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuLL_DDM_Accuracy( MenuGroup, RootMenu, LL_Accuracy ) self.LL_Accuracy = LL_Accuracy MESSAGE:New( string.format( "Settings: Default LL accuracy set to %s for all players!", LL_Accuracy ), 5 ):ToAll() self:SetSystemMenu( MenuGroup, RootMenu ) end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuMGRS_Accuracy( MenuGroup, RootMenu, MGRS_Accuracy ) self.MGRS_Accuracy = MGRS_Accuracy MESSAGE:New( string.format( "Settings: Default MGRS accuracy set to %s for all players!", MGRS_Accuracy ), 5 ):ToAll() self:SetSystemMenu( MenuGroup, RootMenu ) end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuMWSystem( MenuGroup, RootMenu, MW ) self.Metric = MW MESSAGE:New( string.format( "Settings: Default measurement format set to %s for all players!", MW and "Metric" or "Imperial" ), 5 ):ToAll() self:SetSystemMenu( MenuGroup, RootMenu ) end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuMessageTimingsSystem( MenuGroup, RootMenu, MessageType, MessageTime ) self:SetMessageTime( MessageType, MessageTime ) MESSAGE:New( string.format( "Settings: Default message time set for %s to %d.", MessageType, MessageTime ), 5 ):ToAll() end do - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuGroupA2GSystem( PlayerUnit, PlayerGroup, PlayerName, A2GSystem ) BASE:E( { self, PlayerUnit:GetName(), A2GSystem } ) self.A2GSystem = A2GSystem @@ -998,7 +998,7 @@ do -- SETTINGS end end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuGroupA2ASystem( PlayerUnit, PlayerGroup, PlayerName, A2ASystem ) self.A2ASystem = A2ASystem MESSAGE:New( string.format( "Settings: A2A format set to %s for player %s.", A2ASystem, PlayerName ), 5 ):ToGroup( PlayerGroup ) @@ -1008,7 +1008,7 @@ do -- SETTINGS end end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuGroupLL_DDM_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy ) self.LL_Accuracy = LL_Accuracy MESSAGE:New( string.format( "Settings: LL format accuracy set to %d decimal places for player %s.", LL_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup ) @@ -1018,7 +1018,7 @@ do -- SETTINGS end end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuGroupMGRS_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy ) self.MGRS_Accuracy = MGRS_Accuracy MESSAGE:New( string.format( "Settings: MGRS format accuracy set to %d for player %s.", MGRS_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup ) @@ -1028,7 +1028,7 @@ do -- SETTINGS end end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuGroupMWSystem( PlayerUnit, PlayerGroup, PlayerName, MW ) self.Metric = MW MESSAGE:New( string.format( "Settings: Measurement format set to %s for player %s.", MW and "Metric" or "Imperial", PlayerName ), 5 ):ToGroup( PlayerGroup ) @@ -1038,7 +1038,7 @@ do -- SETTINGS end end - --- @param #SETTINGS self + -- @param #SETTINGS self function SETTINGS:MenuGroupMessageTimingsSystem( PlayerUnit, PlayerGroup, PlayerName, MessageType, MessageTime ) self:SetMessageTime( MessageType, MessageTime ) MESSAGE:New( string.format( "Settings: Default message time set for %s to %d.", MessageType, MessageTime ), 5 ):ToGroup( PlayerGroup ) diff --git a/Moose Development/Moose/Core/Spawn.lua b/Moose Development/Moose/Core/Spawn.lua index b1370313f..0c3958929 100644 --- a/Moose Development/Moose/Core/Spawn.lua +++ b/Moose Development/Moose/Core/Spawn.lua @@ -268,7 +268,7 @@ SPAWN = { -- @type SPAWN.Takeoff -- @extends Wrapper.Group#GROUP.Takeoff ---- @field #SPAWN.Takeoff Takeoff +-- @field #SPAWN.Takeoff Takeoff SPAWN.Takeoff = { Air = 1, Runway = 2, @@ -276,7 +276,7 @@ SPAWN.Takeoff = { Cold = 4, } ---- @type SPAWN.SpawnZoneTable +-- @type SPAWN.SpawnZoneTable -- @list SpawnZone --- Creates the main object to spawn a @{Wrapper.Group} defined in the DCS ME. @@ -3419,7 +3419,7 @@ end -- TODO Need to delete this... _DATABASE does this now ... ---- @param #SPAWN self +-- @param #SPAWN self -- @param Core.Event#EVENTDATA EventData function SPAWN:_OnBirth( EventData ) self:F( self.SpawnTemplatePrefix ) @@ -3439,7 +3439,7 @@ function SPAWN:_OnBirth( EventData ) end ---- @param #SPAWN self +-- @param #SPAWN self -- @param Core.Event#EVENTDATA EventData function SPAWN:_OnDeadOrCrash( EventData ) self:F( self.SpawnTemplatePrefix ) diff --git a/Moose Development/Moose/Core/SpawnStatic.lua b/Moose Development/Moose/Core/SpawnStatic.lua index 4420f70ed..2c38d389e 100644 --- a/Moose Development/Moose/Core/SpawnStatic.lua +++ b/Moose Development/Moose/Core/SpawnStatic.lua @@ -34,7 +34,7 @@ -- @module Core.SpawnStatic -- @image Core_Spawnstatic.JPG ---- @type SPAWNSTATIC +-- @type SPAWNSTATIC -- @field #string SpawnTemplatePrefix Name of the template group. -- @field #number CountryID Country ID. -- @field #number CoalitionID Coalition ID. diff --git a/Moose Development/Moose/Core/Spot.lua b/Moose Development/Moose/Core/Spot.lua index d87606937..48bb2cb84 100644 --- a/Moose Development/Moose/Core/Spot.lua +++ b/Moose Development/Moose/Core/Spot.lua @@ -33,7 +33,7 @@ do - --- @type SPOT + -- @type SPOT -- @extends Core.Fsm#FSM @@ -292,7 +292,7 @@ do self:__Lasing(-1) end - --- @param #SPOT self + -- @param #SPOT self -- @param Core.Event#EVENTDATA EventData function SPOT:OnEventDead(EventData) self:F( { Dead = EventData.IniDCSUnitName, Target = self.Target } ) @@ -311,7 +311,7 @@ do end end - --- @param #SPOT self + -- @param #SPOT self -- @param From -- @param Event -- @param To @@ -337,7 +337,7 @@ do end - --- @param #SPOT self + -- @param #SPOT self -- @param From -- @param Event -- @param To diff --git a/Moose Development/Moose/Core/UserFlag.lua b/Moose Development/Moose/Core/UserFlag.lua index 5ed5d6cd7..3a277e49b 100644 --- a/Moose Development/Moose/Core/UserFlag.lua +++ b/Moose Development/Moose/Core/UserFlag.lua @@ -18,7 +18,7 @@ do -- UserFlag - --- @type USERFLAG + -- @type USERFLAG -- @field #string ClassName Name of the class -- @field #string UserFlagName Name of the flag. -- @extends Core.Base#BASE diff --git a/Moose Development/Moose/Core/Velocity.lua b/Moose Development/Moose/Core/Velocity.lua index e71282208..1181271c7 100644 --- a/Moose Development/Moose/Core/Velocity.lua +++ b/Moose Development/Moose/Core/Velocity.lua @@ -20,7 +20,7 @@ do -- Velocity - --- @type VELOCITY + -- @type VELOCITY -- @extends Core.Base#BASE @@ -127,7 +127,7 @@ end do -- VELOCITY_POSITIONABLE - --- @type VELOCITY_POSITIONABLE + -- @type VELOCITY_POSITIONABLE -- @extends Core.Base#BASE diff --git a/Moose Development/Moose/Core/Zone.lua b/Moose Development/Moose/Core/Zone.lua index 12391027c..8859ca7ed 100644 --- a/Moose Development/Moose/Core/Zone.lua +++ b/Moose Development/Moose/Core/Zone.lua @@ -53,7 +53,7 @@ -- @module Core.Zone -- @image Core_Zones.JPG ---- @type ZONE_BASE +-- @type ZONE_BASE -- @field #string ZoneName Name of the zone. -- @field #number ZoneProbability A value between 0 and 1. 0 = 0% and 1 = 100% probability. -- @field #number DrawID Unique ID of the drawn zone on the F10 map. @@ -1496,7 +1496,7 @@ function ZONE_RADIUS:GetRandomCoordinateWithoutBuildings(inner,outer,distance,ma end ---- @type ZONE +-- @type ZONE -- @extends #ZONE_RADIUS @@ -1581,7 +1581,7 @@ end ---- @type ZONE_UNIT +-- @type ZONE_UNIT -- @field Wrapper.Unit#UNIT ZoneUNIT -- @extends Core.Zone#ZONE_RADIUS @@ -1723,7 +1723,7 @@ function ZONE_UNIT:GetVec3( Height ) return Vec3 end ---- @type ZONE_GROUP +-- @type ZONE_GROUP -- @extends #ZONE_RADIUS @@ -1809,7 +1809,7 @@ function ZONE_GROUP:GetRandomPointVec2( inner, outer ) end ---- @type ZONE_POLYGON_BASE +-- @type ZONE_POLYGON_BASE -- @field #ZONE_POLYGON_BASE.ListVec2 Polygon The polygon defined by an array of @{DCS#Vec2}. -- @extends #ZONE_BASE @@ -2458,7 +2458,7 @@ function ZONE_POLYGON_BASE:Boundary(Coalition, Color, Radius, Alpha, Segments, C return self end ---- @type ZONE_POLYGON +-- @type ZONE_POLYGON -- @extends #ZONE_POLYGON_BASE @@ -2909,7 +2909,7 @@ end do -- ZONE_ELASTIC - --- @type ZONE_ELASTIC + -- @type ZONE_ELASTIC -- @field #table points Points in 2D. -- @field #table setGroups Set of GROUPs. -- @field #table setOpsGroups Set of OPSGROUPS. @@ -3109,7 +3109,7 @@ end do -- ZONE_AIRBASE - --- @type ZONE_AIRBASE + -- @type ZONE_AIRBASE -- @field #boolean isShip If `true`, airbase is a ship. -- @field #boolean isHelipad If `true`, airbase is a helipad. -- @field #boolean isAirdrome If `true`, airbase is an airdrome. diff --git a/Moose Development/Moose/Core/Zone_Detection.lua b/Moose Development/Moose/Core/Zone_Detection.lua index bb5424a37..b7f453952 100644 --- a/Moose Development/Moose/Core/Zone_Detection.lua +++ b/Moose Development/Moose/Core/Zone_Detection.lua @@ -2,7 +2,7 @@ -- @module Core.Zone_Detection -- @image MOOSE.JPG ---- @type ZONE_DETECTION +-- @type ZONE_DETECTION -- @field DCS#Vec2 Vec2 The current location of the zone. -- @field DCS#Distance Radius The radius of the zone. -- @extends #ZONE_BASE diff --git a/Moose Development/Moose/DCS.lua b/Moose Development/Moose/DCS.lua index 7635d03a9..605b008be 100644 --- a/Moose Development/Moose/DCS.lua +++ b/Moose Development/Moose/DCS.lua @@ -345,11 +345,11 @@ end -- country do -- Command - --- @type Command + -- @type Command -- @field #string id -- @field #Command.params params - --- @type Command.params + -- @type Command.params end -- Command @@ -390,7 +390,7 @@ end -- coalition do -- Types - --- @type Desc + -- @type Desc -- @field #number speedMax0 Max speed in meters/second at zero altitude. -- @field #number massEmpty Empty mass in kg. -- @field #number tankerType Type of refueling system: 0=boom, 1=probe. @@ -487,16 +487,16 @@ do -- Types -- @type AttributeNameArray -- @list <#AttributeName> - --- @type Zone + -- @type Zone -- @field DCSVec3#Vec3 point -- @field #number radius Zone = {} - --- @type ModelTime + -- @type ModelTime -- @extends #number - --- @type Time + -- @type Time -- @extends #number --- A task descriptor (internal structure for DCS World). See [https://wiki.hoggitworld.com/view/Category:Tasks](https://wiki.hoggitworld.com/view/Category:Tasks). @@ -505,7 +505,7 @@ do -- Types -- @field #string id -- @field #Task.param param - --- @type Task.param + -- @type Task.param --- List of @{#Task} -- @type TaskArray @@ -552,7 +552,7 @@ do -- Object -- @field SCENERY -- @field CARGO - --- @type Object.Desc + -- @type Object.Desc -- @extends #Desc -- @field #number life initial life level -- @field #Box3 box bounding box of collision geometry @@ -994,7 +994,7 @@ end -- Controller do -- Unit - --- @type Unit + -- @type Unit -- @extends #CoalitionObject -- @field ID Identifier of an unit. It assigned to an unit by the Mission Editor automatically. -- @field #Unit.Category Category @@ -1109,15 +1109,15 @@ do -- Unit -- @field #Distance detectionDistanceHRM detection distance for RCS=1m^2 in high-resolution mapping mode, nil if radar has no HRM -- @field #Unit.Radar.detectionDistanceAir detectionDistanceAir detection distance for RCS=1m^2 airborne target, nil if radar doesn't support air search - --- @type Unit.Radar.detectionDistanceAir + -- @type Unit.Radar.detectionDistanceAir -- @field #Unit.Radar.detectionDistanceAir.upperHemisphere upperHemisphere -- @field #Unit.Radar.detectionDistanceAir.lowerHemisphere lowerHemisphere - --- @type Unit.Radar.detectionDistanceAir.upperHemisphere + -- @type Unit.Radar.detectionDistanceAir.upperHemisphere -- @field #Distance headOn -- @field #Distance tailOn - --- @type Unit.Radar.detectionDistanceAir.lowerHemisphere + -- @type Unit.Radar.detectionDistanceAir.lowerHemisphere -- @field #Distance headOn -- @field #Distance tailOn @@ -1419,22 +1419,22 @@ do -- AI -- @field IR_POINTER -- @field LASER - --- @type AI.Task.WaypointType + -- @type AI.Task.WaypointType -- @field TAKEOFF -- @field TAKEOFF_PARKING -- @field TURNING_POINT -- @field TAKEOFF_PARKING_HOT -- @field LAND - --- @type AI.Task.TurnMethod + -- @type AI.Task.TurnMethod -- @field FLY_OVER_POINT -- @field FIN_POINT - --- @type AI.Task.AltitudeType + -- @type AI.Task.AltitudeType -- @field BARO -- @field RADIO - --- @type AI.Task.VehicleFormation + -- @type AI.Task.VehicleFormation -- @field OFF_ROAD -- @field ON_ROAD -- @field RANK @@ -1444,27 +1444,27 @@ do -- AI -- @field ECHELON_LEFT -- @field ECHELON_RIGHT - --- @type AI.Option + -- @type AI.Option -- @field #AI.Option.Air Air -- @field #AI.Option.Ground Ground -- @field #AI.Option.Naval Naval - --- @type AI.Option.Air + -- @type AI.Option.Air -- @field #AI.Option.Air.id id -- @field #AI.Option.Air.val val - --- @type AI.Option.Ground + -- @type AI.Option.Ground -- @field #AI.Option.Ground.id id -- @field #AI.Option.Ground.val val -- @field #AI.Option.Ground.mid mid -- @field #AI.Option.Ground.mval mval -- - --- @type AI.Option.Naval + -- @type AI.Option.Naval -- @field #AI.Option.Naval.id id -- @field #AI.Option.Naval.val val - --- @type AI.Option.Air.id + -- @type AI.Option.Air.id -- @field NO_OPTION -- @field ROE -- @field REACTION_ON_THREAT @@ -1487,7 +1487,7 @@ do -- AI -- @field JETT_TANKS_IF_EMPTY -- @field FORCED_ATTACK - --- @type AI.Option.Air.id.FORMATION + -- @type AI.Option.Air.id.FORMATION -- @field LINE_ABREAST -- @field TRAIL -- @field WEDGE @@ -1506,45 +1506,45 @@ do -- AI -- @field JAVELIN_DOWN - --- @type AI.Option.Air.val + -- @type AI.Option.Air.val -- @field #AI.Option.Air.val.ROE ROE -- @field #AI.Option.Air.val.REACTION_ON_THREAT REACTION_ON_THREAT -- @field #AI.Option.Air.val.RADAR_USING RADAR_USING -- @field #AI.Option.Air.val.FLARE_USING FLARE_USING - --- @type AI.Option.Air.val.ROE + -- @type AI.Option.Air.val.ROE -- @field WEAPON_FREE -- @field OPEN_FIRE_WEAPON_FREE -- @field OPEN_FIRE -- @field RETURN_FIRE -- @field WEAPON_HOLD - --- @type AI.Option.Air.val.REACTION_ON_THREAT + -- @type AI.Option.Air.val.REACTION_ON_THREAT -- @field NO_REACTION -- @field PASSIVE_DEFENCE -- @field EVADE_FIRE -- @field BYPASS_AND_ESCAPE -- @field ALLOW_ABORT_MISSION - --- @type AI.Option.Air.val.RADAR_USING + -- @type AI.Option.Air.val.RADAR_USING -- @field NEVER -- @field FOR_ATTACK_ONLY -- @field FOR_SEARCH_IF_REQUIRED -- @field FOR_CONTINUOUS_SEARCH - --- @type AI.Option.Air.val.FLARE_USING + -- @type AI.Option.Air.val.FLARE_USING -- @field NEVER -- @field AGAINST_FIRED_MISSILE -- @field WHEN_FLYING_IN_SAM_WEZ -- @field WHEN_FLYING_NEAR_ENEMIES - --- @type AI.Option.Air.val.ECM_USING + -- @type AI.Option.Air.val.ECM_USING -- @field NEVER_USE -- @field USE_IF_ONLY_LOCK_BY_RADAR -- @field USE_IF_DETECTED_LOCK_BY_RADAR -- @field ALWAYS_USE - --- @type AI.Option.Air.val.MISSILE_ATTACK + -- @type AI.Option.Air.val.MISSILE_ATTACK -- @field MAX_RANGE -- @field NEZ_RANGE -- @field HALF_WAY_RMAX_NEZ @@ -1552,7 +1552,7 @@ do -- AI -- @field RANDOM_RANGE - --- @type AI.Option.Ground.id + -- @type AI.Option.Ground.id -- @field NO_OPTION -- @field ROE @{#AI.Option.Ground.val.ROE} -- @field FORMATION @@ -1561,42 +1561,42 @@ do -- AI -- @field ENGAGE_AIR_WEAPONS -- @field AC_ENGAGEMENT_RANGE_RESTRICTION - --- @type AI.Option.Ground.mid -- Moose added + -- @type AI.Option.Ground.mid -- Moose added -- @field RESTRICT_AAA_MIN 27 -- @field RESTRICT_AAA_MAX 29 -- @field RESTRICT_TARGETS @{#AI.Option.Ground.mval.ENGAGE_TARGETS} 28 - --- @type AI.Option.Ground.val + -- @type AI.Option.Ground.val -- @field #AI.Option.Ground.val.ROE ROE -- @field #AI.Option.Ground.val.ALARM_STATE ALARM_STATE -- @field #AI.Option.Ground.val.ENGAGE_TARGETS RESTRICT_TARGETS - --- @type AI.Option.Ground.val.ROE + -- @type AI.Option.Ground.val.ROE -- @field OPEN_FIRE -- @field RETURN_FIRE -- @field WEAPON_HOLD - --- @type AI.Option.Ground.mval -- Moose added + -- @type AI.Option.Ground.mval -- Moose added -- @field #AI.Option.Ground.mval.ENGAGE_TARGETS ENGAGE_TARGETS - --- @type AI.Option.Ground.mval.ENGAGE_TARGETS -- Moose added + -- @type AI.Option.Ground.mval.ENGAGE_TARGETS -- Moose added -- @field ANY_TARGET -- 0 -- @field AIR_UNITS_ONLY -- 1 -- @field GROUND_UNITS_ONLY -- 2 - --- @type AI.Option.Ground.val.ALARM_STATE + -- @type AI.Option.Ground.val.ALARM_STATE -- @field AUTO -- @field GREEN -- @field RED - --- @type AI.Option.Naval.id + -- @type AI.Option.Naval.id -- @field NO_OPTION -- @field ROE - --- @type AI.Option.Naval.val + -- @type AI.Option.Naval.val -- @field #AI.Option.Naval.val.ROE ROE - --- @type AI.Option.Naval.val.ROE + -- @type AI.Option.Naval.val.ROE -- @field OPEN_FIRE -- @field RETURN_FIRE -- @field WEAPON_HOLD diff --git a/Moose Development/Moose/Functional/ATC_Ground.lua b/Moose Development/Moose/Functional/ATC_Ground.lua index 5e89ff144..74cdae7cd 100644 --- a/Moose Development/Moose/Functional/ATC_Ground.lua +++ b/Moose Development/Moose/Functional/ATC_Ground.lua @@ -26,7 +26,7 @@ -- @module Functional.ATC_Ground -- @image Air_Traffic_Control_Ground_Operations.JPG ---- @type ATC_GROUND +-- @type ATC_GROUND -- @field Core.Set#SET_CLIENT SetClient -- @extends Core.Base#BASE @@ -39,7 +39,7 @@ ATC_GROUND = { AirbaseNames = nil, } ---- @type ATC_GROUND.AirbaseNames +-- @type ATC_GROUND.AirbaseNames -- @list <#string> @@ -82,7 +82,7 @@ function ATC_GROUND:New( Airbases, AirbaseList ) end self.SetClient:ForEachClient( - --- @param Wrapper.Client#CLIENT Client + -- @param Wrapper.Client#CLIENT Client function( Client ) Client:SetState( self, "Speeding", false ) Client:SetState( self, "Warnings", 0) @@ -246,11 +246,11 @@ function ATC_GROUND:SetMaximumKickSpeedMiph( MaximumKickSpeedMiph, Airbase ) return self end ---- @param #ATC_GROUND self +-- @param #ATC_GROUND self function ATC_GROUND:_AirbaseMonitor() self.SetClient:ForEachClient( - --- @param Wrapper.Client#CLIENT Client + -- @param Wrapper.Client#CLIENT Client function( Client ) if Client:IsAlive() then @@ -331,7 +331,7 @@ function ATC_GROUND:_AirbaseMonitor() Client:SetState( self, "Warnings", SpeedingWarnings + 1 ) else MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. " has been kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll() - --- @param Wrapper.Client#CLIENT Client + -- @param Wrapper.Client#CLIENT Client Client:Destroy() Client:SetState( self, "Speeding", false ) Client:SetState( self, "Warnings", 0 ) @@ -363,7 +363,7 @@ function ATC_GROUND:_AirbaseMonitor() Client:SetState( self, "OffRunwayWarnings", OffRunwayWarnings + 1 ) else MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. " has been kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll() - --- @param Wrapper.Client#CLIENT Client + -- @param Wrapper.Client#CLIENT Client Client:Destroy() Client:SetState( self, "IsOffRunway", false ) Client:SetState( self, "OffRunwayWarnings", 0 ) @@ -461,7 +461,7 @@ function ATC_GROUND_UNIVERSAL:New(AirbaseList) end self.SetClient:ForEachClient( - --- @param Wrapper.Client#CLIENT Client + -- @param Wrapper.Client#CLIENT Client function( Client ) Client:SetState( self, "Speeding", false ) Client:SetState( self, "Warnings", 0) @@ -681,7 +681,7 @@ end function ATC_GROUND_UNIVERSAL:_AirbaseMonitor() self.SetClient:ForEachClient( - --- @param Wrapper.Client#CLIENT Client + -- @param Wrapper.Client#CLIENT Client function( Client ) if Client:IsAlive() then @@ -766,7 +766,7 @@ function ATC_GROUND_UNIVERSAL:_AirbaseMonitor() Client:SetState( self, "Warnings", SpeedingWarnings + 1 ) else MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. " has been kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll() - --- @param Wrapper.Client#CLIENT Client + -- @param Wrapper.Client#CLIENT Client Client:Destroy() Client:SetState( self, "Speeding", false ) Client:SetState( self, "Warnings", 0 ) @@ -798,7 +798,7 @@ function ATC_GROUND_UNIVERSAL:_AirbaseMonitor() Client:SetState( self, "OffRunwayWarnings", OffRunwayWarnings + 1 ) else MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. " has been kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll() - --- @param Wrapper.Client#CLIENT Client + -- @param Wrapper.Client#CLIENT Client Client:Destroy() Client:SetState( self, "IsOffRunway", false ) Client:SetState( self, "OffRunwayWarnings", 0 ) @@ -846,7 +846,7 @@ function ATC_GROUND_UNIVERSAL:Start( RepeatScanSeconds ) return self end ---- @type ATC_GROUND_CAUCASUS +-- @type ATC_GROUND_CAUCASUS -- @extends #ATC_GROUND --- # ATC\_GROUND\_CAUCASUS, extends @{#ATC_GROUND_UNIVERSAL} @@ -986,7 +986,7 @@ end ---- @type ATC_GROUND_NEVADA +-- @type ATC_GROUND_NEVADA -- @extends #ATC_GROUND @@ -1124,7 +1124,7 @@ function ATC_GROUND_NEVADA:Start( RepeatScanSeconds ) end ---- @type ATC_GROUND_NORMANDY +-- @type ATC_GROUND_NORMANDY -- @extends #ATC_GROUND @@ -1280,7 +1280,7 @@ function ATC_GROUND_NORMANDY:Start( RepeatScanSeconds ) self.AirbaseMonitor = SCHEDULER:New( self, self._AirbaseMonitor, { self }, 0, 2, RepeatScanSeconds ) end ---- @type ATC_GROUND_PERSIANGULF +-- @type ATC_GROUND_PERSIANGULF -- @extends #ATC_GROUND @@ -1423,7 +1423,7 @@ function ATC_GROUND_PERSIANGULF:Start( RepeatScanSeconds ) end - --- @type ATC_GROUND_MARIANAISLANDS + -- @type ATC_GROUND_MARIANAISLANDS -- @extends #ATC_GROUND @@ -1517,7 +1517,7 @@ end -- * @{#ATC_GROUND.SetMaximumKickSpeedKmph}(): Set the maximum speed allowed at an airbase in kilometers per hour. -- * @{#ATC_GROUND.SetMaximumKickSpeedMiph}(): Set the maximum speed allowed at an airbase in miles per hour. -- ----- @field #ATC_GROUND_MARIANAISLANDS +-- @field #ATC_GROUND_MARIANAISLANDS ATC_GROUND_MARIANAISLANDS = { ClassName = "ATC_GROUND_MARIANAISLANDS", } @@ -1529,7 +1529,7 @@ ATC_GROUND_MARIANAISLANDS = { function ATC_GROUND_MARIANAISLANDS:New( AirbaseNames ) -- Inherits from BASE - local self = BASE:Inherit( self, ATC_GROUND_UNIVERSAL:New( self.Airbases, AirbaseNames ) ) + local self = BASE:Inherit( self, ATC_GROUND_UNIVERSAL:New( AirbaseNames ) ) self:SetKickSpeedKmph( 50 ) self:SetMaximumKickSpeedKmph( 150 ) diff --git a/Moose Development/Moose/Functional/CleanUp.lua b/Moose Development/Moose/Functional/CleanUp.lua index 994147589..4ba1d3e4c 100644 --- a/Moose Development/Moose/Functional/CleanUp.lua +++ b/Moose Development/Moose/Functional/CleanUp.lua @@ -52,11 +52,11 @@ -- @module Functional.CleanUp -- @image CleanUp_Airbases.JPG ---- @type CLEANUP_AIRBASE.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-) +-- @type CLEANUP_AIRBASE.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-) -- @field #map<#string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases. -- @extends Core.Base#BASE ---- @type CLEANUP_AIRBASE +-- @type CLEANUP_AIRBASE -- @extends #CLEANUP_AIRBASE.__ --- Keeps airbases clean, and tries to guarantee continuous airbase operations, even under combat. @@ -93,7 +93,7 @@ CLEANUP_AIRBASE = { -- @field #CLEANUP_AIRBASE.__ CLEANUP_AIRBASE.__ = {} ---- @field #CLEANUP_AIRBASE.__.Airbases +-- @field #CLEANUP_AIRBASE.__.Airbases CLEANUP_AIRBASE.__.Airbases = {} --- Creates the main object which is handling the cleaning of the debris within the given Zone Names. @@ -240,7 +240,8 @@ function CLEANUP_AIRBASE.__:DestroyMissile( MissileObject ) end end ---- @param #CLEANUP_AIRBASE self +--- +-- @param #CLEANUP_AIRBASE self -- @param Core.Event#EVENTDATA EventData function CLEANUP_AIRBASE.__:OnEventBirth( EventData ) self:F( { EventData } ) diff --git a/Moose Development/Moose/Functional/Designate.lua b/Moose Development/Moose/Functional/Designate.lua index 7bc0c7a82..ec5676b40 100644 --- a/Moose Development/Moose/Functional/Designate.lua +++ b/Moose Development/Moose/Functional/Designate.lua @@ -182,7 +182,7 @@ do -- DESIGNATE - --- @type DESIGNATE + -- @type DESIGNATE -- @extends Core.Fsm#FSM_PROCESS --- Manage the designation of detected targets. @@ -523,7 +523,7 @@ do -- DESIGNATE self.AttackSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP AttackGroup + -- @param Wrapper.Group#GROUP AttackGroup function( AttackGroup ) self.FlashStatusMenu[AttackGroup] = FlashMenu end @@ -552,7 +552,7 @@ do -- DESIGNATE self.AttackSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP AttackGroup + -- @param Wrapper.Group#GROUP AttackGroup function( AttackGroup ) self.FlashDetectionMessage[AttackGroup] = FlashDetectionMessage end @@ -824,7 +824,7 @@ do -- DESIGNATE -- This Detection is obsolete, remove from the designate scope self.Designating[DesignateIndex] = nil self.AttackSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP AttackGroup + -- @param Wrapper.Group#GROUP AttackGroup function( AttackGroup ) if AttackGroup:IsAlive() == true then local DetectionText = self.Detection:DetectedItemReportSummary( DetectedItem, AttackGroup ):Text( ", " ) @@ -901,7 +901,7 @@ do -- DESIGNATE self.AttackSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP GroupReport + -- @param Wrapper.Group#GROUP GroupReport function( AttackGroup ) if self.FlashStatusMenu[AttackGroup] or ( MenuAttackGroup and ( AttackGroup:GetName() == MenuAttackGroup:GetName() ) ) then @@ -1058,7 +1058,7 @@ do -- DESIGNATE self.AttackSet:ForEachGroupAlive( - --- @param Wrapper.Group#GROUP GroupReport + -- @param Wrapper.Group#GROUP GroupReport function( AttackGroup ) self:ScheduleOnce( Delay, self.SetMenu, self, AttackGroup ) @@ -1230,7 +1230,7 @@ do -- DESIGNATE if self.AutoLase or ( not self.AutoLase and ( self.LaseStart + Duration >= timer.getTime() ) ) then TargetSetUnit:ForEachUnitPerThreatLevel( 10, 0, - --- @param Wrapper.Unit#UNIT SmokeUnit + -- @param Wrapper.Unit#UNIT SmokeUnit function( TargetUnit ) self:F( { TargetUnit = TargetUnit:GetName() } ) @@ -1390,7 +1390,7 @@ do -- DESIGNATE local MarkedCount = 0 TargetSetUnit:ForEachUnitPerThreatLevel( 10, 0, - --- @param Wrapper.Unit#UNIT SmokeUnit + -- @param Wrapper.Unit#UNIT SmokeUnit function( SmokeUnit ) if MarkedCount < self.MaximumMarkings then diff --git a/Moose Development/Moose/Functional/Detection.lua b/Moose Development/Moose/Functional/Detection.lua index e7f76ef0f..24e3577dc 100644 --- a/Moose Development/Moose/Functional/Detection.lua +++ b/Moose Development/Moose/Functional/Detection.lua @@ -39,7 +39,7 @@ do -- DETECTION_BASE - --- @type DETECTION_BASE + -- @type DETECTION_BASE -- @field Core.Set#SET_GROUP DetectionSetGroup The @{Core.Set} of GROUPs in the Forward Air Controller role. -- @field DCS#Distance DetectionRange The range till which targets are accepted to be detected. -- @field #DETECTION_BASE.DetectedObjects DetectedObjects The list of detected objects. @@ -269,10 +269,10 @@ do -- DETECTION_BASE DetectedItemsByIndex = {}, } - --- @type DETECTION_BASE.DetectedObjects + -- @type DETECTION_BASE.DetectedObjects -- @list <#DETECTION_BASE.DetectedObject> - --- @type DETECTION_BASE.DetectedObject + -- @type DETECTION_BASE.DetectedObject -- @field #string Name -- @field #boolean IsVisible -- @field #boolean KnowType @@ -284,7 +284,7 @@ do -- DETECTION_BASE -- @field #boolean LastPos -- @field #number LastVelocity - --- @type DETECTION_BASE.DetectedItems + -- @type DETECTION_BASE.DetectedItems -- @list <#DETECTION_BASE.DetectedItem> --- Detected item data structure. @@ -522,7 +522,7 @@ do -- DETECTION_BASE do -- State Transition Handling - --- @param #DETECTION_BASE self + -- @param #DETECTION_BASE self -- @param #string From The From State string. -- @param #string Event The Event string. -- @param #string To The To State string. @@ -530,7 +530,7 @@ do -- DETECTION_BASE self:__Detect( 1 ) end - --- @param #DETECTION_BASE self + -- @param #DETECTION_BASE self -- @param #string From The From State string. -- @param #string Event The Event string. -- @param #string To The To State string. @@ -570,7 +570,7 @@ do -- DETECTION_BASE end - --- @param #DETECTION_BASE self + -- @param #DETECTION_BASE self -- @param #number The amount of alive recce. function DETECTION_BASE:CountAliveRecce() @@ -578,7 +578,7 @@ do -- DETECTION_BASE end - --- @param #DETECTION_BASE self + -- @param #DETECTION_BASE self function DETECTION_BASE:ForEachAliveRecce( IteratorFunction, ... ) self:F2( arg ) @@ -587,7 +587,7 @@ do -- DETECTION_BASE return self end - --- @param #DETECTION_BASE self + -- @param #DETECTION_BASE self -- @param #string From The From State string. -- @param #string Event The Event string. -- @param #string To The To State string. @@ -1354,7 +1354,7 @@ do -- DETECTION_BASE } } - --- @param DCS#Unit FoundDCSUnit + -- @param DCS#Unit FoundDCSUnit -- @param Wrapper.Group#GROUP ReportGroup -- @param Core.Set#SET_GROUP ReportSetGroup local FindNearByFriendlies = function( FoundDCSUnit, ReportGroupData ) @@ -1419,7 +1419,7 @@ do -- DETECTION_BASE DetectedItem.PlayersNearBy = nil _DATABASE:ForEachPlayer( - --- @param Wrapper.Unit#UNIT PlayerUnit + -- @param Wrapper.Unit#UNIT PlayerUnit function( PlayerUnitName ) local PlayerUnit = UNIT:FindByName( PlayerUnitName ) @@ -1976,7 +1976,7 @@ end do -- DETECTION_UNITS - --- @type DETECTION_UNITS + -- @type DETECTION_UNITS -- @field DCS#Distance DetectionRange The range till which targets are detected. -- @extends Functional.Detection#DETECTION_BASE @@ -2232,7 +2232,7 @@ end do -- DETECTION_TYPES - --- @type DETECTION_TYPES + -- @type DETECTION_TYPES -- @extends Functional.Detection#DETECTION_BASE --- Will detect units within the battle zone. @@ -2434,7 +2434,7 @@ end do -- DETECTION_AREAS - --- @type DETECTION_AREAS + -- @type DETECTION_AREAS -- @field DCS#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target. -- @field #DETECTION_BASE.DetectedItems DetectedItems A list of areas containing the set of @{Wrapper.Unit}s, @{Core.Zone}s, the center @{Wrapper.Unit} within the zone, and ID of each area that was detected within a DetectionZoneRange. -- @extends Functional.Detection#DETECTION_BASE @@ -2960,7 +2960,7 @@ do -- DETECTION_AREAS -- DetectedSet:Flush( self ) - DetectedSet:ForEachUnit( --- @param Wrapper.Unit#UNIT DetectedUnit + DetectedSet:ForEachUnit( -- @param Wrapper.Unit#UNIT DetectedUnit function( DetectedUnit ) if DetectedUnit:IsAlive() then -- self:T( "Detected Set #" .. DetectedItem.ID .. ":" .. DetectedUnit:GetName() ) diff --git a/Moose Development/Moose/Functional/DetectionZones.lua b/Moose Development/Moose/Functional/DetectionZones.lua index 8cb9b9d10..2cef564e4 100644 --- a/Moose Development/Moose/Functional/DetectionZones.lua +++ b/Moose Development/Moose/Functional/DetectionZones.lua @@ -4,7 +4,7 @@ do -- DETECTION_ZONES - --- @type DETECTION_ZONES + -- @type DETECTION_ZONES -- @field DCS#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target. -- @field #DETECTION_BASE.DetectedItems DetectedItems A list of areas containing the set of @{Wrapper.Unit}s, @{Core.Zone}s, the center @{Wrapper.Unit} within the zone, and ID of each area that was detected within a DetectionZoneRange. -- @extends Functional.Detection#DETECTION_BASE @@ -68,7 +68,7 @@ do -- DETECTION_ZONES return self end - --- @param #DETECTION_ZONES self + -- @param #DETECTION_ZONES self -- @param #number The amount of alive recce. function DETECTION_ZONES:CountAliveRecce() @@ -76,7 +76,7 @@ do -- DETECTION_ZONES end - --- @param #DETECTION_ZONES self + -- @param #DETECTION_ZONES self function DETECTION_ZONES:ForEachAliveRecce( IteratorFunction, ... ) self:F2( arg ) @@ -352,7 +352,7 @@ do -- DETECTION_ZONES --DetectedSet:Flush( self ) DetectedSet:ForEachUnit( - --- @param Wrapper.Unit#UNIT DetectedUnit + -- @param Wrapper.Unit#UNIT DetectedUnit function( DetectedUnit ) if DetectedUnit:IsAlive() then --self:T( "Detected Set #" .. DetectedItem.ID .. ":" .. DetectedUnit:GetName() ) @@ -380,7 +380,7 @@ do -- DETECTION_ZONES end - --- @param #DETECTION_ZONES self + -- @param #DETECTION_ZONES self -- @param #string From The From State string. -- @param #string Event The Event string. -- @param #string To The To State string. diff --git a/Moose Development/Moose/Functional/Escort.lua b/Moose Development/Moose/Functional/Escort.lua index 57a9ed5da..90f9f925a 100644 --- a/Moose Development/Moose/Functional/Escort.lua +++ b/Moose Development/Moose/Functional/Escort.lua @@ -109,7 +109,7 @@ ---- @type ESCORT +-- @type ESCORT -- @extends Core.Base#BASE -- @field Wrapper.Client#CLIENT EscortClient -- @field Wrapper.Group#GROUP EscortGroup @@ -693,7 +693,7 @@ function ESCORT:MenuResumeMission() end ---- @param #MENUPARAM MenuParam +-- @param #MENUPARAM MenuParam function ESCORT:_HoldPosition( OrbitGroup, OrbitHeight, OrbitSeconds ) local EscortGroup = self.EscortGroup @@ -733,7 +733,7 @@ function ESCORT:_HoldPosition( OrbitGroup, OrbitHeight, OrbitSeconds ) end ---- @param #MENUPARAM MenuParam +-- @param #MENUPARAM MenuParam function ESCORT:_JoinUpAndFollow( Distance ) local EscortGroup = self.EscortGroup @@ -766,7 +766,7 @@ function ESCORT:JoinUpAndFollow( EscortGroup, EscortClient, Distance ) EscortGroup:MessageToClient( "Rejoining and Following at " .. Distance .. "!", 30, EscortClient ) end ---- @param #MENUPARAM MenuParam +-- @param #MENUPARAM MenuParam function ESCORT:_Flare( Color, Message ) local EscortGroup = self.EscortGroup @@ -776,7 +776,7 @@ function ESCORT:_Flare( Color, Message ) EscortGroup:MessageToClient( Message, 10, EscortClient ) end ---- @param #MENUPARAM MenuParam +-- @param #MENUPARAM MenuParam function ESCORT:_Smoke( Color, Message ) local EscortGroup = self.EscortGroup @@ -787,7 +787,7 @@ function ESCORT:_Smoke( Color, Message ) end ---- @param #MENUPARAM MenuParam +-- @param #MENUPARAM MenuParam function ESCORT:_ReportNearbyTargetsNow() local EscortGroup = self.EscortGroup @@ -814,7 +814,7 @@ function ESCORT:_SwitchReportNearbyTargets( ReportTargets ) end end ---- @param #MENUPARAM MenuParam +-- @param #MENUPARAM MenuParam function ESCORT:_ScanTargets( ScanDuration ) local EscortGroup = self.EscortGroup -- Wrapper.Group#GROUP @@ -844,7 +844,7 @@ function ESCORT:_ScanTargets( ScanDuration ) end ---- @param Wrapper.Group#GROUP EscortGroup +-- @param Wrapper.Group#GROUP EscortGroup function _Resume( EscortGroup ) env.info( '_Resume' ) @@ -856,7 +856,7 @@ function _Resume( EscortGroup ) end ---- @param #ESCORT self +-- @param #ESCORT self -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem function ESCORT:_AttackTarget( DetectedItem ) @@ -877,7 +877,7 @@ function ESCORT:_AttackTarget( DetectedItem ) local Tasks = {} DetectedSet:ForEachUnit( - --- @param Wrapper.Unit#UNIT DetectedUnit + -- @param Wrapper.Unit#UNIT DetectedUnit function( DetectedUnit, Tasks ) if DetectedUnit:IsAlive() then Tasks[#Tasks+1] = EscortGroup:TaskAttackUnit( DetectedUnit ) @@ -900,7 +900,7 @@ function ESCORT:_AttackTarget( DetectedItem ) local Tasks = {} DetectedSet:ForEachUnit( - --- @param Wrapper.Unit#UNIT DetectedUnit + -- @param Wrapper.Unit#UNIT DetectedUnit function( DetectedUnit, Tasks ) if DetectedUnit:IsAlive() then Tasks[#Tasks+1] = EscortGroup:TaskFireAtPoint( DetectedUnit:GetVec2(), 50 ) @@ -921,7 +921,7 @@ function ESCORT:_AttackTarget( DetectedItem ) end --- ---- @param #ESCORT self +-- @param #ESCORT self -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem ) @@ -939,7 +939,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem ) local Tasks = {} DetectedSet:ForEachUnit( - --- @param Wrapper.Unit#UNIT DetectedUnit + -- @param Wrapper.Unit#UNIT DetectedUnit function( DetectedUnit, Tasks ) if DetectedUnit:IsAlive() then Tasks[#Tasks+1] = EscortGroupAttack:TaskAttackUnit( DetectedUnit ) @@ -961,7 +961,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem ) local Tasks = {} DetectedSet:ForEachUnit( - --- @param Wrapper.Unit#UNIT DetectedUnit + -- @param Wrapper.Unit#UNIT DetectedUnit function( DetectedUnit, Tasks ) if DetectedUnit:IsAlive() then Tasks[#Tasks+1] = EscortGroupAttack:TaskFireAtPoint( DetectedUnit:GetVec2(), 50 ) @@ -981,7 +981,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem ) end ---- @param #MENUPARAM MenuParam +-- @param #MENUPARAM MenuParam function ESCORT:_ROE( EscortROEFunction, EscortROEMessage ) local EscortGroup = self.EscortGroup @@ -991,7 +991,7 @@ function ESCORT:_ROE( EscortROEFunction, EscortROEMessage ) EscortGroup:MessageToClient( EscortROEMessage, 10, EscortClient ) end ---- @param #MENUPARAM MenuParam +-- @param #MENUPARAM MenuParam function ESCORT:_ROT( EscortROTFunction, EscortROTMessage ) local EscortGroup = self.EscortGroup @@ -1001,7 +1001,7 @@ function ESCORT:_ROT( EscortROTFunction, EscortROTMessage ) EscortGroup:MessageToClient( EscortROTMessage, 10, EscortClient ) end ---- @param #MENUPARAM MenuParam +-- @param #MENUPARAM MenuParam function ESCORT:_ResumeMission( WayPoint ) local EscortGroup = self.EscortGroup @@ -1036,7 +1036,7 @@ function ESCORT:RegisterRoute() return TaskPoints end ---- @param Functional.Escort#ESCORT self +-- @param Functional.Escort#ESCORT self function ESCORT:_FollowScheduler() self:F( { self.FollowDistance } ) diff --git a/Moose Development/Moose/Functional/Fox.lua b/Moose Development/Moose/Functional/Fox.lua index 5d2e35865..6644890a5 100644 --- a/Moose Development/Moose/Functional/Fox.lua +++ b/Moose Development/Moose/Functional/Fox.lua @@ -142,7 +142,7 @@ FOX = { explosiondist = 200, explosiondist2 = 500, bigmissilemass = 50, - destroy = nil, + --destroy = nil, dt50 = 5, dt10 = 1, dt05 = 0.5, diff --git a/Moose Development/Moose/Functional/MissileTrainer.lua b/Moose Development/Moose/Functional/MissileTrainer.lua index 24f2046bc..72e9ddc97 100644 --- a/Moose Development/Moose/Functional/MissileTrainer.lua +++ b/Moose Development/Moose/Functional/MissileTrainer.lua @@ -68,7 +68,7 @@ -- @image Missile_Trainer.JPG ---- @type MISSILETRAINER +-- @type MISSILETRAINER -- @field Core.Set#SET_CLIENT DBClients -- @extends Core.Base#BASE @@ -205,7 +205,7 @@ function MISSILETRAINER:New( Distance, Briefing ) -- self.DB:ForEachClient( --- --- @param Wrapper.Client#CLIENT Client +-- -- @param Wrapper.Client#CLIENT Client -- function( Client ) -- -- ... actions ... diff --git a/Moose Development/Moose/Functional/Movement.lua b/Moose Development/Moose/Functional/Movement.lua index bcb8bb9c1..3b4031433 100644 --- a/Moose Development/Moose/Functional/Movement.lua +++ b/Moose Development/Moose/Functional/Movement.lua @@ -10,7 +10,7 @@ -- @module Functional.Movement -- @image MOOSE.JPG ---- @type MOVEMENT +-- @type MOVEMENT -- @extends Core.Base#BASE --- diff --git a/Moose Development/Moose/Functional/Scoring.lua b/Moose Development/Moose/Functional/Scoring.lua index 950ccd3c0..33d50f923 100644 --- a/Moose Development/Moose/Functional/Scoring.lua +++ b/Moose Development/Moose/Functional/Scoring.lua @@ -88,7 +88,7 @@ -- @module Functional.Scoring -- @image Scoring.JPG ---- @type SCORING +-- @type SCORING -- @field Players A collection of the current players that have joined the game. -- @extends Core.Base#BASE diff --git a/Moose Development/Moose/Functional/Sead.lua b/Moose Development/Moose/Functional/Sead.lua index ebcd2228c..0ed37dadb 100644 --- a/Moose Development/Moose/Functional/Sead.lua +++ b/Moose Development/Moose/Functional/Sead.lua @@ -66,7 +66,7 @@ SEAD = { -- @field Harms SEAD.Harms = { ["AGM_88"] = "AGM_88", - ["AGM_45"] = "AGM_45", + --["AGM_45"] = "AGM_45", ["AGM_122"] = "AGM_122", ["AGM_84"] = "AGM_84", ["AGM_45"] = "AGM_45", @@ -369,7 +369,7 @@ function SEAD:onafterManageEvasion(From,Event,To,_targetskill,_targetgroup,SEADP local reach = 10 if hit then local wpndata = SEAD.HarmData[data] - reach = wpndata[1] * 1,1 + reach = wpndata[1] * 1.1 local mach = wpndata[2] wpnspeed = math.floor(mach * 340.29) end diff --git a/Moose Development/Moose/Functional/Shorad.lua b/Moose Development/Moose/Functional/Shorad.lua index e08f7fa29..8affe3cf6 100644 --- a/Moose Development/Moose/Functional/Shorad.lua +++ b/Moose Development/Moose/Functional/Shorad.lua @@ -112,7 +112,7 @@ do -- @field Harms SHORAD.Harms = { ["AGM_88"] = "AGM_88", - ["AGM_45"] = "AGM_45", + --["AGM_45"] = "AGM_45", ["AGM_122"] = "AGM_122", ["AGM_84"] = "AGM_84", ["AGM_45"] = "AGM_45", @@ -213,7 +213,7 @@ do if onoff then self:SwitchDebugOn() else - self.SwitchDebugOff() + self:SwitchDebugOff() end return self end diff --git a/Moose Development/Moose/Functional/Warehouse.lua b/Moose Development/Moose/Functional/Warehouse.lua index f420a770e..3820c947b 100644 --- a/Moose Development/Moose/Functional/Warehouse.lua +++ b/Moose Development/Moose/Functional/Warehouse.lua @@ -8229,7 +8229,7 @@ end -- @return #number Request ID. function WAREHOUSE:_GetIDsFromGroupName(groupname) - ---@param #string text The text to analyse. + -- @param #string text The text to analyse. local function analyse(text) -- Get rid of #0001 tail from spawn. diff --git a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua index 3215b9a12..eef5c72ff 100644 --- a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua +++ b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua @@ -48,7 +48,7 @@ do -- ZONE_CAPTURE_COALITION - --- @type ZONE_CAPTURE_COALITION + -- @type ZONE_CAPTURE_COALITION -- @field #string ClassName Name of the class. -- @field #number MarkBlue ID of blue F10 mark. -- @field #number MarkRed ID of red F10 mark. @@ -161,7 +161,7 @@ do -- ZONE_CAPTURE_COALITION -- The mission designer can use these values to alter the logic. -- For example: -- - -- --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self + -- -- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self -- function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To ) -- if From ~= "Empty" then -- -- Display a message @@ -172,7 +172,7 @@ do -- ZONE_CAPTURE_COALITION -- -- ## Example Event Handler. -- - -- --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self + -- -- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self -- function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To ) -- if From ~= To then -- local Coalition = self:GetCoalition() @@ -273,7 +273,7 @@ do -- ZONE_CAPTURE_COALITION -- Depending on the zone ownership, different messages are sent. -- Note the methods `ZoneCaptureCoalition:GetZoneName()`. -- - -- --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self + -- -- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self -- function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To ) -- if From ~= To then -- local Coalition = self:GetCoalition() @@ -294,7 +294,7 @@ do -- ZONE_CAPTURE_COALITION -- Next is the Event Handler when the **Empty** state transition is triggered. -- Now we smoke the ZoneCaptureCoalition with a green color, using `self:Smoke( SMOKECOLOR.Green )`. -- - -- --- @param Functional.Protect#ZONE_CAPTURE_COALITION self + -- -- @param Functional.Protect#ZONE_CAPTURE_COALITION self -- function ZoneCaptureCoalition:OnEnterEmpty() -- self:Smoke( SMOKECOLOR.Green ) -- US_CC:MessageTypeToCoalition( string.format( "%s is unprotected, and can be captured!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information ) @@ -304,7 +304,7 @@ do -- ZONE_CAPTURE_COALITION -- The next Event Handlers speak for itself. -- When the zone is Attacked, we smoke the zone white and send some messages to each coalition. -- - -- --- @param Functional.Protect#ZONE_CAPTURE_COALITION self + -- -- @param Functional.Protect#ZONE_CAPTURE_COALITION self -- function ZoneCaptureCoalition:OnEnterAttacked() -- ZoneCaptureCoalition:Smoke( SMOKECOLOR.White ) -- local Coalition = self:GetCoalition() @@ -321,7 +321,7 @@ do -- ZONE_CAPTURE_COALITION -- When the zone is Captured, we send some victory or loss messages to the correct coalition. -- And we add some score. -- - -- --- @param Functional.Protect#ZONE_CAPTURE_COALITION self + -- -- @param Functional.Protect#ZONE_CAPTURE_COALITION self -- function ZoneCaptureCoalition:OnEnterCaptured() -- local Coalition = self:GetCoalition() -- self:E({Coalition = Coalition}) @@ -641,7 +641,7 @@ do -- ZONE_CAPTURE_COALITION -- -- @usage -- -- For example, one could stop the monitoring when the zone was captured! - -- --- @param Functional.Protect#ZONE_CAPTURE_COALITION self + -- -- @param Functional.Protect#ZONE_CAPTURE_COALITION self -- function ZoneCaptureCoalition:OnEnterCaptured() -- local Coalition = self:GetCoalition() -- self:E({Coalition = Coalition}) diff --git a/Moose Development/Moose/Functional/ZoneGoal.lua b/Moose Development/Moose/Functional/ZoneGoal.lua index 1044e7920..2d0b5a4b3 100644 --- a/Moose Development/Moose/Functional/ZoneGoal.lua +++ b/Moose Development/Moose/Functional/ZoneGoal.lua @@ -17,7 +17,7 @@ do -- Zone - --- @type ZONE_GOAL + -- @type ZONE_GOAL -- @field #string ClassName Name of the class. -- @field Core.Goal#GOAL Goal The goal object. -- @field #number SmokeTime Time stamp in seconds when the last smoke of the zone was triggered. @@ -178,7 +178,7 @@ do -- Zone end - --- @param #ZONE_GOAL self + -- @param #ZONE_GOAL self -- @param Core.Event#EVENTDATA EventData Event data table. function ZONE_GOAL:__Destroyed( EventData ) self:F( { "EventDead", EventData } ) diff --git a/Moose Development/Moose/Functional/ZoneGoalCargo.lua b/Moose Development/Moose/Functional/ZoneGoalCargo.lua index fdd0deedf..3295cc2a4 100644 --- a/Moose Development/Moose/Functional/ZoneGoalCargo.lua +++ b/Moose Development/Moose/Functional/ZoneGoalCargo.lua @@ -16,7 +16,7 @@ do -- ZoneGoal - --- @type ZONE_GOAL_CARGO + -- @type ZONE_GOAL_CARGO -- @extends Functional.ZoneGoal#ZONE_GOAL @@ -50,7 +50,7 @@ do -- ZoneGoal ClassName = "ZONE_GOAL_CARGO", } - --- @field #table ZONE_GOAL_CARGO.States + -- @field #table ZONE_GOAL_CARGO.States ZONE_GOAL_CARGO.States = {} --- ZONE_GOAL_CARGO Constructor. diff --git a/Moose Development/Moose/Functional/ZoneGoalCoalition.lua b/Moose Development/Moose/Functional/ZoneGoalCoalition.lua index 1f5da5440..df60a05eb 100644 --- a/Moose Development/Moose/Functional/ZoneGoalCoalition.lua +++ b/Moose Development/Moose/Functional/ZoneGoalCoalition.lua @@ -16,7 +16,7 @@ do -- ZoneGoal - --- @type ZONE_GOAL_COALITION + -- @type ZONE_GOAL_COALITION -- @field #string ClassName Name of the Class. -- @field #number Coalition The current coalition ID of the zone owner. -- @field #number PreviousCoalition The previous owner of the zone. @@ -48,7 +48,7 @@ do -- ZoneGoal ObjectCategories = nil, } - --- @field #table ZONE_GOAL_COALITION.States + -- @field #table ZONE_GOAL_COALITION.States ZONE_GOAL_COALITION.States = {} --- ZONE_GOAL_COALITION Constructor. diff --git a/Moose Development/Moose/Ops/ATIS.lua b/Moose Development/Moose/Ops/ATIS.lua index 3780ba573..25b8dc81c 100644 --- a/Moose Development/Moose/Ops/ATIS.lua +++ b/Moose Development/Moose/Ops/ATIS.lua @@ -1,3 +1,4 @@ +---@diagnostic disable: cast-local-type --- **Ops** - Automatic Terminal Information Service (ATIS). -- -- === @@ -2139,6 +2140,8 @@ function ATIS:onafterBroadcast( From, Event, To ) end end alltext = alltext .. ";\n" .. subtitle + + local _RUNACT if not self.ATISforFARPs then -- Active runway. @@ -2148,7 +2151,7 @@ function ATIS:onafterBroadcast( From, Event, To ) elseif rwyLandingLeft==false then subtitle=subtitle.." Right" end - local _RUNACT = subtitle + _RUNACT = subtitle if not self.useSRS then self:Transmission(ATIS.Sound.ActiveRunway, 1.0, subtitle) self.radioqueue:Number2Transmission(runwayLanding) diff --git a/Moose Development/Moose/Ops/Auftrag.lua b/Moose Development/Moose/Ops/Auftrag.lua index 00fb6ddbd..7f3ff6337 100644 --- a/Moose Development/Moose/Ops/Auftrag.lua +++ b/Moose Development/Moose/Ops/Auftrag.lua @@ -1,3 +1,4 @@ +---@diagnostic disable: undefined-global --- **Ops** - Auftrag (mission) for Ops. -- -- ## Main Features: @@ -477,7 +478,7 @@ AUFTRAG.Type={ RELOCATECOHORT="Relocate Cohort", AIRDEFENSE="Air Defence", EWR="Early Warning Radar", - RECOVERYTANKER="Recovery Tanker", + --RECOVERYTANKER="Recovery Tanker", REARMING="Rearming", CAPTUREZONE="Capture Zone", NOTHING="Nothing", diff --git a/Moose Development/Moose/Ops/Awacs.lua b/Moose Development/Moose/Ops/Awacs.lua index 0407a445d..b99e16a5c 100644 --- a/Moose Development/Moose/Ops/Awacs.lua +++ b/Moose Development/Moose/Ops/Awacs.lua @@ -2027,9 +2027,9 @@ function AWACS:_StartEscorts(Shiftchange) self.CatchAllMissions[#self.CatchAllMissions+1] = escort if Shiftchange then - self.EscortMissionReplacement[i] = mission + self.EscortMissionReplacement[i] = escort else - self.EscortMission[i] = mission + self.EscortMission[i] = escort end end @@ -3597,10 +3597,13 @@ function AWACS:_SetClientMenus() local tasking = MENU_GROUP:New(cgrp,"Tasking",basemenu) local showtask = MENU_GROUP_COMMAND:New(cgrp,"Showtask",tasking,self._Showtask,self,cgrp) + local commit + local unable + local abort if self.PlayerCapAssignment then - local commit = MENU_GROUP_COMMAND:New(cgrp,"Commit",tasking,self._Commit,self,cgrp) - local unable = MENU_GROUP_COMMAND:New(cgrp,"Unable",tasking,self._Unable,self,cgrp) - local abort = MENU_GROUP_COMMAND:New(cgrp,"Abort",tasking,self._TaskAbort,self,cgrp) + commit = MENU_GROUP_COMMAND:New(cgrp,"Commit",tasking,self._Commit,self,cgrp) + unable = MENU_GROUP_COMMAND:New(cgrp,"Unable",tasking,self._Unable,self,cgrp) + abort = MENU_GROUP_COMMAND:New(cgrp,"Abort",tasking,self._TaskAbort,self,cgrp) --local judy = MENU_GROUP_COMMAND:New(cgrp,"Judy",tasking,self._Judy,self,cgrp) end @@ -4933,8 +4936,8 @@ function AWACS:_AnnounceContact(Contact,IsNew,Group,IsBogeyDope,Tag,IsPopup,Repo end end - string.gsub(BRAText,"BRAA","brah") - string.gsub(BRAText,"BRA","brah") + BRAText = string.gsub(BRAText,"BRAA","brah") + BRAText = string.gsub(BRAText,"BRA","brah") local prio = IsNew or IsBogeyDope self:_NewRadioEntry(BRAText,TextScreen,GID,isGroup,true,IsNew,false,prio) @@ -5547,7 +5550,7 @@ end -- @param #string Event -- @param #string To -- @return #AWACS self -function AWACS:onbeforeStart(From,Event,to) +function AWACS:onbeforeStart(From,Event,To) self:T({From, Event, To}) if self.IncludeHelicopters then self.clientset:FilterCategories("helicopter") diff --git a/Moose Development/Moose/Ops/CSAR.lua b/Moose Development/Moose/Ops/CSAR.lua index f9ec9e5f5..450311cbb 100644 --- a/Moose Development/Moose/Ops/CSAR.lua +++ b/Moose Development/Moose/Ops/CSAR.lua @@ -230,7 +230,7 @@ CSAR = { takenOff = {}, csarUnits = {}, -- table of unit names downedPilots = {}, - woundedGroups = {}, + -- = {}, landedStatus = {}, addedTo = {}, woundedGroups = {}, -- contains the new group of units @@ -1306,7 +1306,7 @@ end -- @param #string UnitName -- @return #string CallSign function CSAR:_GetCustomCallSign(UnitName) - local callsign = Unitname + local callsign = UnitName local unit = UNIT:FindByName(UnitName) if unit and unit:IsAlive() then local group = unit:GetGroup() @@ -1876,7 +1876,7 @@ function CSAR:_SignalFlare(_unitName) if _closest ~= nil and _closest.pilot ~= nil and _closest.distance > 0 and _closest.distance < smokedist then local _clockDir = self:_GetClockDirection(_heli, _closest.pilot) - local _distance = 0 + local _distance = "" if _SETTINGS:IsImperial() then _distance = string.format("%.1fnm",UTILS.MetersToNM(_closest.distance)) else @@ -1889,12 +1889,13 @@ function CSAR:_SignalFlare(_unitName) _coord:FlareRed(_clockDir) else local _distance = smokedist + local dtext = "" if _SETTINGS:IsImperial() then - _distance = string.format("%.1fnm",UTILS.MetersToNM(smokedist)) + dtext = string.format("%.1fnm",UTILS.MetersToNM(smokedist)) else - _distance = string.format("%.1fkm",smokedist/1000) + dtext = string.format("%.1fkm",smokedist/1000) end - self:_DisplayMessageToSAR(_heli, string.format("No Pilots within %s",_distance), self.messageTime, false, false, true) + self:_DisplayMessageToSAR(_heli, string.format("No Pilots within %s",dtext), self.messageTime, false, false, true) end return self end @@ -1930,7 +1931,7 @@ function CSAR:_Reqsmoke( _unitName ) local _closest = self:_GetClosestDownedPilot(_heli) if _closest ~= nil and _closest.pilot ~= nil and _closest.distance > 0 and _closest.distance < smokedist then local _clockDir = self:_GetClockDirection(_heli, _closest.pilot) - local _distance = 0 + local _distance = string.format("%.1fkm",_closest.distance/1000) if _SETTINGS:IsImperial() then _distance = string.format("%.1fnm",UTILS.MetersToNM(_closest.distance)) else @@ -1942,7 +1943,7 @@ function CSAR:_Reqsmoke( _unitName ) local color = self.smokecolor _coord:Smoke(color) else - local _distance = 0 + local _distance = string.format("%.1fkm",smokedist/1000) if _SETTINGS:IsImperial() then _distance = string.format("%.1fnm",UTILS.MetersToNM(smokedist)) else diff --git a/Moose Development/Moose/Ops/CTLD.lua b/Moose Development/Moose/Ops/CTLD.lua index 298f7b1dd..1ced7de11 100644 --- a/Moose Development/Moose/Ops/CTLD.lua +++ b/Moose Development/Moose/Ops/CTLD.lua @@ -204,7 +204,7 @@ CTLD_CARGO = { -- @param #CTLD_CARGO self -- @param #boolean loaded function CTLD_CARGO:Isloaded() - if self.HasBeenMoved and not self.WasDropped() then + if self.HasBeenMoved and not self:WasDropped() then return true else return false diff --git a/Moose Development/Moose/Ops/Cohort.lua b/Moose Development/Moose/Ops/Cohort.lua index 5ab2e97da..afd37f936 100644 --- a/Moose Development/Moose/Ops/Cohort.lua +++ b/Moose Development/Moose/Ops/Cohort.lua @@ -75,7 +75,7 @@ COHORT = { livery = nil, skill = nil, legion = nil, - Ngroups = nil, + --Ngroups = nil, Ngroups = 0, engageRange = nil, tacanChannel = {}, diff --git a/Moose Development/Moose/Ops/PlayerRecce.lua b/Moose Development/Moose/Ops/PlayerRecce.lua index df55a88d4..d8e9d8dc8 100644 --- a/Moose Development/Moose/Ops/PlayerRecce.lua +++ b/Moose Development/Moose/Ops/PlayerRecce.lua @@ -1068,7 +1068,7 @@ self:T(self.lid.."_ReportLaserTargets") if number > 0 and self.AutoLase[playername] then local Settings = ( client and _DATABASE:GetPlayerSettings( playername ) ) or _SETTINGS local target = self:_GetHVTTarget(targetset) -- the one we're lasing - local ThreatLevel = target:GetThreatLevel() + local ThreatLevel = target:GetThreatLevel() or 1 local ThreatLevelText = "high" if ThreatLevel > 3 and ThreatLevel < 8 then ThreatLevelText = "medium" @@ -1078,7 +1078,7 @@ self:T(self.lid.."_ReportLaserTargets") local ThreatGraph = "[" .. string.rep( "■", ThreatLevel ) .. string.rep( "□", 10 - ThreatLevel ) .. "]: "..ThreatLevel local report = REPORT:New("Lasing Report") report:Add(string.rep("-",15)) - report:Add("Target type: "..target:GetTypeName()) + report:Add("Target type: "..target:GetTypeName() or "unknown") report:Add("Threat Level: "..ThreatGraph.." ("..ThreatLevelText..")") if not self.ReferencePoint then report:Add("Location: "..client:GetCoordinate():ToStringBULLS(self.Coalition,Settings)) diff --git a/Moose Development/Moose/Ops/PlayerTask.lua b/Moose Development/Moose/Ops/PlayerTask.lua index a7c127b1f..94f1b35c8 100644 --- a/Moose Development/Moose/Ops/PlayerTask.lua +++ b/Moose Development/Moose/Ops/PlayerTask.lua @@ -522,7 +522,7 @@ function PLAYERTASK:MarkTargetOnF10Map(Text,Coalition,ReadOnly) -- Marker exists, delete one first self.TargetMarker:Remove() end - local text = Text or "Target of "..self.lid + local text = Text or ("Target of "..self.lid) self.TargetMarker = MARKER:New(coordinate,text) if ReadOnly then self.TargetMarker:ReadOnly() diff --git a/Moose Development/Moose/Sound/SoundOutput.lua b/Moose Development/Moose/Sound/SoundOutput.lua index 57ce2f9a4..bf3fc4d6d 100644 --- a/Moose Development/Moose/Sound/SoundOutput.lua +++ b/Moose Development/Moose/Sound/SoundOutput.lua @@ -24,7 +24,7 @@ do -- Sound Base - --- @type SOUNDBASE + -- @type SOUNDBASE -- @field #string ClassName Name of the class. -- @extends Core.Base#BASE @@ -100,7 +100,7 @@ end do -- Sound File - --- @type SOUNDFILE + -- @type SOUNDFILE -- @field #string ClassName Name of the class -- @field #string filename Name of the flag. -- @field #string path Directory path, where the sound file is located. This includes the final slash "/". @@ -276,7 +276,7 @@ end do -- Text-To-Speech - --- @type SOUNDTEXT + -- @type SOUNDTEXT -- @field #string ClassName Name of the class -- @field #string text Text to speak. -- @field #number duration Duration in seconds. diff --git a/Moose Development/Moose/Sound/UserSound.lua b/Moose Development/Moose/Sound/UserSound.lua index cbccffe12..1cef70970 100644 --- a/Moose Development/Moose/Sound/UserSound.lua +++ b/Moose Development/Moose/Sound/UserSound.lua @@ -21,7 +21,7 @@ do -- UserSound - --- @type USERSOUND + -- @type USERSOUND -- @extends Core.Base#BASE diff --git a/Moose Development/Moose/Tasking/CommandCenter.lua b/Moose Development/Moose/Tasking/CommandCenter.lua index 8af4786bc..4d80a5d6b 100644 --- a/Moose Development/Moose/Tasking/CommandCenter.lua +++ b/Moose Development/Moose/Tasking/CommandCenter.lua @@ -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 diff --git a/Moose Development/Moose/Tasking/DetectionManager.lua b/Moose Development/Moose/Tasking/DetectionManager.lua index 6005a9ffa..d48f49f98 100644 --- a/Moose Development/Moose/Tasking/DetectionManager.lua +++ b/Moose Development/Moose/Tasking/DetectionManager.lua @@ -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. diff --git a/Moose Development/Moose/Tasking/Mission.lua b/Moose Development/Moose/Tasking/Mission.lua index b0f39072f..7ad1de610 100644 --- a/Moose Development/Moose/Tasking/Mission.lua +++ b/Moose Development/Moose/Tasking/Mission.lua @@ -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 ---- - Aborted Tasks (xp) ---- - 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 ) diff --git a/Moose Development/Moose/Tasking/Task.lua b/Moose Development/Moose/Tasking/Task.lua index 950ca6656..5a2dfd709 100644 --- a/Moose Development/Moose/Tasking/Task.lua +++ b/Moose Development/Moose/Tasking/Task.lua @@ -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() diff --git a/Moose Development/Moose/Tasking/TaskInfo.lua b/Moose Development/Moose/Tasking/TaskInfo.lua index 9c1eb7a18..408067981 100644 --- a/Moose Development/Moose/Tasking/TaskInfo.lua +++ b/Moose Development/Moose/Tasking/TaskInfo.lua @@ -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 diff --git a/Moose Development/Moose/Tasking/Task_A2A.lua b/Moose Development/Moose/Tasking/Task_A2A.lua index b9af14ef2..23d919190 100644 --- a/Moose Development/Moose/Tasking/Task_A2A.lua +++ b/Moose Development/Moose/Tasking/Task_A2A.lua @@ -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 diff --git a/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua index 52f2317aa..7eb627760 100644 --- a/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua @@ -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. diff --git a/Moose Development/Moose/Tasking/Task_A2G.lua b/Moose Development/Moose/Tasking/Task_A2G.lua index d6c8dd613..bf4a3c580 100644 --- a/Moose Development/Moose/Tasking/Task_A2G.lua +++ b/Moose Development/Moose/Tasking/Task_A2G.lua @@ -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 diff --git a/Moose Development/Moose/Tasking/Task_CARGO.lua b/Moose Development/Moose/Tasking/Task_CARGO.lua index 3c1923b3c..e18d0ee16 100644 --- a/Moose Development/Moose/Tasking/Task_CARGO.lua +++ b/Moose Development/Moose/Tasking/Task_CARGO.lua @@ -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 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 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 diff --git a/Moose Development/Moose/Tasking/Task_Capture_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_Capture_Dispatcher.lua index 87046e1ff..ee9b11983 100644 --- a/Moose Development/Moose/Tasking/Task_Capture_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_Capture_Dispatcher.lua @@ -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 diff --git a/Moose Development/Moose/Tasking/Task_Capture_Zone.lua b/Moose Development/Moose/Tasking/Task_Capture_Zone.lua index 9a7a30a9b..956b28f15 100644 --- a/Moose Development/Moose/Tasking/Task_Capture_Zone.lua +++ b/Moose Development/Moose/Tasking/Task_Capture_Zone.lua @@ -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 ) diff --git a/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua b/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua index c48c27a22..1790511cd 100644 --- a/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua +++ b/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua @@ -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 diff --git a/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua index fd3be1018..7121cd25c 100644 --- a/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua @@ -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 diff --git a/Moose Development/Moose/Tasking/Task_Cargo_Transport.lua b/Moose Development/Moose/Tasking/Task_Cargo_Transport.lua index 25bcb2c9c..c8a746ddd 100644 --- a/Moose Development/Moose/Tasking/Task_Cargo_Transport.lua +++ b/Moose Development/Moose/Tasking/Task_Cargo_Transport.lua @@ -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 diff --git a/Moose Development/Moose/Utilities/Routines.lua b/Moose Development/Moose/Utilities/Routines.lua index 8545a1dd7..e774a290f 100644 --- a/Moose Development/Moose/Utilities/Routines.lua +++ b/Moose Development/Moose/Utilities/Routines.lua @@ -54,7 +54,7 @@ routines.utils.oneLineSerialize = function( tbl ) -- serialization of a table al if type( tbl ) == 'table' then -- function only works for tables! if lookup_table[tbl] then - return lookup_table[object] + return lookup_table[tbl] end local tbl_str = {} diff --git a/Moose Development/Moose/Utilities/Utils.lua b/Moose Development/Moose/Utilities/Utils.lua index 891718da7..74307d9eb 100644 --- a/Moose Development/Moose/Utilities/Utils.lua +++ b/Moose Development/Moose/Utilities/Utils.lua @@ -13,7 +13,7 @@ -- @image MOOSE.JPG ---- @type SMOKECOLOR +-- @type SMOKECOLOR -- @field Green -- @field Red -- @field White @@ -22,7 +22,7 @@ SMOKECOLOR = trigger.smokeColor -- #SMOKECOLOR ---- @type FLARECOLOR +-- @type FLARECOLOR -- @field Green -- @field Red -- @field White diff --git a/Moose Development/Moose/Wrapper/Airbase.lua b/Moose Development/Moose/Wrapper/Airbase.lua index 66aca8d82..60c47d7e8 100644 --- a/Moose Development/Moose/Wrapper/Airbase.lua +++ b/Moose Development/Moose/Wrapper/Airbase.lua @@ -12,7 +12,7 @@ -- @image Wrapper_Airbase.JPG ---- @type AIRBASE +-- @type AIRBASE -- @field #string ClassName Name of the class, i.e. "AIRBASE". -- @field #table CategoryName Names of airbase categories. -- @field #string AirbaseName Name of the airbase. diff --git a/Moose Development/Moose/Wrapper/Client.lua b/Moose Development/Moose/Wrapper/Client.lua index 01dce4828..d53630890 100644 --- a/Moose Development/Moose/Wrapper/Client.lua +++ b/Moose Development/Moose/Wrapper/Client.lua @@ -323,7 +323,7 @@ function CLIENT:Alive( CallBackFunction, ... ) return self end ---- @param #CLIENT self +-- @param #CLIENT self function CLIENT:_AliveCheckScheduler( SchedulerName ) self:F3( { SchedulerName, self.ClientName, self.ClientAlive2, self.ClientBriefingShown, self.ClientCallBack } ) diff --git a/Moose Development/Moose/Wrapper/Controllable.lua b/Moose Development/Moose/Wrapper/Controllable.lua index ba53f6f60..f62cb0ed4 100644 --- a/Moose Development/Moose/Wrapper/Controllable.lua +++ b/Moose Development/Moose/Wrapper/Controllable.lua @@ -11,7 +11,7 @@ -- @module Wrapper.Controllable -- @image Wrapper_Controllable.JPG ---- @type CONTROLLABLE +-- @type CONTROLLABLE -- @field DCS#Controllable DCSControllable The DCS controllable class. -- @field #string ControllableName The name of the controllable. -- @extends Wrapper.Positionable#POSITIONABLE @@ -1906,7 +1906,7 @@ end -- -- GroundGroup = GROUP:FindByName( "Vehicle" ) -- --- --- @param Wrapper.Group#GROUP GroundGroup +-- -- @param Wrapper.Group#GROUP GroundGroup -- function RouteToZone( Vehicle, ZoneRoute ) -- -- local Route = {} diff --git a/Moose Development/Moose/Wrapper/Group.lua b/Moose Development/Moose/Wrapper/Group.lua index fdc6c8f1e..bb8ed9408 100644 --- a/Moose Development/Moose/Wrapper/Group.lua +++ b/Moose Development/Moose/Wrapper/Group.lua @@ -38,7 +38,7 @@ -- @image Wrapper_Group.JPG ---- @type GROUP +-- @type GROUP -- @extends Wrapper.Controllable#CONTROLLABLE -- @field #string GroupName The name of the group. @@ -91,7 +91,7 @@ -- -- Tasks[#Tasks+1] = HeliGroup:TaskFunction( "_Resume", { "''" } ) -- --- --- @param Wrapper.Group#GROUP HeliGroup +-- -- @param Wrapper.Group#GROUP HeliGroup -- function _Resume( HeliGroup ) -- env.info( '_Resume' ) -- diff --git a/Moose Development/Moose/Wrapper/Identifiable.lua b/Moose Development/Moose/Wrapper/Identifiable.lua index 1710289d7..8786807d5 100644 --- a/Moose Development/Moose/Wrapper/Identifiable.lua +++ b/Moose Development/Moose/Wrapper/Identifiable.lua @@ -11,7 +11,7 @@ -- @module Wrapper.Identifiable -- @image MOOSE.JPG ---- @type IDENTIFIABLE +-- @type IDENTIFIABLE -- @extends Wrapper.Object#OBJECT -- @field #string IdentifiableName The name of the identifiable. diff --git a/Moose Development/Moose/Wrapper/Object.lua b/Moose Development/Moose/Wrapper/Object.lua index 4488141fa..382e13f5e 100644 --- a/Moose Development/Moose/Wrapper/Object.lua +++ b/Moose Development/Moose/Wrapper/Object.lua @@ -12,7 +12,7 @@ -- @image MOOSE.JPG ---- @type OBJECT +-- @type OBJECT -- @extends Core.Base#BASE -- @field #string ObjectName The name of the Object. diff --git a/Moose Development/Moose/Wrapper/Positionable.lua b/Moose Development/Moose/Wrapper/Positionable.lua index 571e0d48c..8a951fb79 100644 --- a/Moose Development/Moose/Wrapper/Positionable.lua +++ b/Moose Development/Moose/Wrapper/Positionable.lua @@ -11,10 +11,10 @@ -- @module Wrapper.Positionable -- @image Wrapper_Positionable.JPG ---- @type POSITIONABLE.__ Methods which are not intended for mission designers, but which are used internally by the moose designer :-) +-- @type POSITIONABLE.__ Methods which are not intended for mission designers, but which are used internally by the moose designer :-) -- @extends Wrapper.Identifiable#IDENTIFIABLE ---- @type POSITIONABLE +-- @type POSITIONABLE -- @field Core.Point#COORDINATE coordinate Coordinate object. -- @field Core.Point#POINT_VEC3 pointvec3 Point Vec3 object. -- @extends Wrapper.Identifiable#IDENTIFIABLE @@ -51,10 +51,10 @@ POSITIONABLE = { pointvec3 = nil, } ---- @field #POSITIONABLE.__ +-- @field #POSITIONABLE.__ POSITIONABLE.__ = {} ---- @field #POSITIONABLE.__.Cargo +-- @field #POSITIONABLE.__.Cargo POSITIONABLE.__.Cargo = {} --- A DCSPositionable diff --git a/Moose Development/Moose/Wrapper/Static.lua b/Moose Development/Moose/Wrapper/Static.lua index 933052517..5143c698c 100644 --- a/Moose Development/Moose/Wrapper/Static.lua +++ b/Moose Development/Moose/Wrapper/Static.lua @@ -12,7 +12,7 @@ -- @image Wrapper_Static.JPG ---- @type STATIC +-- @type STATIC -- @extends Wrapper.Positionable#POSITIONABLE --- Wrapper class to handle Static objects. diff --git a/Moose Development/Moose/Wrapper/Unit.lua b/Moose Development/Moose/Wrapper/Unit.lua index cd6769fc2..98f24d5ad 100644 --- a/Moose Development/Moose/Wrapper/Unit.lua +++ b/Moose Development/Moose/Wrapper/Unit.lua @@ -21,7 +21,7 @@ -- @image Wrapper_Unit.JPG ---- @type UNIT +-- @type UNIT -- @field #string ClassName Name of the class. -- @field #string UnitName Name of the unit. -- @field #string GroupName Name of the group the unit belongs to.