MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2021-12-11 13:27:06 +00:00
parent c1b74bddf9
commit 73be61e71f
24 changed files with 9048 additions and 800 deletions

View File

@@ -1669,7 +1669,9 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
my_ctld.cratecountry = country.id.GERMANY -- ID of crates. Will default to country.id.RUSSIA for RED coalition setups.
my_ctld.allowcratepickupagain = true -- allow re-pickup crates that were dropped.
my_ctld.enableslingload = false -- allow cargos to be slingloaded - might not work for all cargo types
my_ctld.pilotmustopendoors = false -- -- force opening of doors
my_ctld.pilotmustopendoors = false -- force opening of doors
my_ctld.SmokeColor = SMOKECOLOR.Red -- color to use when dropping smoke from heli
my_ctld.FlareColor = FLARECOLOR.Red -- color to use when flaring from heli
</code></pre>
<h2>2.1 User functions</h2>
@@ -1825,7 +1827,7 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
<h2>4.1 Manage Crates</h2>
<p>Use this entry to get, load, list nearby, drop, build and repair crates. Also @see options.</p>
<p>Use this entry to get, load, list nearby, drop, build and repair crates. Also see options.</p>
<h2>4.2 Manage Troops</h2>
@@ -1836,7 +1838,7 @@ Currently limited CTLD_CARGO troops, which are build from <strong>one</strong> t
<p>Lists what you have loaded. Shows load capabilities for number of crates and number of seats for troops.</p>
<h2>4.4 Smoke &amp; Flare zones nearby</h2>
<h2>4.4 Smoke &amp; Flare zones nearby or drop smoke or flare from Heli</h2>
<p>Does what it says.</p>
@@ -2165,6 +2167,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).ExtractFactor">CTLD.ExtractFactor</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).FlareColor">CTLD.FlareColor</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2417,12 +2425,24 @@ 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).RemoveStockTroops">CTLD:RemoveStockTroops(Name, Number)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>User - function to remove stock of a certain troops type</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).SmokeColor">CTLD.SmokeColor</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).SmokePositionNow">CTLD:SmokePositionNow(Unit, Flare)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>User function - Drop a smoke or flare at current location.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).SmokeZoneNearBy">CTLD:SmokeZoneNearBy(Unit, Flare)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>User function - Start smoke in a zone close to the Unit.</p>
<p>User function - Start smoke/flare in a zone close to the Unit.</p>
</td>
</tr>
<tr class="w3-border">
@@ -5612,7 +5632,7 @@ 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">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -5634,7 +5654,7 @@ 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">
#table
<a id="#(CTLD).DroppedTroops" ><strong>CTLD.DroppedTroops</strong></a>
@@ -5659,28 +5679,11 @@ 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">
#number
<a id="#(CTLD).Engineers" ><strong>CTLD.Engineers</strong></a>
<p>use as counter</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).EngineersInField" ><strong>CTLD.EngineersInField</strong></a>
<p>holds #CTLD_ENGINEERING objects</p>
</div>
</div>
@@ -5695,6 +5698,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> factor for troops extraction, i.e. CrateDistance * Extractfactor</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD).FlareColor" ><strong>CTLD.FlareColor</strong></a>
</div>
</div>
@@ -5853,14 +5867,11 @@ 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">
#table
<a id="#(CTLD).PilotGroups" ><strong>CTLD.PilotGroups</strong></a>
<p> tables</p>
</div>
</div>
@@ -5888,6 +5899,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD).SmokeColor" ><strong>CTLD.SmokeColor</strong></a>
<p> Smokes and Flares</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -6255,7 +6280,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> time to repair a unit/group</p>
<p> noob catch</p>
</div>
@@ -9049,6 +9074,52 @@ 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).SmokePositionNow" ><strong>CTLD:SmokePositionNow(Unit, Flare)</strong></a></h2>
</div>
<p>User function - Drop a smoke or flare at current location.</p>
<div id= "#Functions##SmokePositionNow" 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.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Flare</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, flare instead.</p>
</div>
</div>
</div>
</div>
</div>
@@ -9058,7 +9129,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(CTLD).SmokeZoneNearBy" ><strong>CTLD:SmokeZoneNearBy(Unit, Flare)</strong></a></h2>
</div>
<p>User function - Start smoke in a zone close to the Unit.</p>
<p>User function - Start smoke/flare in a zone close to the Unit.</p>
<div id= "#Functions##SmokeZoneNearBy" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12682,7 +12753,7 @@ 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">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -12704,7 +12775,7 @@ 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">
#table
<a id="#(CTLD).DroppedTroops" ><strong>CTLD.DroppedTroops</strong></a>
@@ -12729,28 +12800,11 @@ 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">
#number
<a id="#(CTLD).Engineers" ><strong>CTLD.Engineers</strong></a>
<p>use as counter</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).EngineersInField" ><strong>CTLD.EngineersInField</strong></a>
<p>holds #CTLD_ENGINEERING objects</p>
</div>
</div>
@@ -12765,6 +12819,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> factor for troops extraction, i.e. CrateDistance * Extractfactor</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD).FlareColor" ><strong>CTLD.FlareColor</strong></a>
</div>
</div>
@@ -12923,14 +12988,11 @@ 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">
#table
<a id="#(CTLD).PilotGroups" ><strong>CTLD.PilotGroups</strong></a>
<p> tables</p>
</div>
</div>
@@ -12958,6 +13020,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD).SmokeColor" ><strong>CTLD.SmokeColor</strong></a>
<p> Smokes and Flares</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -13325,7 +13401,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> time to repair a unit/group</p>
<p> noob catch</p>
</div>
@@ -14970,7 +15046,7 @@ 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">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -14992,7 +15068,7 @@ 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">
#table
<a id="#(CTLD).DroppedTroops" ><strong>CTLD.DroppedTroops</strong></a>
@@ -15017,28 +15093,11 @@ 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">
#number
<a id="#(CTLD).Engineers" ><strong>CTLD.Engineers</strong></a>
<p>use as counter</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).EngineersInField" ><strong>CTLD.EngineersInField</strong></a>
<p>holds #CTLD_ENGINEERING objects</p>
</div>
</div>
@@ -15053,6 +15112,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> factor for troops extraction, i.e. CrateDistance * Extractfactor</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD).FlareColor" ><strong>CTLD.FlareColor</strong></a>
</div>
</div>
@@ -15211,14 +15281,11 @@ 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">
#table
<a id="#(CTLD).PilotGroups" ><strong>CTLD.PilotGroups</strong></a>
<p> tables</p>
</div>
</div>
@@ -15246,6 +15313,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD).SmokeColor" ><strong>CTLD.SmokeColor</strong></a>
<p> Smokes and Flares</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -15613,7 +15694,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> time to repair a unit/group</p>
<p> noob catch</p>
</div>
@@ -19407,6 +19488,17 @@ BASE:TraceOnOff( false )</code></pre>
<p>Can transport crate.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD.UnitCapabilities).length" ><strong>CTLD.UnitCapabilities.length</strong></a>
</div>
</div>