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

128
Documentation/Wrapper.Unit.html
View File

@@ -1623,7 +1623,7 @@
<h3>Author: <strong>FlightControl</strong></h3>
<h3>Contributions: <strong>funkyfranky</strong></h3>
<h3>Contributions: <strong>funkyfranky</strong>, <strong>Applevangelist</strong></h3>
<hr/>
@@ -1663,6 +1663,8 @@ If the DCS Unit object does not exist or is nil, the UNIT methods will return ni
<ul>
<li><a href="##(UNIT).Find">UNIT.Find</a>(): Find a UNIT instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a DCS Unit object.</li>
<li><a href="##(UNIT).FindByName">UNIT.FindByName</a>(): Find a UNIT instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a DCS Unit name.</li>
<li><a href="##(UNIT)">#UNIT</a>(): Find a UNIT instance from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a pattern.</li>
<li><a href="##(UNIT)">#UNIT</a>(): Find all UNIT instances from the global _DATABASE object (an instance of <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a>) using a pattern.</li>
</ul>
<p>IMPORTANT: ONE SHOULD NEVER SANITIZE these UNIT OBJECT REFERENCES! (make the UNIT object references nil).</p>
@@ -1762,6 +1764,18 @@ If you want to obtain the complete <strong>3D position</strong> including orient
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).Find">UNIT:Find(DCSUnit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a UNIT from the _DATABASE using a DCSUnit object.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).FindAllByMatching">UNIT:FindAllByMatching(Pattern)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Find all UNIT 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="##(UNIT).FindByMatching">UNIT:FindByMatching(Pattern)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Find the first(!) UNIT matching using patterns.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4695,6 +4709,118 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UNIT).FindAllByMatching" ><strong>UNIT:FindAllByMatching(Pattern)</strong></a></h2>
</div>
<p>Find all UNIT 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>UNIT</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>Units Table of matching #UNIT objects found</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> -- Find all group with a partial group name
local unittable = UNIT:FindAllByMatching( "Apple" )
-- will return all units with "Apple" in the name
-- using a pattern
local unittable = UNIT:FindAllByMatching( ".%d.%d$" )
-- will return the all units 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="#(UNIT).FindByMatching" ><strong>UNIT:FindByMatching(Pattern)</strong></a></h2>
</div>
<p>Find the first(!) UNIT 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>UNIT</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="##(UNIT)">#UNIT</a>:</p>
</div>
<div class="w3-half">
<p>The UNIT.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> -- Find a group with a partial group name
local unit = UNIT:FindByMatching( "Apple" )
-- will return e.g. a group named "Apple-1-1"
-- using a pattern
local unit = UNIT: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>