weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2026-08-13 17:25:58 +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
Documentation/Wrapper.Group.html
+31 -97
View File
@@ -3398,7 +3398,7 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).WayPointInitialize">GROUP: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">
@@ -4252,7 +4252,7 @@ amount of fuel in the group.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetEventPriority">GROUP: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">
@@ -4550,7 +4550,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="##(GROUP).SetEventPriority">GROUP: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">
@@ -4981,18 +4981,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="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -9384,18 +9373,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -10514,7 +10492,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>
@@ -11015,7 +10993,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>
@@ -11747,7 +11725,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">
@@ -12013,7 +11991,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>
@@ -13824,7 +13802,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">
@@ -13875,7 +13853,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">
@@ -14213,7 +14191,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>
@@ -14322,7 +14300,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>
@@ -14431,7 +14409,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>
@@ -14967,7 +14945,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">
@@ -16344,7 +16322,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>
@@ -16693,7 +16671,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>
@@ -16971,7 +16949,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>
@@ -17092,7 +17070,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>
@@ -18020,12 +17998,12 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
<h2><a id="#(GROUP).WayPointInitialize" ><strong>GROUP: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">
@@ -18281,18 +18259,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -22138,18 +22105,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -22774,18 +22730,7 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -23045,18 +22990,7 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -23793,7 +23727,7 @@ If the Identifiable is alive, true is returned. </p>
<h2><a id="#(GROUP).GetEventPriority" ><strong>GROUP: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,
@@ -23812,7 +23746,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>
@@ -25797,7 +25731,7 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<h2><a id="#(GROUP).SetEventPriority" ><strong>GROUP: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,
@@ -25819,7 +25753,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>