MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-03-15 19:22:04 +00:00
parent 32297a1fa6
commit 676ec0d3d8
27 changed files with 608 additions and 791 deletions
+244 -27
View File
@@ -1768,6 +1768,7 @@ Create the late-activated troops, vehicles, that will make up your deployable fo
<pre><code> my_ctld.useprefix = true -- (DO NOT SWITCH THIS OFF UNLESS YOU KNOW WHAT YOU ARE DOING!) Adjust **before** starting CTLD. If set to false, *all* choppers of the coalition side will be enabled for CTLD.
my_ctld.CrateDistance = 35 -- List and Load crates in this radius only.
my_ctld.dropcratesanywhere = false -- Option to allow crates to be dropped anywhere.
my_ctld.dropAsCargoCrate = false -- Parachuted herc cargo is not unpacked automatically but placed as crate to be unpacked. Needs a cargo with the same name defined like the cargo that was dropped.
my_ctld.maximumHoverHeight = 15 -- Hover max this high to load.
my_ctld.minimumHoverHeight = 4 -- Hover min this low to load.
my_ctld.forcehoverload = true -- Crates (not: troops) can **only** be loaded while hovering.
@@ -2050,6 +2051,20 @@ not achieve anything here. If you just want to unload on the ground, use the nor
<pre><code> ["Hercules"] = {type="Hercules", crates=true, troops=true, cratelimit = 7, trooplimit = 64}, -- 19t cargo, 64 paratroopers
</code></pre>
<h3>5.3 Don't automatically unpack dropped cargo but drop as CTLD_CARGO</h3>
<p>Cargo can be defined to be automatically dropped as crates.</p>
<pre><code> my_ctld.dropAsCargoCrate = true -- default is false
</code></pre>
<p>The idea is, to have those crate behave like brought in with a helo. So any unpack restictions apply.
To enable those cargo drops, the cargo types must be added manually in the CTLD configuration. So when the above defined template for "Vulcan" should be used
as CTLD_Cargo, the following line has to be added. NoCrates, PerCrateMass, Stock, SubCategory can be configured freely.</p>
<pre><code> my_ctld:AddCratesCargo("Vulcan", {"Vulcan"}, CTLD_CARGO.Enum.VEHICLE, 6, 2000, nil, "SAM/AAA")
</code></pre>
<p>So if the Vulcan in the example now needs six crates to complete, you have to bring two Hercs with three Vulcan crates each and drop them very close together...</p>
<h2>6. Save and load back units - persistance</h2>
<p>You can save and later load back units dropped or build to make your mission persistent.
@@ -3267,6 +3282,12 @@ for FARP vehicles, so -- services are goin to work (e.g. for the blue side: an u
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).debug">CTLD.debug</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).dropAsCargoCrate">CTLD.dropAsCargoCrate</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -6253,6 +6274,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_HERCULES).Cargo_Initialize">CTLD_HERCULES:Cargo_Initialize(Initiator, Cargo_Contents, Cargo_Type_name, Container_Enclosed, SoldierGroup, ParatrooperGroupSpawnInit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[Internal] Function to initialize dropped cargo</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_HERCULES).Cargo_SpawnDroppedAsCargo">CTLD_HERCULES:Cargo_SpawnDroppedAsCargo(Cargo_Type_name, Cargo_Drop_Position, _name, _pos)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[Internal] Function to spawn cargo by type at position</p>
</td>
</tr>
<tr class="w3-border">
@@ -7491,6 +7518,17 @@ 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>
@@ -7522,7 +7560,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>
@@ -7544,7 +7582,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>
@@ -7569,11 +7607,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).EngineersInField" ><strong>CTLD.EngineersInField</strong></a>
<p>holds #CTLD_ENGINEERING objects</p>
</div>
</div>
@@ -7616,7 +7657,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).FreeUHFFrequencies" ><strong>CTLD.FreeUHFFrequencies</strong></a>
@@ -7632,9 +7673,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Beacons</p>
</div>
</div>
@@ -7760,11 +7798,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>
@@ -8022,6 +8063,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">
#boolean
<a id="#(CTLD).dropAsCargoCrate" ><strong>CTLD.dropAsCargoCrate</strong></a>
<p> Parachuted herc cargo is not unpacked automatically but placed as crate to be unpacked</p>
</div>
</div>
@@ -8047,6 +8102,17 @@ 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>
@@ -8303,7 +8369,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> noob catch</p>
<p> time to repairor build a unit/group</p>
</div>
@@ -17065,6 +17131,17 @@ However, if you create a new folder inside the miz file, which contains the soun
<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>
@@ -17096,7 +17173,7 @@ However, if you create a new folder inside the miz file, which contains the soun
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -17118,7 +17195,7 @@ However, if you create a new folder inside the miz file, which contains the soun
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).DroppedTroops" ><strong>CTLD.DroppedTroops</strong></a>
@@ -17143,11 +17220,14 @@ However, if you create a new folder inside the miz file, which contains the soun
<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>
@@ -17190,7 +17270,7 @@ However, if you create a new folder inside the miz file, which contains the soun
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).FreeUHFFrequencies" ><strong>CTLD.FreeUHFFrequencies</strong></a>
@@ -17206,9 +17286,6 @@ However, if you create a new folder inside the miz file, which contains the soun
<p> Beacons</p>
</div>
</div>
@@ -17334,11 +17411,14 @@ However, if you create a new folder inside the miz file, which contains the soun
<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>
@@ -17596,6 +17676,20 @@ However, if you create a new folder inside the miz file, which contains the soun
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CTLD).dropAsCargoCrate" ><strong>CTLD.dropAsCargoCrate</strong></a>
<p> Parachuted herc cargo is not unpacked automatically but placed as crate to be unpacked</p>
</div>
</div>
@@ -17621,6 +17715,17 @@ However, if you create a new folder inside the miz file, which contains the soun
<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>
@@ -17877,7 +17982,7 @@ However, if you create a new folder inside the miz file, which contains the soun
<p> noob catch</p>
<p> time to repairor build a unit/group</p>
</div>
@@ -19531,6 +19636,17 @@ However, if you create a new folder inside the miz file, which contains the soun
<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>
@@ -19562,7 +19678,7 @@ However, if you create a new folder inside the miz file, which contains the soun
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -19584,7 +19700,7 @@ However, if you create a new folder inside the miz file, which contains the soun
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).DroppedTroops" ><strong>CTLD.DroppedTroops</strong></a>
@@ -19609,11 +19725,14 @@ However, if you create a new folder inside the miz file, which contains the soun
<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>
@@ -19656,7 +19775,7 @@ However, if you create a new folder inside the miz file, which contains the soun
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).FreeUHFFrequencies" ><strong>CTLD.FreeUHFFrequencies</strong></a>
@@ -19672,9 +19791,6 @@ However, if you create a new folder inside the miz file, which contains the soun
<p> Beacons</p>
</div>
</div>
@@ -19800,11 +19916,14 @@ However, if you create a new folder inside the miz file, which contains the soun
<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>
@@ -20062,6 +20181,20 @@ However, if you create a new folder inside the miz file, which contains the soun
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CTLD).dropAsCargoCrate" ><strong>CTLD.dropAsCargoCrate</strong></a>
<p> Parachuted herc cargo is not unpacked automatically but placed as crate to be unpacked</p>
</div>
</div>
@@ -20087,6 +20220,17 @@ However, if you create a new folder inside the miz file, which contains the soun
<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>
@@ -20343,7 +20487,7 @@ However, if you create a new folder inside the miz file, which contains the soun
<p> noob catch</p>
<p> time to repairor build a unit/group</p>
</div>
@@ -32851,6 +32995,79 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CTLD_HERCULES).Cargo_SpawnDroppedAsCargo" ><strong>CTLD_HERCULES:Cargo_SpawnDroppedAsCargo(Cargo_Type_name, Cargo_Drop_Position, _name, _pos)</strong></a></h2>
</div>
<p>[Internal] Function to spawn cargo by type at position</p>
<div id= "#Functions##Cargo_SpawnDroppedAsCargo" 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_HERCULES</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>
#string
<strong><strong>Cargo_Type_name</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Point.html##(POINT_VEC3)">Core.Point#POINT_VEC3</a>
<strong><strong>Cargo_Drop_Position</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>_name</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>_pos</strong></strong>
</p>
</div>
<div class="w3-half">
<p></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_HERCULES)">#CTLD_HERCULES</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>