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:
FlightControl-User
@@ -1414,7 +1414,7 @@ Controls a network of SAM sites.</p>
|
||||
|
||||
<h3>Author: <strong>FlightControl</strong></h3>
|
||||
|
||||
<h3>Contributions:</h3>
|
||||
<h3>Contributions: <strong>funkyfranky</strong></h3>
|
||||
|
||||
<hr/>
|
||||
|
||||
@@ -1525,6 +1525,12 @@ If you want to obtain the complete <strong>3D position</strong> including ori<72>
|
||||
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from UNIT</th>
|
||||
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<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).Explode">UNIT:Explode(power, delay)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
@@ -1565,6 +1571,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).GetCategoryName">UNIT:GetCategoryName()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the category name of the #UNIT.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).GetClient">UNIT:GetClient()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Get the CLIENT of the unit </p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1731,6 +1743,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).IsAlive">UNIT:IsAlive()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns if the Unit is alive.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).IsClient">UNIT:IsClient()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Checks is the unit is a <em>Player</em> or <em>Client</em> slot.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1815,6 +1833,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).UnHandleEvent">UNIT:UnHandleEvent(EventID)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>UnSubscribe to a DCS event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).UnitName">UNIT.UnitName</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Name of the unit.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -3373,6 +3397,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).CreateEventDead">UNIT:CreateEventDead(EventTime, Initiator)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Creation of a Dead Event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).CreateEventPlayerEnterAircraft">UNIT:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3616,6 +3646,12 @@ place: Object that the unit landed on.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).OnEventPilotDead">UNIT:OnEventPilotDead(EventData)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Occurs when the pilot of an aircraft is killed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).OnEventPlayerEnterAircraft">UNIT:OnEventPlayerEnterAircraft(EventData)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3864,6 +3900,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="fields w3-container w3-theme-l2">
|
||||
<h2>Field(s)</h2>
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).ClassName" ><strong>UNIT.ClassName</strong></a>
|
||||
|
||||
<p>Name of the class.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).UnitName" ><strong>UNIT.UnitName</strong></a>
|
||||
|
||||
<p>Name of the unit.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
@@ -4161,6 +4219,36 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UNIT).GetClient" ><strong>UNIT:GetClient()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Get the CLIENT of the unit </p>
|
||||
|
||||
<div id= "#Functions##GetClient" 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="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p> </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -5180,6 +5268,39 @@ 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).IsClient" ><strong>UNIT:IsClient()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Checks is the unit is a <em>Player</em> or <em>Client</em> slot.</p>
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
<div id= "#Functions##IsClient" 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>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>If true, unit is a player or client aircraft </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -5703,7 +5824,7 @@ If the Unit is alive but not active, false is returned. </p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -5789,6 +5910,28 @@ If the Unit is alive but not active, false is returned. </p>
|
||||
<div class="fields w3-container w3-theme-l2">
|
||||
<h2>Field(s)</h2>
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).ClassName" ><strong>UNIT.ClassName</strong></a>
|
||||
|
||||
<p>Name of the class.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).UnitName" ><strong>UNIT.UnitName</strong></a>
|
||||
|
||||
<p>Name of the unit.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
@@ -14092,6 +14235,28 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
|
||||
<div class="fields w3-container w3-theme-l2">
|
||||
<h2>Field(s)</h2>
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).ClassName" ><strong>UNIT.ClassName</strong></a>
|
||||
|
||||
<p>Name of the class.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).UnitName" ><strong>UNIT.UnitName</strong></a>
|
||||
|
||||
<p>Name of the unit.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
@@ -17424,6 +17589,28 @@ Coordinates are dependent on the position of the maps origin.</p>
|
||||
<div class="fields w3-container w3-theme-l2">
|
||||
<h2>Field(s)</h2>
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).ClassName" ><strong>UNIT.ClassName</strong></a>
|
||||
|
||||
<p>Name of the class.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).UnitName" ><strong>UNIT.UnitName</strong></a>
|
||||
|
||||
<p>Name of the unit.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
@@ -17946,6 +18133,28 @@ If the Identifiable is alive, true is returned. </p>
|
||||
<div class="fields w3-container w3-theme-l2">
|
||||
<h2>Field(s)</h2>
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).ClassName" ><strong>UNIT.ClassName</strong></a>
|
||||
|
||||
<p>Name of the class.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).UnitName" ><strong>UNIT.UnitName</strong></a>
|
||||
|
||||
<p>Name of the unit.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
@@ -18074,6 +18283,28 @@ If the Identifiable is alive, true is returned. </p>
|
||||
<div class="fields w3-container w3-theme-l2">
|
||||
<h2>Field(s)</h2>
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).ClassName" ><strong>UNIT.ClassName</strong></a>
|
||||
|
||||
<p>Name of the class.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(UNIT).UnitName" ><strong>UNIT.UnitName</strong></a>
|
||||
|
||||
<p>Name of the unit.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
@@ -18289,6 +18520,39 @@ If the Identifiable is alive, true 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).CreateEventPlayerEnterAircraft" ><strong>UNIT:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
||||
|
||||
<div id= "#Functions##CreateEventPlayerEnterAircraft" 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="Core.Base.html##(BASE)">Core.Base#BASE</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>
|
||||
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
|
||||
<strong><strong>PlayerUnit</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The aircraft unit the player entered.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -19842,6 +20106,43 @@ initiator : The unit that the pilot has died in. </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).OnEventPlayerEnterAircraft" ><strong>UNIT:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
||||
|
||||
|
||||
<p><strong>NOTE</strong>: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event.
|
||||
initiator : The unit that is being taken control of. </p>
|
||||
|
||||
<div id= "#Functions##OnEventPlayerEnterAircraft" 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="Core.Base.html##(BASE)">Core.Base#BASE</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>
|
||||
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
||||
<strong><strong>EventData</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The EventData structure.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user