MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-01-15 10:46:55 +00:00
parent d1bf494df5
commit b2f9d87a4d
20 changed files with 1007 additions and 384 deletions

View File

@@ -1560,7 +1560,7 @@ Controls a network of short range air/missile defense groups.</p>
<ul>
<li>Object oriented refactoring of Ciribob's fantastic CTLD script.</li>
<li>No need for extra MIST loading.</li>
<li>No need for extra MIST loading. </li>
<li>Additional events to tailor your mission.</li>
<li>ANY late activated group can serve as cargo, either as troops, crates, which have to be build on-location, or static like ammo chests.</li>
<li>Option to persist (save&amp;load) your dropped troops, crates and vehicles.</li>
@@ -1568,7 +1568,7 @@ Controls a network of short range air/missile defense groups.</p>
<h2>0. Prerequisites</h2>
<p>You need to load an .ogg sound file for the pilot's beacons into the mission, e.g. "beacon.ogg", use a once trigger, "sound to country" for that.
<p>You need to load an .ogg soundfile for the pilot's beacons into the mission, e.g. "beacon.ogg", use a once trigger, "sound to country" for that.
Create the late-activated troops, vehicles (no statics at this point!) that will make up your deployable forces.</p>
<h2>1. Basic Setup</h2>
@@ -1596,7 +1596,7 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
my_ctld:AddTroopsCargo("Anti-Air",{"AA","AA2"},CTLD_CARGO.Enum.TROOPS,4,nil,2)
-- add an engineers unit called "Wrenches" using template "Engineers", of type ENGINEERS with size 2. Engineers can be loaded, dropped,
-- and extracted like troops. However, they will seek to build and/or repair crates found in a given radius. Handy if you can't stay
-- and extracted like troops. However, they will seek to build and/or repair crates found in a given radius. Handy if you can\'t stay
-- to build or repair or under fire.
my_ctld:AddTroopsCargo("Wrenches",{"Engineers"},CTLD_CARGO.Enum.ENGINEERS,4)
myctld.EngineerSearch = 2000 -- teams will search for crates in this radius.
@@ -1617,7 +1617,7 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
my_ctld.repairtime = 300 -- takes 300 seconds to repair something
-- add static cargo objects, e.g ammo chests - the name needs to refer to a STATIC object in the mission editor,
-- here: it's the UNIT name (not the GROUP name!), the second parameter is the weight in kg.
-- here: it\'s the UNIT name (not the GROUP name!), the second parameter is the weight in kg.
my_ctld:AddStaticsCargo("Ammunition",500)
</code></pre>
@@ -1672,6 +1672,7 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
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
my_ctld.basetype = "container_cargo" -- default shape of the cargo container
</code></pre>
<h2>2.1 User functions</h2>
@@ -1698,6 +1699,7 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
["Hercules"] = {type="Hercules", crates=true, troops=true, cratelimit = 7, trooplimit = 64, length = 25},
</code></pre>
<h3>2.1.2 Activate and deactivate zones</h3>
<p>Activate a zone:</p>
@@ -1900,8 +1902,8 @@ There is a risk involved in doing that; if you do not know what that means, this
</code></pre>
<p><strong>Caveat:</strong>
If you use units build by multiple templates, they will effectively double on loading. Dropped crates are not saved. Current stock is not saved.</p>
If you use units build by multiple templates, they will effectively double on loading. Dropped crates are not saved. Current stock is not saved.
</p>
</div>
@@ -2778,6 +2780,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).allowcratepickupagain">CTLD.allowcratepickupagain</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).basetype">CTLD.basetype</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -5671,20 +5679,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">
@@ -5880,11 +5874,14 @@ 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>
@@ -6039,6 +6036,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">
#string
<a id="#(CTLD).basetype" ><strong>CTLD.basetype</strong></a>
<p> shape of the container</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -6292,6 +6303,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> time to repair a unit/group</p>
</div>
</div>
@@ -6351,7 +6365,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> self.I({prefixes = self.prefixes})</p>
<p>self.I({prefixes = self.prefixes})</p>
</div>
@@ -12806,20 +12820,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">
@@ -13015,11 +13015,14 @@ 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>
@@ -13174,6 +13177,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">
#string
<a id="#(CTLD).basetype" ><strong>CTLD.basetype</strong></a>
<p> shape of the container</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -13427,6 +13444,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> time to repair a unit/group</p>
</div>
</div>
@@ -13486,7 +13506,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> self.I({prefixes = self.prefixes})</p>
<p>self.I({prefixes = self.prefixes})</p>
</div>
@@ -15113,20 +15133,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">
@@ -15322,11 +15328,14 @@ 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>
@@ -15481,6 +15490,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">
#string
<a id="#(CTLD).basetype" ><strong>CTLD.basetype</strong></a>
<p> shape of the container</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -15734,6 +15757,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> time to repair a unit/group</p>
</div>
</div>
@@ -15793,7 +15819,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> self.I({prefixes = self.prefixes})</p>
<p>self.I({prefixes = self.prefixes})</p>
</div>
@@ -19527,17 +19553,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
<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>
@@ -23246,6 +23261,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<a id="#(CTLD_ENGINEERING).currwpt" ><strong>CTLD_ENGINEERING.currwpt</strong></a>
</div>
</div>
@@ -23899,6 +23925,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<a id="#(CTLD_ENGINEERING).currwpt" ><strong>CTLD_ENGINEERING.currwpt</strong></a>
</div>
</div>