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:
FlightControl-User
2021-01-02 23:13:23 +00:00
parent 57b032b0e7
commit 3fbca8e731
97 changed files with 10993 additions and 518 deletions
Download Patch File Download Diff File Expand all files Collapse all files

274
Documentation/Tasking.Task_Cargo_Dispatcher.html
View File

@@ -2468,6 +2468,12 @@ You can use this event handler to post messages to players, or provide status up
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CARGO_DISPATCHER).CreateEventDead">TASK_CARGO_DISPATCHER:CreateEventDead(EventTime, Initiator)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Dead Event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CARGO_DISPATCHER).CreateEventPlayerEnterAircraft">TASK_CARGO_DISPATCHER:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2711,6 +2717,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CARGO_DISPATCHER).OnEventPilotDead">TASK_CARGO_DISPATCHER:OnEventPilotDead(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when the pilot of an aircraft is killed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TASK_CARGO_DISPATCHER).OnEventPlayerEnterAircraft">TASK_CARGO_DISPATCHER:OnEventPlayerEnterAircraft(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2954,7 +2966,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">
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
<a id="#(TASK_CARGO_DISPATCHER).CSARBriefing" ><strong>TASK_CARGO_DISPATCHER.CSARBriefing</strong></a>
@@ -2965,7 +2977,51 @@ 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">
<a id="#(TASK_CARGO_DISPATCHER).MaxCSAR" ><strong>TASK_CARGO_DISPATCHER.MaxCSAR</strong></a>
<a id="#(TASK_CARGO_DISPATCHER).CSARDeployZones" ><strong>TASK_CARGO_DISPATCHER.CSARDeployZones</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).CSARTaskName" ><strong>TASK_CARGO_DISPATCHER.CSARTaskName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(TASK_CARGO_DISPATCHER).CSARTasks" ><strong>TASK_CARGO_DISPATCHER.CSARTasks</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(TASK_CARGO_DISPATCHER).CountCSAR" ><strong>TASK_CARGO_DISPATCHER.CountCSAR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
@@ -4033,7 +4089,7 @@ This method can only be used once!</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
<a id="#(TASK_CARGO_DISPATCHER).CSARBriefing" ><strong>TASK_CARGO_DISPATCHER.CSARBriefing</strong></a>
@@ -4044,7 +4100,51 @@ This method can only be used once!</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).MaxCSAR" ><strong>TASK_CARGO_DISPATCHER.MaxCSAR</strong></a>
<a id="#(TASK_CARGO_DISPATCHER).CSARDeployZones" ><strong>TASK_CARGO_DISPATCHER.CSARDeployZones</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).CSARTaskName" ><strong>TASK_CARGO_DISPATCHER.CSARTaskName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(TASK_CARGO_DISPATCHER).CSARTasks" ><strong>TASK_CARGO_DISPATCHER.CSARTasks</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(TASK_CARGO_DISPATCHER).CountCSAR" ><strong>TASK_CARGO_DISPATCHER.CountCSAR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
@@ -4891,7 +4991,7 @@ This method can only be used once!</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
<a id="#(TASK_CARGO_DISPATCHER).CSARBriefing" ><strong>TASK_CARGO_DISPATCHER.CSARBriefing</strong></a>
@@ -4902,7 +5002,51 @@ This method can only be used once!</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).MaxCSAR" ><strong>TASK_CARGO_DISPATCHER.MaxCSAR</strong></a>
<a id="#(TASK_CARGO_DISPATCHER).CSARDeployZones" ><strong>TASK_CARGO_DISPATCHER.CSARDeployZones</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).CSARTaskName" ><strong>TASK_CARGO_DISPATCHER.CSARTaskName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(TASK_CARGO_DISPATCHER).CSARTasks" ><strong>TASK_CARGO_DISPATCHER.CSARTasks</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(TASK_CARGO_DISPATCHER).CountCSAR" ><strong>TASK_CARGO_DISPATCHER.CountCSAR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
@@ -6385,7 +6529,7 @@ This method can only be used once!</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
<a id="#(TASK_CARGO_DISPATCHER).CSARBriefing" ><strong>TASK_CARGO_DISPATCHER.CSARBriefing</strong></a>
@@ -6396,7 +6540,51 @@ This method can only be used once!</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).MaxCSAR" ><strong>TASK_CARGO_DISPATCHER.MaxCSAR</strong></a>
<a id="#(TASK_CARGO_DISPATCHER).CSARDeployZones" ><strong>TASK_CARGO_DISPATCHER.CSARDeployZones</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).CSARTaskName" ><strong>TASK_CARGO_DISPATCHER.CSARTaskName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(TASK_CARGO_DISPATCHER).CSARTasks" ><strong>TASK_CARGO_DISPATCHER.CSARTasks</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(TASK_CARGO_DISPATCHER).CountCSAR" ><strong>TASK_CARGO_DISPATCHER.CountCSAR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
@@ -6640,6 +6828,39 @@ This method can only be used once!</p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(TASK_CARGO_DISPATCHER).CreateEventPlayerEnterAircraft" ><strong>TASK_CARGO_DISPATCHER:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
</div>
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
<div id= "#Functions##CreateEventPlayerEnterAircraft" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>PlayerUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The aircraft unit the player entered.</p>
</div>
</div>
</div>
</div>
</div>
@@ -8193,6 +8414,43 @@ initiator : The unit that the pilot has died in. </p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(TASK_CARGO_DISPATCHER).OnEventPlayerEnterAircraft" ><strong>TASK_CARGO_DISPATCHER:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
</div>
<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>
<div id= "#Functions##OnEventPlayerEnterAircraft" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>