From 676bc0fef064fcb65976f092f94335d638f63971 Mon Sep 17 00:00:00 2001 From: TommyC81 Date: Thu, 27 Oct 2022 20:38:59 +0400 Subject: [PATCH] Documentation fixes. (#1815) Minor documentation and code formatting fixes. This is mostly intended to have something re-trigger the documentation generation to see if the filename capitalization is resolved. --- Moose Development/Moose/AI/AI_CAP.lua | 103 +++++++++++--------------- Moose Development/Moose/Ops/ATIS.lua | 18 ++--- 2 files changed, 53 insertions(+), 68 deletions(-) diff --git a/Moose Development/Moose/AI/AI_CAP.lua b/Moose Development/Moose/AI/AI_CAP.lua index da3d52d28..f767a52cd 100644 --- a/Moose Development/Moose/AI/AI_CAP.lua +++ b/Moose Development/Moose/AI/AI_CAP.lua @@ -6,7 +6,6 @@ -- * Trigger detected events when enemy airplanes are detected. -- * Manage a fuel threshold to RTB on time. -- * Engage the enemy when detected. --- -- -- === -- @@ -19,26 +18,24 @@ -- === -- -- ### Author: **FlightControl** --- ### Contributions: +-- ### Contributions: -- -- * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing. -- * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing. -- * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision. -- * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing. --- * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing. +-- * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing. -- -- === -- -- @module AI.AI_CAP -- @image AI_Combat_Air_Patrol.JPG - --- @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 - --- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group} -- and automatically engage any airborne enemies that are within a certain range or within a certain zone. -- @@ -123,8 +120,6 @@ AI_CAP_ZONE = { ClassName = "AI_CAP_ZONE", } - - --- Creates a new AI_CAP_ZONE object -- @param #AI_CAP_ZONE self -- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed. @@ -141,7 +136,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude self.Accomplished = false self.Engaging = false - + self:AddTransition( { "Patrolling", "Engaging" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE. --- OnBefore Transition Handler for Event Engage. @@ -152,7 +147,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string Event The Event string. -- @param #string To The To State string. -- @return #boolean Return false to cancel Transition. - + --- OnAfter Transition Handler for Event Engage. -- @function [parent=#AI_CAP_ZONE] OnAfterEngage -- @param #AI_CAP_ZONE self @@ -160,11 +155,11 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string From The From State string. -- @param #string Event The Event string. -- @param #string To The To State string. - + --- Synchronous Event Trigger for Event Engage. -- @function [parent=#AI_CAP_ZONE] Engage -- @param #AI_CAP_ZONE self - + --- Asynchronous Event Trigger for Event Engage. -- @function [parent=#AI_CAP_ZONE] __Engage -- @param #AI_CAP_ZONE self @@ -188,7 +183,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string To The To State string. self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE. - + --- OnBefore Transition Handler for Event Fired. -- @function [parent=#AI_CAP_ZONE] OnBeforeFired -- @param #AI_CAP_ZONE self @@ -197,7 +192,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string Event The Event string. -- @param #string To The To State string. -- @return #boolean Return false to cancel Transition. - + --- OnAfter Transition Handler for Event Fired. -- @function [parent=#AI_CAP_ZONE] OnAfterFired -- @param #AI_CAP_ZONE self @@ -205,11 +200,11 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string From The From State string. -- @param #string Event The Event string. -- @param #string To The To State string. - + --- Synchronous Event Trigger for Event Fired. -- @function [parent=#AI_CAP_ZONE] Fired -- @param #AI_CAP_ZONE self - + --- Asynchronous Event Trigger for Event Fired. -- @function [parent=#AI_CAP_ZONE] __Fired -- @param #AI_CAP_ZONE self @@ -225,7 +220,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string Event The Event string. -- @param #string To The To State string. -- @return #boolean Return false to cancel Transition. - + --- OnAfter Transition Handler for Event Destroy. -- @function [parent=#AI_CAP_ZONE] OnAfterDestroy -- @param #AI_CAP_ZONE self @@ -233,17 +228,16 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string From The From State string. -- @param #string Event The Event string. -- @param #string To The To State string. - + --- Synchronous Event Trigger for Event Destroy. -- @function [parent=#AI_CAP_ZONE] Destroy -- @param #AI_CAP_ZONE self - + --- Asynchronous Event Trigger for Event Destroy. -- @function [parent=#AI_CAP_ZONE] __Destroy -- @param #AI_CAP_ZONE self -- @param #number Delay The delay in seconds. - self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE. --- OnBefore Transition Handler for Event Abort. @@ -254,7 +248,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string Event The Event string. -- @param #string To The To State string. -- @return #boolean Return false to cancel Transition. - + --- OnAfter Transition Handler for Event Abort. -- @function [parent=#AI_CAP_ZONE] OnAfterAbort -- @param #AI_CAP_ZONE self @@ -262,11 +256,11 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string From The From State string. -- @param #string Event The Event string. -- @param #string To The To State string. - + --- Synchronous Event Trigger for Event Abort. -- @function [parent=#AI_CAP_ZONE] Abort -- @param #AI_CAP_ZONE self - + --- Asynchronous Event Trigger for Event Abort. -- @function [parent=#AI_CAP_ZONE] __Abort -- @param #AI_CAP_ZONE self @@ -282,7 +276,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string Event The Event string. -- @param #string To The To State string. -- @return #boolean Return false to cancel Transition. - + --- OnAfter Transition Handler for Event Accomplish. -- @function [parent=#AI_CAP_ZONE] OnAfterAccomplish -- @param #AI_CAP_ZONE self @@ -290,11 +284,11 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude -- @param #string From The From State string. -- @param #string Event The Event string. -- @param #string To The To State string. - + --- Synchronous Event Trigger for Event Accomplish. -- @function [parent=#AI_CAP_ZONE] Accomplish -- @param #AI_CAP_ZONE self - + --- Asynchronous Event Trigger for Event Accomplish. -- @function [parent=#AI_CAP_ZONE] __Accomplish -- @param #AI_CAP_ZONE self @@ -303,7 +297,6 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude return self end - --- Set the Engage Zone which defines where the AI will engage bogies. -- @param #AI_CAP_ZONE self -- @param Core.Zone#ZONE EngageZone The zone where the AI is performing CAP. @@ -346,7 +339,6 @@ function AI_CAP_ZONE:onafterStart( Controllable, From, Event, To ) end - --- @param AI.AI_CAP#AI_CAP_ZONE -- @param Wrapper.Group#GROUP EngageGroup function AI_CAP_ZONE.EngageRoute( EngageGroup, Fsm ) @@ -358,8 +350,6 @@ function AI_CAP_ZONE.EngageRoute( EngageGroup, Fsm ) end end - - --- @param #AI_CAP_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. @@ -380,11 +370,11 @@ end function AI_CAP_ZONE:onafterDetected( Controllable, From, Event, To ) if From ~= "Engaging" then - + local Engage = false - + for DetectedUnit, Detected in pairs( self.DetectedUnits ) do - + local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT self:T( DetectedUnit ) if DetectedUnit:IsAlive() and DetectedUnit:IsAir() then @@ -392,7 +382,7 @@ function AI_CAP_ZONE:onafterDetected( Controllable, From, Event, To ) break end end - + if Engage == true then self:F( 'Detected -> Engaging' ) self:__Engage( 1 ) @@ -400,7 +390,6 @@ function AI_CAP_ZONE:onafterDetected( Controllable, From, Event, To ) end end - --- @param #AI_CAP_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. @@ -411,9 +400,6 @@ function AI_CAP_ZONE:onafterAbort( Controllable, From, Event, To ) self:__Route( 1 ) end - - - --- @param #AI_CAP_ZONE self -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM. -- @param #string From The From State string. @@ -427,24 +413,23 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To ) --- Calculate the current route point. local CurrentVec2 = self.Controllable:GetVec2() - + if not CurrentVec2 then return self end - + --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1). local CurrentAltitude = self.Controllable:GetAltitude() local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y ) local ToEngageZoneSpeed = self.PatrolMaxSpeed - local CurrentRoutePoint = CurrentPointVec3:WaypointAir( - self.PatrolAltType, - POINT_VEC3.RoutePointType.TurningPoint, - POINT_VEC3.RoutePointAction.TurningPoint, - ToEngageZoneSpeed, - true + local CurrentRoutePoint = CurrentPointVec3:WaypointAir( + self.PatrolAltType, + POINT_VEC3.RoutePointType.TurningPoint, + POINT_VEC3.RoutePointAction.TurningPoint, + ToEngageZoneSpeed, + true ) - + EngageRoute[#EngageRoute+1] = CurrentRoutePoint - --- Find a random 2D point in PatrolZone. local ToTargetVec2 = self.PatrolZone:GetRandomVec2() self:T2( ToTargetVec2 ) @@ -453,17 +438,17 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To ) local ToTargetAltitude = math.random( self.EngageFloorAltitude, self.EngageCeilingAltitude ) local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed ) self:T2( { self.PatrolMinSpeed, self.PatrolMaxSpeed, ToTargetSpeed } ) - + --- Obtain a 3D @{Point} from the 2D point + altitude. local ToTargetPointVec3 = POINT_VEC3:New( ToTargetVec2.x, ToTargetAltitude, ToTargetVec2.y ) - + --- Create a route point of type air. - local ToPatrolRoutePoint = ToTargetPointVec3:WaypointAir( - self.PatrolAltType, - POINT_VEC3.RoutePointType.TurningPoint, - POINT_VEC3.RoutePointAction.TurningPoint, - ToTargetSpeed, - true + local ToPatrolRoutePoint = ToTargetPointVec3:WaypointAir( + self.PatrolAltType, + POINT_VEC3.RoutePointType.TurningPoint, + POINT_VEC3.RoutePointAction.TurningPoint, + ToTargetSpeed, + true ) EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint @@ -482,7 +467,7 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To ) self:F( {"Within Zone and Engaging ", DetectedUnit } ) AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit ) end - else + else if self.EngageRange then if DetectedUnit:GetPointVec3():Get2DDistance(Controllable:GetPointVec3() ) <= self.EngageRange then self:F( {"Within Range and Engaging", DetectedUnit } ) @@ -506,12 +491,12 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To ) AttackTasks[#AttackTasks+1] = Controllable:TaskFunction( "AI_CAP_ZONE.EngageRoute", self ) EngageRoute[1].task = Controllable:TaskCombo( AttackTasks ) - + self:SetDetectionDeactivated() end - + Controllable:Route( EngageRoute, 0.5 ) - + end end diff --git a/Moose Development/Moose/Ops/ATIS.lua b/Moose Development/Moose/Ops/ATIS.lua index 0fb3a24a0..c9ae8ea41 100644 --- a/Moose Development/Moose/Ops/ATIS.lua +++ b/Moose Development/Moose/Ops/ATIS.lua @@ -122,7 +122,7 @@ -- The @{#ATIS.New}(*airbasename*, *frequency*) creates a new ATIS object. The parameter *airbasename* is the name of the airbase or airport. Note that this has to be spelled exactly as in the DCS mission editor. -- The parameter *frequency* is the frequency the ATIS broadcasts in MHz. -- --- Broadcasting is started via the @{#ATIS.Start}() function. The start can be delayed by useing @{#ATIS.__Start}(*delay*), where *delay* is the delay in seconds. +-- Broadcasting is started via the @{#ATIS.Start}() function. The start can be delayed by using @{#ATIS.__Start}(*delay*), where *delay* is the delay in seconds. -- -- ## Subtitles -- @@ -1258,16 +1258,16 @@ function ATIS:onafterStart( From, Event, To ) -- Start radio queue. if not self.useSRS then self.radioqueue = RADIOQUEUE:New( self.frequency, self.modulation, string.format( "ATIS %s", self.airbasename ) ) - + -- Send coordinate is airbase coord. self.radioqueue:SetSenderCoordinate( self.airbase:GetCoordinate() ) - + -- Set relay unit if we have one. self.radioqueue:SetSenderUnitName( self.relayunitname ) - + -- Set radio power. self.radioqueue:SetRadioPower( self.power ) - + -- Init numbers. self.radioqueue:SetDigit( 0, ATIS.Sound.N0.filename, ATIS.Sound.N0.duration, self.soundpath ) self.radioqueue:SetDigit( 1, ATIS.Sound.N1.filename, ATIS.Sound.N1.duration, self.soundpath ) @@ -1279,11 +1279,11 @@ function ATIS:onafterStart( From, Event, To ) self.radioqueue:SetDigit( 7, ATIS.Sound.N7.filename, ATIS.Sound.N7.duration, self.soundpath ) self.radioqueue:SetDigit( 8, ATIS.Sound.N8.filename, ATIS.Sound.N8.duration, self.soundpath ) self.radioqueue:SetDigit( 9, ATIS.Sound.N9.filename, ATIS.Sound.N9.duration, self.soundpath ) - + -- Start radio queue. self.radioqueue:Start( 1, 0.1 ) end - + -- Handle airbase capture -- Handle events. self:HandleEvent( EVENTS.BaseCaptured ) @@ -1397,10 +1397,10 @@ function ATIS:onafterBroadcast( From, Event, To ) qnh = Q / 100 end - + local mBarqnh = qnh local mBarqfe = qfe - + -- Convert to inHg. if self.PmmHg then qfe = UTILS.hPa2mmHg( qfe )