weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
MOOSE/Documentation/Group.html
FlightControl 9da2f56d37 Updated CLEANUP luadoc documentation.
2016-04-02 23:06:26 +02:00

2165 lines
43 KiB
HTML
Raw Blame History

<!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="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="DCSAirbase.html">DCSAirbase</a></li>
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</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="DCStimer.html">DCStimer</a></li>
<li><a href="DEPLOYTASK.html">DEPLOYTASK</a></li>
<li><a href="DESTROYBASETASK.html">DESTROYBASETASK</a></li>
<li><a href="DESTROYGROUPSTASK.html">DESTROYGROUPSTASK</a></li>
<li><a href="DESTROYRADARSTASK.html">DESTROYRADARSTASK</a></li>
<li><a href="DESTROYUNITTYPESTASK.html">DESTROYUNITTYPESTASK</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Escort.html">Escort</a></li>
<li><a href="GOHOMETASK.html">GOHOMETASK</a></li>
<li>Group</li>
<li><a href="MISSION.html">MISSION</a></li>
<li><a href="MOVEMENT.html">MOVEMENT</a></li>
<li><a href="Menu.html">Menu</a></li>
<li><a href="Message.html">Message</a></li>
<li><a href="NOTASK.html">NOTASK</a></li>
<li><a href="PICKUPTASK.html">PICKUPTASK</a></li>
<li><a href="ROUTETASK.html">ROUTETASK</a></li>
<li><a href="STAGE.html">STAGE</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="StaticObject.html">StaticObject</a></li>
<li><a href="TASK.html">TASK</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="Zone.html">Zone</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>Group</code></h1>
<p>A GROUP class abstraction of a DCSGroup class.</p>
<p>The GROUP class will take an abstraction of the DCSGroup class, providing more methods that can be done with a GROUP.</p>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#GROUP">GROUP</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(DCSGroup)">Type <code>DCSGroup</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(DCSGroup).id_">DCSGroup.id_</a></td>
<td class="summary">
<p>The ID of the group in DCS</p>
</td>
</tr>
</table>
<h2><a id="#(GROUP)">Type <code>GROUP</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).Activate">GROUP:Activate()</a></td>
<td class="summary">
<p>Activates a GROUP.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).AllOnGround">GROUP:AllOnGround()</a></td>
<td class="summary">
<p>Returns if all units of the group are on the ground or landed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).ClassName">GROUP.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).Controller">GROUP.Controller</a></td>
<td class="summary">
<p>The controller of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).CopyRoute">GROUP:CopyRoute(Begin, End, Randomize, Radius)</a></td>
<td class="summary">
<p>Return the route of a group by using the <a href="Database.html##(DATABASE)">Database#DATABASE</a> class.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).DCSGroup">GROUP.DCSGroup</a></td>
<td class="summary">
<p>The DCS group class.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).Destroy">GROUP:Destroy()</a></td>
<td class="summary">
<p>Destroy a GROUP
Note that this destroy method also raises a destroy event at run-time.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).FindGroup">GROUP.FindGroup(Group, DCSGroup)</a></td>
<td class="summary">
<p>Find the created GROUP using the DCSGroup ID.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetCallsign">GROUP:GetCallsign()</a></td>
<td class="summary">
<p>Gets the callsign of the fist unit of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetDCSGroup">GROUP:GetDCSGroup()</a></td>
<td class="summary">
<p>Gets the DCSGroup of the GROUP.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetDCSUnit">GROUP:GetDCSUnit(UnitNumber)</a></td>
<td class="summary">
<p>Gets the DCS Unit of the GROUP.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetDetectedTargets">GROUP:GetDetectedTargets()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetID">GROUP:GetID()</a></td>
<td class="summary">
<p>Gets the ID of the GROUP.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetMaxHeight">GROUP:GetMaxHeight()</a></td>
<td class="summary">
<p>Returns the current maximum height of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetMaxVelocity">GROUP:GetMaxVelocity()</a></td>
<td class="summary">
<p>Returns the current maximum velocity of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetMinHeight">GROUP:GetMinHeight()</a></td>
<td class="summary">
<p>Returns the current minimum height of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetName">GROUP:GetName()</a></td>
<td class="summary">
<p>Gets the name of the GROUP.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetPointVec2">GROUP:GetPointVec2()</a></td>
<td class="summary">
<p>Gets the current Point of the GROUP in VEC3 format.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetPositionVec3">GROUP:GetPositionVec3()</a></td>
<td class="summary">
<p>Gets the current Point of the GROUP in VEC3 format.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetTaskMission">GROUP:GetTaskMission()</a></td>
<td class="summary">
<p>Return the mission template of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetTaskRoute">GROUP:GetTaskRoute()</a></td>
<td class="summary">
<p>Return the mission route of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetTypeName">GROUP:GetTypeName()</a></td>
<td class="summary">
<p>Gets the type name of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetUnit">GROUP:GetUnit(UnitNumber)</a></td>
<td class="summary">
<p>Gets the DCS Unit.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GroupID">GROUP.GroupID</a></td>
<td class="summary">
<p>the ID of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).GroupName">GROUP.GroupName</a></td>
<td class="summary">
<p>The name of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).IsAir">GROUP:IsAir()</a></td>
<td class="summary">
<p>Returns if the group is of an air category.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).IsAlive">GROUP:IsAlive()</a></td>
<td class="summary">
<p>Returns if the group is alive.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).IsTargetDetected">GROUP:IsTargetDetected(DCSObject)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).Message">GROUP:Message(Message, Duration)</a></td>
<td class="summary">
<p>Returns a message for a coalition or a client.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).MessageToAll">GROUP:MessageToAll(Message, Duration)</a></td>
<td class="summary">
<p>Send a message to all coalitions.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).MessageToBlue">GROUP:MessageToBlue(Message, Duration)</a></td>
<td class="summary">
<p>Send a message to the blue coalition.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).MessageToClient">GROUP:MessageToClient(Message, Duration, Client)</a></td>
<td class="summary">
<p>Send a message to a client.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).MessageToRed">GROUP:MessageToRed(Message, Duration)</a></td>
<td class="summary">
<p>Send a message to the red coalition.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).New">GROUP:New(DCSGroup)</a></td>
<td class="summary">
<p>Create a new GROUP from a DCSGroup</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).NewFromDCSUnit">GROUP:NewFromDCSUnit(DCSUnit)</a></td>
<td class="summary">
<p>Create a new GROUP from an existing DCSUnit in the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).NewFromName">GROUP:NewFromName(GroupName)</a></td>
<td class="summary">
<p>Create a new GROUP from an existing group name.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).OptionROEHoldFire">GROUP:OptionROEHoldFire()</a></td>
<td class="summary">
<p>Holding weapons.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).OptionROEOpenFire">GROUP:OptionROEOpenFire()</a></td>
<td class="summary">
<p>Openfire.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).OptionROEReturnFire">GROUP:OptionROEReturnFire()</a></td>
<td class="summary">
<p>Return fire.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).OptionROEWeaponFree">GROUP:OptionROEWeaponFree()</a></td>
<td class="summary">
<p>Weapon free.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).OptionROTEvadeFire">GROUP:OptionROTEvadeFire()</a></td>
<td class="summary">
<p>Evade fire.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).OptionROTNoReaction">GROUP:OptionROTNoReaction()</a></td>
<td class="summary">
<p>No evasion on enemy threats.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).OptionROTPassiveDefense">GROUP:OptionROTPassiveDefense()</a></td>
<td class="summary">
<p>Evasion passive defense.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).OptionROTVertical">GROUP:OptionROTVertical()</a></td>
<td class="summary">
<p>Vertical manoeuvres.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).PopCurrentTask">GROUP:PopCurrentTask()</a></td>
<td class="summary">
<p>Popping current Task from the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).PushTask">GROUP:PushTask(DCSTask)</a></td>
<td class="summary">
<p>Pushing Task on the queue from the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).RegisterWayPoint">GROUP:RegisterWayPoint(WayPoint)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).Route">GROUP:Route(GoPoints)</a></td>
<td class="summary">
<p>Make the group to follow a given route.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).SetTask">GROUP:SetTask(DCSTask)</a></td>
<td class="summary">
<p>Clearing the Task Queue and Setting the Task on the queue from the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskAttackUnit">GROUP:TaskAttackUnit(The, AttackUnit)</a></td>
<td class="summary">
<p>Attack the Unit.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskCondition">GROUP:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint)</a></td>
<td class="summary">
<p>Return a condition section for a controlled task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskControlled">GROUP:TaskControlled(DCSTask, DCSStopCondition)</a></td>
<td class="summary">
<p>Return a Controlled Task taking a Task and a TaskCondition</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskEmbarkToTransportAtVec2">GROUP:TaskEmbarkToTransportAtVec2(Point, Radius)</a></td>
<td class="summary">
<p>Move to a defined Vec2 Point, and embark to a group when arrived within a defined Radius.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskEmbarkingAtVec2">GROUP:TaskEmbarkingAtVec2(Point, Duration, EmbarkingGroup)</a></td>
<td class="summary">
<p>Move the group to a Vec2 Point, wait for a defined duration and embark a group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskHoldPosition">GROUP:TaskHoldPosition(Duration)</a></td>
<td class="summary">
<p>Hold position at the current position of the first unit of the group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskLandAtVec2">GROUP:TaskLandAtVec2(Point, Duration)</a></td>
<td class="summary">
<p>Land the group at a Vec2Point.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskLandAtZone">GROUP:TaskLandAtZone(Zone, Duration)</a></td>
<td class="summary">
<p>Land the group at a @{Zone#ZONE).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskMission">GROUP:TaskMission(TaskMission)</a></td>
<td class="summary">
<p>Return a Misson task from a mission template.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskOrbitCircle">GROUP:TaskOrbitCircle(Altitude, Speed)</a></td>
<td class="summary">
<p>Orbit at the current position of the first unit of the group at a specified alititude</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskOrbitCircleAtVec2">GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed)</a></td>
<td class="summary">
<p>Orbit at a specified position at a specified alititude during a specified duration with a specified speed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskRegisterWayPoint">GROUP:TaskRegisterWayPoint(WayPoint)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskRoute">GROUP:TaskRoute(Points)</a></td>
<td class="summary">
<p>Return a Misson task to follow a given route defined by Points.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskRouteToVec3">GROUP:TaskRouteToVec3(Point, Speed)</a></td>
<td class="summary">
<p>Make the group to fly to a given point and hover.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP).TaskRouteToZone">GROUP:TaskRouteToZone(Zone, Randomize, Speed, Formation)</a></td>
<td class="summary">
<p>Route the group to a given zone.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(GROUP)._GetController">GROUP:_GetController()</a></td>
<td class="summary">
<p>Get the controller for the GROUP.</p>
</td>
</tr>
</table>
<h2><a id="#(Vec3)">Type <code>Vec3</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(Vec3).x">Vec3.x</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(Vec3).y">Vec3.y</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(GROUP)">#GROUP</a></em>
<a id="GROUP" >
<strong>GROUP</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Group)" >Type <code>Group</code></a></h2>
<h2><a id="#(DCSGroup)" >Type <code>DCSGroup</code></a></h2>
<p>A DCSGroup</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(DCSGroup).id_" >
<strong>DCSGroup.id_</strong>
</a>
</dt>
<dd>
<p>The ID of the group in DCS</p>
</dd>
</dl>
<h2><a id="#(DCSStopCondition)" >Type <code>DCSStopCondition</code></a></h2>
<h2><a id="#(DCSTask)" >Type <code>DCSTask</code></a></h2>
<h2><a id="#(Duration)" >Type <code>Duration</code></a></h2>
<h2><a id="#(GROUP)" >Type <code>GROUP</code></a></h2>
<p>The GROUP class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(GROUP).Activate" >
<strong>GROUP:Activate()</strong>
</a>
</dt>
<dd>
<p>Activates a GROUP.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).AllOnGround" >
<strong>GROUP:AllOnGround()</strong>
</a>
</dt>
<dd>
<p>Returns if all units of the group are on the ground or landed.</p>
<p>If all units of this group are on the ground, this function will return true, otherwise false.</p>
<h3>Return value</h3>
<p><em>#boolean:</em>
All units on the ground result.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(GROUP).ClassName" >
<strong>GROUP.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#table</em>
<a id="#(GROUP).Controller" >
<strong>GROUP.Controller</strong>
</a>
</dt>
<dd>
<p>The controller of the group.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).CopyRoute" >
<strong>GROUP:CopyRoute(Begin, End, Randomize, Radius)</strong>
</a>
</dt>
<dd>
<p>Return the route of a group by using the <a href="Database.html##(DATABASE)">Database#DATABASE</a> class.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number Begin </em></code>:
The route point from where the copy will start. The base route point is 0.</p>
</li>
<li>
<p><code><em>#number End </em></code>:
The route point where the copy will end. The End point is the last point - the End point. The last point has base 0.</p>
</li>
<li>
<p><code><em>#boolean Randomize </em></code>:
Randomization of the route, when true.</p>
</li>
<li>
<p><code><em>#number Radius </em></code>:
When randomization is on, the randomization is within the radius. </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="DCSGroup.html##(Group)">DCSGroup#Group</a></em>
<a id="#(GROUP).DCSGroup" >
<strong>GROUP.DCSGroup</strong>
</a>
</dt>
<dd>
<p>The DCS group class.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).Destroy" >
<strong>GROUP:Destroy()</strong>
</a>
</dt>
<dd>
<p>Destroy a GROUP
Note that this destroy method also raises a destroy event at run-time.</p>
<p>So all event listeners will catch the destroy event of this GROUP.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).FindGroup" >
<strong>GROUP.FindGroup(Group, DCSGroup)</strong>
</a>
</dt>
<dd>
<p>Find the created GROUP using the DCSGroup ID.</p>
<p>If a GROUP was created with the DCSGroupID, the the GROUP instance will be returned.
Otherwise nil will be returned.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="DCSGroup.html##(Group)">DCSGroup#Group</a> Group </em></code>: </p>
</li>
<li>
<p><code><em> DCSGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetCallsign" >
<strong>GROUP:GetCallsign()</strong>
</a>
</dt>
<dd>
<p>Gets the callsign of the fist unit of the group.</p>
<h3>Return value</h3>
<p><em>#string:</em>
The callsign of the first unit of the group.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetDCSGroup" >
<strong>GROUP:GetDCSGroup()</strong>
</a>
</dt>
<dd>
<p>Gets the DCSGroup of the GROUP.</p>
<h3>Return value</h3>
<p><em><a href="##(Group)">#Group</a>:</em>
The DCSGroup.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetDCSUnit" >
<strong>GROUP:GetDCSUnit(UnitNumber)</strong>
</a>
</dt>
<dd>
<p>Gets the DCS Unit of the GROUP.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number UnitNumber </em></code>:
The unit index to be returned from the GROUP.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(Unit)">#Unit</a>:</em>
The DCS Unit.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetDetectedTargets" >
<strong>GROUP:GetDetectedTargets()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetID" >
<strong>GROUP:GetID()</strong>
</a>
</dt>
<dd>
<p>Gets the ID of the GROUP.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The ID of the GROUP.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetMaxHeight" >
<strong>GROUP:GetMaxHeight()</strong>
</a>
</dt>
<dd>
<p>Returns the current maximum height of the group.</p>
<p>Each unit within the group gets evaluated, and the maximum height (= the unit which is the highest elevated) is returned.</p>
<h3>Return value</h3>
<p><em>#number:</em>
Maximum height found.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetMaxVelocity" >
<strong>GROUP:GetMaxVelocity()</strong>
</a>
</dt>
<dd>
<p>Returns the current maximum velocity of the group.</p>
<p>Each unit within the group gets evaluated, and the maximum velocity (= the unit which is going the fastest) is returned.</p>
<h3>Return value</h3>
<p><em>#number:</em>
Maximum velocity found.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetMinHeight" >
<strong>GROUP:GetMinHeight()</strong>
</a>
</dt>
<dd>
<p>Returns the current minimum height of the group.</p>
<p>Each unit within the group gets evaluated, and the minimum height (= the unit which is the lowest elevated) is returned.</p>
<h3>Return value</h3>
<p><em>#number:</em>
Minimum height found.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetName" >
<strong>GROUP:GetName()</strong>
</a>
</dt>
<dd>
<p>Gets the name of the GROUP.</p>
<h3>Return value</h3>
<p><em>#string:</em>
The name of the GROUP.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetPointVec2" >
<strong>GROUP:GetPointVec2()</strong>
</a>
</dt>
<dd>
<p>Gets the current Point of the GROUP in VEC3 format.</p>
<h3>Return value</h3>
<p><em><a href="##(Vec3)">#Vec3</a>:</em>
Current x,y and z position of the group.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetPositionVec3" >
<strong>GROUP:GetPositionVec3()</strong>
</a>
</dt>
<dd>
<p>Gets the current Point of the GROUP in VEC3 format.</p>
<h3>Return value</h3>
<p><em><a href="##(Vec3)">#Vec3</a>:</em>
Current Vec3 position of the group.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetTaskMission" >
<strong>GROUP:GetTaskMission()</strong>
</a>
</dt>
<dd>
<p>Return the mission template of the group.</p>
<h3>Return value</h3>
<p><em>#table:</em>
The MissionTemplate</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetTaskRoute" >
<strong>GROUP:GetTaskRoute()</strong>
</a>
</dt>
<dd>
<p>Return the mission route of the group.</p>
<h3>Return value</h3>
<p><em>#table:</em>
The mission route defined by points.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetTypeName" >
<strong>GROUP:GetTypeName()</strong>
</a>
</dt>
<dd>
<p>Gets the type name of the group.</p>
<h3>Return value</h3>
<p><em>#string:</em>
The type name of the group.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).GetUnit" >
<strong>GROUP:GetUnit(UnitNumber)</strong>
</a>
</dt>
<dd>
<p>Gets the DCS Unit.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number UnitNumber </em></code>:
The number of the Unit to be returned.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Unit.html##(UNIT)">Unit#UNIT</a>:</em>
The DCS Unit.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(GROUP).GroupID" >
<strong>GROUP.GroupID</strong>
</a>
</dt>
<dd>
<p>the ID of the group.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(GROUP).GroupName" >
<strong>GROUP.GroupName</strong>
</a>
</dt>
<dd>
<p>The name of the group.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).IsAir" >
<strong>GROUP:IsAir()</strong>
</a>
</dt>
<dd>
<p>Returns if the group is of an air category.</p>
<p>If the group is a helicopter or a plane, then this method will return true, otherwise false.</p>
<h3>Return value</h3>
<p><em>#boolean:</em>
Air category evaluation result.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).IsAlive" >
<strong>GROUP:IsAlive()</strong>
</a>
</dt>
<dd>
<p>Returns if the group is alive.</p>
<p>When the group exists at run-time, this method will return true, otherwise false.</p>
<h3>Return value</h3>
<p><em>#boolean:</em>
Alive result.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).IsTargetDetected" >
<strong>GROUP:IsTargetDetected(DCSObject)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> DCSObject </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).Message" >
<strong>GROUP:Message(Message, Duration)</strong>
</a>
</dt>
<dd>
<p>Returns a message for a coalition or a client.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="##(Duration)">#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Message.html##(MESSAGE)">Message#MESSAGE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).MessageToAll" >
<strong>GROUP:MessageToAll(Message, Duration)</strong>
</a>
</dt>
<dd>
<p>Send a message to all coalitions.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="##(Duration)">#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).MessageToBlue" >
<strong>GROUP:MessageToBlue(Message, Duration)</strong>
</a>
</dt>
<dd>
<p>Send a message to the blue coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="##(Duration)">#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).MessageToClient" >
<strong>GROUP:MessageToClient(Message, Duration, Client)</strong>
</a>
</dt>
<dd>
<p>Send a message to a client.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="##(Duration)">#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em><a href="Client.html##(CLIENT)">Client#CLIENT</a> Client </em></code>:
The client object receiving the message.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).MessageToRed" >
<strong>GROUP:MessageToRed(Message, Duration)</strong>
</a>
</dt>
<dd>
<p>Send a message to the red coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="##(Duration)">#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).New" >
<strong>GROUP:New(DCSGroup)</strong>
</a>
</dt>
<dd>
<p>Create a new GROUP from a DCSGroup</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="DCSGroup.html##(Group)">DCSGroup#Group</a> DCSGroup </em></code>:
The DCS Group</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).NewFromDCSUnit" >
<strong>GROUP:NewFromDCSUnit(DCSUnit)</strong>
</a>
</dt>
<dd>
<p>Create a new GROUP from an existing DCSUnit in the mission.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> DCSUnit </em></code>:
The DCSUnit.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).NewFromName" >
<strong>GROUP:NewFromName(GroupName)</strong>
</a>
</dt>
<dd>
<p>Create a new GROUP from an existing group name.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> GroupName </em></code>:
The name of the DCS Group.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).OptionROEHoldFire" >
<strong>GROUP:OptionROEHoldFire()</strong>
</a>
</dt>
<dd>
<p>Holding weapons.</p>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).OptionROEOpenFire" >
<strong>GROUP:OptionROEOpenFire()</strong>
</a>
</dt>
<dd>
<p>Openfire.</p>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).OptionROEReturnFire" >
<strong>GROUP:OptionROEReturnFire()</strong>
</a>
</dt>
<dd>
<p>Return fire.</p>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).OptionROEWeaponFree" >
<strong>GROUP:OptionROEWeaponFree()</strong>
</a>
</dt>
<dd>
<p>Weapon free.</p>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).OptionROTEvadeFire" >
<strong>GROUP:OptionROTEvadeFire()</strong>
</a>
</dt>
<dd>
<p>Evade fire.</p>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).OptionROTNoReaction" >
<strong>GROUP:OptionROTNoReaction()</strong>
</a>
</dt>
<dd>
<p>No evasion on enemy threats.</p>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).OptionROTPassiveDefense" >
<strong>GROUP:OptionROTPassiveDefense()</strong>
</a>
</dt>
<dd>
<p>Evasion passive defense.</p>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).OptionROTVertical" >
<strong>GROUP:OptionROTVertical()</strong>
</a>
</dt>
<dd>
<p>Vertical manoeuvres.</p>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).PopCurrentTask" >
<strong>GROUP:PopCurrentTask()</strong>
</a>
</dt>
<dd>
<p>Popping current Task from the group.</p>
<h3>Return value</h3>
<p><em><a href="Group.html##(GROUP)">Group#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).PushTask" >
<strong>GROUP:PushTask(DCSTask)</strong>
</a>
</dt>
<dd>
<p>Pushing Task on the queue from the group.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> DCSTask </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Group.html##(GROUP)">Group#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).RegisterWayPoint" >
<strong>GROUP:RegisterWayPoint(WayPoint)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> WayPoint </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).Route" >
<strong>GROUP:Route(GoPoints)</strong>
</a>
</dt>
<dd>
<p>Make the group to follow a given route.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#table GoPoints </em></code>:
A table of Route Points.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self </p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).SetTask" >
<strong>GROUP:SetTask(DCSTask)</strong>
</a>
</dt>
<dd>
<p>Clearing the Task Queue and Setting the Task on the queue from the group.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> DCSTask </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Group.html##(GROUP)">Group#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskAttackUnit" >
<strong>GROUP:TaskAttackUnit(The, AttackUnit)</strong>
</a>
</dt>
<dd>
<p>Attack the Unit.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> The </em></code>:
unit.</p>
</li>
<li>
<p><code><em> AttackUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(DCSTask)">#DCSTask</a>:</em>
The DCS task structure.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskCondition" >
<strong>GROUP:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint)</strong>
</a>
</dt>
<dd>
<p>Return a condition section for a controlled task</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(Time)">#Time</a> time </em></code>: </p>
</li>
<li>
<p><code><em>#string userFlag </em></code>: </p>
</li>
<li>
<p><code><em>#boolean userFlagValue </em></code>: </p>
</li>
<li>
<p><code><em>#string condition </em></code>: </p>
</li>
<li>
<p><code><em><a href="##(Time)">#Time</a> duration </em></code>: </p>
</li>
<li>
<p><code><em>#number lastWayPoint </em></code>: </p>
<p>return #DCSTask</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskControlled" >
<strong>GROUP:TaskControlled(DCSTask, DCSStopCondition)</strong>
</a>
</dt>
<dd>
<p>Return a Controlled Task taking a Task and a TaskCondition</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(DCSTask)">#DCSTask</a> DCSTask </em></code>: </p>
</li>
<li>
<p><code><em><a href="##(DCSStopCondition)">#DCSStopCondition</a> DCSStopCondition </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(DCSTask)">#DCSTask</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskEmbarkToTransportAtVec2" >
<strong>GROUP:TaskEmbarkToTransportAtVec2(Point, Radius)</strong>
</a>
</dt>
<dd>
<p>Move to a defined Vec2 Point, and embark to a group when arrived within a defined Radius.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(Vec2)">#Vec2</a> Point </em></code>:
The point where to wait.</p>
</li>
<li>
<p><code><em>#number Radius </em></code>:
The radius of the embarking zone around the Point.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(DCSTask)">#DCSTask</a>:</em>
The DCS task structure.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskEmbarkingAtVec2" >
<strong>GROUP:TaskEmbarkingAtVec2(Point, Duration, EmbarkingGroup)</strong>
</a>
</dt>
<dd>
<p>Move the group to a Vec2 Point, wait for a defined duration and embark a group.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(Vec2)">#Vec2</a> Point </em></code>:
The point where to wait.</p>
</li>
<li>
<p><code><em>#number Duration </em></code>:
The duration in seconds to wait.</p>
</li>
<li>
<p><code><em><a href="##(GROUP)">#GROUP</a> EmbarkingGroup </em></code>:
The group to be embarked.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(DCSTask)">#DCSTask</a>:</em>
The DCS task structure</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskHoldPosition" >
<strong>GROUP:TaskHoldPosition(Duration)</strong>
</a>
</dt>
<dd>
<p>Hold position at the current position of the first unit of the group.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Duration </em></code>:
The maximum duration in seconds to hold the position.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskLandAtVec2" >
<strong>GROUP:TaskLandAtVec2(Point, Duration)</strong>
</a>
</dt>
<dd>
<p>Land the group at a Vec2Point.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(Vec2)">#Vec2</a> Point </em></code>:
The point where to land.</p>
</li>
<li>
<p><code><em>#number Duration </em></code>:
The duration in seconds to stay on the ground.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskLandAtZone" >
<strong>GROUP:TaskLandAtZone(Zone, Duration)</strong>
</a>
</dt>
<dd>
<p>Land the group at a @{Zone#ZONE).</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Zone.html##(ZONE)">Zone#ZONE</a> Zone </em></code>:
The zone where to land.</p>
</li>
<li>
<p><code><em>#number Duration </em></code>:
The duration in seconds to stay on the ground.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskMission" >
<strong>GROUP:TaskMission(TaskMission)</strong>
</a>
</dt>
<dd>
<p>Return a Misson task from a mission template.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#table TaskMission </em></code>:
A table containing the mission task.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(DCSTask)">#DCSTask</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskOrbitCircle" >
<strong>GROUP:TaskOrbitCircle(Altitude, Speed)</strong>
</a>
</dt>
<dd>
<p>Orbit at the current position of the first unit of the group at a specified alititude</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number Altitude </em></code>:
The altitude to hold the position.</p>
</li>
<li>
<p><code><em>#number Speed </em></code>:
The speed flying when holding the position.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskOrbitCircleAtVec2" >
<strong>GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed)</strong>
</a>
</dt>
<dd>
<p>Orbit at a specified position at a specified alititude during a specified duration with a specified speed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(Vec2)">#Vec2</a> Point </em></code>:
The point to hold the position.</p>
</li>
<li>
<p><code><em>#number Altitude </em></code>:
The altitude to hold the position.</p>
</li>
<li>
<p><code><em>#number Speed </em></code>:
The speed flying when holding the position.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskRegisterWayPoint" >
<strong>GROUP:TaskRegisterWayPoint(WayPoint)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> WayPoint </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskRoute" >
<strong>GROUP:TaskRoute(Points)</strong>
</a>
</dt>
<dd>
<p>Return a Misson task to follow a given route defined by Points.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#table Points </em></code>:
A table of route points.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(DCSTask)">#DCSTask</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskRouteToVec3" >
<strong>GROUP:TaskRouteToVec3(Point, Speed)</strong>
</a>
</dt>
<dd>
<p>Make the group to fly to a given point and hover.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(Vec3)">#Vec3</a> Point </em></code>:
The destination point.</p>
</li>
<li>
<p><code><em>#number Speed </em></code>:
The speed to travel.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(GROUP)">#GROUP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP).TaskRouteToZone" >
<strong>GROUP:TaskRouteToZone(Zone, Randomize, Speed, Formation)</strong>
</a>
</dt>
<dd>
<p>Route the group to a given zone.</p>
<p>The group final destination point can be randomized.
A speed can be given in km/h.
A given formation can be given.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Zone.html##(ZONE)">Zone#ZONE</a> Zone </em></code>:
The zone where to route to.</p>
</li>
<li>
<p><code><em>#boolean Randomize </em></code>:
Defines whether to target point gets randomized within the Zone.</p>
</li>
<li>
<p><code><em>#number Speed </em></code>:
The speed.</p>
</li>
<li>
<p><code><em><a href="Base.html##(FORMATION)">Base#FORMATION</a> Formation </em></code>:
The formation string.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(GROUP)._GetController" >
<strong>GROUP:_GetController()</strong>
</a>
</dt>
<dd>
<p>Get the controller for the GROUP.</p>
<h3>Return value</h3>
<p><em><a href="Controller.html##(Controller)">Controller#Controller</a>:</em></p>
</dd>
</dl>
<h2><a id="#(Time)" >Type <code>Time</code></a></h2>
<h2><a id="#(Unit)" >Type <code>Unit</code></a></h2>
<h2><a id="#(Vec2)" >Type <code>Vec2</code></a></h2>
<h2><a id="#(Vec3)" >Type <code>Vec3</code></a></h2>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em></em>
<a id="#(Vec3).x" >
<strong>Vec3.x</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(Vec3).y" >
<strong>Vec3.y</strong>
</a>
</dt>
<dd>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink