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

Auto commit by GitHub Actions Workflow

Browse Source
This commit is contained in:
MooseBotter
2024-09-01 13:39:09 +00:00
parent 6ee8b913cf
commit 79308f7628
28 changed files with 2133 additions and 593 deletions
Download Patch File Download Diff File Expand all files Collapse all files

365
Documentation/Wrapper.Group.html
View File

@@ -2840,6 +2840,18 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).DCSControllable">GROUP.DCSControllable</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The DCS controllable class.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).DisableIRMarker">GROUP:DisableIRMarker()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[GROUND] Disable the IR marker.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).DisableIRMarkerForGroup">GROUP:DisableIRMarkerForGroup()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[GROUND] Disable the IR markers for a whole group.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2912,6 +2924,18 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).EnRouteTaskTanker">GROUP:EnRouteTaskTanker()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Aircraft will act as a tanker for friendly units.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).EnableIRMarker">GROUP:EnableIRMarker(Runtime)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[GROUND] Enable the IR marker.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).EnableIRMarkerForGroup">GROUP:EnableIRMarkerForGroup()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[GROUND] Enable the IR markers for a whole group.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2984,6 +3008,18 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).HasTask">GROUP:HasTask()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Checking the Task Queue of the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IRMarkerGroup">GROUP.IRMarkerGroup</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).IRMarkerUnit">GROUP.IRMarkerUnit</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -3026,6 +3062,12 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).New">GROUP:New(ControllableName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a new CONTROLLABLE from a DCSControllable</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).NewIRMarker">GROUP:NewIRMarker(EnableImmediately, Runtime)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[GROUND] Create and enable a new IR Marker for the given controllable UNIT or GROUP.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3842,12 +3884,36 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP)._GetController">GROUP:_GetController()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the controller for the CONTROLLABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP)._MarkerBlink">GROUP:_MarkerBlink()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[Internal] This method is called by the scheduler after enabling the IR marker.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).___PassingWaypoint">GROUP.___PassingWaypoint(controllable, n, N, waypointfunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Task function when controllable passes a waypoint.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).spot">GROUP.spot</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).stoptimer">GROUP.stoptimer</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).timer">GROUP.timer</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -5522,18 +5588,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>
@@ -10347,18 +10402,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>
@@ -11622,6 +11666,66 @@ Note that this can only work on GROUP level, although individual UNITs can be co
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).DisableIRMarker" ><strong>GROUP:DisableIRMarker()</strong></a></h2>
</div>
<p>[GROUND] Disable the IR marker.</p>
<div id= "#Functions##DisableIRMarker" 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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>self </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).DisableIRMarkerForGroup" ><strong>GROUP:DisableIRMarkerForGroup()</strong></a></h2>
</div>
<p>[GROUND] Disable the IR markers for a whole group.</p>
<div id= "#Functions##DisableIRMarkerForGroup" 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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>self </p>
</div>
</div>
</div>
</div>
</div>
@@ -12587,6 +12691,80 @@ See <a href="https://wiki.hoggitworld.com/view/DCS_task_tanker">hoggit</a>.</p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).EnableIRMarker" ><strong>GROUP:EnableIRMarker(Runtime)</strong></a></h2>
</div>
<p>[GROUND] Enable the IR marker.</p>
<div id= "#Functions##EnableIRMarker" 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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>
#number
<strong><strong>Runtime</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optionally) Run this IR Marker for the given number of seconds, then stop. Else run until you call <code>myobject:DisableIRMarker()</code>.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>self </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).EnableIRMarkerForGroup" ><strong>GROUP:EnableIRMarkerForGroup()</strong></a></h2>
</div>
<p>[GROUND] Enable the IR markers for a whole group.</p>
<div id= "#Functions##EnableIRMarkerForGroup" 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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>self </p>
</div>
</div>
</div>
</div>
</div>
@@ -13843,6 +14021,63 @@ If <strong>at least one</strong> detection method is specified, only the methods
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).NewIRMarker" ><strong>GROUP:NewIRMarker(EnableImmediately, Runtime)</strong></a></h2>
</div>
<p>[GROUND] Create and enable a new IR Marker for the given controllable UNIT or GROUP.</p>
<div id= "#Functions##NewIRMarker" 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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>EnableImmediately</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optionally) If true start up the IR Marker immediately. Else you need to call <code>myobject:EnableIRMarker()</code> later on.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Runtime</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optionally) Run this IR Marker for the given number of seconds, then stop. Use in conjunction with EnableImmediately.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -23056,6 +23291,36 @@ mygroup:WayPointExecute()</code></pre>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP)._MarkerBlink" ><strong>GROUP:_MarkerBlink()</strong></a></h2>
</div>
<p>[Internal] This method is called by the scheduler after enabling the IR marker.</p>
<div id= "#Functions##_MarkerBlink" 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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>self </p>
</div>
</div>
</div>
</div>
</div>
@@ -23261,18 +23526,7 @@ mygroup:WayPointExecute()</code></pre>
<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>
@@ -27375,18 +27629,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>
@@ -28041,18 +28284,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>
@@ -28308,18 +28540,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>