weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2023-02-04 16:42:25 +00:00
parent 5f572736ab
commit 9f62ca05d4
24 changed files with 1045 additions and 527 deletions
Download Patch File Download Diff File Expand all files Collapse all files

281
Documentation/Ops.CTLD.html
View File

@@ -2706,6 +2706,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).Positionable">CTLD.Positionable</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).PreloadCrates">CTLD:PreloadCrates(Unit, Cratesname, NumberOfCrates)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(User) Pre-load crates into a helo, e.g.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2904,6 +2910,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)._ExtractTroops">CTLD:_ExtractTroops(Group, Unit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to extract (load from the field) troops into a heli.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._FindCratesCargoObject">CTLD:_FindCratesCargoObject(Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Find a crates CTLD_CARGO object in stock</p>
</td>
</tr>
<tr class="w3-border">
@@ -3030,6 +3042,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)._MoveGroupToZone">CTLD:_MoveGroupToZone(Group)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to move group to WP zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._PreloadCrates">CTLD:_PreloadCrates(Group, Unit, Cargo, NumberOfCrates)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Pre-load crates into a helo.</p>
</td>
</tr>
<tr class="w3-border">
@@ -7528,7 +7546,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).FreeVHFFrequencies" ><strong>CTLD.FreeVHFFrequencies</strong></a>
@@ -7702,14 +7720,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">
#string
<a id="#(CTLD).RadioPath" ><strong>CTLD.RadioPath</strong></a>
<p> Folderpath.</p>
</div>
</div>
@@ -12056,6 +12071,85 @@ 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).PreloadCrates" ><strong>CTLD:PreloadCrates(Unit, Cratesname, NumberOfCrates)</strong></a></h2>
</div>
<p>(User) Pre-load crates into a helo, e.g.</p>
<p>for airstart. Unit <strong>must</strong> be alive in-game, i.e. player has taken the slot!</p>
<div id= "#Functions##PreloadCrates" 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 to load into, can be handed as Wrapper.Client#CLIENT object</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Cratesname</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the cargo to be loaded. Must be created prior in the CTLD setup!</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>NumberOfCrates</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Number of crates to be loaded. Default - all necessary to build this object. Might overload the helo!</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)">#CTLD</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> local client = UNIT:FindByName("Helo-1-1")
if client and client:IsAlive() then
myctld:PreloadCrates(client,"Humvee")
end</code></pre>
</div>
</div>
</div>
@@ -13048,6 +13142,50 @@ However, if you create a new folder inside the miz file, which contains the soun
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CTLD)._FindCratesCargoObject" ><strong>CTLD:_FindCratesCargoObject(Name)</strong></a></h2>
</div>
<p>(Internal) Find a crates CTLD_CARGO object in stock</p>
<div id= "#Functions##_FindCratesCargoObject" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Name</strong></strong>
</p>
</div>
<div class="w3-half">
<p>of the object</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_CARGO)">#CTLD_CARGO</a>:</p>
</div>
<div class="w3-half">
<p>Cargo object, nil if it cannot be found</p>
</div>
</div>
</div>
</div>
</div>
@@ -14057,6 +14195,92 @@ However, if you create a new folder inside the miz file, which contains the soun
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CTLD)._PreloadCrates" ><strong>CTLD:_PreloadCrates(Group, Unit, Cargo, NumberOfCrates)</strong></a></h2>
</div>
<p>(Internal) Pre-load crates into a helo.</p>
<p>Do not use standalone!</p>
<div id= "#Functions##_PreloadCrates" 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.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>Group</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The group to load into, can be handed as Wrapper.Client#CLIENT object</p>
</div>
</div>
<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 to load into, can be handed as Wrapper.Client#CLIENT object</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="##(CTLD_CARGO)">#CTLD_CARGO</a>
<strong><strong>Cargo</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Cargo crate object to load</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>NumberOfCrates</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Number of crates to be loaded. Default - all necessary to build this object. Might overload the helo!</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)">#CTLD</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -16518,7 +16742,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).FreeVHFFrequencies" ><strong>CTLD.FreeVHFFrequencies</strong></a>
@@ -16692,14 +16916,11 @@ 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">
#string
<a id="#(CTLD).RadioPath" ><strong>CTLD.RadioPath</strong></a>
<p> Folderpath.</p>
</div>
</div>
@@ -18984,7 +19205,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).FreeVHFFrequencies" ><strong>CTLD.FreeVHFFrequencies</strong></a>
@@ -19158,14 +19379,11 @@ 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">
#string
<a id="#(CTLD).RadioPath" ><strong>CTLD.RadioPath</strong></a>
<p> Folderpath.</p>
</div>
</div>
@@ -23740,6 +23958,17 @@ 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>
@@ -27696,6 +27925,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>
@@ -28349,6 +28589,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>