From 62ab859215f4047069f942fd3cc902d67bd6d5b3 Mon Sep 17 00:00:00 2001 From: FlightControl_Master Date: Tue, 29 Aug 2017 21:48:11 +0200 Subject: [PATCH] DESIGNATE can now lase for specific codes * DESIGNATE can now lase targets with specific laser codes upon request by players. Methods :AddMenuLaserCode() and :RemoveMenuLaserCode() added, which allow to set or delete specific additional menu options in the lase menu for players to lase with specific codes. This comes in handy for the SU-25T and the A-10A and other planes. --- .../Moose/Functional/Designate.lua | 114 ++++- docs/Documentation/AI_A2A_Dispatcher.html | 9 +- docs/Documentation/AI_Patrol.html | 3 - docs/Documentation/Designate.html | 478 +++++++++++++++++- docs/Documentation/Detection.html | 427 ++++++++-------- docs/Documentation/Fsm.html | 3 +- docs/Documentation/Menu.html | 100 ++++ docs/Documentation/Mission.html | 12 +- docs/Documentation/Point.html | 46 +- docs/Documentation/Positionable.html | 17 +- docs/Documentation/Scheduler.html | 20 + docs/Documentation/Set.html | 5 + docs/Documentation/Settings.html | 293 +++++------ docs/Documentation/Spawn.html | 32 +- docs/Documentation/SpawnStatic.html | 1 + docs/Documentation/Spot.html | 4 - docs/Documentation/Task.html | 89 +++- docs/Documentation/Task_A2A.html | 57 +++ docs/Documentation/Task_A2A_Dispatcher.html | 27 + docs/Documentation/Task_A2G_Dispatcher.html | 27 + docs/Documentation/Task_Cargo.html | 4 +- docs/Documentation/Zone.html | 39 ++ 22 files changed, 1345 insertions(+), 462 deletions(-) diff --git a/Moose Development/Moose/Functional/Designate.lua b/Moose Development/Moose/Functional/Designate.lua index 13fdabfd7..78758e763 100644 --- a/Moose Development/Moose/Functional/Designate.lua +++ b/Moose Development/Moose/Functional/Designate.lua @@ -133,7 +133,7 @@ do -- DESIGNATE -- -- ## 4. Laser codes -- - -- ### 4.1 Set possible laser codes + -- ### 4.1. Set possible laser codes -- -- An array of laser codes can be provided, that will be used by the DESIGNATE when lasing. -- The laser code is communicated by the Recce when it is lasing a larget. @@ -151,10 +151,19 @@ do -- DESIGNATE -- -- The above sets a collection of possible laser codes that can be assigned. **Note the { } notation!** -- - -- ### 4.2 Auto generate laser codes + -- ### 4.2. Auto generate laser codes -- -- Use the method @{#DESIGNATE.GenerateLaserCodes}() to generate all possible laser codes. Logic implemented and advised by Ciribob! -- + -- ### 4.3. Add specific lase codes to the lase menu + -- + -- Certain plane types can only drop laser guided ordonnance when targets are lased with specific laser codes. + -- The SU-25T needs targets to be lased using laser code 1113. + -- The A-10A needs targets to be lased using laser code 1680. + -- + -- The method @{#DESIGNATE.AddMenuLaserCode}() to allow a player to lase a target using a specific laser code. + -- Remove such a lase menu option using @{#DESIGNATE.RemoveMenuLaserCode}(). + -- -- ## 5. Autolase to automatically lase detected targets. -- -- DetectionItems can be auto lased once detected by Recces. As such, there is almost no action required from the Players using the Designate Menu. @@ -396,6 +405,8 @@ do -- DESIGNATE self.LaserCodesUsed = {} + self.MenuLaserCodes = {} -- This map contains the laser codes that will be shown in the designate menu to lase with specific laser codes. + self.Detection:__Start( 2 ) self:__Detect( -15 ) @@ -491,6 +502,43 @@ do -- DESIGNATE end + --- Add a specific lase code to the designate lase menu to lase targets with a specific laser code. + -- The MenuText will appear in the lase menu. + -- @param #DESIGNATE self + -- @param #number LaserCode The specific laser code to be added to the lase menu. + -- @param #string MenuText The text to be shown to the player. If you specify a %d in the MenuText, the %d will be replaced with the LaserCode specified. + -- @return #DESIGNATE + -- @usage + -- RecceDesignation:AddMenuLaserCode( 1113, "Lase with %d for Su-25T" ) + -- RecceDesignation:AddMenuLaserCode( 1680, "Lase with %d for A-10A" ) + -- + function DESIGNATE:AddMenuLaserCode( LaserCode, MenuText ) + + self.MenuLaserCodes[LaserCode] = MenuText + self:SetDesignateMenu() + + return self + end + + + --- Removes a specific lase code from the designate lase menu. + -- @param #DESIGNATE self + -- @param #number LaserCode The specific laser code that was set to be added to the lase menu. + -- @return #DESIGNATE + -- @usage + -- RecceDesignation:RemoveMenuLaserCode( 1113 ) + -- + function DESIGNATE:RemoveMenuLaserCode( LaserCode ) + + self.MenuLaserCodes[LaserCode] = nil + self:SetDesignateMenu() + + return self + end + + + + --- Set the name of the designation. The name will appear in the menu. -- This method can be used to control different designations for different plane types. -- @param #DESIGNATE self @@ -811,8 +859,10 @@ do -- DESIGNATE MenuText = "(-) " .. MenuText local DetectedMenu = MENU_GROUP:New( AttackGroup, MenuText, MenuDesignate ):SetTime( MenuTime ):SetTag( self.DesignateName ) MENU_GROUP_COMMAND:New( AttackGroup, "Search other target", DetectedMenu, self.MenuForget, self, DesignateIndex ):SetTime( MenuTime ):SetTag( self.DesignateName ) - MENU_GROUP_COMMAND:New( AttackGroup, "Lase target 60 secs", DetectedMenu, self.MenuLaseOn, self, DesignateIndex, 60 ):SetTime( MenuTime ):SetTag( self.DesignateName ) - MENU_GROUP_COMMAND:New( AttackGroup, "Lase target 120 secs", DetectedMenu, self.MenuLaseOn, self, DesignateIndex, 120 ):SetTime( MenuTime ):SetTag( self.DesignateName ) + for LaserCode, MenuText in pairs( self.MenuLaserCodes ) do + MENU_GROUP_COMMAND:New( AttackGroup, string.format( MenuText, LaserCode ), DetectedMenu, self.MenuLaseCode, self, DesignateIndex, 60, LaserCode ):SetTime( MenuTime ):SetTag( self.DesignateName ) + end + MENU_GROUP_COMMAND:New( AttackGroup, "Lase targets", DetectedMenu, self.MenuLaseOn, self, DesignateIndex, 60 ):SetTime( MenuTime ):SetTag( self.DesignateName ) MENU_GROUP_COMMAND:New( AttackGroup, "Smoke red", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Red ):SetTime( MenuTime ):SetTag( self.DesignateName ) MENU_GROUP_COMMAND:New( AttackGroup, "Smoke blue", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Blue ):SetTime( MenuTime ):SetTag( self.DesignateName ) MENU_GROUP_COMMAND:New( AttackGroup, "Smoke green", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Green ):SetTime( MenuTime ):SetTag( self.DesignateName ) @@ -912,6 +962,18 @@ do -- DESIGNATE self:SetDesignateMenu() end + + --- + -- @param #DESIGNATE self + function DESIGNATE:MenuLaseCode( Index, Duration, LaserCode ) + + self:E( "Designate through Lase using " .. LaserCode ) + + self:__LaseOn( 1, Index, Duration, LaserCode ) + self:SetDesignateMenu() + end + + --- -- @param #DESIGNATE self function DESIGNATE:MenuLaseOff( Index, Duration ) @@ -925,21 +987,22 @@ do -- DESIGNATE --- -- @param #DESIGNATE self - function DESIGNATE:onafterLaseOn( From, Event, To, Index, Duration ) + function DESIGNATE:onafterLaseOn( From, Event, To, Index, Duration, LaserCode ) self.Designating[Index] = "Laser" - self:__Lasing( -1, Index, Duration ) + self:__Lasing( -1, Index, Duration, LaserCode ) end --- -- @param #DESIGNATE self -- @return #DESIGNATE - function DESIGNATE:onafterLasing( From, Event, To, Index, Duration ) + function DESIGNATE:onafterLasing( From, Event, To, Index, Duration, LaserCodeRequested ) + local TargetSetUnit = self.Detection:GetDetectedSet( Index ) - local MarkedCount = 0 + local MarkingCount = 0 local MarkedTypes = {} local ReportTypes = REPORT:New() local ReportLaserCodes = REPORT:New() @@ -951,12 +1014,30 @@ do -- DESIGNATE local Recce = RecceData -- Wrapper.Unit#UNIT self:F( { TargetUnit = TargetUnit, Recce = Recce:GetName() } ) if not Recce:IsLasing() then - local LaserCode = Recce:GetLaserCode() --(Not deleted when stopping with lasing). + local LaserCode = Recce:GetLaserCode() -- (Not deleted when stopping with lasing). self:F( { ClearingLaserCode = LaserCode } ) self.LaserCodesUsed[LaserCode] = nil self.Recces[TargetUnit] = nil end end + + -- If a specific lasercode is requested, we disable one active lase! + if LaserCodeRequested then + for TargetUnit, RecceData in pairs( self.Recces ) do -- We break after the first has been processed. + local Recce = RecceData -- Wrapper.Unit#UNIT + self:F( { TargetUnit = TargetUnit, Recce = Recce:GetName() } ) + if Recce:IsLasing() then + -- When a Recce is lasing, we switch the lasing off, and clear the references to the lasing in the DESIGNATE class. + Recce:LaseOff() -- Switch off the lasing. + local LaserCode = Recce:GetLaserCode() -- (Not deleted when stopping with lasing). + self:F( { ClearingLaserCode = LaserCode } ) + self.LaserCodesUsed[LaserCode] = nil + self.Recces[TargetUnit] = nil + break + end + end + end + TargetSetUnit:ForEachUnitPerThreatLevel( 10, 0, --- @param Wrapper.Unit#UNIT SmokeUnit @@ -964,7 +1045,7 @@ do -- DESIGNATE self:F( { TargetUnit = TargetUnit:GetName() } ) - if MarkedCount < self.MaximumMarkings then + if MarkingCount < self.MaximumMarkings then if TargetUnit:IsAlive() then @@ -991,6 +1072,11 @@ do -- DESIGNATE local LaserCode = self.LaserCodes[LaserCodeIndex] --self:F( { LaserCode = LaserCode, LaserCodeUsed = self.LaserCodesUsed[LaserCode] } ) + if LaserCodeRequested and LaserCodeRequested ~= LaserCode then + LaserCode = LaserCodeRequested + LaserCodeRequested = nil + end + if not self.LaserCodesUsed[LaserCode] then self.LaserCodesUsed[LaserCode] = LaserCodeIndex @@ -1005,7 +1091,7 @@ do -- DESIGNATE self.Recces[TargetUnit] = RecceUnit RecceUnit:MessageToSetGroup( "Marking " .. TargetUnit:GetTypeName() .. " with laser " .. RecceUnit:GetSpot().LaserCode .. " for " .. Duration .. "s.", 5, self.AttackSet, self.DesignateName ) -- OK. We have assigned for the Recce a TargetUnit. We can exit the function. - MarkedCount = MarkedCount + 1 + MarkingCount = MarkingCount + 1 local TargetUnitType = TargetUnit:GetTypeName() if not MarkedTypes[TargetUnitType] then MarkedTypes[TargetUnitType] = true @@ -1029,7 +1115,7 @@ do -- DESIGNATE Recce:MessageToSetGroup( "Target " .. TargetUnit:GetTypeName() "out of LOS. Cancelling lase!", 5, self.AttackSet, self.DesignateName ) end else - MarkedCount = MarkedCount + 1 + MarkingCount = MarkingCount + 1 local TargetUnitType = TargetUnit:GetTypeName() if not MarkedTypes[TargetUnitType] then MarkedTypes[TargetUnitType] = true @@ -1041,7 +1127,7 @@ do -- DESIGNATE end end else - MarkedCount = MarkedCount + 1 + MarkingCount = MarkingCount + 1 local TargetUnitType = TargetUnit:GetTypeName() if not MarkedTypes[TargetUnitType] then MarkedTypes[TargetUnitType] = true @@ -1058,7 +1144,7 @@ do -- DESIGNATE local MarkedTypesText = ReportTypes:Text(', ') local MarkedLaserCodesText = ReportLaserCodes:Text(', ') for MarkedType, MarketCount in pairs( MarkedTypes ) do - self.CC:GetPositionable():MessageToSetGroup( "Marking " .. MarkedCount .. " x " .. MarkedTypesText .. " with lasers " .. MarkedLaserCodesText .. ".", 5, self.AttackSet, self.DesignateName ) + self.CC:GetPositionable():MessageToSetGroup( "Marking " .. MarkingCount .. " x " .. MarkedTypesText .. " with lasers " .. MarkedLaserCodesText .. ".", 5, self.AttackSet, self.DesignateName ) end self:__Lasing( -30, Index, Duration ) diff --git a/docs/Documentation/AI_A2A_Dispatcher.html b/docs/Documentation/AI_A2A_Dispatcher.html index 14b161be1..a44b0d577 100644 --- a/docs/Documentation/AI_A2A_Dispatcher.html +++ b/docs/Documentation/AI_A2A_Dispatcher.html @@ -713,7 +713,7 @@ Per one, two, three, four?

