mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
2737 lines
60 KiB
HTML
2737 lines
60 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html>
|
|
<head>
|
|
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="product">
|
|
<div id="product_logo"></div>
|
|
<div id="product_name"><big><b></b></big></div>
|
|
<div id="product_description"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="navigation">
|
|
<h2>Modules</h2>
|
|
<ul><li>
|
|
<a href="index.html">index</a>
|
|
</li></ul>
|
|
<ul>
|
|
<li><a href="AI_A2A.html">AI_A2A</a></li>
|
|
<li><a href="AI_A2A_Cap.html">AI_A2A_Cap</a></li>
|
|
<li><a href="AI_A2A_Dispatcher.html">AI_A2A_Dispatcher</a></li>
|
|
<li><a href="AI_A2A_GCI.html">AI_A2A_GCI</a></li>
|
|
<li><a href="AI_A2A_Patrol.html">AI_A2A_Patrol</a></li>
|
|
<li><a href="AI_Bai.html">AI_Bai</a></li>
|
|
<li><a href="AI_Balancer.html">AI_Balancer</a></li>
|
|
<li><a href="AI_Cap.html">AI_Cap</a></li>
|
|
<li><a href="AI_Cas.html">AI_Cas</a></li>
|
|
<li><a href="AI_Formation.html">AI_Formation</a></li>
|
|
<li><a href="AI_Patrol.html">AI_Patrol</a></li>
|
|
<li><a href="ATC_Ground.html">ATC_Ground</a></li>
|
|
<li><a href="Account.html">Account</a></li>
|
|
<li><a href="Airbase.html">Airbase</a></li>
|
|
<li><a href="Assign.html">Assign</a></li>
|
|
<li><a href="Base.html">Base</a></li>
|
|
<li><a href="Cargo.html">Cargo</a></li>
|
|
<li><a href="CleanUp.html">CleanUp</a></li>
|
|
<li><a href="Client.html">Client</a></li>
|
|
<li><a href="CommandCenter.html">CommandCenter</a></li>
|
|
<li><a href="Controllable.html">Controllable</a></li>
|
|
<li><a href="DCSAirbase.html">DCSAirbase</a></li>
|
|
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</a></li>
|
|
<li><a href="DCSCommand.html">DCSCommand</a></li>
|
|
<li><a href="DCSController.html">DCSController</a></li>
|
|
<li><a href="DCSGroup.html">DCSGroup</a></li>
|
|
<li><a href="DCSObject.html">DCSObject</a></li>
|
|
<li><a href="DCSTask.html">DCSTask</a></li>
|
|
<li><a href="DCSTypes.html">DCSTypes</a></li>
|
|
<li><a href="DCSUnit.html">DCSUnit</a></li>
|
|
<li><a href="DCSVec3.html">DCSVec3</a></li>
|
|
<li><a href="DCSWorld.html">DCSWorld</a></li>
|
|
<li><a href="DCSZone.html">DCSZone</a></li>
|
|
<li><a href="DCScountry.html">DCScountry</a></li>
|
|
<li><a href="DCStimer.html">DCStimer</a></li>
|
|
<li><a href="DCStrigger.html">DCStrigger</a></li>
|
|
<li><a href="Database.html">Database</a></li>
|
|
<li><a href="Designate.html">Designate</a></li>
|
|
<li><a href="Detection.html">Detection</a></li>
|
|
<li><a href="DetectionManager.html">DetectionManager</a></li>
|
|
<li>Escort</li>
|
|
<li><a href="Event.html">Event</a></li>
|
|
<li><a href="Fsm.html">Fsm</a></li>
|
|
<li><a href="Goal.html">Goal</a></li>
|
|
<li><a href="Group.html">Group</a></li>
|
|
<li><a href="Identifiable.html">Identifiable</a></li>
|
|
<li><a href="Menu.html">Menu</a></li>
|
|
<li><a href="Message.html">Message</a></li>
|
|
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
|
|
<li><a href="Mission.html">Mission</a></li>
|
|
<li><a href="Movement.html">Movement</a></li>
|
|
<li><a href="Object.html">Object</a></li>
|
|
<li><a href="Point.html">Point</a></li>
|
|
<li><a href="Positionable.html">Positionable</a></li>
|
|
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
|
|
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
|
|
<li><a href="Protect.html">Protect</a></li>
|
|
<li><a href="Radio.html">Radio</a></li>
|
|
<li><a href="Rat.html">Rat</a></li>
|
|
<li><a href="Route.html">Route</a></li>
|
|
<li><a href="Scenery.html">Scenery</a></li>
|
|
<li><a href="ScheduleDispatcher.html">ScheduleDispatcher</a></li>
|
|
<li><a href="Scheduler.html">Scheduler</a></li>
|
|
<li><a href="Scoring.html">Scoring</a></li>
|
|
<li><a href="Sead.html">Sead</a></li>
|
|
<li><a href="Set.html">Set</a></li>
|
|
<li><a href="Settings.html">Settings</a></li>
|
|
<li><a href="Smoke.html">Smoke</a></li>
|
|
<li><a href="Spawn.html">Spawn</a></li>
|
|
<li><a href="SpawnStatic.html">SpawnStatic</a></li>
|
|
<li><a href="Spot.html">Spot</a></li>
|
|
<li><a href="Static.html">Static</a></li>
|
|
<li><a href="StaticObject.html">StaticObject</a></li>
|
|
<li><a href="Task.html">Task</a></li>
|
|
<li><a href="TaskZoneCapture.html">TaskZoneCapture</a></li>
|
|
<li><a href="Task_A2A.html">Task_A2A</a></li>
|
|
<li><a href="Task_A2A_Dispatcher.html">Task_A2A_Dispatcher</a></li>
|
|
<li><a href="Task_A2G.html">Task_A2G</a></li>
|
|
<li><a href="Task_A2G_Dispatcher.html">Task_A2G_Dispatcher</a></li>
|
|
<li><a href="Task_Cargo.html">Task_Cargo</a></li>
|
|
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
|
|
<li><a href="Unit.html">Unit</a></li>
|
|
<li><a href="UserFlag.html">UserFlag</a></li>
|
|
<li><a href="UserSound.html">UserSound</a></li>
|
|
<li><a href="Utils.html">Utils</a></li>
|
|
<li><a href="Velocity.html">Velocity</a></li>
|
|
<li><a href="Zone.html">Zone</a></li>
|
|
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
|
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
|
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
|
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
|
<li><a href="env.html">env</a></li>
|
|
<li><a href="land.html">land</a></li>
|
|
<li><a href="routines.html">routines</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="content">
|
|
<h1>Module <code>Escort</code></h1>
|
|
|
|
<p><strong>Functional</strong> -- Taking the lead of AI escorting your flight.</p>
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
<h1><a href="##(ESCORT)">#ESCORT</a> class</h1>
|
|
<p>The <a href="##(ESCORT)">#ESCORT</a> class allows you to interact with escorting AI on your flight and take the lead.
|
|
Each escorting group can be commanded with a whole set of radio commands (radio menu in your flight, and then F10).</p>
|
|
|
|
<p>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.</p>
|
|
|
|
<h1>RADIO MENUs that can be created:</h1>
|
|
<p>Find a summary below of the current available commands:</p>
|
|
|
|
<h2>Navigation ...:</h2>
|
|
<p>Escort group navigation functions:</p>
|
|
|
|
<ul>
|
|
<li><strong>"Join-Up and Follow at x meters":</strong> The escort group fill follow you at about x meters, and they will follow you.</li>
|
|
<li><strong>"Flare":</strong> Provides menu commands to let the escort group shoot a flare in the air in a color.</li>
|
|
<li><strong>"Smoke":</strong> 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.</li>
|
|
</ul>
|
|
|
|
<h2>Hold position ...:</h2>
|
|
<p>Escort group navigation functions:</p>
|
|
|
|
<ul>
|
|
<li><strong>"At current location":</strong> Stops the escort group and they will hover 30 meters above the ground at the position they stopped.</li>
|
|
<li><strong>"At client location":</strong> Stops the escort group and they will hover 30 meters above the ground at the position they stopped.</li>
|
|
</ul>
|
|
|
|
<h2>Report targets ...:</h2>
|
|
<p>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).</p>
|
|
|
|
<ul>
|
|
<li><strong>"Report now":</strong> Will report the current detected targets.</li>
|
|
<li><strong>"Report targets on":</strong> Will make the escort group to report detected targets and will fill the "Attack nearby targets" menu list.</li>
|
|
<li><strong>"Report targets off":</strong> Will stop detecting targets.</li>
|
|
</ul>
|
|
|
|
<h2>Scan targets ...:</h2>
|
|
<p>Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or defined task.</p>
|
|
|
|
<ul>
|
|
<li><strong>"Scan targets 30 seconds":</strong> Scan 30 seconds for targets.</li>
|
|
<li><strong>"Scan targets 60 seconds":</strong> Scan 60 seconds for targets.</li>
|
|
</ul>
|
|
|
|
<h2>Attack targets ...:</h2>
|
|
<p>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.</p>
|
|
|
|
<h2>Request assistance from ...:</h2>
|
|
<p>This menu item will list all detected targets within a 15km range, as with the menu item <strong>Attack Targets</strong>.
|
|
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.</p>
|
|
|
|
<h2>ROE ...:</h2>
|
|
<p>Sets the Rules of Engagement (ROE) of the escort group when in flight.</p>
|
|
|
|
<ul>
|
|
<li><strong>"Hold Fire":</strong> The escort group will hold fire.</li>
|
|
<li><strong>"Return Fire":</strong> The escort group will return fire.</li>
|
|
<li><strong>"Open Fire":</strong> The escort group will open fire on designated targets.</li>
|
|
<li><strong>"Weapon Free":</strong> The escort group will engage with any target.</li>
|
|
</ul>
|
|
|
|
<h2>Evasion ...:</h2>
|
|
<p>Will define the evasion techniques that the escort group will perform during flight or combat.</p>
|
|
|
|
<ul>
|
|
<li><strong>"Fight until death":</strong> The escort group will have no reaction to threats.</li>
|
|
<li><strong>"Use flares, chaff and jammers":</strong> The escort group will use passive defense using flares and jammers. No evasive manoeuvres are executed.</li>
|
|
<li><strong>"Evade enemy fire":</strong> The rescort group will evade enemy fire before firing.</li>
|
|
<li><strong>"Go below radar and evade fire":</strong> The escort group will perform evasive vertical manoeuvres.</li>
|
|
</ul>
|
|
|
|
<h2>Resume Mission ...:</h2>
|
|
<p>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.</p>
|
|
|
|
<h1>ESCORT construction methods.</h1>
|
|
<p>Create a new SPAWN object with the <a href="##(ESCORT).New">ESCORT.New</a> method:</p>
|
|
|
|
<ul>
|
|
<li><a href="##(ESCORT).New">ESCORT.New</a>: Creates a new ESCORT object from a <a href="Group.html##(GROUP)">Group#GROUP</a> for a <a href="Client.html##(CLIENT)">Client#CLIENT</a>, with an optional briefing text.</li>
|
|
</ul>
|
|
|
|
<h1>ESCORT initialization methods.</h1>
|
|
<p>The following menus are created within the RADIO MENU (F10) of an active unit hosted by a player:</p>
|
|
|
|
<ul>
|
|
<li><a href="##(ESCORT).MenuFollowAt">ESCORT.MenuFollowAt</a>: Creates a menu to make the escort follow the client.</li>
|
|
<li><a href="##(ESCORT).MenuHoldAtEscortPosition">ESCORT.MenuHoldAtEscortPosition</a>: Creates a menu to hold the escort at its current position.</li>
|
|
<li><a href="##(ESCORT).MenuHoldAtLeaderPosition">ESCORT.MenuHoldAtLeaderPosition</a>: Creates a menu to hold the escort at the client position.</li>
|
|
<li><a href="##(ESCORT).MenuScanForTargets">ESCORT.MenuScanForTargets</a>: Creates a menu so that the escort scans targets.</li>
|
|
<li><a href="##(ESCORT).MenuFlare">ESCORT.MenuFlare</a>: Creates a menu to disperse flares.</li>
|
|
<li><a href="##(ESCORT).MenuSmoke">ESCORT.MenuSmoke</a>: Creates a menu to disparse smoke.</li>
|
|
<li><a href="##(ESCORT).MenuReportTargets">ESCORT.MenuReportTargets</a>: Creates a menu so that the escort reports targets.</li>
|
|
<li><a href="##(ESCORT).MenuReportPosition">ESCORT.MenuReportPosition</a>: Creates a menu so that the escort reports its current position from bullseye.</li>
|
|
<li><a href="##(ESCORT).MenuAssistedAttack">ESCORT.MenuAssistedAttack</a>: Creates a menu structure so that the escort can resume from a waypoint.</li>
|
|
</ul>
|
|
|
|
|
|
|
|
<h2>Usage:</h2>
|
|
<pre class="example"><code>-- Declare a new EscortPlanes object as follows:
|
|
|
|
-- First find the GROUP object and the CLIENT object.
|
|
local EscortClient = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
|
|
local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
|
|
|
|
-- Now use these 2 objects to construct the new EscortPlanes object.
|
|
EscortPlanes = ESCORT:New( EscortClient, 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." )
|
|
|
|
|
|
</code></pre>
|
|
|
|
<h2>Global(s)</h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#ESCORT">ESCORT</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#_Resume">_Resume(EscortGroup)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a id="#(ESCORT)">Type <code>ESCORT</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).CT1">ESCORT.CT1</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).ClassName">ESCORT.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).Detection">ESCORT.Detection</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortBriefing">ESCORT.EscortBriefing</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortClient">ESCORT.EscortClient</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortGroup">ESCORT.EscortGroup</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenu">ESCORT.EscortMenu</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuAttackNearbyTargets">ESCORT.EscortMenuAttackNearbyTargets</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuEvasion">ESCORT.EscortMenuEvasion</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuEvasionEvadeFire">ESCORT.EscortMenuEvasionEvadeFire</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuEvasionNoReaction">ESCORT.EscortMenuEvasionNoReaction</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuEvasionPassiveDefense">ESCORT.EscortMenuEvasionPassiveDefense</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuFlare">ESCORT.EscortMenuFlare</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuFlareGreen">ESCORT.EscortMenuFlareGreen</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuFlareRed">ESCORT.EscortMenuFlareRed</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuFlareWhite">ESCORT.EscortMenuFlareWhite</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuFlareYellow">ESCORT.EscortMenuFlareYellow</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuHold">ESCORT.EscortMenuHold</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuHoldAtLeaderPosition">ESCORT.EscortMenuHoldAtLeaderPosition</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuHoldPosition">ESCORT.EscortMenuHoldPosition</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuJoinUpAndFollow">ESCORT.EscortMenuJoinUpAndFollow</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuOptionEvasionVertical">ESCORT.EscortMenuOptionEvasionVertical</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuROE">ESCORT.EscortMenuROE</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuROEHoldFire">ESCORT.EscortMenuROEHoldFire</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuROEOpenFire">ESCORT.EscortMenuROEOpenFire</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuROEReturnFire">ESCORT.EscortMenuROEReturnFire</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuROEWeaponFree">ESCORT.EscortMenuROEWeaponFree</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuReportNavigation">ESCORT.EscortMenuReportNavigation</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuReportNearbyTargets">ESCORT.EscortMenuReportNearbyTargets</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuReportNearbyTargetsNow">ESCORT.EscortMenuReportNearbyTargetsNow</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuReportNearbyTargetsOff">ESCORT.EscortMenuReportNearbyTargetsOff</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuReportNearbyTargetsOn">ESCORT.EscortMenuReportNearbyTargetsOn</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuResumeMission">ESCORT.EscortMenuResumeMission</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuScan">ESCORT.EscortMenuScan</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuScanForTargets">ESCORT.EscortMenuScanForTargets</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuSmoke">ESCORT.EscortMenuSmoke</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuSmokeBlue">ESCORT.EscortMenuSmokeBlue</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuSmokeGreen">ESCORT.EscortMenuSmokeGreen</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuSmokeOrange">ESCORT.EscortMenuSmokeOrange</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuSmokeRed">ESCORT.EscortMenuSmokeRed</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuSmokeWhite">ESCORT.EscortMenuSmokeWhite</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMenuTargetAssistance">ESCORT.EscortMenuTargetAssistance</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortMode">ESCORT.EscortMode</a></td>
|
|
<td class="summary">
|
|
<p>The mode the escort is in.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortName">ESCORT.EscortName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).EscortSetGroup">ESCORT.EscortSetGroup</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).FollowDistance">ESCORT.FollowDistance</a></td>
|
|
<td class="summary">
|
|
<p>The current follow distance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).FollowScheduler">ESCORT.FollowScheduler</a></td>
|
|
<td class="summary">
|
|
<p>The instance of the SCHEDULER class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).FunctionalMENU_GROUPDETECTION_BASE">ESCORT.FunctionalMENU_GROUPDETECTION_BASE</a></td>
|
|
<td class="summary">
|
|
<p>Detection</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).GT1">ESCORT.GT1</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).JoinUpAndFollow">ESCORT:JoinUpAndFollow(EscortGroup, EscortClient, Distance)</a></td>
|
|
<td class="summary">
|
|
<p>JoinsUp and Follows a CLIENT.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MODE">ESCORT.MODE</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuAssistedAttack">ESCORT:MenuAssistedAttack()</a></td>
|
|
<td class="summary">
|
|
<p>Defines a menu slot to let the escort attack its detected targets using assisted attack from another escort joined also with the client.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuEvasion">ESCORT:MenuEvasion(MenuTextFormat)</a></td>
|
|
<td class="summary">
|
|
<p>Defines a menu to let the escort set its evasion when under threat.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuFlare">ESCORT:MenuFlare(MenuTextFormat)</a></td>
|
|
<td class="summary">
|
|
<p>Defines a menu slot to let the escort disperse a flare in a certain color.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuFollowAt">ESCORT:MenuFollowAt(Distance)</a></td>
|
|
<td class="summary">
|
|
<p>Defines a menu slot to let the escort Join and Follow you at a certain distance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuHoldAtEscortPosition">ESCORT:MenuHoldAtEscortPosition(Height, Seconds, MenuTextFormat)</a></td>
|
|
<td class="summary">
|
|
<p>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.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuHoldAtLeaderPosition">ESCORT:MenuHoldAtLeaderPosition(Height, Seconds, MenuTextFormat)</a></td>
|
|
<td class="summary">
|
|
<p>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.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuROE">ESCORT:MenuROE(MenuTextFormat)</a></td>
|
|
<td class="summary">
|
|
<p>Defines a menu to let the escort set its rules of engagement.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuReportTargets">ESCORT:MenuReportTargets(Seconds)</a></td>
|
|
<td class="summary">
|
|
<p>Defines a menu slot to let the escort report their current detected targets with a specified time interval in seconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuResumeMission">ESCORT:MenuResumeMission()</a></td>
|
|
<td class="summary">
|
|
<p>Defines a menu to let the escort resume its mission from a waypoint on its route.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuScanForTargets">ESCORT:MenuScanForTargets(Height, Seconds, MenuTextFormat)</a></td>
|
|
<td class="summary">
|
|
<p>Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).MenuSmoke">ESCORT:MenuSmoke(MenuTextFormat)</a></td>
|
|
<td class="summary">
|
|
<p>Defines a menu slot to let the escort disperse a smoke in a certain color.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).Menus">ESCORT:Menus()</a></td>
|
|
<td class="summary">
|
|
<p>Defines the default menus</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).New">ESCORT:New(EscortClient, EscortGroup, EscortName, EscortBriefing)</a></td>
|
|
<td class="summary">
|
|
<p>ESCORT class constructor for an AI group</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).OptionROE">ESCORT.OptionROE</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).OptionReactionOnThreat">ESCORT.OptionReactionOnThreat</a></td>
|
|
<td class="summary">
|
|
<p>Which REACTION<em>ON</em>THREAT is set to the EscortGroup.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).RegisterRoute">ESCORT:RegisterRoute()</a></td>
|
|
<td class="summary">
|
|
<p>Registers the waypoints</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).ReportTargets">ESCORT.ReportTargets</a></td>
|
|
<td class="summary">
|
|
<p>If true, nearby targets are reported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).ReportTargetsScheduler">ESCORT.ReportTargetsScheduler</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).SetDetection">ESCORT:SetDetection(Detection)</a></td>
|
|
<td class="summary">
|
|
<p>Set a Detection method for the EscortClient to be reported upon.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).SmokeDirectionVector">ESCORT.SmokeDirectionVector</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).Targets">ESCORT.Targets</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).TaskPoints">ESCORT.TaskPoints</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT).TestSmokeDirectionVector">ESCORT:TestSmokeDirectionVector(SmokeDirection)</a></td>
|
|
<td class="summary">
|
|
<p>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.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._AssistTarget">ESCORT._AssistTarget(DetectedItemID, self, EscortGroupAttack)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._AttackTarget">ESCORT:_AttackTarget(DetectedItemID)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._Flare">ESCORT._Flare(MenuParam, self, Color, Message)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._FollowScheduler">ESCORT:_FollowScheduler()</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._HoldPosition">ESCORT._HoldPosition(MenuParam, self, OrbitGroup, OrbitHeight, OrbitSeconds)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._JoinUpAndFollow">ESCORT._JoinUpAndFollow(MenuParam, self, Distance)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._ROE">ESCORT._ROE(MenuParam, self, EscortROEFunction, EscortROEMessage)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._ROT">ESCORT._ROT(MenuParam, self, EscortROTFunction, EscortROTMessage)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._ReportNearbyTargetsNow">ESCORT._ReportNearbyTargetsNow(MenuParam, self)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._ReportTargetsScheduler">ESCORT:_ReportTargetsScheduler()</a></td>
|
|
<td class="summary">
|
|
<p>Report Targets Scheduler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._ResumeMission">ESCORT._ResumeMission(MenuParam, self, WayPoint)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._ScanTargets">ESCORT._ScanTargets(MenuParam, self, ScanDuration)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._Smoke">ESCORT._Smoke(MenuParam, self, Color, Message)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT)._SwitchReportNearbyTargets">ESCORT:_SwitchReportNearbyTargets(ReportTargets)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(ESCORT.MODE)">Type <code>ESCORT.MODE</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT.MODE).FOLLOW">ESCORT.MODE.FOLLOW</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ESCORT.MODE).MISSION">ESCORT.MODE.MISSION</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(MENUPARAM)">Type <code>MENUPARAM</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(MENUPARAM).Distance">MENUPARAM.Distance</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(MENUPARAM).ParamDistance">MENUPARAM.ParamDistance</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(MENUPARAM).ParamFunction">MENUPARAM.ParamFunction</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(MENUPARAM).ParamMessage">MENUPARAM.ParamMessage</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(MENUPARAM).ParamSelf">MENUPARAM.ParamSelf</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2>Global(s)</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(ESCORT)">#ESCORT</a></em>
|
|
<a id="ESCORT" >
|
|
<strong>ESCORT</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="_Resume" >
|
|
<strong>_Resume(EscortGroup)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> EscortGroup </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<h2><a id="#(Escort)" >Type <code>Escort</code></a></h2>
|
|
|
|
<h2><a id="#(Distance)" >Type <code>Distance</code></a></h2>
|
|
|
|
<h2><a id="#(ESCORT)" >Type <code>ESCORT</code></a></h2>
|
|
|
|
<p>ESCORT class</p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(ESCORT).CT1" >
|
|
<strong>ESCORT.CT1</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(ESCORT).ClassName" >
|
|
<strong>ESCORT.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).Detection" >
|
|
<strong>ESCORT.Detection</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortBriefing" >
|
|
<strong>ESCORT.EscortBriefing</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a></em>
|
|
<a id="#(ESCORT).EscortClient" >
|
|
<strong>ESCORT.EscortClient</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a></em>
|
|
<a id="#(ESCORT).EscortGroup" >
|
|
<strong>ESCORT.EscortGroup</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenu" >
|
|
<strong>ESCORT.EscortMenu</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuAttackNearbyTargets" >
|
|
<strong>ESCORT.EscortMenuAttackNearbyTargets</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
<p> Attack Targets</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuEvasion" >
|
|
<strong>ESCORT.EscortMenuEvasion</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
<p> Reaction to Threats</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuEvasionEvadeFire" >
|
|
<strong>ESCORT.EscortMenuEvasionEvadeFire</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuEvasionNoReaction" >
|
|
<strong>ESCORT.EscortMenuEvasionNoReaction</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuEvasionPassiveDefense" >
|
|
<strong>ESCORT.EscortMenuEvasionPassiveDefense</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuFlare" >
|
|
<strong>ESCORT.EscortMenuFlare</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuFlareGreen" >
|
|
<strong>ESCORT.EscortMenuFlareGreen</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuFlareRed" >
|
|
<strong>ESCORT.EscortMenuFlareRed</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuFlareWhite" >
|
|
<strong>ESCORT.EscortMenuFlareWhite</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuFlareYellow" >
|
|
<strong>ESCORT.EscortMenuFlareYellow</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuHold" >
|
|
<strong>ESCORT.EscortMenuHold</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuHoldAtLeaderPosition" >
|
|
<strong>ESCORT.EscortMenuHoldAtLeaderPosition</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuHoldPosition" >
|
|
<strong>ESCORT.EscortMenuHoldPosition</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuJoinUpAndFollow" >
|
|
<strong>ESCORT.EscortMenuJoinUpAndFollow</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuOptionEvasionVertical" >
|
|
<strong>ESCORT.EscortMenuOptionEvasionVertical</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuROE" >
|
|
<strong>ESCORT.EscortMenuROE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
<p> Rules of Engagement</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuROEHoldFire" >
|
|
<strong>ESCORT.EscortMenuROEHoldFire</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuROEOpenFire" >
|
|
<strong>ESCORT.EscortMenuROEOpenFire</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuROEReturnFire" >
|
|
<strong>ESCORT.EscortMenuROEReturnFire</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuROEWeaponFree" >
|
|
<strong>ESCORT.EscortMenuROEWeaponFree</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuReportNavigation" >
|
|
<strong>ESCORT.EscortMenuReportNavigation</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuReportNearbyTargets" >
|
|
<strong>ESCORT.EscortMenuReportNearbyTargets</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuReportNearbyTargetsNow" >
|
|
<strong>ESCORT.EscortMenuReportNearbyTargetsNow</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
<p> Report Targets</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuReportNearbyTargetsOff" >
|
|
<strong>ESCORT.EscortMenuReportNearbyTargetsOff</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuReportNearbyTargetsOn" >
|
|
<strong>ESCORT.EscortMenuReportNearbyTargetsOn</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuResumeMission" >
|
|
<strong>ESCORT.EscortMenuResumeMission</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
<p> Mission Resume Menu Root</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuScan" >
|
|
<strong>ESCORT.EscortMenuScan</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuScanForTargets" >
|
|
<strong>ESCORT.EscortMenuScanForTargets</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuSmoke" >
|
|
<strong>ESCORT.EscortMenuSmoke</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuSmokeBlue" >
|
|
<strong>ESCORT.EscortMenuSmokeBlue</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuSmokeGreen" >
|
|
<strong>ESCORT.EscortMenuSmokeGreen</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuSmokeOrange" >
|
|
<strong>ESCORT.EscortMenuSmokeOrange</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuSmokeRed" >
|
|
<strong>ESCORT.EscortMenuSmokeRed</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuSmokeWhite" >
|
|
<strong>ESCORT.EscortMenuSmokeWhite</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortMenuTargetAssistance" >
|
|
<strong>ESCORT.EscortMenuTargetAssistance</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
|
|
<p> Request assistance from other escorts.
|
|
This is very useful to let f.e. an escorting ship attack a target detected by an escorting plane...</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(ESCORT.MODE)">#ESCORT.MODE</a></em>
|
|
<a id="#(ESCORT).EscortMode" >
|
|
<strong>ESCORT.EscortMode</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>The mode the escort is in.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(ESCORT).EscortName" >
|
|
<strong>ESCORT.EscortName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).EscortSetGroup" >
|
|
<strong>ESCORT.EscortSetGroup</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(ESCORT).FollowDistance" >
|
|
<strong>ESCORT.FollowDistance</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>The current follow distance.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Core.Scheduler.html##(SCHEDULER)">Core.Scheduler#SCHEDULER</a></em>
|
|
<a id="#(ESCORT).FollowScheduler" >
|
|
<strong>ESCORT.FollowScheduler</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>The instance of the SCHEDULER class.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).FunctionalMENU_GROUPDETECTION_BASE" >
|
|
<strong>ESCORT.FunctionalMENU_GROUPDETECTION_BASE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Detection</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(ESCORT).GT1" >
|
|
<strong>ESCORT.GT1</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).JoinUpAndFollow" >
|
|
<strong>ESCORT:JoinUpAndFollow(EscortGroup, EscortClient, Distance)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>JoinsUp and Follows a CLIENT.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> EscortGroup </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> EscortClient </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> Distance </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).MODE" >
|
|
<strong>ESCORT.MODE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuAssistedAttack" >
|
|
<strong>ESCORT:MenuAssistedAttack()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines a menu slot to let the escort attack its detected targets using assisted attack from another escort joined also with the client.</p>
|
|
|
|
|
|
<p>This menu will appear under <strong>Request assistance from</strong>.
|
|
Note that this method needs to be preceded with the method MenuReportTargets.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuEvasion" >
|
|
<strong>ESCORT:MenuEvasion(MenuTextFormat)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines a menu to let the escort set its evasion when under threat.</p>
|
|
|
|
|
|
<p>All rules of engagement will appear under the menu <strong>Evasion</strong>.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> MenuTextFormat </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuFlare" >
|
|
<strong>ESCORT:MenuFlare(MenuTextFormat)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines a menu slot to let the escort disperse a flare in a certain color.</p>
|
|
|
|
|
|
<p>This menu will appear under <strong>Navigation</strong>.
|
|
The flare will be fired from the first unit in the group.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string MenuTextFormat </em></code>:
|
|
Optional parameter that shows the menu option text. If no text is given, the default text will be displayed.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuFollowAt" >
|
|
<strong>ESCORT:MenuFollowAt(Distance)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines a menu slot to let the escort Join and Follow you at a certain distance.</p>
|
|
|
|
|
|
<p>This menu will appear under <strong>Navigation</strong>.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> Distance </em></code>:
|
|
The distance in meters that the escort needs to follow the client.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuHoldAtEscortPosition" >
|
|
<strong>ESCORT:MenuHoldAtEscortPosition(Height, Seconds, MenuTextFormat)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>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.</p>
|
|
|
|
|
|
<p>This menu will appear under <strong>Hold position</strong>.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> Height </em></code>:
|
|
Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Time)">Dcs.DCSTypes#Time</a> Seconds </em></code>:
|
|
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.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string MenuTextFormat </em></code>:
|
|
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.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em>
|
|
TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuHoldAtLeaderPosition" >
|
|
<strong>ESCORT:MenuHoldAtLeaderPosition(Height, Seconds, MenuTextFormat)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>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.</p>
|
|
|
|
|
|
<p>This menu will appear under <strong>Navigation</strong>.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> Height </em></code>:
|
|
Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Time)">Dcs.DCSTypes#Time</a> Seconds </em></code>:
|
|
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.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string MenuTextFormat </em></code>:
|
|
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.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em>
|
|
TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuROE" >
|
|
<strong>ESCORT:MenuROE(MenuTextFormat)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines a menu to let the escort set its rules of engagement.</p>
|
|
|
|
|
|
<p>All rules of engagement will appear under the menu <strong>ROE</strong>.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> MenuTextFormat </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuReportTargets" >
|
|
<strong>ESCORT:MenuReportTargets(Seconds)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines a menu slot to let the escort report their current detected targets with a specified time interval in seconds.</p>
|
|
|
|
|
|
<p>This menu will appear under <strong>Report targets</strong>.
|
|
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.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Time)">Dcs.DCSTypes#Time</a> Seconds </em></code>:
|
|
Optional parameter that lets the escort report their current detected targets after specified time interval in seconds. The default time is 30 seconds.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuResumeMission" >
|
|
<strong>ESCORT:MenuResumeMission()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines a menu to let the escort resume its mission from a waypoint on its route.</p>
|
|
|
|
|
|
<p>All rules of engagement will appear under the menu <strong>Resume mission from</strong>.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuScanForTargets" >
|
|
<strong>ESCORT:MenuScanForTargets(Height, Seconds, MenuTextFormat)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds.</p>
|
|
|
|
|
|
<p>This menu will appear under <strong>Scan targets</strong>.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> Height </em></code>:
|
|
Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Time)">Dcs.DCSTypes#Time</a> Seconds </em></code>:
|
|
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.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string MenuTextFormat </em></code>:
|
|
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.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).MenuSmoke" >
|
|
<strong>ESCORT:MenuSmoke(MenuTextFormat)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines a menu slot to let the escort disperse a smoke in a certain color.</p>
|
|
|
|
|
|
<p>This menu will appear under <strong>Navigation</strong>.
|
|
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.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string MenuTextFormat </em></code>:
|
|
Optional parameter that shows the menu option text. If no text is given, the default text will be displayed.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).Menus" >
|
|
<strong>ESCORT:Menus()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Defines the default menus</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).New" >
|
|
<strong>ESCORT:New(EscortClient, EscortGroup, EscortName, EscortBriefing)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>ESCORT class constructor for an AI group</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> EscortClient </em></code>:
|
|
The client escorted by the EscortGroup.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> EscortGroup </em></code>:
|
|
The group AI escorting the EscortClient.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string EscortName </em></code>:
|
|
Name of the escort.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string EscortBriefing </em></code>:
|
|
A text showing the ESCORT briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ESCORT)">#ESCORT</a>:</em>
|
|
self</p>
|
|
|
|
<h3>Usage:</h3>
|
|
<pre class="example"><code>-- Declare a new EscortPlanes object as follows:
|
|
|
|
-- First find the GROUP object and the CLIENT object.
|
|
local EscortClient = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
|
|
local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
|
|
|
|
-- Now use these 2 objects to construct the new EscortPlanes object.
|
|
EscortPlanes = ESCORT:New( EscortClient, 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." )</code></pre>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).OptionROE" >
|
|
<strong>ESCORT.OptionROE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Dcs.DCSTypes.html##(AI.Option.Air.val.REACTION_ON_THREAT)">Dcs.DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT</a></em>
|
|
<a id="#(ESCORT).OptionReactionOnThreat" >
|
|
<strong>ESCORT.OptionReactionOnThreat</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Which REACTION<em>ON</em>THREAT is set to the EscortGroup.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).RegisterRoute" >
|
|
<strong>ESCORT:RegisterRoute()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Registers the waypoints</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#table:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(ESCORT).ReportTargets" >
|
|
<strong>ESCORT.ReportTargets</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>If true, nearby targets are reported.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).ReportTargetsScheduler" >
|
|
<strong>ESCORT.ReportTargetsScheduler</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).SetDetection" >
|
|
<strong>ESCORT:SetDetection(Detection)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set a Detection method for the EscortClient to be reported upon.</p>
|
|
|
|
|
|
<p>Detection methods are based on the derived classes from DETECTION_BASE.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Function.Detection.html##(DETECTION_BASE)">Function.Detection#DETECTION_BASE</a> Detection </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).SmokeDirectionVector" >
|
|
<strong>ESCORT.SmokeDirectionVector</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).Targets" >
|
|
<strong>ESCORT.Targets</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ESCORT).TaskPoints" >
|
|
<strong>ESCORT.TaskPoints</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT).TestSmokeDirectionVector" >
|
|
<strong>ESCORT:TestSmokeDirectionVector(SmokeDirection)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>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.</p>
|
|
|
|
|
|
<p>This allows to visualize where the escort is flying to.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean SmokeDirection </em></code>:
|
|
If true, then the direction vector will be smoked.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._AssistTarget" >
|
|
<strong>ESCORT._AssistTarget(DetectedItemID, self, EscortGroupAttack)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number DetectedItemID </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> EscortGroupAttack </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._AttackTarget" >
|
|
<strong>ESCORT:_AttackTarget(DetectedItemID)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number DetectedItemID </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._Flare" >
|
|
<strong>ESCORT._Flare(MenuParam, self, Color, Message)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(MENUPARAM)">#MENUPARAM</a> MenuParam </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> Color </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> Message </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._FollowScheduler" >
|
|
<strong>ESCORT:_FollowScheduler()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._HoldPosition" >
|
|
<strong>ESCORT._HoldPosition(MenuParam, self, OrbitGroup, OrbitHeight, OrbitSeconds)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(MENUPARAM)">#MENUPARAM</a> MenuParam </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> OrbitGroup </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> OrbitHeight </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> OrbitSeconds </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._JoinUpAndFollow" >
|
|
<strong>ESCORT._JoinUpAndFollow(MenuParam, self, Distance)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(MENUPARAM)">#MENUPARAM</a> MenuParam </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> Distance </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._ROE" >
|
|
<strong>ESCORT._ROE(MenuParam, self, EscortROEFunction, EscortROEMessage)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(MENUPARAM)">#MENUPARAM</a> MenuParam </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> EscortROEFunction </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> EscortROEMessage </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._ROT" >
|
|
<strong>ESCORT._ROT(MenuParam, self, EscortROTFunction, EscortROTMessage)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(MENUPARAM)">#MENUPARAM</a> MenuParam </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> EscortROTFunction </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> EscortROTMessage </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._ReportNearbyTargetsNow" >
|
|
<strong>ESCORT._ReportNearbyTargetsNow(MenuParam, self)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(MENUPARAM)">#MENUPARAM</a> MenuParam </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._ReportTargetsScheduler" >
|
|
<strong>ESCORT:_ReportTargetsScheduler()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Report Targets Scheduler.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._ResumeMission" >
|
|
<strong>ESCORT._ResumeMission(MenuParam, self, WayPoint)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(MENUPARAM)">#MENUPARAM</a> MenuParam </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> WayPoint </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._ScanTargets" >
|
|
<strong>ESCORT._ScanTargets(MenuParam, self, ScanDuration)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(MENUPARAM)">#MENUPARAM</a> MenuParam </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> ScanDuration </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._Smoke" >
|
|
<strong>ESCORT._Smoke(MenuParam, self, Color, Message)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(MENUPARAM)">#MENUPARAM</a> MenuParam </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> Color </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> Message </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ESCORT)._SwitchReportNearbyTargets" >
|
|
<strong>ESCORT:_SwitchReportNearbyTargets(ReportTargets)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> ReportTargets </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(ESCORT.MODE)" >Type <code>ESCORT.MODE</code></a></h2>
|
|
|
|
<p>ESCORT.Mode class</p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(ESCORT.MODE).FOLLOW" >
|
|
<strong>ESCORT.MODE.FOLLOW</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(ESCORT.MODE).MISSION" >
|
|
<strong>ESCORT.MODE.MISSION</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(MENUPARAM)" >Type <code>MENUPARAM</code></a></h2>
|
|
|
|
<p>MENUPARAM type</p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(MENUPARAM).Distance" >
|
|
<strong>MENUPARAM.Distance</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(Distance)">#Distance</a></em>
|
|
<a id="#(MENUPARAM).ParamDistance" >
|
|
<strong>MENUPARAM.ParamDistance</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#function</em>
|
|
<a id="#(MENUPARAM).ParamFunction" >
|
|
<strong>MENUPARAM.ParamFunction</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(MENUPARAM).ParamMessage" >
|
|
<strong>MENUPARAM.ParamMessage</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(ESCORT)">#ESCORT</a></em>
|
|
<a id="#(MENUPARAM).ParamSelf" >
|
|
<strong>MENUPARAM.ParamSelf</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|