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

110
Documentation/Wrapper.Controllable.html
View File

@@ -3474,7 +3474,7 @@ The method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoi
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).OnEventEjection">CONTROLLABLE: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">
@@ -3511,8 +3511,7 @@ initiator : The unit that has ejected </p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).OnEventLand">CONTROLLABLE: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">
@@ -3524,7 +3523,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="##(CONTROLLABLE).OnEventLandingQualityMark">CONTROLLABLE: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">
@@ -3548,13 +3547,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="##(CONTROLLABLE).OnEventMissionEnd">CONTROLLABLE: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="##(CONTROLLABLE).OnEventMissionStart">CONTROLLABLE: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">
@@ -17188,7 +17187,7 @@ If the Identifiable is alive, true is returned. </p>
<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">
@@ -17221,7 +17220,7 @@ If the Identifiable is alive, true is returned. </p>
<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">
@@ -17258,10 +17257,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>
@@ -17320,7 +17319,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">
@@ -17618,9 +17617,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>
@@ -17652,7 +17651,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">
@@ -17721,8 +17720,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">
@@ -17758,7 +17757,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">
@@ -17794,7 +17793,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">
@@ -17830,7 +17829,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">
@@ -17938,7 +17937,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">
@@ -17974,7 +17973,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">
@@ -18010,7 +18009,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">
@@ -18046,9 +18045,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">
@@ -18084,7 +18083,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">
@@ -18123,7 +18122,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>
@@ -18161,11 +18160,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">
@@ -18241,7 +18239,7 @@ place: Object that the unit landed on.</p>
<h2><a id="#(CONTROLLABLE).OnEventLandingQualityMark" ><strong>CONTROLLABLE: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">
@@ -18277,7 +18275,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">
@@ -18313,7 +18311,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">
@@ -18349,7 +18347,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">
@@ -18382,7 +18380,7 @@ place: Object that the unit landed on.</p>
<h2><a id="#(CONTROLLABLE).OnEventMissionEnd" ><strong>CONTROLLABLE: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">
@@ -18415,7 +18413,7 @@ place: Object that the unit landed on.</p>
<h2><a id="#(CONTROLLABLE).OnEventMissionStart" ><strong>CONTROLLABLE: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">
@@ -18488,7 +18486,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">
@@ -18524,8 +18522,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">
@@ -18561,7 +18559,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">
@@ -18597,7 +18595,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">
@@ -18633,7 +18631,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">
@@ -18669,7 +18667,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">
@@ -18742,7 +18740,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">
@@ -18778,9 +18776,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">
@@ -18816,7 +18814,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">
@@ -18852,8 +18850,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">
@@ -19180,7 +19178,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">
@@ -19228,7 +19226,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">
@@ -19611,11 +19609,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>
@@ -19782,7 +19782,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>