mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
527 lines
11 KiB
HTML
527 lines
11 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="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>DCSGroup</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><a href="Group.html">Group</a></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>DCSGroup</code></h1>
|
|
|
|
|
|
|
|
<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="#(Group)">Type <code>Group</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).Category">Group.Category</a></td>
|
|
<td class="summary">
|
|
<p>Enum contains identifiers of group types. </p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).ID">Group.ID</a></td>
|
|
<td class="summary">
|
|
<p>Identifier of a group. It is assigned to a group by Mission Editor automatically. </p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).destroy">Group:destroy()</a></td>
|
|
<td class="summary">
|
|
<p>Destroys the group and all of its units.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).getByName">Group.getByName(name)</a></td>
|
|
<td class="summary">
|
|
<p>Returns group by the name assigned to the group in Mission Editor. </p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).getCategory">Group:getCategory()</a></td>
|
|
<td class="summary">
|
|
<p>Returns category of the group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).getController">Group:getController()</a></td>
|
|
<td class="summary">
|
|
<p>Returns controller of the group. </p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).getID">Group:getID()</a></td>
|
|
<td class="summary">
|
|
<p>Returns the group identifier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).getInitialSize">Group:getInitialSize()</a></td>
|
|
<td class="summary">
|
|
<p>Returns initial size of the group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).getName">Group:getName()</a></td>
|
|
<td class="summary">
|
|
<p>Returns the group's name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).getSize">Group:getSize()</a></td>
|
|
<td class="summary">
|
|
<p>Returns current size 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>Returns the unit with number unitNumber.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).getUnits">Group:getUnits()</a></td>
|
|
<td class="summary">
|
|
<p>Returns array of the units present in the group now.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group).isExist">Group:isExist()</a></td>
|
|
<td class="summary">
|
|
<p>returns true if the group exist or false otherwise. </p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(Group.Category)">Type <code>Group.Category</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group.Category).AIRPLANE">Group.Category.AIRPLANE</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group.Category).GROUND">Group.Category.GROUND</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group.Category).HELICOPTER">Group.Category.HELICOPTER</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(Group.Category).SHIP">Group.Category.SHIP</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="#(DCSGroup)" >Type <code>DCSGroup</code></a></h2>
|
|
|
|
<h2><a id="#(Group)" >Type <code>Group</code></a></h2>
|
|
|
|
<p>Represents group of Units.</p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(Group.Category)">#Group.Category</a></em>
|
|
<a id="#(Group).Category" >
|
|
<strong>Group.Category</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enum contains identifiers of group types. </p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(ID)">#ID</a></em>
|
|
<a id="#(Group).ID" >
|
|
<strong>Group.ID</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Identifier of a group. It is assigned to a group by Mission Editor automatically. </p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).destroy" >
|
|
<strong>Group:destroy()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Destroys the group and all of its units.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).getByName" >
|
|
<strong>Group.getByName(name)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Returns group by the name assigned to the group in Mission Editor. </p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string name </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).getCategory" >
|
|
<strong>Group:getCategory()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Returns category of the group.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(Group.Category)">#Group.Category</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).getController" >
|
|
<strong>Group:getController()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Returns controller of the group. </p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="Controller.html##(Controller)">Controller#Controller</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).getID" >
|
|
<strong>Group:getID()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Returns the group identifier.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ID)">#ID</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).getInitialSize" >
|
|
<strong>Group:getInitialSize()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Returns initial size of the group.</p>
|
|
|
|
|
|
<p>If some of the units will be destroyed, initial size of the group will not be changed. Initial size limits the unitNumber parameter for Group.getUnit() function.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).getName" >
|
|
<strong>Group:getName()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Returns the group's name.</p>
|
|
|
|
|
|
<p>This is the same name assigned to the group in Mission Editor.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#string:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).getSize" >
|
|
<strong>Group:getSize()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Returns current size of the group.</p>
|
|
|
|
|
|
<p>If some of the units will be destroyed, As units are destroyed the size of the group will be changed.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).getUnit" >
|
|
<strong>Group:getUnit(unitNumber)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Returns the unit with number unitNumber.</p>
|
|
|
|
|
|
<p>If the unit is not exists the function will return nil.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number unitNumber </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="DCSUnit.html##(Unit)">DCSUnit#Unit</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).getUnits" >
|
|
<strong>Group:getUnits()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Returns array of the units present in the group now.</p>
|
|
|
|
|
|
<p>Destroyed units will not be enlisted at all.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(list)">#list</a>:</em>
|
|
DCSUnit#Unit> array of Units</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group).isExist" >
|
|
<strong>Group:isExist()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>returns true if the group exist or false otherwise. </p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#boolean:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(Group.Category)" >Type <code>Group.Category</code></a></h2>
|
|
|
|
<p>Enum contains identifiers of group types.</p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group.Category).AIRPLANE" >
|
|
<strong>Group.Category.AIRPLANE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group.Category).GROUND" >
|
|
<strong>Group.Category.GROUND</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group.Category).HELICOPTER" >
|
|
<strong>Group.Category.HELICOPTER</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(Group.Category).SHIP" >
|
|
<strong>Group.Category.SHIP</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(ID)" >Type <code>ID</code></a></h2>
|
|
|
|
<h2><a id="#(list)" >Type <code>list</code></a></h2>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|