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
@@ -1581,7 +1581,7 @@ Controls a network of short range air/missile defense groups.</p>
|
||||
|
||||
<h3>Author: <strong>FlightControl</strong></h3>
|
||||
|
||||
<h3>Contributions:</h3>
|
||||
<h3>Contributions: <strong>Applevangelist</strong></h3>
|
||||
|
||||
<hr/>
|
||||
|
||||
@@ -1636,27 +1636,45 @@ Controls a network of short range air/missile defense groups.</p>
|
||||
<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="##(SCENERY).FindByName">SCENERY:FindByName(name)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).ClassName">SCENERY.ClassName</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p> Create a SCENERY object from it's name/id.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).FindByName">SCENERY:FindByName(Name, Coordinate, Radius)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p> Find a SCENERY object from it's name/id.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).FindByNameInZone">SCENERY:FindByNameInZone(Name, Zone, Radius)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p> Find a SCENERY object from it's name/id.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).GetDCSObject">SCENERY:GetDCSObject()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p> Register scenery object as POSITIONABLE.</p>
|
||||
<p> Obtain DCS Object from the SCENERY Object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).GetThreatLevel">SCENERY:GetThreatLevel()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p> Register scenery object as POSITIONABLE.</p>
|
||||
<p> Get the threat level of a SCENERY object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).Register">SCENERY:Register(SceneryName, SceneryObject)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p> Register scenery object as POSITIONABLE.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).SceneryName">SCENERY.SceneryName</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2921,7 +2939,29 @@ 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">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).ClassName" ><strong>SCENERY.ClassName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).SceneryName" ><strong>SCENERY.SceneryName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<a href="##(DCS.Object)">#DCS.Object</a>
|
||||
<a id="#(SCENERY).SceneryObject" ><strong>SCENERY.SceneryObject</strong></a>
|
||||
|
||||
|
||||
@@ -2935,10 +2975,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(SCENERY).FindByName" ><strong>SCENERY:FindByName(name)</strong></a></h2>
|
||||
<h2><a id="#(SCENERY).FindByName" ><strong>SCENERY:FindByName(Name, Coordinate, Radius)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p> Create a SCENERY object from it's name/id.</p>
|
||||
<p> Find a SCENERY object from it's name/id.</p>
|
||||
|
||||
|
||||
<p>Since SCENERY isn't registered in the Moose database (just too many objects per map), we need to do a scan first
|
||||
to find the correct object.</p>
|
||||
|
||||
<div id= "#Functions##FindByName" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -2946,18 +2990,44 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-margin-left">
|
||||
<p>SCENERY</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>name</strong></strong>
|
||||
<strong><strong>Name</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The name/id of the scenery object as taken from the ME. Ex. '595785449'</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
||||
<strong><strong>Coordinate</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Where to find the scenery object</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Radius</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Search radius around coordinate, defaults to 100</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
@@ -2967,7 +3037,81 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Scenery Object - <strong>Note</strong> this might not point to anything useful. Check with <code>myscenery:IsAlive()</code> if it is valid.</p>
|
||||
<p>Scenery Object or <code>nil</code> if it cannot be found</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="#(SCENERY).FindByNameInZone" ><strong>SCENERY:FindByNameInZone(Name, Zone, Radius)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p> Find a SCENERY object from it's name/id.</p>
|
||||
|
||||
|
||||
<p>Since SCENERY isn't registered in the Moose database (just too many objects per map), we need to do a scan first
|
||||
to find the correct object.</p>
|
||||
|
||||
<div id= "#Functions##FindByNameInZone" 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>SCENERY</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Name</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The name/id of the scenery object as taken from the ME. Ex. '595785449'</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
||||
<strong><strong>Zone</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Where to find the scenery object. Can be handed as zone name.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Radius</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Search radius around coordinate, defaults to 100</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="##(SCENERY)">#SCENERY</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Scenery Object or <code>nil</code> if it cannot be found</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -2982,7 +3126,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<h2><a id="#(SCENERY).GetDCSObject" ><strong>SCENERY:GetDCSObject()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p> Register scenery object as POSITIONABLE.</p>
|
||||
<p> Obtain DCS Object from the SCENERY Object.</p>
|
||||
|
||||
<div id= "#Functions##GetDCSObject" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -3012,7 +3156,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<h2><a id="#(SCENERY).GetThreatLevel" ><strong>SCENERY:GetThreatLevel()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p> Register scenery object as POSITIONABLE.</p>
|
||||
<p> Get the threat level of a SCENERY object.</p>
|
||||
|
||||
|
||||
<p>Always 0.</p>
|
||||
|
||||
<div id= "#Functions##GetThreatLevel" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -3107,7 +3254,29 @@ 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">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).ClassName" ><strong>SCENERY.ClassName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).SceneryName" ><strong>SCENERY.SceneryName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<a href="##(DCS.Object)">#DCS.Object</a>
|
||||
<a id="#(SCENERY).SceneryObject" ><strong>SCENERY.SceneryObject</strong></a>
|
||||
|
||||
|
||||
@@ -6832,7 +7001,29 @@ Coordinates are dependent on the position of the maps origin.</p>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).ClassName" ><strong>SCENERY.ClassName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).SceneryName" ><strong>SCENERY.SceneryName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<a href="##(DCS.Object)">#DCS.Object</a>
|
||||
<a id="#(SCENERY).SceneryObject" ><strong>SCENERY.SceneryObject</strong></a>
|
||||
|
||||
|
||||
@@ -7336,7 +7527,29 @@ If the Identifiable is alive, true is returned. </p>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).ClassName" ><strong>SCENERY.ClassName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).SceneryName" ><strong>SCENERY.SceneryName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<a href="##(DCS.Object)">#DCS.Object</a>
|
||||
<a id="#(SCENERY).SceneryObject" ><strong>SCENERY.SceneryObject</strong></a>
|
||||
|
||||
|
||||
@@ -7475,7 +7688,29 @@ If the Identifiable is alive, true is returned. </p>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).ClassName" ><strong>SCENERY.ClassName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SCENERY).SceneryName" ><strong>SCENERY.SceneryName</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<a href="##(DCS.Object)">#DCS.Object</a>
|
||||
<a id="#(SCENERY).SceneryObject" ><strong>SCENERY.SceneryObject</strong></a>
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user