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
2022-10-21 12:00:43 +00:00
parent e2dde8a474
commit 16abde2bbb
112 changed files with 1711 additions and 1623 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
Documentation/Wrapper.Client.html
View File

@@ -3164,7 +3164,7 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).WayPointInitialize">CLIENT:WayPointInitialize(WayPoints)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Retrieve the controllable mission and allow to place function hooks within the mission waypoint plan.</p>
<p>Retrieve the controllable mission and allow to place function hooks within the mission waypoint plan.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4018,7 +4018,7 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetEventPriority">CLIENT:GetEventPriority()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the Class <a href="Event.html">Event</a> processing Priority.</p>
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4316,7 +4316,7 @@ Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SetEventPriority">CLIENT:SetEventPriority(EventPriority)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the Class <a href="Event.html">Event</a> processing Priority.</p>
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
</td>
</tr>
<tr class="w3-border">
@@ -9312,7 +9312,7 @@ Note that this can only work on GROUP level, although individual UNITs can be co
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<a href="##(CONTROLLABLE)">#CONTROLLABLE</a>
<strong><strong>AttackGroup</strong></strong>
</p>
</div>
@@ -9813,7 +9813,7 @@ If the task is assigned to the controllable lead unit will be a FAC.</p>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<a href="##(CONTROLLABLE)">#CONTROLLABLE</a>
<strong><strong>AttackGroup</strong></strong>
</p>
</div>
@@ -10545,7 +10545,7 @@ TODO: Rework the method how to retrieve a template ...</p>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>:</p>
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
@@ -10811,7 +10811,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<a href="##(CONTROLLABLE)">#CONTROLLABLE</a>
<strong><strong>self</strong></strong>
</p>
</div>
@@ -12622,7 +12622,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>:</p>
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
@@ -12673,7 +12673,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>:</p>
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
@@ -13011,7 +13011,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="##(CONTROLLABLE)">#CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
@@ -13120,7 +13120,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="##(CONTROLLABLE)">#CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
@@ -13229,7 +13229,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="##(CONTROLLABLE)">#CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
@@ -13765,7 +13765,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>:</p>
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
@@ -15142,7 +15142,7 @@ The unit / controllable will also protect that controllable from threats of spec
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<a href="##(CONTROLLABLE)">#CONTROLLABLE</a>
<strong><strong>FollowControllable</strong></strong>
</p>
</div>
@@ -15491,7 +15491,7 @@ If another controllable is on land the unit / controllable will orbit around.</p
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<a href="##(CONTROLLABLE)">#CONTROLLABLE</a>
<strong><strong>FollowControllable</strong></strong>
</p>
</div>
@@ -15769,7 +15769,7 @@ Used to support CarpetBombing Task</p>
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="##(CONTROLLABLE)">#CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
@@ -15890,7 +15890,7 @@ Used to support CarpetBombing Task</p>
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="##(CONTROLLABLE)">#CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
@@ -16818,12 +16818,12 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
<h2><a id="#(CLIENT).WayPointInitialize" ><strong>CLIENT:WayPointInitialize(WayPoints)</strong></a></h2>
</div>
<p> Retrieve the controllable mission and allow to place function hooks within the mission waypoint plan.</p>
<p>Retrieve the controllable mission and allow to place function hooks within the mission waypoint plan.</p>
<p> Use the method <a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> to define the hook functions for specific waypoints.
Use the method @{Controllable@CONTROLLABLE:WayPointExecute) to start the execution of the new mission plan.
Note that when WayPointInitialize is called, the Mission of the controllable is RESTARTED!</p>
<p>Use the method <a href="##(CONTROLLABLE).WayPointFunction">CONTROLLABLE.WayPointFunction</a>() to define the hook functions for specific waypoints.
Use the method @{#CONTROLLABLE.WayPointExecute)() to start the execution of the new mission plan.
Note that when WayPointInitialize is called, the Mission of the controllable is RESTARTED!</p>
<div id= "#Functions##WayPointInitialize" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -22735,7 +22735,7 @@ If the Identifiable is alive, true is returned. </p>
<h2><a id="#(CLIENT).GetEventPriority" ><strong>CLIENT:GetEventPriority()</strong></a></h2>
</div>
<p>Get the Class <a href="Event.html">Event</a> processing Priority.</p>
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
<p>The Event processing Priority is a number from 1 to 10,
@@ -22754,7 +22754,7 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
</div>
<div class="w3-half">
<p>The <a href="Event.html">Event</a> processing Priority.</p>
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
</div>
</div>
@@ -24739,7 +24739,7 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<h2><a id="#(CLIENT).SetEventPriority" ><strong>CLIENT:SetEventPriority(EventPriority)</strong></a></h2>
</div>
<p>Set the Class <a href="Event.html">Event</a> processing Priority.</p>
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
<p>The Event processing Priority is a number from 1 to 10,
@@ -24761,7 +24761,7 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
</div>
<div class="w3-half">
<p>The <a href="Event.html">Event</a> processing Priority.</p>
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
</div>
</div>