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

52
Documentation/Wrapper.Controllable.html
View File

@@ -1664,7 +1664,7 @@ Controls a network of short range air/missile defense groups.</p>
<h1>2) CONTROLLABLE Task methods</h1>
<p>Several controllable task methods are available that help you to prepare tasks.
These methods return a string consisting of the task description, which can then be given to either a <a href="Wrapper.Controllable.html##(CONTROLLABLE).PushTask">Wrapper.Controllable#CONTROLLABLE.PushTask</a> or <a href="Wrapper.Controllable.html##(SetTask)">Wrapper.Controllable#SetTask</a> method to assign the task to the CONTROLLABLE.
These methods return a string consisting of the task description, which can then be given to either a <a href="##(CONTROLLABLE).PushTask">CONTROLLABLE.PushTask</a>() or <a href="##(CONTROLLABLE).SetTask">CONTROLLABLE.SetTask</a>() method to assign the task to the CONTROLLABLE.
Tasks are specific for the category of the CONTROLLABLE, more specific, for AIR, GROUND or AIR and GROUND.
Each task description where applicable indicates for which controllable category the task is valid.
There are 2 main subdivisions of tasks: Assigned tasks and EnRoute tasks.</p>
@@ -2697,7 +2697,7 @@ The method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoi
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).WayPointInitialize">CONTROLLABLE: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">
@@ -3551,7 +3551,7 @@ The method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoi
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).GetEventPriority">CONTROLLABLE: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">
@@ -3849,7 +3849,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="##(CONTROLLABLE).SetEventPriority">CONTROLLABLE: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">
@@ -5105,7 +5105,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>
@@ -5606,7 +5606,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>
@@ -6338,7 +6338,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">
@@ -6604,7 +6604,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>
@@ -8415,7 +8415,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">
@@ -8466,7 +8466,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">
@@ -8804,7 +8804,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>
@@ -8913,7 +8913,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>
@@ -9022,7 +9022,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>
@@ -9558,7 +9558,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">
@@ -10935,7 +10935,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>
@@ -11284,7 +11284,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>
@@ -11562,7 +11562,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>
@@ -11683,7 +11683,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>
@@ -12611,12 +12611,12 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
<h2><a id="#(CONTROLLABLE).WayPointInitialize" ><strong>CONTROLLABLE: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">
@@ -17988,7 +17988,7 @@ If the Identifiable is alive, true is returned. </p>
<h2><a id="#(CONTROLLABLE).GetEventPriority" ><strong>CONTROLLABLE: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,
@@ -18007,7 +18007,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>
@@ -19992,7 +19992,7 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<h2><a id="#(CONTROLLABLE).SetEventPriority" ><strong>CONTROLLABLE: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,
@@ -20014,7 +20014,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>