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
2023-11-08 16:47:29 +00:00
parent 464d0bfd8e
commit 6c986809b9
28 changed files with 1083 additions and 1092 deletions
Download Patch File Download Diff File Expand all files Collapse all files

213
Documentation/Wrapper.Group.html
View File

@@ -1642,6 +1642,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return
<ul>
<li><strong>Entropy</strong>, <strong>Afinegan</strong>: Came up with the requirement for AIOnOff().</li>
<li><strong>Applevangelist</strong>: various</li>
</ul>
<hr/>
@@ -1669,14 +1670,18 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return
<h2>Finding groups</h2>
<p>The GROUP class provides the following functions to retrieve quickly the relevant GROUP instance:</p>
<ul>
<li><a href="##(GROUP).Find">GROUP.Find</a>(): Find a GROUP instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a DCS Group object.</li>
<li><a href="##(GROUP).FindByName">GROUP.FindByName</a>(): Find a GROUP instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a DCS Group name.</li>
<li><a href="##(GROUP)">#GROUP</a>(): Find a GROUP instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using pattern matching.</li>
<li><a href="##(GROUP)">#GROUP</a>(): Find all GROUP instances from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using pattern matching.</li>
</ul>
<h1>1. Tasking of groups</h1>
<h2>Tasking of groups</h2>
<p>A GROUP is derived from the wrapper class CONTROLLABLE (<a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>).
See the <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> task methods section for a description of the task methods.</p>
@@ -1886,12 +1891,24 @@ Use the following Zone validation methods on the group:</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).Find">GROUP:Find(DCSGroup)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Find the GROUP wrapper class instance using the DCS Group.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).FindAllByMatching">GROUP:FindAllByMatching(Pattern)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Find all GROUP objects matching using patterns.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).FindByMatching">GROUP:FindByMatching(Pattern)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Find the first(!) GROUP matching using patterns.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).FindByName">GROUP:FindByName(GroupName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Find the created GROUP using the DCS Group Name.</p>
<p>Find a GROUP using the DCS Group Name.</p>
</td>
</tr>
<tr class="w3-border">
@@ -5208,7 +5225,18 @@ 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).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -5647,6 +5675,118 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).FindAllByMatching" ><strong>GROUP:FindAllByMatching(Pattern)</strong></a></h2>
</div>
<p>Find all GROUP objects matching using patterns.</p>
<p>Note that this is <strong>a lot</strong> slower than <code>:FindByName()</code>!</p>
<div id= "#Functions##FindAllByMatching" 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>GROUP</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>
#string
<strong><strong>Pattern</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The pattern to look for. Refer to <a href="http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_(Regular_Expressions">LUA patterns</a> for regular expressions in LUA.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>Groups Table of matching #GROUP objects found</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> -- Find all group with a partial group name
local grptable = GROUP:FindAllByMatching( "Apple" )
-- will return all groups with "Apple" in the name
-- using a pattern
local grp = GROUP:FindAllByMatching( ".%d.%d$" )
-- will return the all groups found ending in "-1-1" to "-9-9", but not e.g. "-10-1" or "-1-10"</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).FindByMatching" ><strong>GROUP:FindByMatching(Pattern)</strong></a></h2>
</div>
<p>Find the first(!) GROUP matching using patterns.</p>
<p>Note that this is <strong>a lot</strong> slower than <code>:FindByName()</code>!</p>
<div id= "#Functions##FindByMatching" 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>GROUP</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>
#string
<strong><strong>Pattern</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The pattern to look for. Refer to <a href="http://www.easyuo.com/openeuo/wiki/index.php/Lua_Patterns_and_Captures_(Regular_Expressions">LUA patterns</a> for regular expressions in LUA.</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="##(GROUP)">#GROUP</a>:</p>
</div>
<div class="w3-half">
<p>The GROUP.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> -- Find a group with a partial group name
local grp = GROUP:FindByMatching( "Apple" )
-- will return e.g. a group named "Apple-1-1"
-- using a pattern
local grp = GROUP:FindByMatching( ".%d.%d$" )
-- will return the first group found ending in "-1-1" to "-9-9", but not e.g. "-10-1"</code></pre>
</div>
</div>
</div>
@@ -5656,7 +5796,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
<h2><a id="#(GROUP).FindByName" ><strong>GROUP:FindByName(GroupName)</strong></a></h2>
</div>
<p>Find the created GROUP using the DCS Group Name.</p>
<p>Find a GROUP using the DCS Group Name.</p>
<div id= "#Functions##FindByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -9701,7 +9841,18 @@ 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).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -21857,7 +22008,18 @@ Note that when WayPointInitialize is called, the Mission of the controllable is
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -25946,7 +26108,18 @@ 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).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -26571,7 +26744,18 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -26831,7 +27015,18 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>