MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-11-01 13:44:16 +00:00
parent c47f5406ac
commit 4d9cb198ed
25 changed files with 685 additions and 589 deletions

View File

@@ -1782,6 +1782,7 @@ Create the late-activated troops, vehicles, that will make up your deployable fo
my_ctld.smokedistance = 2000 -- Only smoke or flare zones if requesting player unit is this far away (in meters)
my_ctld.suppressmessages = false -- Set to true if you want to script your own messages.
my_ctld.repairtime = 300 -- Number of seconds it takes to repair a unit.
my_ctld.buildtime = 300 -- Number of seconds it takes to build a unit. Set to zero or nil to build instantly.
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
@@ -1791,6 +1792,7 @@ Create the late-activated troops, vehicles, that will make up your deployable fo
my_ctld.basetype = "container_cargo" -- default shape of the cargo container
my_ctld.droppedbeacontimeout = 600 -- dropped beacon lasts 10 minutes
my_ctld.usesubcats = false -- use sub-category names for crates, adds an extra menu layer in "Get Crates", useful if you have > 10 crate types.
my_ctld.placeCratesAhead = false -- place crates straight ahead of the helicopter, in a random way. If true, crates are more neatly sorted.
</code></pre>
<h2>2.1 User functions</h2>
@@ -2718,7 +2720,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)._BuildObjectFromCrates">CTLD:_BuildObjectFromCrates(Group, Unit, Build, Repair, Coordinate, RepairLocation)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._BuildObjectFromCrates">CTLD:_BuildObjectFromCrates(Group, Unit, Build, Repair, RepairLocation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to actually SPAWN buildables in the mission.</p>
</td>
@@ -2985,6 +2987,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).basetype">CTLD.basetype</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).buildtime">CTLD.buildtime</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -7088,17 +7096,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CargoCounter" ><strong>CTLD.CargoCounter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -7165,17 +7162,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CrateCounter" ><strong>CTLD.CrateCounter</strong></a>
</div>
</div>
@@ -7250,20 +7236,6 @@ 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">
#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">
@@ -7326,14 +7298,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).FreeVHFFrequencies" ><strong>CTLD.FreeVHFFrequencies</strong></a>
<p> Beacons</p>
</div>
</div>
@@ -7558,17 +7527,6 @@ 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">
#number
<a id="#(CTLD).TroopCounter" ><strong>CTLD.TroopCounter</strong></a>
</div>
</div>
@@ -7652,6 +7610,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> shape of the container</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).buildtime" ><strong>CTLD.buildtime</strong></a>
</div>
</div>
@@ -7713,17 +7682,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> #1570</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).droppedBeacons" ><strong>CTLD.droppedBeacons</strong></a>
</div>
</div>
@@ -7941,7 +7899,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> time to repair a unit/group</p>
<p> time to repairor build a unit/group</p>
</div>
@@ -8007,7 +7965,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">
#number
<a id="#(CTLD).troopdropzoneradius" ><strong>CTLD.troopdropzoneradius</strong></a>
@@ -11464,7 +11422,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)._BuildObjectFromCrates" ><strong>CTLD:_BuildObjectFromCrates(Group, Unit, Build, Repair, Coordinate, RepairLocation)</strong></a></h2>
<h2><a id="#(CTLD)._BuildObjectFromCrates" ><strong>CTLD:_BuildObjectFromCrates(Group, Unit, Build, Repair, RepairLocation)</strong></a></h2>
</div>
<p>(Internal) Function to actually SPAWN buildables in the mission.</p>
@@ -11526,7 +11484,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-half">
<p>
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coordinate</strong></strong>
<strong><strong>RepairLocation</strong></strong>
</p>
</div>
<div class="w3-half">
@@ -11535,16 +11493,6 @@ 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>RepairLocation</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
@@ -14765,17 +14713,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CargoCounter" ><strong>CTLD.CargoCounter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -14842,17 +14779,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CrateCounter" ><strong>CTLD.CrateCounter</strong></a>
</div>
</div>
@@ -14927,20 +14853,6 @@ 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">
#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">
@@ -15003,14 +14915,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).FreeVHFFrequencies" ><strong>CTLD.FreeVHFFrequencies</strong></a>
<p> Beacons</p>
</div>
</div>
@@ -15235,17 +15144,6 @@ 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">
#number
<a id="#(CTLD).TroopCounter" ><strong>CTLD.TroopCounter</strong></a>
</div>
</div>
@@ -15329,6 +15227,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> shape of the container</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).buildtime" ><strong>CTLD.buildtime</strong></a>
</div>
</div>
@@ -15390,17 +15299,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> #1570</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).droppedBeacons" ><strong>CTLD.droppedBeacons</strong></a>
</div>
</div>
@@ -15618,7 +15516,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> time to repair a unit/group</p>
<p> time to repairor build a unit/group</p>
</div>
@@ -15684,7 +15582,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">
#number
<a id="#(CTLD).troopdropzoneradius" ><strong>CTLD.troopdropzoneradius</strong></a>
@@ -17195,17 +17093,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CargoCounter" ><strong>CTLD.CargoCounter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -17272,17 +17159,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CrateCounter" ><strong>CTLD.CrateCounter</strong></a>
</div>
</div>
@@ -17357,20 +17233,6 @@ 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">
#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">
@@ -17433,14 +17295,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).FreeVHFFrequencies" ><strong>CTLD.FreeVHFFrequencies</strong></a>
<p> Beacons</p>
</div>
</div>
@@ -17665,17 +17524,6 @@ 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">
#number
<a id="#(CTLD).TroopCounter" ><strong>CTLD.TroopCounter</strong></a>
</div>
</div>
@@ -17759,6 +17607,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> shape of the container</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).buildtime" ><strong>CTLD.buildtime</strong></a>
</div>
</div>
@@ -17820,17 +17679,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> #1570</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).droppedBeacons" ><strong>CTLD.droppedBeacons</strong></a>
</div>
</div>
@@ -18048,7 +17896,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> time to repair a unit/group</p>
<p> time to repairor build a unit/group</p>
</div>
@@ -18114,7 +17962,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">
#number
<a id="#(CTLD).troopdropzoneradius" ><strong>CTLD.troopdropzoneradius</strong></a>
@@ -22244,17 +22092,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
<p>Flag for direct loading.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD_CARGO).Mark" ><strong>CTLD_CARGO.Mark</strong></a>
</div>
</div>
@@ -22404,17 +22241,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
<p>Flag for direct loading.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD_CARGO).Mark" ><strong>CTLD_CARGO.Mark</strong></a>
</div>
</div>
@@ -30235,17 +30061,6 @@ 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>
@@ -31499,17 +31314,6 @@ 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>