- AI_A2A_DISPATCHER:SetDefenderTask(Defender, Type, Fsm, Target) + AI_A2A_DISPATCHER:SetDefenderTask(SquadronName, Defender, Type, Fsm, Target) @@ -3895,7 +3895,7 @@ A string defining the group name of the Tanker as defined within the Mission Edi
-AI_A2A_DISPATCHER:SetDefenderTask(Defender, Type, Fsm, Target) +AI_A2A_DISPATCHER:SetDefenderTask(SquadronName, Defender, Type, Fsm, Target)
@@ -3906,6 +3906,11 @@ A string defining the group name of the Tanker as defined within the Mission Edi
diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index a076cec3d..31210aea8 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -164,6 +164,12 @@ each detected set of potential targets can be lased or smoked...

Type DESIGNATE

+ + + + + + + + @@ -257,12 +269,42 @@ each detected set of potential targets can be lased or smoked...

+ + + + + + + + + + + + + + + + + + + + @@ -293,6 +335,12 @@ each detected set of potential targets can be lased or smoked...

+ + + + @@ -305,6 +353,12 @@ each detected set of potential targets can be lased or smoked...

+ + + + @@ -413,6 +467,12 @@ each detected set of potential targets can be lased or smoked...

+ + + + @@ -422,7 +482,7 @@ each detected set of potential targets can be lased or smoked...

