Module AI.AI_Escort
AI - Taking the lead of AI escorting your flight or of other AI.
Features:
- Escort navigation commands.
- Escort hold at position commands.
- Escorts reporting detected targets.
- Escorts scanning targets in advance.
- Escorts attacking specific targets.
- Request assistance from other groups for attack.
- Manage rule of engagement of escorts.
- Manage the allowed evasion techniques of escorts.
- Make escort to execute a defined mission or path.
- Escort tactical situation reporting.
Missions:
Allows you to interact with escorting AI on your flight and take the lead.
Each escorting group can be commanded with a complete set of radio commands (radio menu in your flight, and then F10).
The radio commands will vary according the category of the group. The richest set of commands are with helicopters and airPlanes. Ships and Ground troops will have a more limited set, but they can provide support through the bombing of targets designated by the other escorts.
Escorts detect targets using a built-in detection mechanism. The detected targets are reported at a specified time interval. Once targets are reported, each escort has these targets as menu options to command the attack of these targets. Targets are by default grouped per area of 5000 meters, but the kind of detection and the grouping range can be altered.
Different formations can be selected in the Flight menu: Trail, Stack, Left Line, Right Line, Left Wing, Right Wing, Central Wing and Boxed formations are available. The Flight menu also allows for a mass attack, where all of the escorts are commanded to attack a target.
Escorts can emit flares to reports their location. They can be commanded to hold at a location, which can be their current or the leader location. In this way, you can spread out the escorts over the battle field before a coordinated attack.
But basically, the escort class provides 4 modes of operation, and depending on the mode, you are either leading the flight, or following the flight.
Leading the flight
When leading the flight, you are expected to guide the escorts towards the target areas, and carefully coordinate the attack based on the threat levels reported, and the available weapons carried by the escorts. Ground ships or ground troops can execute A-assisted attacks, when they have long-range ground precision weapons for attack.
Following the flight
Escorts can be commanded to execute a specific mission path. In this mode, the escorts are in the lead. You as a player, are following the escorts, and are commanding them to progress the mission while ensuring that the escorts survive. You are joining the escorts in the battlefield. They will detect and report targets and you will ensure that the attacks are well coordinated, assigning the correct escort type for the detected target type. Once the attack is finished, the escort will resume the mission it was assigned. In other words, you can use the escorts for reconnaissance, and for guiding the attack. Imagine you as a mi-8 pilot, assigned to pickup cargo. Two ka-50s are guiding the way, and you are following. You are in control. The ka-50s detect targets, report them, and you command how the attack will commence and from where. You can control where the escorts are holding position and which targets are attacked first. You are in control how the ka-50s will follow their mission path.
Escorts can act as part of a AI A2G dispatcher offensive. In this way, You was a player are in control. The mission is defined by the A2G dispatcher, and you are responsible to join the flight and ensure that the attack is well coordinated.
It is with great proud that I present you this class, and I hope you will enjoy the functionality and the dynamism it brings in your DCS world simulations.
RADIO MENUs that can be created:
Find a summary below of the current available commands:
Navigation ...:
Escort group navigation functions:
- "Join-Up": The escort group fill follow you in the assigned formation.
- "Flare": Provides menu commands to let the escort group shoot a flare in the air in a color.
- "Smoke": Provides menu commands to let the escort group smoke the air in a color. Note that smoking is only available for ground and naval troops.
Hold position ...:
Escort group navigation functions:
- "At current location": The escort group will hover above the ground at the position they were. The altitude can be specified as a parameter.
- "At my location": The escort group will hover or orbit at the position where you are. The escort will fly to your location and hold position. The altitude can be specified as a parameter.
Report targets ...:
Report targets will make the escort group to report any target that it identifies within detection range. Any detected target can be attacked using the "Attack Targets" menu function. (see below).
- "Report now": Will report the current detected targets.
- "Report targets on": Will make the escorts to report the detected targets and will fill the "Attack Targets" menu list.
- "Report targets off": Will stop detecting targets.
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. This menu will be available in Flight menu or in each Escort menu.
Scan targets ...:
Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or rejoin formation.
- "Scan targets 30 seconds": Scan 30 seconds for targets.
- "Scan targets 60 seconds": Scan 60 seconds for targets.
Request assistance from ...:
This menu item will list all detected targets within a 15km range, similar as with the menu item Attack Targets. This menu item allows to request attack support from other ground based escorts supporting the current escort. 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.
ROE ...:
Sets the Rules of Engagement (ROE) of the escort group when in flight.
- "Hold Fire": The escort group will hold fire.
- "Return Fire": The escort group will return fire.
- "Open Fire": The escort group will open fire on designated targets.
- "Weapon Free": The escort group will engage with any target.
Evasion ...:
Will define the evasion techniques that the escort group will perform during flight or combat.
- "Fight until death": The escort group will have no reaction to threats.
- "Use flares, chaff and jammers": The escort group will use passive defense using flares and jammers. No evasive manoeuvres are executed.
- "Evade enemy fire": The rescort group will evade enemy fire before firing.
- "Go below radar and evade fire": The escort group will perform evasive vertical manoeuvres.
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.
Authors: FlightControl
Global(s)
Global AI_ESCORT |
AI_ESCORT class AI_ESCORT construction methods. |
AI_ESCORT class
AI_ESCORT construction methods.
Create a new AI_ESCORT object with the AI_ESCORT.New method:
- AI_ESCORT.New: Creates a new AI_ESCORT object from a Wrapper.Group#GROUP for a Wrapper.Client#CLIENT, with an optional briefing text.
Usage:
-- Declare a new EscortPlanes object as follows:
-- First find the GROUP object and the CLIENT object.
local EscortUnit = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
local EscortGroup = SET_GROUP:New():FilterPrefixes("Escort"):FilterOnce() -- The the group name of the escorts contains "Escort".
-- Now use these 2 objects to construct the new EscortPlanes object.
EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
EscortPlanes:MenusAirplanes() -- create menus for airplanes
EscortPlanes:__Start(2)
# Developer Note
Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
Therefore, this class is considered to be deprecated
Type(s)
| Fields and Methods inherited from AI_ESCORT | Description |
|---|---|
|
Measure distance between coordinate player and coordinate detected item. |
|
|
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 slot to let the escort disperse a flare in a certain color. |
|
AI_ESCORT:MenuFormationBox(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) |
Defines a menu slot to let the escort to join in a box formation. |
AI_ESCORT:MenuFormationCenterWing(XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
Defines a menu slot to let the escort to join in a center wing formation. |
AI_ESCORT:MenuFormationLeftLine(XStart, YStart, ZStart, ZSpace) |
Defines a menu slot to let the escort to join in a leFt wing formation. |
AI_ESCORT:MenuFormationLeftWing(XStart, XSpace, YStart, ZStart, ZSpace) |
Defines a menu slot to let the escort to join in a left wing formation. |
AI_ESCORT:MenuFormationRightLine(XStart, YStart, ZStart, ZSpace) |
Defines a menu slot to let the escort to join in a right line formation. |
AI_ESCORT:MenuFormationRightWing(XStart, XSpace, YStart, ZStart, ZSpace) |
Defines a menu slot to let the escort to join in a right wing formation. |
AI_ESCORT:MenuFormationStack(XStart, XSpace, YStart, YSpace) |
Defines a menu slot to let the escort to join in a stacked formation. |
|
Defines a menu slot to let the escort to join in a trail formation. |
|
AI_ESCORT:MenuFormationVic(XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
Defines a menu slot to let the escort to join in a vic formation. |
AI_ESCORT:MenuHoldAtEscortPosition(Height, Speed, MenuTextFormat) |
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. |
AI_ESCORT:MenuHoldAtLeaderPosition(Height, Speed, MenuTextFormat) |
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 --- Defines a menu slot to let the escort to join formation. |
|
|
Defines a menu to let the escort set its rules of engagement. |
|
|
Defines a menu to let the escort set its evasion when under threat. |
|
AI_ESCORT:MenuScanForTargets(Height, Seconds, MenuTextFormat) |
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 a menu slot to let the escort report their current detected targets with a specified time interval in seconds. |
|
AI_ESCORT:MenusAirplanes(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) |
Defines the default menus for airplanes. |
AI_ESCORT:MenusHelicopters(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) |
Defines the default menus for helicopters. |
AI_ESCORT:New(EscortUnit, EscortGroupSet, EscortName, EscortBriefing) |
AI_ESCORT class constructor for an AI group |
|
Registers the waypoints |
|
|
Set a Detection method for the EscortUnit to be reported upon. |
|
|
Sets a menu slot to join formation for an escort. |
|
|
Defines a menu to let the escort resume its mission from a waypoint on its route. |
|
|
This function is for test, it will put on the frequency of the FollowScheduler a red smoke at the direction vector calculated for the escort to fly to. |
|
AI_ESCORT:_EscortFormationStack(XStart, XSpace, YStart, YSpace, EscortGroup) |
Lets the escort to join in a stacked formation. |
AI_ESCORT:_EscortFormationTrail(XStart, XSpace, YStart, EscortGroup) |
Lets the escort to join in a trail formation. |
AI_ESCORT:_FlightFormationStack(XStart, XSpace, YStart, YSpace) |
|
AI_ESCORT:_FlightHoldPosition(OrbitGroup, OrbitHeight, OrbitSeconds) |
|
|
Report Targets Scheduler for the flight. |
|
AI_ESCORT:_HoldPosition(OrbitGroup, EscortGroup, OrbitHeight, OrbitSeconds) |
|
AI_ESCORT:_ROE(EscortGroup, EscortROEFunction, EscortROEMessage) |
|
AI_ESCORT:_ROT(EscortGroup, EscortROTFunction, EscortROTMessage) |
|
|
Report Targets Scheduler. |
|
|
Resume Scheduler. |
|
| Fields and Methods inherited from AI_FORMATION | Description |
|---|---|
|
The current follow distance. |
|
AI_ESCORT:FollowMe(FollowGroup, ClientUnit, CT1, CV1, CT2, CV2) |
Follow me. |
|
The mode the escort is in. |
|
|
The instance of the SCHEDULER class. |
|
AI_ESCORT:FormationBox(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) |
FormationBox Trigger for AI_FORMATION |
AI_ESCORT:FormationCenterWing(XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
FormationCenterWing Trigger for AI_FORMATION |
|
FormationLeftLine Trigger for AI_FORMATION |
|
AI_ESCORT:FormationLeftWing(XStart, XSpace, YStart, ZStart, ZSpace) |
FormationLeftWing Trigger for AI_FORMATION |
AI_ESCORT:FormationLine(XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
FormationLine Trigger for AI_FORMATION |
AI_ESCORT:FormationRightLine(XStart, YStart, ZStart, ZSpace) |
FormationRightLine Trigger for AI_FORMATION |
AI_ESCORT:FormationRightWing(XStart, XSpace, YStart, ZStart, ZSpace) |
FormationRightWing Trigger for AI_FORMATION |
|
FormationStack Trigger for AI_FORMATION |
|
|
FormationTrail Trigger for AI_FORMATION |
|
AI_ESCORT:FormationVic(XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
FormationVic Trigger for AI_FORMATION |
|
Gets your escorts to flight mode. |
|
AI_ESCORT:New(FollowUnit, FollowGroupSet, FollowName, FollowBriefing) |
AI_FORMATION class constructor for an AI group |
|
FormationBox Handler OnAfter for AI_FORMATION |
|
|
FormationCenterWing Handler OnAfter for AI_FORMATION |
|
AI_ESCORT:OnAfterFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace) |
FormationLeftLine Handler OnAfter for AI_FORMATION |
|
FormationLeftWing Handler OnAfter for AI_FORMATION |
|
|
FormationLine Handler OnAfter for AI_FORMATION |
|
AI_ESCORT:OnAfterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace) |
FormationRightLine Handler OnAfter for AI_FORMATION |
|
FormationRightWing Handler OnAfter for AI_FORMATION |
|
AI_ESCORT:OnAfterFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace) |
FormationStack Handler OnAfter for AI_FORMATION |
AI_ESCORT:OnAfterFormationTrail(From, Event, To, XStart, XSpace, YStart) |
FormationTrail Handler OnAfter for AI_FORMATION |
AI_ESCORT:OnAfterFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
FormationVic Handler OnAfter for AI_FORMATION |
|
FormationBox Handler OnBefore for AI_FORMATION |
|
|
FormationCenterWing Handler OnBefore for AI_FORMATION |
|
AI_ESCORT:OnBeforeFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace) |
FormationLeftLine Handler OnBefore for AI_FORMATION |
|
FormationLeftWing Handler OnBefore for AI_FORMATION |
|
|
FormationLine Handler OnBefore for AI_FORMATION |
|
|
FormationRightLine Handler OnBefore for AI_FORMATION |
|
|
FormationRightWing Handler OnBefore for AI_FORMATION |
|
AI_ESCORT:OnBeforeFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace) |
FormationStack Handler OnBefore for AI_FORMATION |
AI_ESCORT:OnBeforeFormationTrail(From, Event, To, XStart, XSpace, YStart) |
FormationTrail Handler OnBefore for AI_FORMATION |
AI_ESCORT:OnBeforeFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
FormationVic Handler OnBefore for AI_FORMATION |
|
Which REACTION_ON_THREAT is set to the FollowGroup. |
|
|
If true, nearby targets are reported. |
|
|
This sets your escorts to execute an attack. |
|
|
This sets your escorts to fly in a formation. |
|
|
This sets your escorts to fly a mission. |
|
|
Use the method AI.AI_Formation#AI_FORMATION.SetFlightRandomization() to make the air units in your formation randomize their flight a bit while in formation. |
|
|
Set time interval between updates of the formation. |
|
|
This function is for test, it will put on the frequency of the FollowScheduler a red smoke at the direction vector calculated for the escort to fly to. |
|
AI_ESCORT:__FormationBox(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels) |
FormationBox Asynchronous Trigger for AI_FORMATION |
AI_ESCORT:__FormationCenterWing(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
FormationCenterWing Asynchronous Trigger for AI_FORMATION |
AI_ESCORT:__FormationLeftLine(Delay, XStart, YStart, ZStart, ZSpace) |
FormationLeftLine Asynchronous Trigger for AI_FORMATION |
AI_ESCORT:__FormationLeftWing(Delay, XStart, XSpace, YStart, ZStart, ZSpace) |
FormationLeftWing Asynchronous Trigger for AI_FORMATION |
AI_ESCORT:__FormationLine(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
FormationLine Asynchronous Trigger for AI_FORMATION |
AI_ESCORT:__FormationRightLine(Delay, XStart, YStart, ZStart, ZSpace) |
FormationRightLine Asynchronous Trigger for AI_FORMATION |
AI_ESCORT:__FormationRightWing(Delay, XStart, XSpace, YStart, ZStart, ZSpace) |
FormationRightWing Asynchronous Trigger for AI_FORMATION |
AI_ESCORT:__FormationStack(Delay, XStart, XSpace, YStart, YSpace) |
FormationStack Asynchronous Trigger for AI_FORMATION |
|
FormationTrail Asynchronous Trigger for AI_FORMATION |
|
AI_ESCORT:__FormationVic(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace) |
FormationVic Asynchronous Trigger for AI_FORMATION |
|
Time step between position updates. |
|
|
FormationBox Handler OnAfter for AI_FORMATION |
|
|
FormationCenterWing Handler OnAfter for AI_FORMATION |
|
AI_ESCORT:onafterFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace) |
FormationLeftLine Handler OnAfter for AI_FORMATION |
|
FormationLeftWing Handler OnAfter for AI_FORMATION |
|
|
FormationLine Handler OnAfter for AI_FORMATION |
|
AI_ESCORT:onafterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace) |
FormationRightLine Handler OnAfter for AI_FORMATION |
AI_ESCORT:onafterFormationStack(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace) |
FormationStack Handler OnAfter for AI_FORMATION |
AI_ESCORT:onafterFormationTrail(FollowGroupSet, From, Event, To, XStart, XSpace, YStart) |
FormationTrail Handler OnAfter for AI_FORMATION |
|
FormationVic Handle for AI_FORMATION |
|
|
Stop function. |
|
|
Follow event fuction. |
|
|
Enter following state. |
| Fields and Methods inherited from FSM_SET | Description |
|---|---|
|
Gets the SET_BASE object that the FSM_SET governs. |
|
|
Creates a new FSM_SET object. |
|
| Fields and Methods inherited from FSM | Description |
|---|---|
|
Adds an End state. |
|
|
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task. |
|
|
Adds a score for the FSM to be achieved. |
|
AI_ESCORT:AddScoreProcess(From, Event, State, ScoreText, Score) |
Adds a score for the FSM_PROCESS to be achieved. |
|
Add a new transition rule to the FSM. |
|
|
Get current state. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Get current state. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Check if FSM is in state. |
|
|
Load call backs. |
|
|
Creates a new FSM object. |
|
|
Sets the start state of the FSM. |
|
|
Add to map. |
|
|
Call handler. |
|
|
Create transition. |
|
|
Delayed transition. |
|
|
Event map. |
|
|
Go sub. |
|
|
Handler. |
|
|
Is end state. |
|
|
Sub maps. |
|
|
Check if can do an event. |
|
|
Check if cannot do an event. |
|
|
Check if FSM is in state. |
|
Field(s)
Request assistance from other escorts. This is very useful to let f.e. an escorting ship attack a target detected by an escorting plane...
Function(s)
Measure distance between coordinate player and coordinate detected item.
Defined in:
AI_ESCORT
Parameters:
PlayerUnit
DetectedItem
Defined in:
AI_ESCORT
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 MenuTargets.
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.
Defined in:
AI_ESCORT
Parameter:
#string MenuTextFormat
Optional parameter that shows the menu option text. If no text is given, the default text will be displayed.
Return value:
Defined in:
AI_ESCORT
Parameters:
Formation
...
Defines a menu slot to let the escort to join in a box formation.
This menu will appear under Formation.
Defined in:
AI_ESCORT
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.
#number 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.
#number 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:
Defines a menu slot to let the escort to join in a center wing formation.
This menu will appear under Formation.
Defined in:
AI_ESCORT
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.
#number 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.
#number 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:
Defines a menu slot to let the escort to join in a leFt wing formation.
This menu will appear under Formation.
Defined in:
AI_ESCORT
Parameters:
#number XStart
The start position on the X-axis in meters for the first group.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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:
Defines a menu slot to let the escort to join in a left wing formation.
This menu will appear under Formation.
Defined in:
AI_ESCORT
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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:
Defines a menu slot to let the escort to join in a right line formation.
This menu will appear under Formation.
Defined in:
AI_ESCORT
Parameters:
#number XStart
The start position on the X-axis in meters for the first group.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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:
Defines a menu slot to let the escort to join in a right wing formation.
This menu will appear under Formation.
Defined in:
AI_ESCORT
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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:
Defines a menu slot to let the escort to join in a stacked formation.
This menu will appear under Formation.
Defined in:
AI_ESCORT
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.
#number 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:
Defines a menu slot to let the escort to join in a trail formation.
This menu will appear under Formation.
Defined in:
AI_ESCORT
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.
#number YStart
The start position on the Y-axis in meters for the first group.
Return value:
Defines a menu slot to let the escort to join in a vic formation.
This menu will appear under Formation.
Defined in:
AI_ESCORT
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.
#number 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.
#number 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:
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.
Defined in:
AI_ESCORT
Parameters:
DCS#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.
DCS#Time Speed
Optional parameter that lets the escort orbit with a specified speed. The default value is a speed that is average for the type of airplane or helicopter.
#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:
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.
Defined in:
AI_ESCORT
Parameters:
DCS#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.
DCS#Time Speed
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:
Defines --- Defines a menu slot to let the escort to join formation.
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 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 scan for targets at a certain height for a certain time in seconds.
This menu will appear under Scan targets.
Defined in:
AI_ESCORT
Parameters:
DCS#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.
DCS#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:
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.
Defined in:
AI_ESCORT
Parameter:
#string MenuTextFormat
Optional parameter that shows the menu option text. If no text is given, the default text will be displayed.
Return value:
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.
Defined in:
AI_ESCORT
Parameter:
DCS#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:
Defines the default menus for airplanes.
Defined in:
AI_ESCORT
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.
#number 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.
#number 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:
Defines the default menus for helicopters.
Defined in:
AI_ESCORT
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.
#number 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.
#number 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:
AI_ESCORT class constructor for an AI group
Defined in:
AI_ESCORT
Parameters:
Wrapper.Client#CLIENT EscortUnit
The client escorted by the EscortGroup.
Core.Set#SET_GROUP EscortGroupSet
The set of group AI escorting the EscortUnit.
#string EscortName
Name of the escort.
#string EscortBriefing
A text showing the AI_ESCORT briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown.
Return value:
self
Usage:
-- Declare a new EscortPlanes object as follows:
-- First find the GROUP object and the CLIENT object.
local EscortUnit = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
local EscortGroup = SET_GROUP:New():FilterPrefixes("Escort"):FilterOnce() -- The the group name of the escorts contains "Escort".
-- Now use these 2 objects to construct the new EscortPlanes object.
EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
EscortPlanes:MenusAirplanes() -- create menus for airplanes
EscortPlanes:__Start(2)
Set a Detection method for the EscortUnit to be reported upon.
Detection methods are based on the derived classes from DETECTION_BASE.
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Sets a menu slot to join formation for an escort.
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Defined in:
AI_ESCORT
Parameter:
EscortGroup
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.
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Parameter:
Formation
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Parameter:
ReportType
This function is for test, it will put on the frequency of the FollowScheduler a red smoke at the direction vector calculated for the escort to fly to.
This allows to visualize where the escort is flying to.
Defined in:
AI_ESCORT
Parameter:
#boolean SmokeDirection
If true, then the direction vector will be smoked.
Defined in:
AI_ESCORT
Parameters:
Wrapper.Group#GROUP EscortGroup
The escort group that will attack the detected item.
Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
@param #AI_ESCORT self @param Wrapper.Group#GROUP EscortGroup The escort group that will attack the detected item. @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
Defined in:
AI_ESCORT
Parameters:
EscortGroup
DetectedItem
Lets the escort to join in a stacked formation.
Defined in:
AI_ESCORT
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.
#number 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.
EscortGroup
Return value:
Lets the escort to join in a trail formation.
Defined in:
AI_ESCORT
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.
#number YStart
The start position on the Y-axis in meters for the first group.
EscortGroup
Return value:
Defined in:
AI_ESCORT
Parameters:
EscortGroup
Color
Message
Defined in:
AI_ESCORT
Parameter:
TargetType
Defined in:
AI_ESCORT
Parameter:
DetectedItem
Defined in:
AI_ESCORT
Parameters:
Color
Message
Defined in:
AI_ESCORT
Parameters:
XStart
XSpace
YStart
YSpace
Defined in:
AI_ESCORT
Parameters:
XStart
XSpace
YStart
@param #AI_ESCORT self @param Wrapper.Group#GROUP OrbitGroup @param #number OrbitHeight @param #number OrbitSeconds
Defined in:
AI_ESCORT
Parameters:
OrbitGroup
OrbitHeight
OrbitSeconds
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Parameter:
EscortROEMessage
Defined in:
AI_ESCORT
Parameter:
EscortROEMessage
Defined in:
AI_ESCORT
Parameter:
EscortROEMessage
Defined in:
AI_ESCORT
Parameter:
EscortROEMessage
Defined in:
AI_ESCORT
Parameter:
EscortROTMessage
Defined in:
AI_ESCORT
Parameter:
EscortROTMessage
Defined in:
AI_ESCORT
Parameter:
EscortROTMessage
Defined in:
AI_ESCORT
Parameter:
EscortROTMessage
Defined in:
AI_ESCORT
Report Targets Scheduler for the flight.
The report is generated from the perspective of the player plane, and is reported by the first plane in the formation set.
Defined in:
AI_ESCORT
Parameters:
Color
Message
Defined in:
AI_ESCORT
Parameter:
ReportTargets
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
@param #AI_ESCORT self @param Wrapper.Group#GROUP OrbitGroup @param Wrapper.Group#GROUP EscortGroup @param #number OrbitHeight @param #number OrbitSeconds
Defined in:
AI_ESCORT
Parameters:
OrbitGroup
EscortGroup
OrbitHeight
OrbitSeconds
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Defined in:
AI_ESCORT
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Defined in:
AI_ESCORT
Parameters:
EscortGroup
EscortROEFunction
EscortROEMessage
Defined in:
AI_ESCORT
Parameters:
EscortGroup
EscortROTFunction
EscortROTMessage
Defined in:
AI_ESCORT
Parameter:
EscortGroup
Report Targets Scheduler.
@param #AI_ESCORT self @param Wrapper.Group#GROUP EscortGroup @param #number WayPoint
Defined in:
AI_ESCORT
Parameters:
EscortGroup
WayPoint
Resume Scheduler.
Defined in:
AI_ESCORT
Parameter:
ScanDuration
Defined in:
AI_ESCORT
Parameters:
EscortGroup
Color
Message
@param Wrapper.Group#GROUP EscortGroup @param #AI_ESCORT self
Defined in:
AI_ESCORT
Parameters:
EscortGroup
self
@param #AI_ESCORT self @param Core.Set#SET_GROUP EscortGroupSet
Defined in:
AI_ESCORT
Parameter:
EscortGroupSet
@param #AI_ESCORT self @param Core.Set#SET_GROUP EscortGroupSet
Defined in:
AI_ESCORT
Parameter:
EscortGroupSet
Field(s)
Request assistance from other escorts. This is very useful to let f.e. an escorting ship attack a target detected by an escorting plane...
Function(s)
Follow me.
Defined in:
Parameters:
Wrapper.Group#GROUP FollowGroup
Follow group.
Wrapper.Unit#UNIT ClientUnit
Client Unit.
DCS#Time CT1
Time
DCS#Vec3 CV1
Vec3
DCS#Time CT2
Time
DCS#Vec3 CV2
Vec3
FormationBox Trigger for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationCenterWing Trigger for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationLeftLine Trigger for AI_FORMATION
Defined in:
Parameters:
#number XStart
The start position on the X-axis in meters for the first group.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationLeftWing Trigger for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationLine Trigger for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationRightLine Trigger for AI_FORMATION
Defined in:
Parameters:
#number XStart
The start position on the X-axis in meters for the first group.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationRightWing Trigger for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationStack Trigger for AI_FORMATION
Defined in:
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.
#number 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.
FormationTrail Trigger for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
FormationVic Trigger for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
Gets your escorts to flight mode.
AI_FORMATION class constructor for an AI group
Defined in:
Parameters:
Wrapper.Unit#UNIT FollowUnit
The UNIT leading the FolllowGroupSet.
Core.Set#SET_GROUP FollowGroupSet
The group AI escorting the FollowUnit.
#string FollowName
Name of the escort.
#string FollowBriefing
Briefing.
Return value:
self
FormationBox Handler OnAfter for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationCenterWing Handler OnAfter for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationLeftLine Handler OnAfter for AI_FORMATION
Defined in:
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 YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationLeftWing Handler OnAfter for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationLine Handler OnAfter for AI_FORMATION
Defined in:
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.
#number 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.
#number 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_ESCORT:OnAfterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)
FormationRightLine Handler OnAfter for AI_FORMATION
Defined in:
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 YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationRightWing Handler OnAfter for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationStack Handler OnAfter for AI_FORMATION
Defined in:
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.
#number 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.
FormationTrail Handler OnAfter for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
FormationVic Handler OnAfter for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationBox Handler OnBefore for AI_FORMATION
Defined in:
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.
#number 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.
#number 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:
FormationCenterWing Handler OnBefore for AI_FORMATION
Defined in:
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.
#number 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.
#number 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:
AI_ESCORT:OnBeforeFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)
FormationLeftLine Handler OnBefore for AI_FORMATION
Defined in:
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 YStart
The start position on the Y-axis in meters for the first group.
#number 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:
FormationLeftWing Handler OnBefore for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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:
FormationLine Handler OnBefore for AI_FORMATION
Defined in:
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.
#number 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.
#number 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:
FormationRightLine Handler OnBefore for AI_FORMATION
Defined in:
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 YStart
The start position on the Y-axis in meters for the first group.
#number 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:
FormationRightWing Handler OnBefore for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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:
FormationStack Handler OnBefore for AI_FORMATION
Defined in:
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.
#number 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:
FormationTrail Handler OnBefore for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
Return value:
#boolean:
FormationVic Handler OnBefore for AI_FORMATION
Defined in:
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.
#number 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.
#number 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:
This sets your escorts to execute an attack.
This sets your escorts to fly in a formation.
This sets your escorts to fly a mission.
Use the method AI.AI_Formation#AI_FORMATION.SetFlightRandomization() to make the air units in your formation randomize their flight a bit while in formation.
Defined in:
Parameter:
#number FlightRandomization
The formation flying errors that pilots can make while in formation. Is a range set in meters.
Return value:
Set time interval between updates of the formation.
Defined in:
Parameter:
#number dt
Time step in seconds between formation updates. Default is every 0.5 seconds.
Return value:
This function is for test, it will put on the frequency of the FollowScheduler a red smoke at the direction vector calculated for the escort to fly to.
This allows to visualize where the escort is flying to.
Defined in:
Parameter:
#boolean SmokeDirection
If true, then the direction vector will be smoked.
Return value:
FormationBox Asynchronous Trigger for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationCenterWing Asynchronous Trigger for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationLeftLine Asynchronous Trigger for AI_FORMATION
Defined in:
Parameters:
#number Delay
#number XStart
The start position on the X-axis in meters for the first group.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationLeftWing Asynchronous Trigger for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationLine Asynchronous Trigger for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationRightLine Asynchronous Trigger for AI_FORMATION
Defined in:
Parameters:
#number Delay
#number XStart
The start position on the X-axis in meters for the first group.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationRightWing Asynchronous Trigger for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationStack Asynchronous Trigger for AI_FORMATION
Defined in:
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.
#number 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.
FormationTrail Asynchronous Trigger for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
FormationVic Asynchronous Trigger for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationBox Handler OnAfter for AI_FORMATION
Defined in:
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.
#number 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.
#number 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:
FormationCenterWing Handler OnAfter for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
FormationLeftLine Handler OnAfter for AI_FORMATION
Defined in:
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 YStart
The start position on the Y-axis in meters for the first group.
#number 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:
FormationLeftWing Handler OnAfter for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
#number 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.
FormationLine Handler OnAfter for AI_FORMATION
Defined in:
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.
#number 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.
#number 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.
Formation
Return value:
AI_ESCORT:onafterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)
FormationRightLine Handler OnAfter for AI_FORMATION
Defined in:
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 YStart
The start position on the Y-axis in meters for the first group.
#number 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:
Defined in:
Parameters:
FollowGroupSet
From
Event
To
XStart
XSpace
YStart
ZStart
ZSpace
FormationStack Handler OnAfter for AI_FORMATION
Defined in:
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.
#number 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:
FormationTrail Handler OnAfter for AI_FORMATION
Defined in:
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.
#number YStart
The start position on the Y-axis in meters for the first group.
Return value:
FormationVic Handle for AI_FORMATION
Defined in:
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.
#number 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.
#number 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:
Stop function.
Formation will not be updated any more.
Defined in:
Parameters:
Core.Set#SET_GROUP FollowGroupSet
The following set of groups.
#string From
From state.
#string Event
Event.
#string To
The to state.
Follow event fuction.
Check if coming from state "stopped". If so the transition is rejected.
Defined in:
Parameters:
Core.Set#SET_GROUP FollowGroupSet
The following set of groups.
#string From
From state.
#string Event
Event.
#string To
The to state.
Enter following state.
Defined in:
Parameters:
Core.Set#SET_GROUP FollowGroupSet
The following set of groups.
#string From
From state.
#string Event
Event.
#string To
The to state.
Field(s)
Request assistance from other escorts. This is very useful to let f.e. an escorting ship attack a target detected by an escorting plane...
Function(s)
Gets the SET_BASE object that the FSM_SET governs.
Creates a new FSM_SET object.
Defined in:
Parameters:
#table FSMT
Finite State Machine Table
Set_SET_BASE
FSMSet (optional) The Set object that the FSM_SET governs.
FSMSet
Return value:
Field(s)
Request assistance from other escorts. This is very useful to let f.e. an escorting ship attack a target detected by an escorting plane...
Function(s)
Adds an End state.
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
Core.Fsm#FSM_PROCESS Process
An sub-process FSM.
#table ReturnEvents
A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.
Return value:
The SubFSM.
Adds a score for the FSM to be achieved.
Defined in:
Parameters:
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Adds a score for the FSM_PROCESS to be achieved.
Defined in:
Parameters:
#string From
is the From State of the main process.
#string Event
is the Event of the main process.
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Add a new transition rule to the FSM.
A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
#string To
The To state.
Get current state.
Returns the End states.
Returns a table of the SubFSM rules defined within the FSM.
Returns a table with the scores defined.
Returns the start state of the FSM.
Get current state.
Returns a table with the Subs defined.
Returns a table of the transition rules defined within the FSM.
Check if FSM is in state.
Defined in:
Parameter:
#string State
State name.
Return value:
#boolean:
If true, FSM is in this state.
Load call backs.
Sets the start state of the FSM.
Add to map.
Call handler.
Defined in:
Parameters:
#string step
Step "onafter", "onbefore", "onenter", "onleave".
#string trigger
Trigger.
#table params
Parameters.
#string EventName
Event name.
Return value:
Value.
Create transition.
Defined in:
Parameter:
#string EventName
Event name.
Return value:
#function:
Function.
Delayed transition.
Defined in:
Parameter:
#string EventName
Event name.
Return value:
#function:
Function.
Event map.
Go sub.
Defined in:
Parameters:
#string ParentFrom
Parent from state.
#string ParentEvent
Parent event name.
Return value:
#table:
Subs.
Handler.
Is end state.
Defined in:
Parameter:
#string Current
Current state name.
Return values:
#table:
FSM parent.
#string:
Event name.
Sub maps.
Check if can do an event.
Defined in:
Parameter:
#string e
Event name.
Return values:
#boolean:
If true, FSM can do the event.
#string:
To state.
Check if cannot do an event.
Defined in:
Parameter:
#string e
Event name.
Return value:
#boolean:
If true, FSM cannot do the event.
Check if FSM is in state.
Defined in:
Parameters:
#string State
State name.
state
Return value:
#boolean:
If true, FSM is in this state.