From 4f806d3e4b4f3c13a266fd12cf7cbaac1a39633a Mon Sep 17 00:00:00 2001 From: FlightControl Date: Sat, 13 May 2017 13:34:57 +0200 Subject: [PATCH] Documentation AI_FORMATION --- docs/Documentation/AI_Formation.html | 1954 +++++++++++++++++++++++++- docs/Documentation/AI_Patrol.html | 3 - docs/Documentation/Cargo.html | 2 +- docs/Documentation/Designate.html | 1 + docs/Documentation/Spawn.html | 10 +- docs/Documentation/Zone.html | 8 +- docs/Documentation/index.html | 10 +- 7 files changed, 1912 insertions(+), 76 deletions(-) diff --git a/docs/Documentation/AI_Formation.html b/docs/Documentation/AI_Formation.html index 289db76de..2809b48df 100644 --- a/docs/Documentation/AI_Formation.html +++ b/docs/Documentation/AI_Formation.html @@ -105,7 +105,31 @@
-

AI_FORMATION makes AI GROUPs fly in formation of various compositions.

+

AI_FORMATION makes AI GROUPs fly in formation of various compositions. +The AI_FORMATION class models formations in a different manner than the internal DCS formation logic!!! +The purpose of the class is to:

+ + + +

A few remarks:

+ + + +

As a result, the AI_FORMATION is not perfect, but is very useful to:

+ +

There are the following types of classes defined:

@@ -158,6 +182,12 @@

Type AI_FORMATION

+ + + + - + + + + + @@ -215,6 +251,12 @@ + + + + @@ -227,6 +269,24 @@ + + + + + + + + + + + + @@ -236,7 +296,13 @@ - + + + + + @@ -251,6 +317,12 @@ + + + + @@ -266,7 +338,31 @@ - + + + + + + + + + + + + + + + + + @@ -281,6 +377,12 @@ + + + + @@ -293,6 +395,24 @@ + + + + + + + + + + + + @@ -305,6 +425,12 @@ + + + + @@ -320,7 +446,13 @@ - + + + + + @@ -335,6 +467,12 @@ + + + + @@ -350,33 +488,81 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -448,6 +634,32 @@ +

AI_FORMATION makes AI GROUPs fly in formation of various compositions. +The AI_FORMATION class models formations in a different manner than the internal DCS formation logic!!! +The purpose of the class is to:

+ + + +

A few remarks:

+ + + +

As a result, the AI_FORMATION is not perfect, but is very useful to:

+ + +

AI_FORMATION construction

Create a new SPAWN object with the AI_FORMATION.New method:

@@ -456,20 +668,25 @@
  • Follow#AI_FORMATION.New(): Creates a new AI_FORMATION object from a Group#GROUP for a Client#CLIENT or a Unit#UNIT, with an optional briefing text.
    • -

    Initialization methods

    +

    Formation methods

    -

    The following menus are created within the RADIO MENU of an active unit hosted by a player:

    +

    The following methods can be used to set or change the formation:

    +

    Randomization

    + +

    Use the method AIFormation#AIFORMATION.SetFlightRandomization() to simulate the formation flying errors that pilots make while in formation. Is a range set in meters.

    Usage:

    @@ -493,6 +710,20 @@ LargeFormation:__Start( 1 )
    + + +AI_FORMATION.FlightRandomization + +
    +
    + + + +
    +
    +
    +
    + #number AI_FORMATION.FollowDistance @@ -586,13 +817,71 @@ LargeFormation:__Start( 1 ) + +
    +
    +
    + + +AI_FORMATION:FormationBox(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) + +
    +
    + +

    FormationBox Trigger for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    • + +

      #number ZLevels : +The amount of levels on the Z-axis.

      + +
      • +
    -AI_FORMATION:FormationCenterWing(XStart, XSpace, YStart, ZStart, ZSpace) +AI_FORMATION:FormationCenterWing(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)
    @@ -621,6 +910,12 @@ The start position on the Y-axis in meters for the first group.

  • +

    #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

    + +
    • +
  • +

    #nubmer ZStart : The start position on the Z-axis in meters for the first group.

    @@ -723,6 +1018,58 @@ The space between groups on the Z-axis in meters for each sequent group.

    + +AI_FORMATION:FormationLine(XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationLine Trigger for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #nubmer YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    +
    +
    +
    +
    + AI_FORMATION:FormationRightLine(XStart, YStart, ZStart, ZSpace) @@ -809,6 +1156,132 @@ The space between groups on the Z-axis in meters for each sequent group.

    + +AI_FORMATION:FormationStack(XStart, XSpace, YStart, YSpace) + +
    +
    + +

    FormationStack Trigger for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    +
    +
    +
    +
    + + +AI_FORMATION:FormationTrail(XStart, XSpace, YStart) + +
    +
    + +

    FormationTrail Trigger for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    +
    +
    +
    +
    + + +AI_FORMATION:FormationVic(XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationVic Trigger for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    +
    +
    +
    +
    + AI_FORMATION:New(FollowUnit, FollowGroupSet, FollowName, FollowBriefing) @@ -853,8 +1326,81 @@ self

    + +AI_FORMATION:OnAfterFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) + +
    +
    + +

    FormationBox Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    • + +

      #number ZLevels : +The amount of levels on the Z-axis.

      + +
      • +
    +
    +
    +
    +
    + -AI_FORMATION:OnAfterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace) +AI_FORMATION:OnAfterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)
    @@ -904,6 +1450,12 @@ The start position on the Y-axis in meters for the first group.

  • +

    #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

    + +
    • +
  • +

    #nubmer ZStart : The start position on the Z-axis in meters for the first group.

    @@ -1048,6 +1600,79 @@ The space between groups on the Z-axis in meters for each sequent group.

    + +AI_FORMATION:OnAfterFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationLine Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      Core.Set#SET_GROUP FollowGroupSet : +The group AI escorting the FollowUnit.

      + +
      • +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #nubmer YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    +
    +
    +
    +
    + AI_FORMATION:OnAfterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace) @@ -1176,8 +1801,257 @@ The space between groups on the Z-axis in meters for each sequent group.

    + +AI_FORMATION:OnAfterFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace) + +
    +
    + +

    FormationStack Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    +
    +
    +
    +
    + + +AI_FORMATION:OnAfterFormationTrail(From, Event, To, XStart, XSpace, YStart) + +
    +
    + +

    FormationTrail Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    +
    +
    +
    +
    + + +AI_FORMATION:OnAfterFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationVic Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    +
    +
    +
    +
    + + +AI_FORMATION:OnBeforeFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) + +
    +
    + +

    FormationBox Handler OnBefore for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    • + +

      #number ZLevels : +The amount of levels on the Z-axis.

      + +
      • +
    +

    Return value

    + +

    #boolean:

    + + +
    +
    +
    +
    + -AI_FORMATION:OnBeforeFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace) +AI_FORMATION:OnBeforeFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)
    @@ -1227,6 +2101,12 @@ The start position on the Y-axis in meters for the first group.

  • +

    #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

    + +
    • +
  • +

    #nubmer ZStart : The start position on the Z-axis in meters for the first group.

    @@ -1381,6 +2261,84 @@ The space between groups on the Z-axis in meters for each sequent group.

    #boolean:

    +
    • +
    +
    +
    + + +AI_FORMATION:OnBeforeFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationLine Handler OnBefore for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      Core.Set#SET_GROUP FollowGroupSet : +The group AI escorting the FollowUnit.

      + +
      • +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #nubmer YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    +

    Return value

    + +

    #boolean:

    + +
    @@ -1519,6 +2477,192 @@ The space between groups on the Z-axis in meters for each sequent group.

    #boolean:

    + +
    +
    +
    + + +AI_FORMATION:OnBeforeFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace) + +
    +
    + +

    FormationStack Handler OnBefore for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    +

    Return value

    + +

    #boolean:

    + + +
    +
    +
    +
    + + +AI_FORMATION:OnBeforeFormationTrail(From, Event, To, XStart, XSpace, YStart) + +
    +
    + +

    FormationTrail Handler OnBefore for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    +

    Return value

    + +

    #boolean:

    + + +
    +
    +
    +
    + + +AI_FORMATION:OnBeforeFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationVic Handler OnBefore for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    +

    Return value

    + +

    #boolean:

    + +
    @@ -1547,6 +2691,33 @@ The space between groups on the Z-axis in meters for each sequent group.

    If true, nearby targets are reported.

    + +
    +
    +
    + + +AI_FORMATION:SetFlightRandomization(FlightRandomization) + +
    +
    + +

    Use the method AIFormation#AIFORMATION.SetFlightRandomization() to make the air units in your formation randomize their flight a bit while in formation.

    + +

    Parameter

    +
      +
    • + +

      #number FlightRandomization : +The formation flying errors that pilots can make while in formation. Is a range set in meters.

      + +
      • +
    +

    Return value

    + +

    #AI_FORMATION:

    + +
    @@ -1595,8 +2766,71 @@ If true, then the direction vector will be smoked.

    + +AI_FORMATION:__FormationBox(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) + +
    +
    + +

    FormationBox Asynchronous Trigger for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #number Delay :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    • + +

      #number ZLevels : +The amount of levels on the Z-axis.

      + +
      • +
    +
    +
    +
    +
    + -AI_FORMATION:__FormationCenterWing(Delay, XStart, XSpace, YStart, ZStart, ZSpace) +AI_FORMATION:__FormationCenterWing(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)
    @@ -1630,6 +2864,12 @@ The start position on the Y-axis in meters for the first group.

  • +

    #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

    + +
    • +
  • +

    #nubmer ZStart : The start position on the Z-axis in meters for the first group.

    @@ -1742,6 +2982,63 @@ The space between groups on the Z-axis in meters for each sequent group.

    + +AI_FORMATION:__FormationLine(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationLine Asynchronous Trigger for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #number Delay :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #nubmer YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    +
    +
    +
    +
    + AI_FORMATION:__FormationRightLine(Delay, XStart, YStart, ZStart, ZSpace) @@ -1838,59 +3135,295 @@ The space between groups on the Z-axis in meters for each sequent group.

    - -AI_FORMATION:onafterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace) + +AI_FORMATION:__FormationStack(Delay, XStart, XSpace, YStart, YSpace)
    - +

    FormationStack Asynchronous Trigger for AI_FORMATION

    Parameters

    • +

      #number Delay :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    +
    +
    +
    +
    + + +AI_FORMATION:__FormationTrail(Delay, XStart, XSpace, YStart) + +
    +
    + +

    FormationTrail Asynchronous Trigger for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #number Delay :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    +
    +
    +
    +
    + + +AI_FORMATION:__FormationVic(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationVic Asynchronous Trigger for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #number Delay :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    +
    +
    +
    +
    + + +AI_FORMATION:onafterFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels, FollowGroupSet) + +
    +
    + +

    FormationBox Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    • + +

      #number ZLevels : +The amount of levels on the Z-axis.

      + +
      • +
    • +

      FollowGroupSet :

      • +
    +

    Return value

    + +

    #AI_FORMATION:

    + + +
    +
    +
    +
    + + +AI_FORMATION:onafterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationCenterWing Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
    • -

      From :

      +

      Core.Set#SET_GROUP FollowGroupSet : +The group AI escorting the FollowUnit.

    • -

      Event :

      +

      #string From :

    • -

      To :

      +

      #string Event :

    • -

      XStart :

      +

      #string To :

    • -

      XSpace :

      +

      #number XStart : +The start position on the X-axis in meters for the first group.

    • -

      YStart :

      +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

    • -

      ZStart :

      +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

    • -

      ZSpace :

      +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

    @@ -1905,51 +3438,61 @@ The space between groups on the Z-axis in meters for each sequent group.

    - +

    FormationLeftLine Handler OnAfter for AI_FORMATION

    Parameters

    • -

      FollowGroupSet :

      +

      Core.Set#SET_GROUP FollowGroupSet : +The group AI escorting the FollowUnit.

    • -

      From :

      +

      #string From :

    • -

      Event :

      +

      #string Event :

    • -

      To :

      +

      #string To :

    • -

      XStart :

      +

      #number XStart : +The start position on the X-axis in meters for the first group.

    • -

      YStart :

      +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

    • -

      ZStart :

      +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

    • -

      ZSpace :

      +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

    +

    Return value

    + +

    #AI_FORMATION:

    + +
    @@ -1961,53 +3504,59 @@ The space between groups on the Z-axis in meters for each sequent group.

    - +

    FormationLeftWing Handler OnAfter for AI_FORMATION

    Parameters

    • -

      FollowGroupSet :

      +

      Core.Set#SET_GROUP FollowGroupSet : +The group AI escorting the FollowUnit.

    • -

      From :

      +

      #string From :

    • -

      Event :

      +

      #string Event :

    • -

      To :

      +

      #string To :

    • -

      XStart :

      +

      #number XStart : +The start position on the X-axis in meters for the first group.

    • -

      XSpace :

      +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

    • -

      YStart :

      +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

    • -

      ZStart :

      +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

    • -

      ZSpace :

      +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

    @@ -2016,57 +3565,145 @@ The space between groups on the Z-axis in meters for each sequent group.

    + +AI_FORMATION:onafterFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) + +
    +
    + +

    FormationLine Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      Core.Set#SET_GROUP FollowGroupSet : +The group AI escorting the FollowUnit.

      + +
      • +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #nubmer YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    +

    Return value

    + +

    #AI_FORMATION:

    + + +
    +
    +
    +
    + AI_FORMATION:onafterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)
    - +

    FormationRightLine Handler OnAfter for AI_FORMATION

    Parameters

    • -

      FollowGroupSet :

      +

      Core.Set#SET_GROUP FollowGroupSet : +The group AI escorting the FollowUnit.

    • -

      From :

      +

      #string From :

    • -

      Event :

      +

      #string Event :

    • -

      To :

      +

      #string To :

    • -

      XStart :

      +

      #number XStart : +The start position on the X-axis in meters for the first group.

    • -

      YStart :

      +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

    • -

      ZStart :

      +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

    • -

      ZSpace :

      +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

    +

    Return value

    + +

    #AI_FORMATION:

    + +
    @@ -2133,6 +3770,209 @@ The space between groups on the Z-axis in meters for each sequent group.

    + +AI_FORMATION:onafterFormationStack(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace) + +
    +
    + +

    FormationStack Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      Core.Set#SET_GROUP FollowGroupSet : +The group AI escorting the FollowUnit.

      + +
      • +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    +

    Return value

    + +

    #AI_FORMATION:

    + + +
    +
    +
    +
    + + +AI_FORMATION:onafterFormationTrail(FollowGroupSet, From, Event, To, XStart, XSpace, YStart) + +
    +
    + +

    FormationTrail Handler OnAfter for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      Core.Set#SET_GROUP FollowGroupSet : +The group AI escorting the FollowUnit.

      + +
      • +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    +

    Return value

    + +

    #AI_FORMATION:

    + + +
    +
    +
    +
    + + +AI_FORMATION:onafterFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, FollowGroupSet) + +
    +
    + +

    FormationVic Handle for AI_FORMATION

    + +

    Parameters

    +
      +
    • + +

      #string From :

      + +
      • +
    • + +

      #string Event :

      + +
      • +
    • + +

      #string To :

      + +
      • +
    • + +

      #number XStart : +The start position on the X-axis in meters for the first group.

      + +
      • +
    • + +

      #number XSpace : +The space between groups on the X-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer YStart : +The start position on the Y-axis in meters for the first group.

      + +
      • +
    • + +

      #number YSpace : +The space between groups on the Y-axis in meters for each sequent group.

      + +
      • +
    • + +

      #nubmer ZStart : +The start position on the Z-axis in meters for the first group.

      + +
      • +
    • + +

      #number ZSpace : +The space between groups on the Z-axis in meters for each sequent group.

      + +
      • +
    • + +

      FollowGroupSet :

      + +
      • +
    +

    Return value

    + +

    #AI_FORMATION:

    + + +
    +
    +
    +
    + AI_FORMATION:onenterFollowing(FollowGroupSet) diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index af53dd252..a349f1b11 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -953,9 +953,6 @@ Use the method AIPATROLZONE.M - -

    This table contains the targets detected during patrol.

    -
    diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 849e4255a..8b2fbef53 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -2921,7 +2921,6 @@ The range till cargo will board.

    - CARGO_UNIT.CargoCarrier @@ -3047,6 +3046,7 @@ The range till cargo will board.

    + #number CARGO_UNIT.RunCount diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index 9133c530d..d8950ff85 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -892,6 +892,7 @@ function below will use the range 1-7 just in case

    + DESIGNATE.LaserCodes diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 5c66f6f52..19d5a6d46 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2073,6 +2073,9 @@ 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.

    +
    • @@ -2540,6 +2543,9 @@ when nothing was spawned.

    + +

    By default, no InitLimit

    +
    @@ -2575,7 +2581,7 @@ when nothing was spawned.

    - + #number SPAWN.SpawnMaxGroups @@ -2592,7 +2598,7 @@ when nothing was spawned.

    - + #number SPAWN.SpawnMaxUnitsAlive diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html index 38eeb7d9b..f18faf4f3 100644 --- a/docs/Documentation/Zone.html +++ b/docs/Documentation/Zone.html @@ -97,6 +97,10 @@

    Module Zone

    +

    Core - ZONE classes define zones within your mission of various forms, with various capabilities.

    + + +

    Banner Image

    @@ -105,10 +109,6 @@
    • Test if an object is within the zone boundaries.
      • -
    - - -
    • Provide the zone behaviour. Some zones are static, while others are moveable.
    diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html index ec204dbb4..938f30550 100644 --- a/docs/Documentation/index.html +++ b/docs/Documentation/index.html @@ -586,15 +586,7 @@ which are excellent tools to be reused in an OO environment!.

    AI_FORMATION.FlightRandomization + +
    AI_FORMATION.FollowDistance

    The current follow distance.

    @@ -200,7 +230,13 @@
    AI_FORMATION:FormationCenterWing(XStart, XSpace, YStart, ZStart, ZSpace)AI_FORMATION:FormationBox(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) +

    FormationBox Trigger for AI_FORMATION

    +
    AI_FORMATION:FormationCenterWing(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

    FormationCenterWing Trigger for AI_FORMATION

    		AI_FORMATION:FormationLeftWing(XStart, XSpace, YStart, ZStart, ZSpace)

    FormationLeftWing Trigger for AI_FORMATION

    +
    AI_FORMATION:FormationLine(XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationLine Trigger for AI_FORMATION
    AI_FORMATION:FormationRightWing(XStart, XSpace, YStart, ZStart, ZSpace)

    FormationRightWing Trigger for AI_FORMATION

    +
    AI_FORMATION:FormationStack(XStart, XSpace, YStart, YSpace) +

    FormationStack Trigger for AI_FORMATION

    +
    AI_FORMATION:FormationTrail(XStart, XSpace, YStart) +

    FormationTrail Trigger for AI_FORMATION

    +
    AI_FORMATION:FormationVic(XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationVic Trigger for AI_FORMATION
    AI_FORMATION:OnAfterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)AI_FORMATION:OnAfterFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) +

    FormationBox Handler OnAfter for AI_FORMATION

    +
    AI_FORMATION:OnAfterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

    FormationCenterWing Handler OnAfter for AI_FORMATION

    		AI_FORMATION:OnAfterFormationLeftWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

    FormationLeftWing Handler OnAfter for AI_FORMATION

    +
    AI_FORMATION:OnAfterFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationLine Handler OnAfter for AI_FORMATION
    AI_FORMATION:OnBeforeFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)AI_FORMATION:OnAfterFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace) +

    FormationStack Handler OnAfter for AI_FORMATION

    +
    AI_FORMATION:OnAfterFormationTrail(From, Event, To, XStart, XSpace, YStart) +

    FormationTrail Handler OnAfter for AI_FORMATION

    +
    AI_FORMATION:OnAfterFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationVic Handler OnAfter for AI_FORMATION

    +
    AI_FORMATION:OnBeforeFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) +

    FormationBox Handler OnBefore for AI_FORMATION

    +
    AI_FORMATION:OnBeforeFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

    FormationCenterWing Handler OnBefore for AI_FORMATION

    		AI_FORMATION:OnBeforeFormationLeftWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

    FormationLeftWing Handler OnBefore for AI_FORMATION

    +
    AI_FORMATION:OnBeforeFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationLine Handler OnBefore for AI_FORMATION
    AI_FORMATION:OnBeforeFormationRightWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

    FormationRightWing Handler OnBefore for AI_FORMATION

    +
    AI_FORMATION:OnBeforeFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace) +

    FormationStack Handler OnBefore for AI_FORMATION

    +
    AI_FORMATION:OnBeforeFormationTrail(From, Event, To, XStart, XSpace, YStart) +

    FormationTrail Handler OnBefore for AI_FORMATION

    +
    AI_FORMATION:OnBeforeFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationVic Handler OnBefore for AI_FORMATION
    AI_FORMATION.ReportTargets

    If true, nearby targets are reported.

    +
    AI_FORMATION:SetFlightRandomization(FlightRandomization) +

    Use the method AIFormation#AIFORMATION.SetFlightRandomization() to make the air units in your formation randomize their flight a bit while in formation.
    AI_FORMATION:__FormationCenterWing(Delay, XStart, XSpace, YStart, ZStart, ZSpace)AI_FORMATION:__FormationBox(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) +

    FormationBox Asynchronous Trigger for AI_FORMATION

    +
    AI_FORMATION:__FormationCenterWing(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

    FormationCenterWing Asynchronous Trigger for AI_FORMATION

    		AI_FORMATION:__FormationLeftWing(Delay, XStart, XSpace, YStart, ZStart, ZSpace)

    FormationLeftWing Asynchronous Trigger for AI_FORMATION

    +
    AI_FORMATION:__FormationLine(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationLine Asynchronous Trigger for AI_FORMATION
    AI_FORMATION:onafterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)AI_FORMATION:__FormationStack(Delay, XStart, XSpace, YStart, YSpace) - +

    FormationStack Asynchronous Trigger for AI_FORMATION

    +
    AI_FORMATION:__FormationTrail(Delay, XStart, XSpace, YStart) +

    FormationTrail Asynchronous Trigger for AI_FORMATION

    +
    AI_FORMATION:__FormationVic(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationVic Asynchronous Trigger for AI_FORMATION

    +
    AI_FORMATION:onafterFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels, FollowGroupSet) +

    FormationBox Handler OnAfter for AI_FORMATION

    +
    AI_FORMATION:onafterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationCenterWing Handler OnAfter for AI_FORMATION
    AI_FORMATION:onafterFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace) - +

    FormationLeftLine Handler OnAfter for AI_FORMATION
    AI_FORMATION:onafterFormationLeftWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace) - +

    FormationLeftWing Handler OnAfter for AI_FORMATION

    +
    AI_FORMATION:onafterFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) +

    FormationLine Handler OnAfter for AI_FORMATION
    AI_FORMATION:onafterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace) - +

    FormationRightLine Handler OnAfter for AI_FORMATION
    AI_FORMATION:onafterFormationRightWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace) +
    AI_FORMATION:onafterFormationStack(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace) +

    FormationStack Handler OnAfter for AI_FORMATION

    +
    AI_FORMATION:onafterFormationTrail(FollowGroupSet, From, Event, To, XStart, XSpace, YStart) +

    FormationTrail Handler OnAfter for AI_FORMATION

    +
    AI_FORMATION:onafterFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, FollowGroupSet) +

    FormationVic Handle for AI_FORMATION
    Zone -

    Banner Image

    - -
    - -

    There are essentially two core functions that zones accomodate:

    - -
      -
    • Test if an object is within the zone boundaries.
      • -
    +

    Core - ZONE classes define zones within your mission of various forms, with various capabilities.