- + @@ -431,6 +491,12 @@ each detected set of potential targets can be lased or smoked...

+ + + + @@ -449,6 +515,30 @@ each detected set of potential targets can be lased or smoked...

+ + + + + + + + + + + + + + + + @@ -542,13 +632,13 @@ each detected set of potential targets can be lased or smoked...

- + - + @@ -685,7 +775,7 @@ Using the menu system, the player can "forget" a designation, so that gradually

4. Laser codes

-

4.1 Set possible laser codes

+

4.1. Set possible laser codes

An array of laser codes can be provided, that will be used by the DESIGNATE when lasing. The laser code is communicated by the Recce when it is lasing a larget. @@ -705,10 +795,19 @@ One laser code can be given or an sequence of laser codes through an table...

The above sets a collection of possible laser codes that can be assigned. Note the { } notation!

-

4.2 Auto generate laser codes

+

4.2. Auto generate laser codes

Use the method DESIGNATE.GenerateLaserCodes() to generate all possible laser codes. Logic implemented and advised by Ciribob!

+

4.3. Add specific lase codes to the lase menu

+ +

Certain plane types can only drop laser guided ordonnance when targets are lased with specific laser codes. +The SU-25T needs targets to be lased using laser code 1113. +The A-10A needs targets to be lased using laser code 1680.

+ +

The method DESIGNATE.AddMenuLaserCode() to allow a player to lase a target using a specific laser code. +Remove such a lase menu option using DESIGNATE.RemoveMenuLaserCode().

+

5. Autolase to automatically lase detected targets.

DetectionItems can be auto lased once detected by Recces. As such, there is almost no action required from the Players using the Designate Menu. @@ -766,6 +865,47 @@ Use the method DESIGNATE.SetMission() to

+ +DESIGNATE:AddMenuLaserCode(LaserCode, MenuText) + +
+
+ +

Add a specific lase code to the designate lase menu to lase targets with a specific laser code.

+ + +

The MenuText will appear in the lase menu.

+ +

Parameters

+
    +
  • + +

    #number LaserCode : +The specific laser code to be added to the lase menu.

    + +
    • +
  • + +

    #string MenuText : +The text to be shown to the player. If you specify a %d in the MenuText, the %d will be replaced with the LaserCode specified.

    + +
    • +
+

Return value

+ +

#DESIGNATE:

+ + +

Usage:

+ 
  RecceDesignation:AddMenuLaserCode( 1113, "Lase with %d for Su-25T" )
+  RecceDesignation:AddMenuLaserCode( 1680, "Lase with %d for A-10A" )
+
+ +
+
+
+
+ DESIGNATE.AttackSet @@ -780,7 +920,6 @@ Use the method DESIGNATE.SetMission() to
- DESIGNATE.AutoLase @@ -821,6 +960,19 @@ Use the method DESIGNATE.SetMission() to

#DESIGNATE:

+ +
+
+
+ + +DESIGNATE.DesignateName + +
+
+ + +
@@ -1000,6 +1152,20 @@ function below will use the range 1-7 just in case

+ +
+
+
+ + + +DESIGNATE.MarkScheduler + +
+
+ + +
@@ -1014,6 +1180,62 @@ function below will use the range 1-7 just in case

+ +
+
+
+ + + +DESIGNATE.MaximumDistanceAirDesignation + +
+
+ + + +
+
+
+
+ + + +DESIGNATE.MaximumDistanceDesignations + +
+
+ + + +
+
+
+
+ + + +DESIGNATE.MaximumDistanceGroundDesignation + +
+
+ + + +
+
+
+
+ + + +DESIGNATE.MaximumMarkings + +
+
+ + +
@@ -1121,6 +1343,37 @@ function below will use the range 1-7 just in case

+ +DESIGNATE:MenuLaseCode(Index, Duration, LaserCode) + +
+
+ + + +

Parameters

+
    +
  • + +

    Index :

    + +
    • +
  • + +

    Duration :

    + +
    • +
  • + +

    LaserCode :

    + +
    • +
+
+
+
+
+ DESIGNATE:MenuLaseOff(Index, Duration) @@ -1168,6 +1421,23 @@ function below will use the range 1-7 just in case

+ +
+
+
+ + + +DESIGNATE.MenuLaserCodes + +
+
+ + + + +

This map contains the laser codes that will be shown in the designate menu to lase with specific laser codes.

+
@@ -1710,6 +1980,37 @@ The Attack collection of GROUP objects to designate and report for.

+ +
+
+
+ + +DESIGNATE:RemoveMenuLaserCode(LaserCode) + +
+
+ +

Removes a specific lase code from the designate lase menu.

+ +

Parameter

+
    +
  • + +

    #number LaserCode : +The specific laser code that was set to be added to the lase menu.

    + +
    • +
+

Return value

+ +

#DESIGNATE:

+ + +

Usage:

+ 
  RecceDesignation:RemoveMenuLaserCode( 1113 )
+
+
@@ -1753,7 +2054,7 @@ The time in seconds the report should be visible.

-DESIGNATE:SetAutoLase(AutoLase) +DESIGNATE:SetAutoLase(AutoLase, Message)
@@ -1763,11 +2064,18 @@ The time in seconds the report should be visible.

Auto lase will start lasing targets immediately when these are in range.

-

Parameter

+

