MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-10-23 14:53:42 +00:00
parent ffeb91ddff
commit f3e47adf8e
57 changed files with 1187 additions and 967 deletions

View File

@@ -1626,8 +1626,8 @@ Controls a network of short range air/missile defense groups.</p>
<hr/>
<p>For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _<a href="DATABASE.html">DATABASE</a> object.
This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Group objects are spawned (using the <a href="SPAWN.html">SPAWN</a> class).</p>
<p>For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).
This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Group objects are spawned (using the <a href="Core.Spawn.html">Core.Spawn</a> class).</p>
<p>The GROUP class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference
using the DCS Group or the DCS GroupName.</p>
@@ -1673,8 +1673,8 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return
<p>The GROUP class provides the following functions to retrieve quickly the relevant GROUP instance:</p>
<ul>
<li><a href="##(GROUP).Find">GROUP.Find</a>(): Find a GROUP instance from the _DATABASE object using a DCS Group object.</li>
<li><a href="##(GROUP).FindByName">GROUP.FindByName</a>(): Find a GROUP instance from the _DATABASE object using a DCS Group name.</li>
<li><a href="##(GROUP).Find">GROUP.Find</a>(): Find a GROUP instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a DCS Group object.</li>
<li><a href="##(GROUP).FindByName">GROUP.FindByName</a>(): Find a GROUP instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a DCS Group name.</li>
</ul>
<h1>1. Tasking of groups</h1>
@@ -1856,7 +1856,7 @@ Use the following Zone validation methods on the group:</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).CopyRoute">GROUP:CopyRoute(Begin, End, Randomize, Radius)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the route of a group by using the <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a> class.</p>
<p>Return the route of a group by using the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).</p>
</td>
</tr>
<tr class="w3-border">
@@ -2148,13 +2148,13 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetTemplate">GROUP:GetTemplate()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the group template from the <a href="DATABASE.html">DATABASE</a> (_DATABASE object).</p>
<p>Returns the group template from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetTemplateRoutePoints">GROUP:GetTemplateRoutePoints()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the group template route.points[] (the waypoints) from the <a href="DATABASE.html">DATABASE</a> (_DATABASE object).</p>
<p>Returns the group template route.points[] (the waypoints) from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).</p>
</td>
</tr>
<tr class="w3-border">
@@ -3712,7 +3712,7 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetVelocity">GROUP:GetVelocity()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the a <a href="Velocity.html">Velocity</a> object from the POSITIONABLE.</p>
<p>Returns the <a href="Core.Velocity.html">Core.Velocity</a> object from the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
@@ -5137,7 +5137,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(GROUP).CopyRoute" ><strong>GROUP:CopyRoute(Begin, End, Randomize, Radius)</strong></a></h2>
</div>
<p>Return the route of a group by using the <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a> class.</p>
<p>Return the route of a group by using the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).</p>
<div id= "#Functions##CopyRoute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -6993,7 +6993,7 @@ amount of fuel in the group.</p>
<h2><a id="#(GROUP).GetTemplate" ><strong>GROUP:GetTemplate()</strong></a></h2>
</div>
<p>Returns the group template from the <a href="DATABASE.html">DATABASE</a> (_DATABASE object).</p>
<p>Returns the group template from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).</p>
<div id= "#Functions##GetTemplate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -7023,7 +7023,7 @@ amount of fuel in the group.</p>
<h2><a id="#(GROUP).GetTemplateRoutePoints" ><strong>GROUP:GetTemplateRoutePoints()</strong></a></h2>
</div>
<p>Returns the group template route.points[] (the waypoints) from the <a href="DATABASE.html">DATABASE</a> (_DATABASE object).</p>
<p>Returns the group template route.points[] (the waypoints) from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>).</p>
<div id= "#Functions##GetTemplateRoutePoints" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -20136,7 +20136,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<h2><a id="#(GROUP).GetVelocity" ><strong>GROUP:GetVelocity()</strong></a></h2>
</div>
<p>Returns the a <a href="Velocity.html">Velocity</a> object from the POSITIONABLE.</p>
<p>Returns the <a href="Core.Velocity.html">Core.Velocity</a> object from the POSITIONABLE.</p>
<div id= "#Functions##GetVelocity" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">