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
@@ -1735,6 +1735,18 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ClassName">CLIENT.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="##(CLIENT).DisableEmission">CLIENT: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="##(CLIENT).EnableEmission">CLIENT: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">
|
||||
@@ -1788,7 +1800,7 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetDCSObject">CLIENT: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">
|
||||
@@ -1934,7 +1946,7 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).InAir">CLIENT:InAir()</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).InAir">CLIENT: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>
|
||||
@@ -2033,6 +2045,12 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ResetEvents">CLIENT: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="##(CLIENT).SetEmission">CLIENT: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">
|
||||
@@ -2728,7 +2746,7 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskFireAtPoint">CLIENT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskFireAtPoint">CLIENT: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>
|
||||
@@ -4122,7 +4140,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
<p> Alive2.</p>
|
||||
<p> Alive.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -5236,7 +5254,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
<p> Alive2.</p>
|
||||
<p> Alive.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -5373,6 +5391,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="#(CLIENT).DisableEmission" ><strong>CLIENT: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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></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="#(CLIENT).EnableEmission" ><strong>CLIENT: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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></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="#(CLIENT).Explode" ><strong>CLIENT:Explode(power, delay)</strong></a></h2>
|
||||
</div>
|
||||
@@ -5704,7 +5788,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<h2><a id="#(CLIENT).GetDCSObject" ><strong>CLIENT: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">
|
||||
@@ -5808,24 +5892,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-margin-left">
|
||||
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></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>
|
||||
|
||||
@@ -6625,7 +6701,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="#(CLIENT).InAir" ><strong>CLIENT:InAir()</strong></a></h2>
|
||||
<h2><a id="#(CLIENT).InAir" ><strong>CLIENT:InAir(NoHeloCheck)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns true if the UNIT is in the air.</p>
|
||||
@@ -6636,6 +6712,20 @@ The spawn sequence number and unit number are contained within the name after th
|
||||
<div class="w3-margin-left">
|
||||
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></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">
|
||||
@@ -7306,6 +7396,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="#(CLIENT).SetEmission" ><strong>CLIENT: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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></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>
|
||||
|
||||
@@ -7376,7 +7513,7 @@ If the Unit is alive but not active, false is returned. </p>
|
||||
|
||||
|
||||
|
||||
<p> Alive2.</p>
|
||||
<p> Alive.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -14224,7 +14361,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="#(CLIENT).TaskFireAtPoint" ><strong>CLIENT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType)</strong></a></h2>
|
||||
<h2><a id="#(CLIENT).TaskFireAtPoint" ><strong>CLIENT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType, Altitude, ASL)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>(GROUND) Fire at a VEC2 point until ammunition is finished.</p>
|
||||
@@ -14286,6 +14423,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>
|
||||
@@ -15831,7 +15994,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
|
||||
|
||||
|
||||
|
||||
<p> Alive2.</p>
|
||||
<p> Alive.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -19315,7 +19478,7 @@ Coordinates are dependent on the position of the maps origin.</p>
|
||||
|
||||
|
||||
|
||||
<p> Alive2.</p>
|
||||
<p> Alive.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -19989,7 +20152,7 @@ If the Identifiable is alive, true is returned. </p>
|
||||
|
||||
|
||||
|
||||
<p> Alive2.</p>
|
||||
<p> Alive.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -20269,7 +20432,7 @@ If the Identifiable is alive, true is returned. </p>
|
||||
|
||||
|
||||
|
||||
<p> Alive2.</p>
|
||||
<p> Alive.</p>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user