mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -1606,44 +1606,44 @@ Create a late-activated single infantry unit as template in the mission editor a
|
||||
|
||||
<p>The following options are available (with their defaults). Only set the ones you want changed:</p>
|
||||
|
||||
<pre><code> self.allowDownedPilotCAcontrol = false -- Set to false if you don\'t want to allow control by Combined Arms.
|
||||
self.allowFARPRescue = true -- allows pilots to be rescued by landing at a FARP or Airbase. Else MASH only!
|
||||
self.FARPRescueDistance = 1000 -- you need to be this close to a FARP or Airport for the pilot to be rescued.
|
||||
self.autosmoke = false -- automatically smoke a downed pilot\'s location when a heli is near.
|
||||
self.autosmokedistance = 1000 -- distance for autosmoke
|
||||
self.coordtype = 1 -- Use Lat/Long DDM (0), Lat/Long DMS (1), MGRS (2), Bullseye imperial (3) or Bullseye metric (4) for coordinates.
|
||||
self.csarOncrash = false -- (WIP) If set to true, will generate a downed pilot when a plane crashes as well.
|
||||
self.enableForAI = false -- set to false to disable AI pilots from being rescued.
|
||||
self.pilotRuntoExtractPoint = true -- Downed pilot will run to the rescue helicopter up to self.extractDistance in meters.
|
||||
self.extractDistance = 500 -- Distance the downed pilot will start to run to the rescue helicopter.
|
||||
self.immortalcrew = true -- Set to true to make wounded crew immortal.
|
||||
self.invisiblecrew = false -- Set to true to make wounded crew insvisible.
|
||||
self.loadDistance = 75 -- configure distance for pilots to get into helicopter in meters.
|
||||
self.mashprefix = {"MASH"} -- prefixes of #GROUP objects used as MASHes.
|
||||
self.max_units = 6 -- max number of pilots that can be carried if #CSAR.AircraftType is undefined.
|
||||
self.messageTime = 15 -- Time to show messages for in seconds. Doubled for long messages.
|
||||
self.radioSound = "beacon.ogg" -- the name of the sound file to use for the pilots\' radio beacons.
|
||||
self.smokecolor = 4 -- Color of smokemarker, 0 is green, 1 is red, 2 is white, 3 is orange and 4 is blue.
|
||||
self.useprefix = true -- Requires CSAR helicopter #GROUP names to have the prefix(es) defined below.
|
||||
self.csarPrefix = { "helicargo", "MEDEVAC"} -- #GROUP name prefixes used for useprefix=true - DO NOT use # in helicopter names in the Mission Editor!
|
||||
self.verbose = 0 -- set to > 1 for stats output for debugging.
|
||||
<pre><code> mycsar.allowDownedPilotCAcontrol = false -- Set to false if you don\'t want to allow control by Combined Arms.
|
||||
mycsar.allowFARPRescue = true -- allows pilots to be rescued by landing at a FARP or Airbase. Else MASH only!
|
||||
mycsar.FARPRescueDistance = 1000 -- you need to be this close to a FARP or Airport for the pilot to be rescued.
|
||||
mycsar.autosmoke = false -- automatically smoke a downed pilot\'s location when a heli is near.
|
||||
mycsar.autosmokedistance = 1000 -- distance for autosmoke
|
||||
mycsar.coordtype = 1 -- Use Lat/Long DDM (0), Lat/Long DMS (1), MGRS (2), Bullseye imperial (3) or Bullseye metric (4) for coordinates.
|
||||
mycsar.csarOncrash = false -- (WIP) If set to true, will generate a downed pilot when a plane crashes as well.
|
||||
mycsar.enableForAI = false -- set to false to disable AI pilots from being rescued.
|
||||
mycsar.pilotRuntoExtractPoint = true -- Downed pilot will run to the rescue helicopter up to mycsar.extractDistance in meters.
|
||||
mycsar.extractDistance = 500 -- Distance the downed pilot will start to run to the rescue helicopter.
|
||||
mycsar.immortalcrew = true -- Set to true to make wounded crew immortal.
|
||||
mycsar.invisiblecrew = false -- Set to true to make wounded crew insvisible.
|
||||
mycsar.loadDistance = 75 -- configure distance for pilots to get into helicopter in meters.
|
||||
mycsar.mashprefix = {"MASH"} -- prefixes of #GROUP objects used as MASHes.
|
||||
mycsar.max_units = 6 -- max number of pilots that can be carried if #CSAR.AircraftType is undefined.
|
||||
mycsar.messageTime = 15 -- Time to show messages for in seconds. Doubled for long messages.
|
||||
mycsar.radioSound = "beacon.ogg" -- the name of the sound file to use for the pilots\' radio beacons.
|
||||
mycsar.smokecolor = 4 -- Color of smokemarker, 0 is green, 1 is red, 2 is white, 3 is orange and 4 is blue.
|
||||
mycsar.useprefix = true -- Requires CSAR helicopter #GROUP names to have the prefix(es) defined below.
|
||||
mycsar.csarPrefix = { "helicargo", "MEDEVAC"} -- #GROUP name prefixes used for useprefix=true - DO NOT use # in helicopter names in the Mission Editor!
|
||||
mycsar.verbose = 0 -- set to > 1 for stats output for debugging.
|
||||
-- (added 0.1.4) limit amount of downed pilots spawned by **ejection** events
|
||||
self.limitmaxdownedpilots = true
|
||||
self.maxdownedpilots = 10
|
||||
mycsar.limitmaxdownedpilots = true
|
||||
mycsar.maxdownedpilots = 10
|
||||
-- (added 0.1.8) - allow to set far/near distance for approach and optionally pilot must open doors
|
||||
self.approachdist_far = 5000 -- switch do 10 sec interval approach mode, meters
|
||||
self.approachdist_near = 3000 -- switch to 5 sec interval approach mode, meters
|
||||
self.pilotmustopendoors = false -- switch to true to enable check of open doors
|
||||
mycsar.approachdist_far = 5000 -- switch do 10 sec interval approach mode, meters
|
||||
mycsar.approachdist_near = 3000 -- switch to 5 sec interval approach mode, meters
|
||||
mycsar.pilotmustopendoors = false -- switch to true to enable check of open doors
|
||||
-- (added 0.1.9)
|
||||
self.suppressmessages = false -- switch off all messaging if you want to do your own
|
||||
mycsar.suppressmessages = false -- switch off all messaging if you want to do your own
|
||||
-- (added 0.1.11)
|
||||
self.rescuehoverheight = 20 -- max height for a hovering rescue in meters
|
||||
self.rescuehoverdistance = 10 -- max distance for a hovering rescue in meters
|
||||
mycsar.rescuehoverheight = 20 -- max height for a hovering rescue in meters
|
||||
mycsar.rescuehoverdistance = 10 -- max distance for a hovering rescue in meters
|
||||
-- (added 0.1.12)
|
||||
-- Country codes for spawned pilots
|
||||
self.countryblue= country.id.USA
|
||||
self.countryred = country.id.RUSSIA
|
||||
self.countryneutral = country.id.UN_PEACEKEEPERS
|
||||
mycsar.countryblue= country.id.USA
|
||||
mycsar.countryred = country.id.RUSSIA
|
||||
mycsar.countryneutral = country.id.UN_PEACEKEEPERS
|
||||
</code></pre>
|
||||
|
||||
<h2>2.1 Experimental Features</h2>
|
||||
@@ -1651,22 +1651,26 @@ Create a late-activated single infantry unit as template in the mission editor a
|
||||
<pre><code> WARNING - Here\'ll be dragons!
|
||||
DANGER - For this to work you need to de-sanitize your mission environment (all three entries) in <DCS root>\Scripts\MissionScripting.lua
|
||||
Needs SRS => 1.9.6 to work (works on the **server** side of SRS)
|
||||
self.useSRS = false -- Set true to use FF\'s SRS integration
|
||||
self.SRSPath = "E:\\Progra~1\\DCS-SimpleRadio-Standalone\\" -- adjust your own path in your SRS installation -- server(!)
|
||||
self.SRSchannel = 300 -- radio channel
|
||||
self.SRSModulation = radio.modulation.AM -- modulation
|
||||
self.SRSport = 5002 -- and SRS port
|
||||
mycsar.useSRS = false -- Set true to use FF\'s SRS integration
|
||||
mycsar.SRSPath = "C:\\Progra~1\\DCS-SimpleRadio-Standalone\\" -- adjust your own path in your SRS installation -- server(!)
|
||||
mycsar.SRSchannel = 300 -- radio channel
|
||||
mycsar.SRSModulation = radio.modulation.AM -- modulation
|
||||
mycsar.SRSport = 5002 -- and SRS Server port
|
||||
mycsar.SRSCulture = "en-GB" -- SRS voice culture
|
||||
mycsar.SRSVoice = nil -- SRS voice, relevant for Google TTS
|
||||
mycsar.SRSGPathToCredentials = nil -- Path to your Google credentials json file, set this if you want to use Google TTS
|
||||
mycsar.SRSVolume = 1 -- Volume, between 0 and 1
|
||||
--
|
||||
self.csarUsePara = false -- If set to true, will use the LandingAfterEjection Event instead of Ejection --shagrat
|
||||
self.wetfeettemplate = "man in floating thingy" -- if you use a mod to have a pilot in a rescue float, put the template name in here for wet feet spawns. Note: in conjunction with csarUsePara this might create dual ejected pilots in edge cases.
|
||||
mycsar.csarUsePara = false -- If set to true, will use the LandingAfterEjection Event instead of Ejection --shagrat
|
||||
mycsar.wetfeettemplate = "man in floating thingy" -- if you use a mod to have a pilot in a rescue float, put the template name in here for wet feet spawns. Note: in conjunction with csarUsePara this might create dual ejected pilots in edge cases.
|
||||
</code></pre>
|
||||
|
||||
<h2>3. Results</h2>
|
||||
|
||||
<p>Number of successful landings with save pilots and aggregated number of saved pilots is stored in these variables in the object:</p>
|
||||
|
||||
<pre><code> self.rescues -- number of successful landings *with* saved pilots
|
||||
self.rescuedpilots -- aggregated number of pilots rescued from the field (of *all* players)
|
||||
<pre><code> mycsar.rescues -- number of successful landings *with* saved pilots
|
||||
mycsar.rescuedpilots -- aggregated number of pilots rescued from the field (of *all* players)
|
||||
</code></pre>
|
||||
|
||||
<h2>4. Events</h2>
|
||||
@@ -1817,6 +1821,18 @@ Create a late-activated single infantry unit as template in the mission editor a
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).OnAfterReturning">CSAR:OnAfterReturning(From, Event, To, Heliname, Woundedgroupname)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>On After "Returning" event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).SRSCulture">CSAR.SRSCulture</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="##(CSAR).SRSGPathToCredentials">CSAR.SRSGPathToCredentials</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1829,6 +1845,18 @@ Create a late-activated single infantry unit as template in the mission editor a
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).SRSPath">CSAR.SRSPath</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="##(CSAR).SRSVoice">CSAR.SRSVoice</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="##(CSAR).SRSVolume">CSAR.SRSVolume</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3602,6 +3630,17 @@ 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="#(CSAR).SRSCulture" ><strong>CSAR.SRSCulture</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3630,6 +3669,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
<p> adjust your own path in your server(!)</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CSAR).SRSVolume" ><strong>CSAR.SRSVolume</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3700,11 +3750,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="#(CSAR).allheligroupset" ><strong>CSAR.allheligroupset</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> GROUP_SET of all helis</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -4249,6 +4302,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">
|
||||
|
||||
#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">
|
||||
@@ -4274,6 +4341,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">
|
||||
|
||||
#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">
|
||||
@@ -8411,6 +8492,17 @@ 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="#(CSAR).SRSCulture" ><strong>CSAR.SRSCulture</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -8439,6 +8531,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
<p> adjust your own path in your server(!)</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CSAR).SRSVolume" ><strong>CSAR.SRSVolume</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -8509,11 +8612,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="#(CSAR).allheligroupset" ><strong>CSAR.allheligroupset</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> GROUP_SET of all helis</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9058,6 +9164,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">
|
||||
|
||||
#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">
|
||||
@@ -9083,6 +9203,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">
|
||||
|
||||
#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">
|
||||
@@ -10713,6 +10847,17 @@ 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="#(CSAR).SRSCulture" ><strong>CSAR.SRSCulture</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -10741,6 +10886,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
<p> adjust your own path in your server(!)</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CSAR).SRSVolume" ><strong>CSAR.SRSVolume</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -10811,11 +10967,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="#(CSAR).allheligroupset" ><strong>CSAR.allheligroupset</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> GROUP_SET of all helis</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -11360,6 +11519,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">
|
||||
|
||||
#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">
|
||||
@@ -11385,6 +11558,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">
|
||||
|
||||
#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">
|
||||
|
||||
Reference in New Issue
Block a user