mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -1494,7 +1494,7 @@ methods will fire off a flare in the air with the corresponding color. Note that
|
||||
|
||||
<p>The UNIT class provides methods to obtain the current point or position of the DCS Unit.
|
||||
The <a href="##(UNIT).GetPointVec2">UNIT.GetPointVec2</a>(), <a href="##(UNIT).GetVec3">UNIT.GetVec3</a>() will obtain the current <strong>location</strong> of the DCS Unit in a Vec2 (2D) or a <strong>point</strong> in a Vec3 (3D) vector respectively.
|
||||
If you want to obtain the complete <strong>3D position</strong> including ori<EFBFBD>ntation and direction vectors, consult the <a href="##(UNIT).GetPositionVec3">UNIT.GetPositionVec3</a>() method respectively.</p>
|
||||
If you want to obtain the complete <strong>3D position</strong> including orientation and direction vectors, consult the <a href="##(UNIT).GetPositionVec3">UNIT.GetPositionVec3</a>() method respectively.</p>
|
||||
|
||||
<h2>Test if alive</h2>
|
||||
|
||||
@@ -1545,6 +1545,18 @@ If you want to obtain the complete <strong>3D position</strong> including ori<72>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).ClassName">UNIT.ClassName</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Name of the class.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).DisableEmission">UNIT:DisableEmission()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sets the passed group or unit objects radar emitters OFF.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).EnableEmission">UNIT:EnableEmission()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sets the passed group or unit objects radar emitters ON.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1598,7 +1610,7 @@ If you want to obtain the complete <strong>3D position</strong> including ori<72>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).GetDCSObject">UNIT:GetDCSObject()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Get the DCS unit object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1744,7 +1756,7 @@ If you want to obtain the complete <strong>3D position</strong> including ori<72>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).InAir">UNIT:InAir()</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).InAir">UNIT:InAir(NoHeloCheck)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns true if the UNIT is in the air.</p>
|
||||
</td>
|
||||
@@ -1843,6 +1855,12 @@ If you want to obtain the complete <strong>3D position</strong> including ori<72>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).ResetEvents">UNIT:ResetEvents()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Reset the subscriptions.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).SetEmission">UNIT:SetEmission(Switch)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sets the passed group or unit objects radar emitters on or off.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2538,7 +2556,7 @@ If you want to obtain the complete <strong>3D position</strong> including ori<72>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).TaskFireAtPoint">UNIT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).TaskFireAtPoint">UNIT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType, Altitude, ASL)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>(GROUND) Fire at a VEC2 point until ammunition is finished.</p>
|
||||
</td>
|
||||
@@ -3973,6 +3991,72 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UNIT).DisableEmission" ><strong>UNIT:DisableEmission()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sets the passed group or unit objects radar emitters OFF.</p>
|
||||
|
||||
|
||||
<p>Can be used on sam sites for example to shut down the radar without setting AI off or changing the alarm state.</p>
|
||||
|
||||
<div id= "#Functions##DisableEmission" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>UNIT</p>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(UNIT)">#UNIT</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UNIT).EnableEmission" ><strong>UNIT:EnableEmission()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sets the passed group or unit objects radar emitters ON.</p>
|
||||
|
||||
|
||||
<p>Can be used on sam sites for example to shut down the radar without setting AI off or changing the alarm state.</p>
|
||||
|
||||
<div id= "#Functions##EnableEmission" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>UNIT</p>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(UNIT)">#UNIT</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UNIT).Explode" ><strong>UNIT:Explode(power, delay)</strong></a></h2>
|
||||
</div>
|
||||
@@ -4304,7 +4388,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<h2><a id="#(UNIT).GetDCSObject" ><strong>UNIT:GetDCSObject()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
<p>Get the DCS unit object.</p>
|
||||
|
||||
<div id= "#Functions##GetDCSObject" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -4408,24 +4492,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-margin-left">
|
||||
<p>UNIT</p>
|
||||
</div>
|
||||
<h2><strong>Return values:</strong></h2>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The Group of the Unit.</p>
|
||||
<div class="w3-half">
|
||||
<p><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The Group of the Unit or <code>nil</code> if the unit does not exist. </p>
|
||||
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#nil:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The DCS Unit is not existing or alive. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -5225,7 +5301,7 @@ The spawn sequence number and unit number are contained within the name after th
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UNIT).InAir" ><strong>UNIT:InAir()</strong></a></h2>
|
||||
<h2><a id="#(UNIT).InAir" ><strong>UNIT:InAir(NoHeloCheck)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns true if the UNIT is in the air.</p>
|
||||
@@ -5236,6 +5312,20 @@ The spawn sequence number and unit number are contained within the name after th
|
||||
<div class="w3-margin-left">
|
||||
<p>UNIT</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>NoHeloCheck</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>If true, no additonal checks for helos are performed.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
@@ -5906,6 +5996,53 @@ If the Unit is alive but not active, false is returned. </p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UNIT).SetEmission" ><strong>UNIT:SetEmission(Switch)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sets the passed group or unit objects radar emitters on or off.</p>
|
||||
|
||||
|
||||
<p>Can be used on sam sites for example to shut down the radar without setting AI off or changing the alarm state.</p>
|
||||
|
||||
<div id= "#Functions##SetEmission" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>UNIT</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>Switch</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>If <code>true</code> or <code>nil</code>, emission is enabled. If <code>false</code>, emission is turned off.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(UNIT)">#UNIT</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -12694,7 +12831,7 @@ If the task is assigned to the controllable lead unit will be a FAC.</p>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UNIT).TaskFireAtPoint" ><strong>UNIT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType)</strong></a></h2>
|
||||
<h2><a id="#(UNIT).TaskFireAtPoint" ><strong>UNIT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType, Altitude, ASL)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>(GROUND) Fire at a VEC2 point until ammunition is finished.</p>
|
||||
@@ -12756,6 +12893,32 @@ If the task is assigned to the controllable lead unit will be a FAC.</p>
|
||||
|
||||
<p>(optional) Enum for weapon type ID. This value is only required if you want the group firing to use a specific weapon, for instance using the task on a ship to force it to fire guided missiles at targets within cannon range. See http://wiki.hoggit.us/view/DCS_enum_weapon_flag</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Altitude</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional) Altitude in meters.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>ASL</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Altitude is above mean sea level. Default is above ground level. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
|
||||
Reference in New Issue
Block a user