Parameters

  • -

    #boolean AutoLase :

    +

    #boolean AutoLase : +(optional) true sets autolase on, false off. Default is off.

    + +
    • +
  • + +

    #boolean Message : +(optional) true is send message, false or nil won't send a message. Default is no message sent.

@@ -1794,6 +2102,36 @@ The time in seconds the report should be visible.

#DESIGNATE:

+
+
+
+
+ + +DESIGNATE:SetDesignateName(DesignateName) + +
+
+ +

Set the name of the designation.

+ + +

The name will appear in the menu. +This method can be used to control different designations for different plane types.

+ +

Parameter

+
    +
  • + +

    #string DesignateName :

    + +
    • +
+

Return value

+ +

#DESIGNATE:

+ +
@@ -1882,6 +2220,114 @@ number> LaserCodes

#DESIGNATE:

+ +
+
+
+ + +DESIGNATE:SetMaximumDistanceAirDesignation(MaximumDistanceAirDesignation) + +
+
+ +

Set the maximum air designation distance.

+ +

Parameter

+
    +
  • + +

    #number MaximumDistanceAirDesignation : +Maximum air designation distance in meters.

    + +
    • +
+

Return value

+ +

#DESIGNATE:

+ + +
+
+
+
+ + +DESIGNATE:SetMaximumDistanceDesignations(MaximumDistanceDesignations) + +
+
+ +

Set the overall maximum distance when designations can be accepted.

+ +

Parameter

+
    +
  • + +

    #number MaximumDistanceDesignations : +Maximum distance in meters to accept designations.

    + +
    • +
+

Return value

+ +

#DESIGNATE:

+ + +
+
+
+
+ + +DESIGNATE:SetMaximumDistanceGroundDesignation(MaximumDistanceGroundDesignation) + +
+
+ +

Set the maximum ground designation distance.

+ +

Parameter

+
    +
  • + +

    #number MaximumDistanceGroundDesignation : +Maximum ground designation distance in meters.

    + +
    • +
+

Return value

+ +

#DESIGNATE:

+ + +
+
+
+
+ + +DESIGNATE:SetMaximumMarkings(MaximumMarkings) + +
+
+ +

Set the maximum amount of markings FACs will do, per designated target group.

+ +

Parameter

+
    +
  • + +

    #number MaximumMarkings : +Maximum markings FACs will do, per designated target group.

    + +
    • +
+

Return value

+ +

#DESIGNATE:

+ +
@@ -2251,7 +2697,7 @@ The MISSION object.

-DESIGNATE:onafterLaseOn(From, Event, To, Index, Duration) +DESIGNATE:onafterLaseOn(From, Event, To, Index, Duration, LaserCode)
@@ -2284,6 +2730,11 @@ The MISSION object.

Duration :

