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-12-17 08:17:23 +00:00
parent 39bebe81f7
commit b3d62703c1
101 changed files with 7997 additions and 8108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

311
Documentation/Ops.CSAR.html
View File

@@ -1560,14 +1560,14 @@ Controls a network of short range air/missile defense groups.</p>
<ul>
<li>Object oriented refactoring of Ciribob's fantastic CSAR script.</li>
<li>No need for extra MIST loading. </li>
<li>No need for extra MIST loading.</li>
<li>Additional events to tailor your mission.</li>
<li>Optional SpawnCASEVAC to create casualties without beacon (e.g. handling dead ground vehicles and create CASVAC requests).</li>
<li>Optional SpawnCASEVAC to create casualties without beacon (e.g. handling dead ground vehicles and create CASEVAC requests).</li>
</ul>
<h2>0. Prerequisites</h2>
<p>You need to load an .ogg soundfile for the pilot's beacons into the mission, e.g. "beacon.ogg", use a once trigger, "sound to country" for that.
<p>You need to load an .ogg sound file for the pilot's beacons into the mission, e.g. "beacon.ogg", use a once trigger, "sound to country" for that.
Create a late-activated single infantry unit as template in the mission editor and name it e.g. "Downed Pilot".</p>
<h2>1. Basic Setup</h2>
@@ -1587,30 +1587,30 @@ 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.
<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.autosmoke = false -- automatically smoke a downed pilot's location when a helicopter is near.
self.autosmokedistance = 1000 -- distance in meters for automatic smoke deployment
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.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.invisiblecrew = false -- Set to true to make wounded crew invisible.
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.radioSound = "beacon.ogg" -- the name of the sound file to use for the pilots' radio beacons.
self.smokecolor = 4 -- Color of smoke marker, 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.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 &gt; 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
self.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
@@ -1629,10 +1629,10 @@ Create a late-activated single infantry unit as template in the mission editor a
<h2>2.1 Experimental Features</h2>
<pre><code> WARNING - Here\'ll be dragons!
<pre><code> WARNING - Here'll be dragons!
DANGER - For this to work you need to de-sanitize your mission environment (all three entries) in &lt;DCS root&gt;\Scripts\MissionScripting.lua
Needs SRS =&gt; 1.9.6 to work (works on the **server** side of SRS)
self.useSRS = false -- Set true to use FF\'s SRS integration
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
@@ -1664,7 +1664,7 @@ Create a late-activated single infantry unit as template in the mission editor a
<h3>4.2. Approach.</h3>
<pre><code> A CSAR helicpoter is closing in on a downed pilot. Use e.g. `function my_csar:OnAfterApproach(...)` to link into this event:
<pre><code> A CSAR helicopter is closing in on a downed pilot. Use e.g. `function my_csar:OnAfterApproach(...)` to link into this event:
function my_csar:OnAfterApproach(from, event, to, heliname, groupname)
... your code here ...
@@ -1695,7 +1695,7 @@ Create a late-activated single infantry unit as template in the mission editor a
function my_csar:OnAfterRescued(from, event, to, heliunit, heliname, pilotssaved)
... your code here ...
end
end
</code></pre>
<h2>5. Spawn downed pilots at location to be picked up.</h2>
@@ -1706,7 +1706,7 @@ Create a late-activated single infantry unit as template in the mission editor a
my_csar:SpawnCSARAtZone( "CSAR_Start_1", coalition.side.BLUE, "Pilot Wagner", true )
--Create a casualty and CASEVAC request from a "Point" (VEC2) for the blue coalition --shagrat
my_csar:SpawnCASEVAC(Point, coalition.side.BLUE)
my_csar:SpawnCASEVAC(Point, coalition.side.BLUE)
</code></pre>
@@ -3012,7 +3012,7 @@ 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).OnEventEjection">CSAR:OnEventEjection(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a pilot ejects from an aircraft
initiator : The unit that has ejected </p>
initiator : The unit that has ejected</p>
</td>
</tr>
<tr class="w3-border">
@@ -3049,8 +3049,7 @@ initiator : The unit that has ejected </p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).OnEventLand">CSAR:OnEventLand(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
initiator : The unit that has landed.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3062,7 +3061,7 @@ place: Object that the unit landed on.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).OnEventLandingQualityMark">CSAR:OnEventLandingQualityMark(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Landing quality mark. </p>
<p>Landing quality mark.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3086,13 +3085,13 @@ place: Object that the unit landed on.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).OnEventMissionEnd">CSAR:OnEventMissionEnd(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a mission ends</p>
<p>Occurs when a mission ends.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).OnEventMissionStart">CSAR:OnEventMissionStart(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a mission starts </p>
<p>Occurs when a mission starts.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3661,7 +3660,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>allows pilot to be rescued by landing at a FARP or Airbase</p>
<p> allows pilot to be rescued by landing at a FARP or Airbase</p>
</div>
@@ -3675,7 +3674,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> switch do 10 sec interval approach mode, meters</p>
<p> switch to 10 sec interval approach mode, meters</p>
</div>
@@ -3717,7 +3716,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> distance for autosmoke
<p> distance in meters for automatic smoke deployment
added 0.1.4</p>
</div>
@@ -3868,14 +3867,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).downedPilots" ><strong>CSAR.downedPilots</strong></a>
<p> Replacement woundedGroups</p>
</div>
</div>
@@ -3913,7 +3909,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Distance the Downed pilot will run to the rescue helicopter</p>
<p> Distance the Downed pilot will run to the rescue helicopter.</p>
</div>
@@ -3997,7 +3993,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Set to true to make wounded crew insvisible </p>
<p> Set to true to make wounded crew invisible</p>
</div>
@@ -4111,7 +4107,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>max number of pilots that can be carried</p>
<p> max number of pilots that can be carried</p>
</div>
@@ -4136,7 +4132,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Time to show longer messages for in seconds </p>
<p> Time to show longer messages for in seconds</p>
</div>
@@ -4150,7 +4146,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Downed Pilot will run to the rescue helicopter up to self.extractDistance METERS </p>
<p> Downed Pilot will run to the rescue helicopter up to self.extractDistance METERS.</p>
</div>
@@ -4178,21 +4174,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> the name of the sound file to use for the Pilot radio beacons. If this isnt added to the mission BEACONS WONT WORK!</p>
</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>
<p> the name of the sound file to use for the Pilot radio beacons. If this isn't added to the mission BEACONS WONT WORK!</p>
</div>
@@ -4221,20 +4203,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).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">
@@ -4259,7 +4227,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Color of smokemarker for blue side, 0 is green, 1 is red, 2 is white, 3 is orange and 4 is blue</p>
<p> Color of smoke marker for blue side, 0 is green, 1 is red, 2 is white, 3 is orange and 4 is blue</p>
</div>
@@ -4309,7 +4277,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Use the Prefixed defined below, Requires Unit have the Prefix defined below </p>
<p> Use the Prefixed defined below, Requires Unit have the Prefix defined below.</p>
</div>
@@ -5101,7 +5069,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</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 work, they can do this like so:
-- Create casualty "CASEVAC" at Point #POINT_VEC2 for the blue coalition.
my_csar:SpawnCASEVAC( POINT_VEC2, coalition.side.BLUE )</code></pre>
@@ -8450,7 +8418,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>allows pilot to be rescued by landing at a FARP or Airbase</p>
<p> allows pilot to be rescued by landing at a FARP or Airbase</p>
</div>
@@ -8464,7 +8432,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> switch do 10 sec interval approach mode, meters</p>
<p> switch to 10 sec interval approach mode, meters</p>
</div>
@@ -8506,7 +8474,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> distance for autosmoke
<p> distance in meters for automatic smoke deployment
added 0.1.4</p>
</div>
@@ -8657,14 +8625,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).downedPilots" ><strong>CSAR.downedPilots</strong></a>
<p> Replacement woundedGroups</p>
</div>
</div>
@@ -8702,7 +8667,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Distance the Downed pilot will run to the rescue helicopter</p>
<p> Distance the Downed pilot will run to the rescue helicopter.</p>
</div>
@@ -8786,7 +8751,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Set to true to make wounded crew insvisible </p>
<p> Set to true to make wounded crew invisible</p>
</div>
@@ -8900,7 +8865,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>max number of pilots that can be carried</p>
<p> max number of pilots that can be carried</p>
</div>
@@ -8925,7 +8890,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Time to show longer messages for in seconds </p>
<p> Time to show longer messages for in seconds</p>
</div>
@@ -8939,7 +8904,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Downed Pilot will run to the rescue helicopter up to self.extractDistance METERS </p>
<p> Downed Pilot will run to the rescue helicopter up to self.extractDistance METERS.</p>
</div>
@@ -8967,21 +8932,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> the name of the sound file to use for the Pilot radio beacons. If this isnt added to the mission BEACONS WONT WORK!</p>
</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>
<p> the name of the sound file to use for the Pilot radio beacons. If this isn't added to the mission BEACONS WONT WORK!</p>
</div>
@@ -9010,20 +8961,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).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">
@@ -9048,7 +8985,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Color of smokemarker for blue side, 0 is green, 1 is red, 2 is white, 3 is orange and 4 is blue</p>
<p> Color of smoke marker for blue side, 0 is green, 1 is red, 2 is white, 3 is orange and 4 is blue</p>
</div>
@@ -9098,7 +9035,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Use the Prefixed defined below, Requires Unit have the Prefix defined below </p>
<p> Use the Prefixed defined below, Requires Unit have the Prefix defined below.</p>
</div>
@@ -10758,7 +10695,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>allows pilot to be rescued by landing at a FARP or Airbase</p>
<p> allows pilot to be rescued by landing at a FARP or Airbase</p>
</div>
@@ -10772,7 +10709,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> switch do 10 sec interval approach mode, meters</p>
<p> switch to 10 sec interval approach mode, meters</p>
</div>
@@ -10814,7 +10751,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> distance for autosmoke
<p> distance in meters for automatic smoke deployment
added 0.1.4</p>
</div>
@@ -10965,14 +10902,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).downedPilots" ><strong>CSAR.downedPilots</strong></a>
<p> Replacement woundedGroups</p>
</div>
</div>
@@ -11010,7 +10944,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Distance the Downed pilot will run to the rescue helicopter</p>
<p> Distance the Downed pilot will run to the rescue helicopter.</p>
</div>
@@ -11094,7 +11028,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Set to true to make wounded crew insvisible </p>
<p> Set to true to make wounded crew invisible</p>
</div>
@@ -11208,7 +11142,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>max number of pilots that can be carried</p>
<p> max number of pilots that can be carried</p>
</div>
@@ -11233,7 +11167,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Time to show longer messages for in seconds </p>
<p> Time to show longer messages for in seconds</p>
</div>
@@ -11247,7 +11181,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Downed Pilot will run to the rescue helicopter up to self.extractDistance METERS </p>
<p> Downed Pilot will run to the rescue helicopter up to self.extractDistance METERS.</p>
</div>
@@ -11275,21 +11209,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> the name of the sound file to use for the Pilot radio beacons. If this isnt added to the mission BEACONS WONT WORK!</p>
</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>
<p> the name of the sound file to use for the Pilot radio beacons. If this isn't added to the mission BEACONS WONT WORK!</p>
</div>
@@ -11318,20 +11238,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).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">
@@ -11356,7 +11262,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Color of smokemarker for blue side, 0 is green, 1 is red, 2 is white, 3 is orange and 4 is blue</p>
<p> Color of smoke marker for blue side, 0 is green, 1 is red, 2 is white, 3 is orange and 4 is blue</p>
</div>
@@ -11406,7 +11312,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Use the Prefixed defined below, Requires Unit have the Prefix defined below </p>
<p> Use the Prefixed defined below, Requires Unit have the Prefix defined below.</p>
</div>
@@ -12059,7 +11965,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Get the ClassName + ClassID of the class instance.</p>
<p>The ClassName + ClassID is formatted as '%s#%09d'. </p>
<p>The ClassName + ClassID is formatted as '%s#%09d'.</p>
<div id= "#Functions##GetClassNameAndID" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12092,7 +11998,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Get the Class <a href="Event.html">Event</a> processing Priority.</p>
<p>The Event processing Priority is a number from 1 to 10,
<p>The Event processing Priority is a number from 1 to 10,
reflecting the order of the classes subscribed to the Event to be processed.</p>
<div id= "#Functions##GetEventPriority" class="w3-show w3-white">
@@ -12129,10 +12035,10 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
<p>Note that the Parent class must be passed to call the parent class method.</p>
<pre><code>self:GetParent(self):ParentMethod()
</code></pre>
<div id= "#Functions##GetParent" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -12191,7 +12097,7 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
<p>Get a Value given a Key from the Object.</p>
<p>Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.</p>
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
<div id= "#Functions##GetState" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12489,9 +12395,9 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
return self
end
</code></pre>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -12523,7 +12429,7 @@ end
<p>Occurs when an object is completely destroyed.</p>
<p>initiator : The unit that is was destroyed. </p>
<p>initiator : The unit that is was destroyed.</p>
<div id= "#Functions##OnEvent" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12592,8 +12498,8 @@ end
<p>Occurs when a ground unit captures either an airbase or a farp.</p>
<p>initiator : The unit that captured the base
place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction. </p>
<p>initiator : The unit that captured the base.
place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.</p>
<div id= "#Functions##OnEventBaseCaptured" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12629,7 +12535,7 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
<p>Occurs when any object is spawned into the mission.</p>
<p>initiator : The unit that was spawned </p>
<p>initiator : The unit that was spawned.</p>
<div id= "#Functions##OnEventBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12665,7 +12571,7 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
<p>Occurs when any aircraft crashes into the ground and is completely destroyed.</p>
<p>initiator : The unit that has crashed </p>
<p>initiator : The unit that has crashed.</p>
<div id= "#Functions##OnEventCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12701,7 +12607,7 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
<p>Occurs when an object is dead.</p>
<p>initiator : The unit that is dead. </p>
<p>initiator : The unit that is dead.</p>
<div id= "#Functions##OnEventDead" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12809,7 +12715,7 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
</div>
<p>Occurs when a pilot ejects from an aircraft
initiator : The unit that has ejected </p>
initiator : The unit that has ejected</p>
<div id= "#Functions##OnEventEjection" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12845,7 +12751,7 @@ initiator : The unit that has ejected </p>
<p>Occurs when any aircraft shuts down its engines.</p>
<p>initiator : The unit that is stopping its engines. </p>
<p>initiator : The unit that is stopping its engines..</p>
<div id= "#Functions##OnEventEngineShutdown" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12881,7 +12787,7 @@ initiator : The unit that has ejected </p>
<p>Occurs when any aircraft starts its engines.</p>
<p>initiator : The unit that is starting its engines. </p>
<p>initiator : The unit that is starting its engines..</p>
<div id= "#Functions##OnEventEngineStartup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12917,9 +12823,9 @@ initiator : The unit that has ejected </p>
<p>Occurs whenever an object is hit by a weapon.</p>
<p>initiator : The unit object the fired the weapon
weapon: Weapon object that hit the target
target: The Object that was hit. </p>
<p>initiator : The unit object the fired the weapon.
weapon: Weapon object that hit the target.
target: The Object that was hit.</p>
<div id= "#Functions##OnEventHit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12955,7 +12861,7 @@ target: The Object that was hit. </p>
<p>Occurs when any system fails on a human controlled aircraft.</p>
<p>initiator : The unit that had the failure </p>
<p>initiator : The unit that had the failure.</p>
<div id= "#Functions##OnEventHumanFailure" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -12994,7 +12900,7 @@ target: The Object that was hit. </p>
<p>Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.</p>
<ul>
<li>initiator: The unit that killed the target</li>
<li>initiator: The unit that killed the target.</li>
<li>target: Target Object</li>
<li>weapon: Weapon Object</li>
</ul>
@@ -13032,11 +12938,10 @@ target: The Object that was hit. </p>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
initiator : The unit that has landed.</p>
<p>Can be an Airbase Object, FARP, or Ships </p>
<p>place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships.</p>
<div id= "#Functions##OnEventLand" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13112,7 +13017,7 @@ place: Object that the unit landed on.</p>
<h2><a id="#(CSAR).OnEventLandingQualityMark" ><strong>CSAR:OnEventLandingQualityMark(EventData)</strong></a></h2>
</div>
<p>Landing quality mark. </p>
<p>Landing quality mark.</p>
<div id= "#Functions##OnEventLandingQualityMark" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13148,7 +13053,7 @@ place: Object that the unit landed on.</p>
<p>Occurs when a new mark was added.</p>
<p>MarkID: ID of the mark. </p>
<p>MarkID: ID of the mark.</p>
<div id= "#Functions##OnEventMarkAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13184,7 +13089,7 @@ place: Object that the unit landed on.</p>
<p>Occurs when a mark text was changed.</p>
<p>MarkID: ID of the mark. </p>
<p>MarkID: ID of the mark.</p>
<div id= "#Functions##OnEventMarkChange" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13220,7 +13125,7 @@ place: Object that the unit landed on.</p>
<p>Occurs when a mark was removed.</p>
<p>MarkID: ID of the mark. </p>
<p>MarkID: ID of the mark.</p>
<div id= "#Functions##OnEventMarkRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13253,7 +13158,7 @@ place: Object that the unit landed on.</p>
<h2><a id="#(CSAR).OnEventMissionEnd" ><strong>CSAR:OnEventMissionEnd(EventData)</strong></a></h2>
</div>
<p>Occurs when a mission ends</p>
<p>Occurs when a mission ends.</p>
<div id= "#Functions##OnEventMissionEnd" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13286,7 +13191,7 @@ place: Object that the unit landed on.</p>
<h2><a id="#(CSAR).OnEventMissionStart" ><strong>CSAR:OnEventMissionStart(EventData)</strong></a></h2>
</div>
<p>Occurs when a mission starts </p>
<p>Occurs when a mission starts.</p>
<div id= "#Functions##OnEventMissionStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13359,7 +13264,7 @@ place: Object that the unit landed on.</p>
<p>Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane.
initiator : The unit that the pilot has died in. </p>
initiator : The unit that the pilot has died in.</p>
<div id= "#Functions##OnEventPilotDead" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13395,8 +13300,8 @@ initiator : The unit that the pilot has died in. </p>
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
<p><strong>NOTE</strong>: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event.
initiator : The unit that is being taken control of. </p>
<p><strong>NOTE</strong>: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event.
initiator : The unit that is being taken control of.</p>
<div id= "#Functions##OnEventPlayerEnterAircraft" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13432,7 +13337,7 @@ initiator : The unit that is being taken control of. </p>
<p>Occurs when any player assumes direct control of a unit.</p>
<p>initiator : The unit that is being taken control of. </p>
<p>initiator : The unit that is being taken control of.</p>
<div id= "#Functions##OnEventPlayerEnterUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13468,7 +13373,7 @@ initiator : The unit that is being taken control of. </p>
<p>Occurs when any player relieves control of a unit to the AI.</p>
<p>initiator : The unit that the player left. </p>
<p>initiator : The unit that the player left.</p>
<div id= "#Functions##OnEventPlayerLeaveUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13504,7 +13409,7 @@ initiator : The unit that is being taken control of. </p>
<p>Occurs when an aircraft connects with a tanker and begins taking on fuel.</p>
<p>initiator : The unit that is receiving fuel. </p>
<p>initiator : The unit that is receiving fuel.</p>
<div id= "#Functions##OnEventRefueling" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13540,7 +13445,7 @@ initiator : The unit that is being taken control of. </p>
<p>Occurs when an aircraft is finished taking fuel.</p>
<p>initiator : The unit that was receiving fuel. </p>
<p>initiator : The unit that was receiving fuel.</p>
<div id= "#Functions##OnEventRefuelingStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13613,7 +13518,7 @@ initiator : The unit that is being taken control of. </p>
<p>Event will always correspond with a shooting start event.
initiator : The unit that was doing the shooting. </p>
initiator : The unit that was doing the shooting.</p>
<div id= "#Functions##OnEventShootingEnd" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13649,9 +13554,9 @@ initiator : The unit that was doing the shooting. </p>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
<p>Most common with aircraft cannons (GAU-8), auto cannons, and machine guns.
initiator : The unit that is doing the shooting.
target: The unit that is being targeted. </p>
target: The unit that is being targeted.</p>
<div id= "#Functions##OnEventShootingStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13687,7 +13592,7 @@ target: The unit that is being targeted. </p>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.</p>
<p>But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.</p>
<div id= "#Functions##OnEventShot" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13723,8 +13628,8 @@ target: The unit that is being targeted. </p>
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
<p>initiator : The unit that tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<p>initiator : The unit that took off.
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships.</p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -14051,7 +13956,7 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<p>Set the Class <a href="Event.html">Event</a> processing Priority.</p>
<p>The Event processing Priority is a number from 1 to 10,
<p>The Event processing Priority is a number from 1 to 10,
reflecting the order of the classes subscribed to the Event to be processed.</p>
<div id= "#Functions##SetEventPriority" class="w3-show w3-white">
@@ -14099,7 +14004,7 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
<p>Set a state or property of the Object given a Key and a Value.</p>
<p>Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.</p>
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
<div id= "#Functions##SetState" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -14482,11 +14387,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Switch the tracing On
BASE:TraceOnOff( true )
<pre class="example"><code>
-- Switch the tracing On
BASE:TraceOnOff( true )
-- Switch the tracing Off
BASE:TraceOnOff( false )</code></pre>
-- Switch the tracing Off
BASE:TraceOnOff( false )
</code></pre>
</div>
@@ -14653,7 +14560,7 @@ BASE:TraceOnOff( false )</code></pre>
<p> TODO: Complete DCS#Event structure. <br/>
<p> TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class.
@param #BASE self
@param DCS#Event event</p>