From 74e3b15fe316cf98112661071c150205516e5106 Mon Sep 17 00:00:00 2001
From: FlightControl 1. Navigation ...: Escort group navigation functions: 2. Report targets ...: Report targets will make the escort group to report any target that it identifies within a 8km range. Any detected target can be attacked using the 4. Attack nearby targets function. (see below). 2. Hold position ...: Escort group navigation functions: 3. Report targets ...: Report targets will make the escort group to report any target that it identifies within a 8km range. Any detected target can be attacked using the 4. Attack nearby targets function. (see below). 3. Scan targets ...: Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or defined task. 4. Scan targets ...: Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or defined task. 4. Attack targets ...: This menu item will list all detected targets within a 15km range. Depending on the level of detection (known/unknown) and visuality, the targets type will also be listed. 5. Attack targets ...: This menu item will list all detected targets within a 15km range. Depending on the level of detection (known/unknown) and visuality, the targets type will also be listed. 5. Request assistance from ...: This menu item will list all detected targets within a 15km range, as with the menu item Attack Targets.
+ 6. Request assistance from ...: This menu item will list all detected targets within a 15km range, as with the menu item Attack Targets.
This menu item allows to request attack support from other escorts supporting the current client group.
eg. the function allows a player to request support from the Ship escort to attack a target identified by the Plane escort with its Tomahawk missiles.
eg. the function allows a player to request support from other Planes escorting to bomb the unit with illumination missiles or bombs, so that the main plane escort can attack the area. 6. ROE ...: Defines the Rules of Engagement of the escort group when in flight. 7. ROE ...: Defines the Rules of Engagement of the escort group when in flight. 7. Evasion ...: Will define the evasion techniques that the escort group will perform during flight or combat. 8. Evasion ...: Will define the evasion techniques that the escort group will perform during flight or combat. 8. Resume Mission ...: Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
+ 9. Resume Mission ...: Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
Note that this is really fantastic, as you now have the dynamic of taking control of the escort groups, and allowing them to resume their path or mission. 9. Abort Current Task: Cancel the current task and rejoin formation. 10. Abort Current Task: Cancel the current task and rejoin formation. Create a new SPAWN object with the ESCORT.New method: ESCORT.New: Creates a new ESCORT object from a Group#GROUP for a Client#CLIENT, with an optional briefing text. None. The following menus can be setup: ESCORT.MenuFollowAt: Creates a menu to make the escort follow the client. ESCORT.MenuHoldAtEscortPosition: Creates a menu to hold the escort at its current position. ESCORT.MenuHoldAtLeaderPosition: Creates a menu to hold the escort at the client position. ESCORT.MenuScanForTargets: Creates a menu so that the escort scans targets. ESCORT.MenuFlare: Creates a menu to disperse flares. ESCORT.MenuSmoke: Creates a menu to disparse smoke. ESCORT.MenuReportTargets: Creates a menu so that the escort reports targets. ESCORT.MenuReportPosition: Creates a menu so that the escort reports its current position from bullseye. ESCORT.MenuAssistedAttack: Creates a menu structure so that the escort can resume from a waypoint. The mode the escort is in. JoinsUp and Follows a CLIENT. Defines a menu slot to let the escort attack its detected targets using assisted attack from another escort joined also with the client. Defines a menu to let the escort set its evasion when under threat. Defines a menu slot to let the escort disperse a flare in a certain color. Defines a menu slot to let the escort Join and Follow you at a certain distance. Defines a menu slot to let the escort hold at their current position and stay low with a specified height during a specified time in seconds. Defines a menu slot to let the escort hold at the client position and stay low with a specified height during a specified time in seconds. Defines a menu to let the escort set its rules of engagement. Defines a menu slot to let the escort report their current detected targets with a specified time interval in seconds. Defines a menu to let the escort resume its mission from a waypoint on its route. Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds. Defines a menu slot to let the escort disperse a smoke in a certain color. Defines the default menus Attack Targets Reaction to Threats Rules of Engagement Report Targets Request assistance from other escorts.
+ This is very useful to let f.e. an escorting ship attack a target detected by an escorting plane... The mode the escort is in. Defines a menu slot to let the escort attack its detected targets using assisted attack from another escort joined also with the client. This menu will appear under Request assistance from.
+Note that this method needs to be preceded with the method MenuReportTargets. Defines a menu to let the escort set its evasion when under threat. All rules of engagement will appear under the menu Evasion. Defines a menu slot to let the escort disperse a flare in a certain color. This menu will appear under Navigation.
+The flare will be fired from the first unit in the group. Defines a menu slot to let the escort Join and Follow you at a certain distance. This menu will appear under Navigation. Defines a menu slot to let the escort hold at their current position and stay low with a specified height during a specified time in seconds. This menu will appear under Hold position. #ESCORT:
+TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function. Defines a menu slot to let the escort hold at the client position and stay low with a specified height during a specified time in seconds. This menu will appear under Navigation. #ESCORT:
+TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function. Defines a menu to let the escort set its rules of engagement. All rules of engagement will appear under the menu ROE. Defines a menu slot to let the escort report their current detected targets with a specified time interval in seconds. This menu will appear under Report targets.
+Note that if a report targets menu is not specified, no targets will be detected by the escort, and the attack and assisted attack menus will not be displayed. Defines a menu to let the escort resume its mission from a waypoint on its route. All rules of engagement will appear under the menu Resume mission from. Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds. This menu will appear under Scan targets. Defines a menu slot to let the escort disperse a smoke in a certain color. This menu will appear under Navigation.
+Note that smoke menu options will only be displayed for ships and ground units. Not for air units.
+The smoke will be fired from the first unit in the group. Defines the default menus
-
-
+
+
+
-
-
-
-
-
ESCORT object construction methods.
ESCORT object initialization methods.
- Global(s)
@@ -168,12 +184,222 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
+ ESCORT
+
+
+
_Resume(EscortGroup)
+
+
ESCORT.EscortGroup
+
+
+
+
+ ESCORT.EscortMenuAttackNearbyTargets
+
+
+
+
+
+ ESCORT.EscortMenuEvasion
+
+
+
+
+
+ ESCORT.EscortMenuEvasionEvadeFire
+
+
+
+
+
+ ESCORT.EscortMenuEvasionNoReaction
+
+
+
+
+
+ ESCORT.EscortMenuEvasionPassiveDefense
+
+
+
+
+
+ ESCORT.EscortMenuFlare
+
+
+
+
+
+ ESCORT.EscortMenuFlareGreen
+
+
+
+
+
+ ESCORT.EscortMenuFlareRed
+
+
+
+
+
+ ESCORT.EscortMenuFlareWhite
+
+
+
+
+
+ ESCORT.EscortMenuFlareYellow
+
+
+
+
+
+ ESCORT.EscortMenuHold
+
+
+
+
+
+ ESCORT.EscortMenuHoldAtLeaderPosition
+
+
+
+
+
+ ESCORT.EscortMenuHoldPosition
+
+
+
+
+
+ ESCORT.EscortMenuJoinUpAndFollow
+
+
+
+
+
+ ESCORT.EscortMenuOptionEvasionVertical
+
+
+
+
+
+ ESCORT.EscortMenuROE
+
+
+
+
+
+ ESCORT.EscortMenuROEHoldFire
+
+
+
+
+
+ ESCORT.EscortMenuROEOpenFire
+
+
+
+
+
+ ESCORT.EscortMenuROEReturnFire
+
+
+
+
+
+ ESCORT.EscortMenuROEWeaponFree
+
+
+
+
+
+ ESCORT.EscortMenuReportNavigation
+
+
+
+
+
+ ESCORT.EscortMenuReportNearbyTargets
+
+
+
+
+
+ ESCORT.EscortMenuReportNearbyTargetsNow
+
+
+
+
+
+ ESCORT.EscortMenuReportNearbyTargetsOff
+
+
+
+
+
ESCORT.EscortMenuReportNearbyTargetsOn
+
+
+ ESCORT.EscortMenuResumeMission
+
+
+
+ ESCORT.EscortMenuScan
+
+
+
+
+
+ ESCORT.EscortMenuScanForTargets
+
+
+
+
+
+ ESCORT.EscortMenuSmoke
+
+
+
+
+
+ ESCORT.EscortMenuSmokeBlue
+
+
+
+
+
+ ESCORT.EscortMenuSmokeGreen
+
+
+
+
+
+ ESCORT.EscortMenuSmokeOrange
+
+
+
+
+
+ ESCORT.EscortMenuSmokeRed
+
+
+
+
+
+ ESCORT.EscortMenuSmokeWhite
+
+
+
+
+
+ ESCORT.EscortMenuTargetAssistance
+
+
+
+
+
ESCORT.EscortMode
+
+
@@ -192,6 +418,84 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
+ ESCORT:JoinUpAndFollow(EscortGroup, EscortClient, Distance)
+
+
+ ESCORT.MODE
+
+
+
+
+
+ ESCORT:MenuAssistedAttack()
+
+
+
+
+ ESCORT:MenuEvasion(MenuTextFormat)
+
+
+
+
+ ESCORT:MenuFlare(MenuTextFormat)
+
+
+
+
+ ESCORT:MenuFollowAt(Distance)
+
+
+
+
+ ESCORT:MenuHoldAtEscortPosition(Height, Seconds, MenuTextFormat)
+
+
+
+
+ ESCORT:MenuHoldAtLeaderPosition(Height, Seconds, MenuTextFormat)
+
+
+
+
+ ESCORT:MenuROE(MenuTextFormat)
+
+
+
+
+ ESCORT:MenuReportTargets(Seconds)
+
+
+
+
+ ESCORT:MenuResumeMission()
+
+
+
+
+ ESCORT:MenuScanForTargets(Height, Seconds, MenuTextFormat)
+
+
+
+
+ ESCORT:MenuSmoke(MenuTextFormat)
+
+
+
+
ESCORT:Menus()
+
+
@@ -270,12 +574,6 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
- ESCORT._HoldPosition(MenuParam)
-
-
-
ESCORT._HoldPositionNearBy(MenuParam)
-
-
@@ -330,6 +628,22 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
+
+
+ ESCORT._SwitchReportNearbyTargets(MenuParam)
+
+ Type
+ ESCORT.MODE
+
@@ -375,6 +689,27 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
+
+
+
+
+ ESCORT.MODE.FOLLOW
+
+
+
+
+
ESCORT.MODE.MISSION
+
+
+
Parameter
+
+
EscortGroup : Type
@@ -426,6 +761,368 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
+
+
+ Escort
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -440,6 +1137,150 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -499,6 +1340,389 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
+
+
+
+
+
+
+ Return value
+
+
+
+
+
+
+ Parameter
+
+
+ MenuTextFormat : Return value
+
+
+
+
+
+
+ Parameter
+
+
+ #string MenuTextFormat :
+Optional parameter that shows the menu option text. If no text is given, the default text will be displayed.Return value
+
+
+
+
+
+
+ Parameter
+
+
+ DCSTypes#Distance Distance :
+The distance in meters that the escort needs to follow the client.Return value
+
+
+
+
+
+
+ Parameters
+
+
+ DCSTypes#Distance Height :
+Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.DCSTypes#Time Seconds :
+Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.#string MenuTextFormat :
+Optional parameter that shows the menu option text. The text string is formatted, and should contain two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.Return value
+
+
+
+ Parameters
+
+
+ DCSTypes#Distance Height :
+Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.DCSTypes#Time Seconds :
+Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.#string MenuTextFormat :
+Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.Return value
+
+
+
+ Parameter
+
+
+ MenuTextFormat : Return value
+
+
+
+
+
+
+ Parameter
+
+
+ DCSTypes#Time Seconds :
+Optional parameter that lets the escort report their current detected targets after specified time interval in seconds. The default time is 30 seconds.Return value
+
+
+
+
+
+
+ Return value
+
+
+
+
+
+
+ Parameters
+
+
+ DCSTypes#Distance Height :
+Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.DCSTypes#Time Seconds :
+Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.#string MenuTextFormat :
+Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.Return value
+
+
+
+
+
+
+ Parameter
+
+
+ #string MenuTextFormat :
+Optional parameter that shows the menu option text. If no text is given, the default text will be displayed.Return value
+
+
+
+
+
+
Return value
+
+
+
+
@@ -741,27 +1965,6 @@ self
#MENUPARAM MenuParam :
ESCORT.MODEESCORT.Mode class
+ +