+ +
  • + +

    LaserCode :

    +
    • @@ -2292,7 +2743,7 @@ The MISSION object.

    -DESIGNATE:onafterLasing(From, Event, To, Index, Duration) +DESIGNATE:onafterLasing(From, Event, To, Index, Duration, LaserCodeRequested)
    @@ -2325,6 +2776,11 @@ The MISSION object.

    Duration :

    + +
  • + +

    LaserCodeRequested :

    +

    • Return value

    diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index a73a97f0a..00b524902 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -190,12 +190,6 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu
    - - - - @@ -262,18 +256,6 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu - - - - - - - - @@ -583,6 +565,12 @@ The different values of Unit.Category can be:

    + + + + @@ -613,6 +601,12 @@ The different values of Unit.Category can be:

    + + + + @@ -643,12 +637,6 @@ The different values of Unit.Category can be:

    - - - - @@ -865,6 +853,18 @@ The different values of Unit.Category can be:

    + + + + + + + + @@ -995,6 +995,18 @@ The different values of Unit.Category can be:

    + + + + + + + + @@ -1013,12 +1025,6 @@ The different values of Unit.Category can be:

    - - - - @@ -1031,6 +1037,12 @@ The different values of Unit.Category can be:

    + + + + @@ -1147,12 +1159,6 @@ The different values of Unit.Category can be:

    - - - - @@ -1235,12 +1241,6 @@ The different values of Unit.Category can be:

    - - - - @@ -1571,8 +1571,6 @@ a DetectedItem. The default range is 6000 meters. For air detections, it is advi

    Type Detection

    -

    Type Core.Point

    -

    Type DETECTION_AREAS

    # 4) DETECTION_AREAS class, extends Detection#DETECTION_BASE

    @@ -1646,27 +1644,6 @@ self

    - - -
    -
    - - -DETECTION_AREAS:CalculateThreatLevelA2G(DetectedItem) - -
    -
    - -

    Calculate the maxium A2G threat level of the DetectedItem.

    - -

    Parameter

    -
    +
    +
    +
    + + +DETECTION_BASE:SetDetectedItemCoordinate(The, Coordinate, DetectedItemUnit, DetectedItem) + +
    +
    + +

    Set the detected item coordinate.

    + +

    Parameters

    + +

    Return value

    + +

    #DETECTION_BASE:

    + + +
    +
    +
    +
    + + +DETECTION_BASE:SetDetectedItemThreatLevel(The, DetectedItem) + +
    +
    + +

    Set the detected item threatlevel.

    + +

    Parameters

    + +

    Return value

    + +

    #DETECTION_BASE:

    + +
    @@ -4775,6 +4798,34 @@ The To State string.

    A list of the changes reported on the detected area. (It is up to the user of the detected area to consume those changes).

    + +
    +
    +
    + + Core.Point#COORDINATE + +DETECTION_BASE.DetectedItem.Coordinate + +
    +
    + +

    The last known coordinate of the DetectedItem.

    + +
    +
    +
    +
    + + + +DETECTION_BASE.DetectedItem.DistanceRecce + +
    +
    + + +
    @@ -4817,20 +4868,6 @@ The To State string.

    - -
    -
    -
    - - - -DETECTION_BASE.DetectedItem.MaxThreatLevelA2G - -
    -
    - - -
    @@ -4859,6 +4896,20 @@ The To State string.

    -- The Set of Units in the detected area.

    + +
    +
    +
    + + + +DETECTION_BASE.DetectedItem.ThreatLevel + +
    +
    + + +
    @@ -5219,32 +5270,6 @@ The Changes text

    - -DETECTION_TYPES:GetDetectedItemCoordinate(DetectedTypeName) - -
    -
    - -

    Get the detected item coordinate.

    - -

    Parameter

    -
      -
    • - -

      DetectedTypeName :

      - -
      • -
    -

    Return value

    - -

    #Core.Point: -COORDINATE

    - -
    -
    -
    -
    - DETECTION_TYPES:New(DetectionSetGroup) @@ -5523,32 +5548,6 @@ The group to generate the report for.

    #string: The Changes text

    - -
    -
    -
    - - -DETECTION_UNITS:GetDetectedItemCoordinate(Index) - -
    -
    - -

    Get the detected item coordinate.

    - -

    Parameter

    -
      -
    • - -

      Index :

      - -
      • -
    -

    Return value

    - -

    Core.Point#COORDINATE:

    - -
    diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index e0276d335..177f34281 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -1598,7 +1598,7 @@ A string defining the start state.

    - + #string FSM._StartState @@ -1897,7 +1897,6 @@ A string defining the start state.

    - FSM.current diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html index 3fab176c6..edded7fd7 100644 --- a/docs/Documentation/Menu.html +++ b/docs/Documentation/Menu.html @@ -194,6 +194,7 @@ On top, MOOSE implements variable parameter passing for command

    The MENUCOMMANDBASE class defines the main MENU class where other MENU COMMAND_ classes are derived from, in order to set commands.

    +
    @@ -369,6 +370,24 @@ classes are derived from, in order to set commands.

    + + + + + + + +
    DESIGNATE:AddMenuLaserCode(LaserCode, MenuText) +

    Add a specific lase code to the designate lase menu to lase targets with a specific laser code.

    +
    DESIGNATE.AttackSet @@ -185,6 +191,12 @@ each detected set of potential targets can be lased or smoked...

    		DESIGNATE:CoordinateLase()

    Coordinates the Auto Lase.

    +
    DESIGNATE.DesignateName +
    DESIGNATE.LaserCodesUsed +
    DESIGNATE.MarkScheduler +
    DESIGNATE.MaximumDesignations +
    DESIGNATE.MaximumDistanceAirDesignation + +
    DESIGNATE.MaximumDistanceDesignations + +
    DESIGNATE.MaximumDistanceGroundDesignation + +
    DESIGNATE.MaximumMarkings +
    DESIGNATE:MenuIlluminate(Index) +
    DESIGNATE:MenuLaseCode(Index, Duration, LaserCode) +
    DESIGNATE:MenuLaseOn(Index, Duration) +
    DESIGNATE.MenuLaserCodes +
    DESIGNATE.Recces +
    DESIGNATE:RemoveMenuLaserCode(LaserCode) +

    Removes a specific lase code from the designate lase menu.
    DESIGNATE:SetAutoLase(AutoLase)DESIGNATE:SetAutoLase(AutoLase, Message)

    Set auto lase.

    		 DESIGNATE:SetDesignateMenu()

    Sets the Designate Menu.

    +
    DESIGNATE:SetDesignateName(DesignateName) +

    Set the name of the designation.
    DESIGNATE:SetMaximumDesignations(MaximumDesignations)

    Set the maximum amount of designations.

    +
    DESIGNATE:SetMaximumDistanceAirDesignation(MaximumDistanceAirDesignation) +

    Set the maximum air designation distance.

    +
    DESIGNATE:SetMaximumDistanceDesignations(MaximumDistanceDesignations) +

    Set the overall maximum distance when designations can be accepted.

    +
    DESIGNATE:SetMaximumDistanceGroundDesignation(MaximumDistanceGroundDesignation) +

    Set the maximum ground designation distance.

    +
    DESIGNATE:SetMaximumMarkings(MaximumMarkings) +

    Set the maximum amount of markings FACs will do, per designated target group.
    DESIGNATE:onafterLaseOn(From, Event, To, Index, Duration)DESIGNATE:onafterLaseOn(From, Event, To, Index, Duration, LaserCode)
    DESIGNATE:onafterLasing(From, Event, To, Index, Duration)DESIGNATE:onafterLasing(From, Event, To, Index, Duration, LaserCodeRequested) DETECTION_AREAS:CalculateIntercept(DetectedItem)

    Calculate the optimal intercept point of the DetectedItem.

    -
    DETECTION_AREAS:CalculateThreatLevelA2G(DetectedItem) -

    Calculate the maxium A2G threat level of the DetectedItem.
    DETECTION_AREAS:GetChangeText(DetectedItem)

    Make text documenting the changes of the detected zone.

    -
    DETECTION_AREAS:GetDetectedItemCoordinate(Index) -

    Get the detected item coordinate.

    -
    DETECTION_AREAS:GetTreatLevelA2G(DetectedItem) -

    Returns the A2G threat level of the units in the DetectedItem
    DETECTION_BASE:GetDetectedItemID(Index)

    Get a detected ItemID using a given numeric index.

    +
    DETECTION_BASE:GetDetectedItemThreatLevel(Index) +

    Get the detected item coordinate.
    DETECTION_BASE:GetDetectedSet(Index)

    Get the Set#SET_UNIT of a detecttion area using a given numeric index.

    +
    DETECTION_BASE:GetDetectedUnitTypeName(DetectedUnit) +

    Gets a detected unit type name, taking into account the detection results.
    DETECTION_BASE:GetPlayersNearBy(DetectedItem)

    Returns friendly units nearby the FAC units ...

    -
    DETECTION_BASE:HasDetectedItemLOS(Index) -

    Has the detected item LOS (Line Of Sight) with one of the Recce?
    DETECTION_BASE:SetAlphaAngleProbability(AlphaAngleProbability)

    Upon a visual detection, the higher the unit is during the detecting process, the more likely the detected unit is to be detected properly.

    +
    DETECTION_BASE:SetDetectedItemCoordinate(The, Coordinate, DetectedItemUnit, DetectedItem) +

    Set the detected item coordinate.

    +
    DETECTION_BASE:SetDetectedItemThreatLevel(The, DetectedItem) +

    Set the detected item threatlevel.
    DETECTION_BASE.DetectedItem.Changes

    A list of the changes reported on the detected area. (It is up to the user of the detected area to consume those changes).

    +
    DETECTION_BASE.DetectedItem.Coordinate +

    The last known coordinate of the DetectedItem.

    +
    DETECTION_BASE.DetectedItem.DistanceRecce +
    DETECTION_BASE.DetectedItem.InterceptCoord -
    DETECTION_BASE.DetectedItem.MaxThreatLevelA2G -
    DETECTION_BASE.DetectedItem.Set

    -- The Set of Units in the detected area.

    +
    DETECTION_BASE.DetectedItem.ThreatLevel +
    DETECTION_TYPES:GetChangeText(DetectedItem)

    Make text documenting the changes of the detected zone.

    -
    DETECTION_TYPES:GetDetectedItemCoordinate(DetectedTypeName) -

    Get the detected item coordinate.
    DETECTION_UNITS:GetChangeText(DetectedItem)

    Make text documenting the changes of the detected zone.

    -
    DETECTION_UNITS:GetDetectedItemCoordinate(Index) -

    Get the detected item coordinate.
    MENU_COMMAND_BASE.New(#, self, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)

    Constructor

    +
    MENU_COMMAND_BASE.SetCommandMenuArguments(#, self, CommandMenuArguments) +

    This sets the new command arguments of a menu, +so that if a menu is regenerated, or if command arguments change, +that the arguments set for the menu are loosely coupled with the menu itself!!! +If the arguments change, no new menu needs to be generated if the menu text is the same!!!

    +
    MENU_COMMAND_BASE.SetCommandMenuFunction(#, self, CommandMenuFunction) +

    This sets the new command function of a menu, +so that if a menu is regenerated, or if command function changes, +that the function set for the menu is loosely coupled with the menu itself!!! +If the function changes, no new menu needs to be generated if the menu text is the same!!!
    @@ -729,6 +748,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde

    The MENUCOMMANDBASE class defines the main MENU class where other MENU COMMAND_ classes are derived from, in order to set commands.

    +
    @@ -1452,6 +1472,86 @@ ENUCOMMANDBASE

    #MENUCOMMANDBASE:

    + +
    +
    +
    + + +MENU_COMMAND_BASE.SetCommandMenuArguments(#, self, CommandMenuArguments) + +
    +
    + +

    This sets the new command arguments of a menu, +so that if a menu is regenerated, or if command arguments change, +that the arguments set for the menu are loosely coupled with the menu itself!!! +If the arguments change, no new menu needs to be generated if the menu text is the same!!!

    + +

    Parameters

    +
      +
    • + +

      # : +ENUCOMMANDBASE

      + +
      • +
    • + +

      self :

      + +
      • +
    • + +

      CommandMenuArguments :

      + +
      • +
    +

    Return value

    + +

    #MENUCOMMANDBASE:

    + + +
    +
    +
    +
    + + +MENU_COMMAND_BASE.SetCommandMenuFunction(#, self, CommandMenuFunction) + +
    +
    + +

    This sets the new command function of a menu, +so that if a menu is regenerated, or if command function changes, +that the function set for the menu is loosely coupled with the menu itself!!! +If the function changes, no new menu needs to be generated if the menu text is the same!!!

    + +

    Parameters

    +
      +
    • + +

      # : +ENUCOMMANDBASE

      + +
      • +
    • + +

      self :

      + +
      • +
    • + +

      CommandMenuFunction :

      + +
      • +
    +

    Return value

    + +

    #MENUCOMMANDBASE:

    + +
    diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html index c0f6adf18..ce693c0a0 100644 --- a/docs/Documentation/Mission.html +++ b/docs/Documentation/Mission.html @@ -544,7 +544,7 @@ - MISSION:ReportSummary() + MISSION:ReportSummary(ReportGroup)

    Create a summary report of the Mission (one line).

    @@ -2489,13 +2489,21 @@ self

    -MISSION:ReportSummary() +MISSION:ReportSummary(ReportGroup)

    Create a summary report of the Mission (one line).

    +

    Parameter

    +

    Return value

    #string:

    diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index 90f96d0c2..22a8976b5 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -416,9 +416,15 @@ - COORDINATE:ToStringLL(Settings) + COORDINATE:ToStringLLDDM(Settings) -

    Provides a Lat Lon string

    +

    Provides a Lat Lon string in Degree Decimal Minute format.

    + + + + COORDINATE:ToStringLLDMS(Settings) + +

    Provides a Lat Lon string in Degree Minute Second format.

    @@ -2111,13 +2117,13 @@ The coordinate Text in the configured coordinate system.

    - -COORDINATE:ToStringLL(Settings) + +COORDINATE:ToStringLLDDM(Settings)
    -

    Provides a Lat Lon string

    +

    Provides a Lat Lon string in Degree Decimal Minute format.

    Parameter

      @@ -2131,7 +2137,34 @@ The coordinate Text in the configured coordinate system.

      Return value

      #string: -The LL Text

      +The LL DDM Text

      + +
    +
    +
    +
    + + +COORDINATE:ToStringLLDMS(Settings) + +
    +
    + +

    Provides a Lat Lon string in Degree Minute Second format.

    + +

    Parameter

    + +

    Return value

    + +

    #string: +The LL DMS Text

    @@ -2829,7 +2862,6 @@ The y coordinate.

    - POINT_VEC2.z diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index 27939a7dd..f5b1c4a9e 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -416,7 +416,7 @@ - POSITIONABLE:Smoke(SmokeColor, Range) + POSITIONABLE:Smoke(SmokeColor, Range, AddHeight)

    Smoke the POSITIONABLE.

    @@ -1738,7 +1738,7 @@ self

    -POSITIONABLE:Smoke(SmokeColor, Range) +POSITIONABLE:Smoke(SmokeColor, Range, AddHeight)
    @@ -1749,12 +1749,20 @@ self

    • -

      SmokeColor :

      +

      Utilities.Utils#SMOKECOLOR SmokeColor : +The color to smoke to positionable.

    • -

      Range :

      +

      #number Range : +The range in meters to randomize the smoking around the positionable.

      + +
      • +
    • + +

      #number AddHeight : +The height in meters to add to the altitude of the positionable.

    @@ -1828,6 +1836,7 @@ self

    + Core.Spot#SPOT POSITIONABLE.Spot diff --git a/docs/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html index 64e0a878f..e3681deff 100644 --- a/docs/Documentation/Scheduler.html +++ b/docs/Documentation/Scheduler.html @@ -172,6 +172,12 @@ SCHEDULER:Clear()

    Clears all pending schedules.

    + + + + SCHEDULER.MasterObject + + @@ -414,6 +420,20 @@ The schedule will stop after 300 seconds.

    Clears all pending schedules.

    +
    +
    +
    +
    + + + +SCHEDULER.MasterObject + +
    +
    + + +
    diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html index ce59ab37f..7b343aea0 100644 --- a/docs/Documentation/Set.html +++ b/docs/Documentation/Set.html @@ -4567,6 +4567,11 @@ self

    Calculate the maxium A2G threat level of the SET_UNIT.

    +

    Return value

    + +

    #number: +The maximum threatlevel

    +
    diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 6836574d8..992d1808d 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -172,15 +172,9 @@ - SETTINGS:GetLL_Accuracy() + SETTINGS:GetLL_DDM_Accuracy()

    Gets the SETTINGS LL accuracy.

    - - - - SETTINGS:GetLL_DMS() - -

    Gets the SETTINGS LL DMS.

    @@ -202,9 +196,15 @@ - SETTINGS:IsA2A_LL() + SETTINGS:IsA2A_LL_DDM() -

    Is LL

    +

    Is LL DDM

    + + + + SETTINGS:IsA2A_LL_DMS() + +

    Is LL DMS

    @@ -220,9 +220,15 @@ - SETTINGS:IsA2G_LL() + SETTINGS:IsA2G_LL_DDM() -

    Is LL

    +

    Is LL DDM

    + + + + SETTINGS:IsA2G_LL_DMS() + +

    Is LL DMS

    @@ -274,13 +280,7 @@ - SETTINGS:MenuGroupLL_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy) - - - - - - SETTINGS:MenuGroupLL_DMSSystem(PlayerUnit, PlayerGroup, PlayerName, LL_DMS) + SETTINGS:MenuGroupLL_DDM_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy) @@ -298,13 +298,7 @@ - SETTINGS:MenuLL_Accuracy(MenuGroup, RootMenu, LL_Accuracy) - - - - - - SETTINGS:MenuLL_DMS(MenuGroup, RootMenu, LL_DMS) + SETTINGS:MenuLL_DDM_Accuracy(MenuGroup, RootMenu, LL_Accuracy) @@ -358,9 +352,15 @@ - SETTINGS:SetA2A_LL() + SETTINGS:SetA2A_LL_DDM() -

    Sets A2A LL

    +

    Sets A2A LL DDM

    + + + + SETTINGS:SetA2A_LL_DMS() + +

    Sets A2A LL DMS

    @@ -376,9 +376,15 @@ - SETTINGS:SetA2G_LL() + SETTINGS:SetA2G_LL_DDM() -

    Sets A2G LL

    +

    Sets A2G LL DDM

    + + + + SETTINGS:SetA2G_LL_DMS() + +

    Sets A2G LL DMS

    @@ -397,12 +403,6 @@ SETTINGS:SetLL_Accuracy(LL_Accuracy)

    Sets the SETTINGS LL accuracy.

    - - - - SETTINGS:SetLL_DMS(LL_DMS) - -

    Sets the SETTINGS LL DMS.

    @@ -544,8 +544,8 @@
    - -SETTINGS:GetLL_Accuracy() + +SETTINGS:GetLL_DDM_Accuracy()
    @@ -557,24 +557,6 @@

    #number:

    -
    -
    -
    -
    - - -SETTINGS:GetLL_DMS() - -
    -
    - -

    Gets the SETTINGS LL DMS.

    - -

    Return value

    - -

    #number:

    - -
    @@ -634,18 +616,36 @@ true if BULLS

    - -SETTINGS:IsA2A_LL() + +SETTINGS:IsA2A_LL_DDM()
    -

    Is LL

    +

    Is LL DDM

    Return value

    #boolean: -true if LL

    +true if LL DDM

    + +
    +
    +
    +
    + + +SETTINGS:IsA2A_LL_DMS() + +
    +
    + +

    Is LL DMS

    + +

    Return value

    + +

    #boolean: +true if LL DMS

    @@ -688,18 +688,36 @@ true if BRA

    - -SETTINGS:IsA2G_LL() + +SETTINGS:IsA2G_LL_DDM()
    -

    Is LL

    +

    Is LL DDM

    Return value

    #boolean: -true if LL

    +true if LL DDM

    + +
    +
    +
    +
    + + +SETTINGS:IsA2G_LL_DMS() + +
    +
    + +

    Is LL DMS

    + +

    Return value

    + +

    #boolean: +true if LL DMS

    @@ -874,8 +892,8 @@ true if metric.

    - -SETTINGS:MenuGroupLL_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy) + +SETTINGS:MenuGroupLL_DDM_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy)
    @@ -910,42 +928,6 @@ true if metric.

    - -SETTINGS:MenuGroupLL_DMSSystem(PlayerUnit, PlayerGroup, PlayerName, LL_DMS) - -
    -
    - - - -

    Parameters

    -
      -
    • - -

      PlayerUnit :

      - -
      • -
    • - -

      PlayerGroup :

      - -
      • -
    • - -

      PlayerName :

      - -
      • -
    • - -

      LL_DMS :

      - -
      • -
    -
    -
    -
    -
    - SETTINGS:MenuGroupMGRS_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy) @@ -1018,8 +1000,8 @@ true if metric.

    - -SETTINGS:MenuLL_Accuracy(MenuGroup, RootMenu, LL_Accuracy) + +SETTINGS:MenuLL_DDM_Accuracy(MenuGroup, RootMenu, LL_Accuracy)
    @@ -1049,37 +1031,6 @@ true if metric.

    - -SETTINGS:MenuLL_DMS(MenuGroup, RootMenu, LL_DMS) - -
    -
    - - - -

    Parameters

    -
      -
    • - -

      MenuGroup :

      - -
      • -
    • - -

      RootMenu :

      - -
      • -
    • - -

      LL_DMS :

      - -
      • -
    -
    -
    -
    -
    - SETTINGS:MenuMGRS_Accuracy(MenuGroup, RootMenu, MGRS_Accuracy) @@ -1263,13 +1214,31 @@ true if metric.

    - -SETTINGS:SetA2A_LL() + +SETTINGS:SetA2A_LL_DDM()
    -

    Sets A2A LL

    +

    Sets A2A LL DDM

    + +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetA2A_LL_DMS() + +
    +
    + +

    Sets A2A LL DMS

    Return value

    @@ -1317,13 +1286,31 @@ true if metric.

    - -SETTINGS:SetA2G_LL() + +SETTINGS:SetA2G_LL_DDM()
    -

    Sets A2G LL

    +

    Sets A2G LL DDM

    + +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetA2G_LL_DMS() + +
    +
    + +

    Sets A2G LL DMS

    Return value

    @@ -1387,32 +1374,6 @@ true if metric.

    #SETTINGS:

    -
    -
    -
    -
    - - -SETTINGS:SetLL_DMS(LL_DMS) - -
    -
    - -

    Sets the SETTINGS LL DMS.

    - -

    Parameter

    -
      -
    • - -

      #number LL_DMS :

      - -
      • -
    -

    Return value

    - -

    #SETTINGS:

    - -
    diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 4229c2ac8..65835348c 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -822,12 +822,6 @@ and any spaces before and after the resulting name are removed.

    SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) - - - - SPAWN.uncontrolled - - @@ -2200,9 +2194,6 @@ The group that was spawned. You can use this group for further actions.

    - -

    Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

    -
    @@ -2755,9 +2746,6 @@ when nothing was spawned.

    - -

    By default, no InitLimit

    -
    @@ -2793,7 +2781,7 @@ when nothing was spawned.

    - #number + SPAWN.SpawnMaxGroups @@ -2810,7 +2798,7 @@ when nothing was spawned.

    - #number + SPAWN.SpawnMaxUnitsAlive @@ -3138,7 +3126,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
    - #boolean + SPAWN.SpawnUnControlled @@ -3742,20 +3730,6 @@ True = Continue Scheduler

    -
    -
    -
    -
    - - - -SPAWN.uncontrolled - -
    -
    - - -
    diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index bc91b9624..d8aa5e633 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -436,6 +436,7 @@ ptional) The name of the new static.

    + #number SPAWNSTATIC.SpawnIndex diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index 5fdc3b305..ead3792db 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -765,7 +765,6 @@ true if it is lasing

    - SPOT.ScheduleID @@ -779,7 +778,6 @@ true if it is lasing

    - SPOT.SpotIR @@ -793,7 +791,6 @@ true if it is lasing

    - SPOT.SpotLaser @@ -807,7 +804,6 @@ true if it is lasing

    - SPOT.Target diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html index 26d342ef7..dd18375a7 100644 --- a/docs/Documentation/Task.html +++ b/docs/Documentation/Task.html @@ -183,6 +183,18 @@ TASK:CrashGroup(PlayerUnit, PlayerGroup)

    A PlayerUnit crashed in a Task.

    + + + + TASK.DetectedItemIndex + + + + + + TASK.Detection + + @@ -516,7 +528,7 @@ - TASK:ReportSummary() + TASK:ReportSummary(ReportGroup)

    Create a summary report of the Task.

    @@ -537,6 +549,12 @@ TASK:SetBriefing(TaskBriefing)

    Sets a Task briefing.

    + + + + TASK:SetDetection(Detection, DetectedItemIndex) + +

    Set detection of a task

    @@ -1156,6 +1174,34 @@ The CLIENT or UNIT of the Player aborting the Task.

    #TASK:

    + +
    +
    +
    + + + +TASK.DetectedItemIndex + +
    +
    + + + +
    +
    +
    +
    + + + +TASK.Detection + +
    +
    + + +
    @@ -2344,7 +2390,7 @@ self

    -TASK:ReportSummary() +TASK:ReportSummary(ReportGroup)
    @@ -2354,6 +2400,14 @@ self

    List the Task Name and Status

    +

    Parameter

    +

    Return value

    #string:

    @@ -2429,6 +2483,37 @@ self

    #TASK: self

    +
    +
    +
    +
    + + +TASK:SetDetection(Detection, DetectedItemIndex) + +
    +
    + +

    Set detection of a task

    + +

    Parameters

    + +

    Return value

    + +

    #TASK:

    + +
    diff --git a/docs/Documentation/Task_A2A.html b/docs/Documentation/Task_A2A.html index a4ca3be69..53005ee57 100644 --- a/docs/Documentation/Task_A2A.html +++ b/docs/Documentation/Task_A2A.html @@ -274,6 +274,12 @@ based on the tasking capabilities defined in Task#TA TASK_A2A_ENGAGE.TargetSetUnit + + + + TASK_A2A_ENGAGE:UpdateTaskInfo() + + @@ -320,6 +326,12 @@ based on the tasking capabilities defined in Task#TA TASK_A2A_INTERCEPT.TargetSetUnit + + + + TASK_A2A_INTERCEPT:UpdateTaskInfo() + + @@ -366,6 +378,12 @@ based on the tasking capabilities defined in Task#TA TASK_A2A_SWEEP.TargetSetUnit + + + + TASK_A2A_SWEEP:UpdateTaskInfo() + + @@ -1069,6 +1087,19 @@ The score in points.

    + +
    +
    +
    + + +TASK_A2A_ENGAGE:UpdateTaskInfo() + +
    +
    + + +
    @@ -1309,6 +1340,19 @@ The score in points.

    + +
    +
    +
    + + +TASK_A2A_INTERCEPT:UpdateTaskInfo() + +
    +
    + + +
    @@ -1549,6 +1593,19 @@ The score in points.

    + +
    +
    +
    + + +TASK_A2A_SWEEP:UpdateTaskInfo() + +
    +
    + + +
    diff --git a/docs/Documentation/Task_A2A_Dispatcher.html b/docs/Documentation/Task_A2A_Dispatcher.html index e9ee5a1da..11141d207 100644 --- a/docs/Documentation/Task_A2A_Dispatcher.html +++ b/docs/Documentation/Task_A2A_Dispatcher.html @@ -199,6 +199,12 @@ TASK_A2A_DISPATCHER:ProcessDetected(Detection)

    Assigns tasks in relation to the detected items to the Set#SET_GROUP.

    + + + + TASK_A2A_DISPATCHER:RemoveTask(TaskIndex) + + @@ -760,6 +766,27 @@ Return true if you want the task assigning to continue... false will cancel the
    + +TASK_A2A_DISPATCHER:RemoveTask(TaskIndex) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      TaskIndex :

      + +
      • +
    +
    +
    +
    +
    + TASK_A2A_DISPATCHER:SetEngageRadius(EngageRadius) diff --git a/docs/Documentation/Task_A2G_Dispatcher.html b/docs/Documentation/Task_A2G_Dispatcher.html index dca001ffa..19f576d02 100644 --- a/docs/Documentation/Task_A2G_Dispatcher.html +++ b/docs/Documentation/Task_A2G_Dispatcher.html @@ -183,6 +183,12 @@ TASK_A2G_DISPATCHER:ProcessDetected(Detection)

    Assigns tasks in relation to the detected items to the Set#SET_GROUP.

    + + + + TASK_A2G_DISPATCHER:RemoveTask(TaskIndex) + + @@ -542,6 +548,27 @@ The detection created by the Detectio

    #boolean: Return true if you want the task assigning to continue... false will cancel the loop.

    + +
    +
    +
    + + +TASK_A2G_DISPATCHER:RemoveTask(TaskIndex) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      TaskIndex :

      + +
      • +
    diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 5ccba6643..349f0de89 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -552,7 +552,7 @@ based on the tasking capabilities defined in Task#TA
    - Core.Cargo#CARGO + Core.Cargo#CARGO_GROUP FSM_PROCESS.Cargo @@ -631,7 +631,7 @@ based on the tasking capabilities defined in Task#TA
    - + #number TASK_CARGO.CargoLimit diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html index da7814e14..67e25dafa 100644 --- a/docs/Documentation/Zone.html +++ b/docs/Documentation/Zone.html @@ -386,6 +386,12 @@

    Type ZONE_GROUP

    + + + +
    ZONE_GROUP:GetRandomPointVec2(inner, outer) +

    Returns a Point#POINT_VEC2 object reflecting a random 2D location within the zone.

    +
    ZONE_GROUP:GetRandomVec2()

    Returns a random location within the zone of the Group.

    @@ -1425,6 +1431,39 @@ The smoke color.

    + +ZONE_GROUP:GetRandomPointVec2(inner, outer) + +
    +
    + +

    Returns a Point#POINT_VEC2 object reflecting a random 2D location within the zone.

    + +

    Parameters

    +
      +
    • + +

      #number inner : +(optional) Minimal distance from the center of the zone. Default is 0.

      + +
      • +
    • + +

      #number outer : +(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.

      + +
      • +
    +

    Return value

    + +

    Core.Point#POINT_VEC2: +The Point#POINT_VEC2 object reflecting the random 3D location within the zone.

    + +
    +
    +
    +
    + ZONE_GROUP:GetRandomVec2()