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
2021-07-14 06:49:18 +00:00
parent 6d428b0b17
commit 8525602b01
23 changed files with 2524 additions and 1018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

216
Documentation/Ops.CSAR.html
View File

@@ -1789,7 +1789,7 @@ Create a late-activated single infantry unit as template in the mission editor a
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).SpawnCSARAtZone">CSAR:SpawnCSARAtZone(Zone, Coalition, Description, RandomPoint, Nomessage)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).SpawnCSARAtZone">CSAR:SpawnCSARAtZone(Zone, Coalition, Description, RandomPoint, Nomessage, Unitname, Typename, Forcedesc)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to add a CSAR object into the scene at a zone coordinate.</p>
</td>
@@ -1819,7 +1819,7 @@ Create a late-activated single infantry unit as template in the mission editor a
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._AddCsar">CSAR:_AddCsar(_coalition, _country, _point, _typeName, _unitName, _playerName, _freq, noMessage, _description)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._AddCsar">CSAR:_AddCsar(_coalition, _country, _point, _typeName, _unitName, _playerName, _freq, noMessage, _description, forcedesc)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to spawn a CSAR object into the scene.</p>
</td>
@@ -2035,7 +2035,7 @@ Create a late-activated single infantry unit as template in the mission editor a
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._SpawnCsarAtZone">CSAR:_SpawnCsarAtZone(_zone, _coalition, _description, _randomPoint, _nomessage)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._SpawnCsarAtZone">CSAR:_SpawnCsarAtZone(_zone, _coalition, _description, _randomPoint, _nomessage, unitname, typename, forcedesc)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to add a CSAR object into the scene at a zone coordinate.</p>
</td>
@@ -3416,7 +3416,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="#(CSAR).FreeVHFFrequencies" ><strong>CSAR.FreeVHFFrequencies</strong></a>
@@ -3516,14 +3516,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="#(CSAR).allheligroupset" ><strong>CSAR.allheligroupset</strong></a>
<p> GROUP_SET of all helis</p>
</div>
</div>
@@ -4004,34 +4001,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="#(CSAR).rescuedpilots" ><strong>CSAR.rescuedpilots</strong></a>
<p> counter for saved pilots</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CSAR).rescues" ><strong>CSAR.rescues</strong></a>
<p> counter for successful rescue landings at FARP/AFB/MASH</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -4691,7 +4660,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="#(CSAR).SpawnCSARAtZone" ><strong>CSAR:SpawnCSARAtZone(Zone, Coalition, Description, RandomPoint, Nomessage)</strong></a></h2>
<h2><a id="#(CSAR).SpawnCSARAtZone" ><strong>CSAR:SpawnCSARAtZone(Zone, Coalition, Description, RandomPoint, Nomessage, Unitname, Typename, Forcedesc)</strong></a></h2>
</div>
<p>Function to add a CSAR object into the scene at a zone coordinate.</p>
@@ -4769,13 +4738,52 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>(optional) If true, don't send a message to SAR.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Unitname</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Name of the lost unit.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Typename</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Type of plane.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Forcedesc</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Force to use the <strong>description passed only</strong> for the pilot track entry. Use to have fully custom names.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>If missions designers want to spawn downed pilots into the field, e.g. at mission begin, to give the helicopter guys works, they can do this like so:
<pre class="example"><code>If missions designers want to spawn downed pilots into the field, e.g. at mission begin, to give the helicopter guys work, they can do this like so:
-- Create downed "Pilot Wagner" in #ZONE "CSAR_Start_1" at a random point for the blue coalition
my_csar:SpawnCSARAtZone( "CSAR_Start_1", coalition.side.BLUE, "Pilot Wagner", true )</code></pre>
my_csar:SpawnCSARAtZone( "CSAR_Start_1", coalition.side.BLUE, "Wagner", true, false, "Charly-1-1", "F5E" )</code></pre>
</div>
@@ -4872,7 +4880,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="#(CSAR)._AddCsar" ><strong>CSAR:_AddCsar(_coalition, _country, _point, _typeName, _unitName, _playerName, _freq, noMessage, _description)</strong></a></h2>
<h2><a id="#(CSAR)._AddCsar" ><strong>CSAR:_AddCsar(_coalition, _country, _point, _typeName, _unitName, _playerName, _freq, noMessage, _description, forcedesc)</strong></a></h2>
</div>
<p>(Internal) Function to spawn a CSAR object into the scene.</p>
@@ -4997,6 +5005,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Description</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>forcedesc</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Use the description only for the pilot track entry</p>
</div>
</div>
</div>
@@ -6094,11 +6115,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(UNIT)">#UNIT</a>:</p>
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>:</p>
</div>
<div class="w3-half">
<p>or nil</p>
<p>The unit or nil</p>
</div>
</div>
@@ -6694,7 +6715,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="#(CSAR)._SpawnCsarAtZone" ><strong>CSAR:_SpawnCsarAtZone(_zone, _coalition, _description, _randomPoint, _nomessage)</strong></a></h2>
<h2><a id="#(CSAR)._SpawnCsarAtZone" ><strong>CSAR:_SpawnCsarAtZone(_zone, _coalition, _description, _randomPoint, _nomessage, unitname, typename, forcedesc)</strong></a></h2>
</div>
<p>(Internal) Function to add a CSAR object into the scene at a zone coordinate.</p>
@@ -6772,6 +6793,45 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>(optional) If true, don't send a message to SAR.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>unitname</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Name of the lost unit.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>typename</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Type of plane.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>forcedesc</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Force to use the description passed only for the pilot track entry. Use to have fully custom names.</p>
</div>
</div>
</div>
@@ -7690,7 +7750,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="#(CSAR).FreeVHFFrequencies" ><strong>CSAR.FreeVHFFrequencies</strong></a>
@@ -7790,14 +7850,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="#(CSAR).allheligroupset" ><strong>CSAR.allheligroupset</strong></a>
<p> GROUP_SET of all helis</p>
</div>
</div>
@@ -8278,34 +8335,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="#(CSAR).rescuedpilots" ><strong>CSAR.rescuedpilots</strong></a>
<p> counter for saved pilots</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CSAR).rescues" ><strong>CSAR.rescues</strong></a>
<p> counter for successful rescue landings at FARP/AFB/MASH</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -9884,7 +9913,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="#(CSAR).FreeVHFFrequencies" ><strong>CSAR.FreeVHFFrequencies</strong></a>
@@ -9984,14 +10013,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="#(CSAR).allheligroupset" ><strong>CSAR.allheligroupset</strong></a>
<p> GROUP_SET of all helis</p>
</div>
</div>
@@ -10472,34 +10498,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="#(CSAR).rescuedpilots" ><strong>CSAR.rescuedpilots</strong></a>
<p> counter for saved pilots</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CSAR).rescues" ><strong>CSAR.rescues</strong></a>
<p> counter for successful rescue landings at FARP/AFB/MASH</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">