MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-10-14 15:02:44 +00:00
parent e57aa7834d
commit b4e6702512
29 changed files with 673 additions and 739 deletions

View File

@@ -1889,7 +1889,9 @@ Create the late-activated troops, vehicles, that will make up your deployable fo
<p> To award player with points, using the SCORING Class (SCORING: my_Scoring, CTLD: CTLD_Cargotransport)</p>
<pre><code> function CTLD_Cargotransport:OnAfterCratesDropped(From, Event, To, Group, Unit, Cargotable)
<pre><code> my_scoring = SCORING:New("Combat Transport")
function CTLD_Cargotransport:OnAfterCratesDropped(From, Event, To, Group, Unit, Cargotable)
local points = 10
if Unit then
local PlayerName = Unit:GetPlayerName()
@@ -1970,7 +1972,7 @@ in your mission!</p>
<pre><code> my_ctld.useprefix = true -- this is true by default and MUST BE ON.
</code></pre>
<h3>5.2 Integrate Hercules ground crew (F8 Menu) loadable objects (alternative method)</h3>
<h3>5.2 Integrate Hercules ground crew (F8 Menu) loadable objects (alternative method, use either the above OR this method, NOT both!)</h3>
<p>Integrate to your CTLD instance like so, where <code>my_ctld</code> is a previously created CTLD instance:</p>
@@ -2001,6 +2003,8 @@ E.g.: </p>
<p>The script works on the EVENTS.Shot trigger, which is used by the mod when you <strong>drop cargo from the Hercules while flying</strong>. Unloading on the ground does
not achieve anything here. If you just want to unload on the ground, use the normal Moose CTLD (see 5.1).</p>
<p>DO NOT use the "splash damage" script together with this method! Your cargo will explode on the ground!</p>
<p>There are two ways of airdropping: </p>
<p>1) Very low and very slow (>5m and &lt;10m AGL) - here you can drop stuff which has "Skid" at the end of the cargo name (loaded via F8 Ground Crew menu) <br/>
@@ -7160,7 +7164,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>
@@ -7203,20 +7207,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">
@@ -7260,7 +7250,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).FreeFMFrequencies" ><strong>CTLD.FreeFMFrequencies</strong></a>
@@ -7271,7 +7261,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>
@@ -7287,9 +7277,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Beacons</p>
</div>
</div>
@@ -7415,14 +7402,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>
@@ -7889,7 +7873,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>
@@ -7955,7 +7939,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>
@@ -14821,7 +14805,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>
@@ -14864,20 +14848,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">
@@ -14921,7 +14891,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).FreeFMFrequencies" ><strong>CTLD.FreeFMFrequencies</strong></a>
@@ -14932,7 +14902,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>
@@ -14948,9 +14918,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Beacons</p>
</div>
</div>
@@ -15076,14 +15043,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>
@@ -15550,7 +15514,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>
@@ -15616,7 +15580,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>
@@ -17235,7 +17199,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>
@@ -17278,20 +17242,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">
@@ -17335,7 +17285,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).FreeFMFrequencies" ><strong>CTLD.FreeFMFrequencies</strong></a>
@@ -17346,7 +17296,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>
@@ -17362,9 +17312,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Beacons</p>
</div>
</div>
@@ -17490,14 +17437,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>
@@ -17964,7 +17908,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>
@@ -18030,7 +17974,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>
@@ -22160,17 +22104,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>
@@ -22320,17 +22253,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>
@@ -30982,13 +30904,21 @@ E.g.:
Expected template names are the ones in the rounded brackets.
HINTS
### HINTS
The script works on the EVENTS.Shot trigger, which is used by the mod when you **drop cargo from the Hercules while flying**. Unloading on the ground does
not achieve anything here. If you just want to unload on the ground, use the normal Moose CTLD.
**Do not use** the **splash damage** script together with this, your cargo will just explode when reaching the ground!
### Airdrops
There are two ways of airdropping:
1) Very low and very slow (&gt;5m and &lt;10m AGL) - here you can drop stuff which has "Skid" at the end of the cargo name (loaded via F8 Ground Crew menu)
2) Higher up and slow (&gt;100m AGL) - here you can drop paratroopers and cargo which has "Air" at the end of the cargo name (loaded via F8 Ground Crew menu)</code></pre>
2) Higher up and slow (&gt;100m AGL) - here you can drop paratroopers and cargo which has "Air" at the end of the cargo name (loaded via F8 Ground Crew menu)
### General
Use either this method to integrate the Hercules **or** the one from the "normal" CTLD. Never both!</code></pre>
</div>