MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-08-01 14:28:00 +00:00
parent 5ec02898bf
commit 5d1e6fbf25
30 changed files with 753 additions and 954 deletions

View File

@@ -1682,7 +1682,7 @@
</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="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).FindByName">SCENERY:FindByName(Name, Coordinate, Radius, Role)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Find a SCENERY object from its name or id.</p>
</td>
@@ -1697,6 +1697,12 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).FindByZoneName">SCENERY:FindByZoneName(ZoneName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Find a SCENERY object from its zone name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).GetAllProperties">SCENERY:GetAllProperties()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the scenery Properties table.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1715,6 +1721,18 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).GetLife0">SCENERY:GetLife0()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Get initial life points of 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).GetName">SCENERY:GetName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Obtain object name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).GetProperty">SCENERY:GetProperty(PropertyName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the Value of the zone with the given PropertyName, or nil if no matching property exists.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1739,6 +1757,12 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).Life0">SCENERY.Life0</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Initial life points.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).Properties">SCENERY.Properties</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -1757,6 +1781,12 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCENERY).SceneryObject">SCENERY.SceneryObject</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>DCS 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).SetProperty">SCENERY:SetProperty(PropertyName, PropertyValue)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set a scenery property</p>
</td>
</tr>
</table>
@@ -3064,6 +3094,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Initial life points.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SCENERY).Properties" ><strong>SCENERY.Properties</strong></a>
</div>
</div>
@@ -3173,7 +3214,7 @@ 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, Coordinate, Radius)</strong></a></h2>
<h2><a id="#(SCENERY).FindByName" ><strong>SCENERY:FindByName(Name, Coordinate, Radius, Role)</strong></a></h2>
</div>
<p> Find a SCENERY object from its name or id.</p>
@@ -3228,6 +3269,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Role</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
@@ -3279,7 +3330,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<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>
<a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>
<strong><strong>Zone</strong></strong>
</p>
</div>
@@ -3363,6 +3414,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="#(SCENERY).GetAllProperties" ><strong>SCENERY:GetAllProperties()</strong></a></h2>
</div>
<p>Returns the scenery Properties table.</p>
<div id= "#Functions##GetAllProperties" 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>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The Key:Value table of QuadZone properties of the zone from the scenery assignment .</p>
</div>
</div>
</div>
</div>
</div>
@@ -3458,6 +3539,80 @@ 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="#(SCENERY).GetName" ><strong>SCENERY:GetName()</strong></a></h2>
</div>
<p> Obtain object name.</p>
<div id= "#Functions##GetName" 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>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>Name</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).GetProperty" ><strong>SCENERY:GetProperty(PropertyName)</strong></a></h2>
</div>
<p>Returns the Value of the zone with the given PropertyName, or nil if no matching property exists.</p>
<div id= "#Functions##GetProperty" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>PropertyName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of a the QuadZone Property from the scenery assignment to be retrieved.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>The Value of the QuadZone Property from the scenery assignment with the given PropertyName, or nil if absent.</p>
</div>
</div>
</div>
</div>
</div>
@@ -3616,6 +3771,59 @@ 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="#(SCENERY).SetProperty" ><strong>SCENERY:SetProperty(PropertyName, PropertyValue)</strong></a></h2>
</div>
<p>Set a scenery property</p>
<div id= "#Functions##SetProperty" 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>PropertyName</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>PropertyValue</strong></strong>
</p>
</div>
<div class="w3-half">
<p></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>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -3641,6 +3849,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Initial life points.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SCENERY).Properties" ><strong>SCENERY.Properties</strong></a>
</div>
</div>
@@ -7642,6 +7861,17 @@ Coordinates are dependent on the position of the maps origin.</p>
<p>Initial life points.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SCENERY).Properties" ><strong>SCENERY.Properties</strong></a>
</div>
</div>
@@ -8179,6 +8409,17 @@ If the Identifiable is alive, true is returned. </p>
<p>Initial life points.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SCENERY).Properties" ><strong>SCENERY.Properties</strong></a>
</div>
</div>
@@ -8351,6 +8592,17 @@ If the Identifiable is alive, true is returned. </p>
<p>Initial life points.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SCENERY).Properties" ><strong>SCENERY.Properties</strong></a>
</div>
</div>