MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-12-21 13:14:59 +00:00
parent 26a7d8436c
commit e074bf7c76
30 changed files with 787 additions and 1087 deletions

View File

@@ -2597,6 +2597,12 @@ If you use units build by multiple templates, they will effectively double on lo
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).Positionable">CTLD.Positionable</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).PreloadTroops">CTLD:PreloadTroops(Unit, Troopname)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(User) Pre-load troops into a helo, e.g.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2789,6 +2795,12 @@ If you use units build by multiple templates, they will effectively double on lo
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._FindRepairNearby">CTLD:_FindRepairNearby(Group, Unit, Repairtype)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._FindTroopsCargoObject">CTLD:_FindTroopsCargoObject(Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Find a troops CTLD_CARGO object in stock</p>
</td>
</tr>
<tr class="w3-border">
@@ -2888,7 +2900,7 @@ If you use units build by multiple templates, they will effectively double on lo
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._LoadTroops">CTLD:_LoadTroops(Group, Unit, Cargotype)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._LoadTroops">CTLD:_LoadTroops(Group, Unit, Cargotype, Inject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to load troops into a heli.</p>
</td>
@@ -11877,6 +11889,72 @@ 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="#(CTLD).PreloadTroops" ><strong>CTLD:PreloadTroops(Unit, Troopname)</strong></a></h2>
</div>
<p>(User) Pre-load troops into a helo, e.g.</p>
<p>for airstart. Unit <strong>must</strong> be alive in-game, i.e. player has taken the slot!</p>
<div id= "#Functions##PreloadTroops" 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>CTLD</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>
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>Unit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The unit to load into, can be handed as Wrapper.Client#CLIENT object</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Troopname</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the Troops to be loaded. Must be created prior in the CTLD setup!</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="##(CTLD)">#CTLD</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> local client = UNIT:FindByName("Helo-1-1")
if client and client:IsAlive() then
myctld:PreloadTroops(client,"Infantry")
end</code></pre>
</div>
</div>
</div>
@@ -12896,6 +12974,50 @@ 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="#(CTLD)._FindTroopsCargoObject" ><strong>CTLD:_FindTroopsCargoObject(Name)</strong></a></h2>
</div>
<p>(Internal) Find a troops CTLD_CARGO object in stock</p>
<div id= "#Functions##_FindTroopsCargoObject" 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>CTLD</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>Name</strong></strong>
</p>
</div>
<div class="w3-half">
<p>of the object</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="##(CTLD_CARGO)">#CTLD_CARGO</a>:</p>
</div>
<div class="w3-half">
<p>Cargo object, nil if it cannot be found</p>
</div>
</div>
</div>
</div>
</div>
@@ -13629,7 +13751,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="#(CTLD)._LoadTroops" ><strong>CTLD:_LoadTroops(Group, Unit, Cargotype)</strong></a></h2>
<h2><a id="#(CTLD)._LoadTroops" ><strong>CTLD:_LoadTroops(Group, Unit, Cargotype, Inject)</strong></a></h2>
</div>
<p>(Internal) Function to load troops into a heli.</p>
@@ -13674,6 +13796,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Inject</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
@@ -31592,6 +31725,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
<p> template for a group of 10 paratroopers</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD_HERCULES).j" ><strong>CTLD_HERCULES.j</strong></a>
</div>
</div>
@@ -32845,6 +32989,17 @@ Use either this method to integrate the Hercules **or** the one from the "normal
<p> template for a group of 10 paratroopers</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD_HERCULES).j" ><strong>CTLD_HERCULES.j</strong></a>
</div>
</div>