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-02-29 18:03:59 +00:00
parent 96907bda0b
commit ee3533af95
27 changed files with 877 additions and 651 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
Documentation/Wrapper.Group.html
View File

@@ -1683,7 +1683,7 @@ If the DCS Group object does not exist or is nil, the GROUP methods will return
<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>).
<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>
<p>But here is an example how a group can be assigned a task.</p>
@@ -1697,13 +1697,13 @@ Same for the <code>"AttackGroup"</code>.</p>
local AttackGroup = GROUP:FindByName( "AttackGroup" )
</code></pre>
<p>Now we retrieve the <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> objects of the <code>AttackGroup</code> object, using the method <code>:GetUnits()</code>. </p>
<p>Now we retrieve the <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> objects of the <code>AttackGroup</code> object, using the method <code>:GetUnits()</code>.</p>
<pre><code> local AttackUnits = AttackGroup:GetUnits()
</code></pre>
<p>Tasks are actually text strings that we build using methods of GROUP.
So first, we declare an list of <code>Tasks</code>. </p>
So first, we declare an list of <code>Tasks</code>.</p>
<pre><code> local Tasks = {}
</code></pre>
@@ -1741,11 +1741,11 @@ The <code>HeliGroup:PushTask</code> method can receive a delay parameter in seco
In the example, <code>30</code> is given as a delay.</p>
<pre><code> HeliGroup:PushTask(
<pre><code> HeliGroup:PushTask(
HeliGroup:TaskCombo(
Tasks
), 30
)
), 30
)
</code></pre>
<p>That's it!
@@ -5303,18 +5303,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>
@@ -5488,7 +5477,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>self </p>
<p>self</p>
</div>
</div>
@@ -5532,7 +5521,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>self </p>
<p>self</p>
</div>
</div>
@@ -5791,7 +5780,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>self </p>
<p>self</p>
</div>
</div>
@@ -5890,7 +5879,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
<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>
@@ -5946,7 +5935,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
<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>
@@ -6024,7 +6013,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>Measure from the ground or from sea level (ASL). Provide <strong>true</strong> for measuring from the ground (AGL). <strong>false</strong> or <strong>nil</strong> if you measure from sea level. </p>
<p>Measure from the ground or from sea level (ASL). Provide <strong>true</strong> for measuring from the ground (AGL). <strong>false</strong> or <strong>nil</strong> if you measure from sea level.</p>
</div>
</div>
@@ -6035,7 +6024,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>The altitude of the group or nil if is not existing or alive. </p>
<p>The altitude of the group or nil if is not existing or alive.</p>
</div>
</div>
@@ -6097,7 +6086,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>Number of missiles left. </p>
<p>Number of missiles left.</p>
</div>
<div class="w3-half">
@@ -6105,7 +6094,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>Number of artillery shells left (with explosive mass, included in shells; shells can also be machine gun ammo) </p>
<p>Number of artillery shells left (with explosive mass, included in shells; shells can also be machine gun ammo)</p>
</div>
</div>
@@ -6484,7 +6473,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>The descriptor of the first unit of the group or #nil if the group does not exist any more. </p>
<p>The descriptor of the first unit of the group or #nil if the group does not exist any more.</p>
</div>
</div>
@@ -6881,7 +6870,7 @@ amount of fuel in the group.</p>
</div>
<div class="w3-half">
<p>Measure from the ground or from sea level (ASL). Provide <strong>true</strong> for measuring from the ground (AGL). <strong>false</strong> or <strong>nil</strong> if you measure from sea level. </p>
<p>Measure from the ground or from sea level (ASL). Provide <strong>true</strong> for measuring from the ground (AGL). <strong>false</strong> or <strong>nil</strong> if you measure from sea level.</p>
</div>
</div>
@@ -6892,7 +6881,7 @@ amount of fuel in the group.</p>
</div>
<div class="w3-half">
<p>The height of the group or nil if is not existing or alive. </p>
<p>The height of the group or nil if is not existing or alive.</p>
</div>
</div>
@@ -7264,7 +7253,7 @@ Each unit within the group gets evaluated, and the maximum height (= the unit wh
</div>
<div class="w3-half">
<p>The first UNIT is not existing or alive. </p>
<p>The first UNIT is not existing or alive.</p>
</div>
</div>
@@ -7294,7 +7283,7 @@ Each unit within the group gets evaluated, and the maximum height (= the unit wh
</div>
<div class="w3-half">
<p>The 3D position vectors of the POSITIONABLE or #nil if the groups not existing or alive. </p>
<p>The 3D position vectors of the POSITIONABLE or #nil if the groups not existing or alive.</p>
</div>
</div>
@@ -7338,13 +7327,12 @@ Each unit within the group gets evaluated, and the maximum height (= the unit wh
</div>
<div class="w3-half">
<p>The random 3D point vector around the first UNIT of the GROUP or #nil The GROUP is invalid or empty. </p>
<p>The random 3D point vector around the first UNIT of the GROUP or #nil The GROUP is invalid or empty.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- If Radius is ignored, returns the DCS#Vec3 of first UNIT of the GROUP</code></pre>
<pre class="example"><code>-- If Radius is ignored, returns the DCS#Vec3 of first UNIT of the GROUP</code></pre>
</div>
@@ -7822,7 +7810,7 @@ If no underlying DCS Units exist, the method will return nil.</p>
</div>
<div class="w3-half">
<p>The velocity Vec3 vector or <code>#nil</code> if the GROUP is not existing or alive. </p>
<p>The velocity Vec3 vector or <code>#nil</code> if the GROUP is not existing or alive.</p>
</div>
</div>
@@ -7977,7 +7965,7 @@ If no underlying DCS Units exist, the method will return nil.</p>
</div>
<div class="w3-half">
<p>true if in the first unit of the group is in the air or #nil if the GROUP is not existing or not alive. </p>
<p>true if in the first unit of the group is in the air or #nil if the GROUP is not existing or not alive.</p>
</div>
</div>
@@ -8376,7 +8364,8 @@ Thus, a band is created around the respawn location where the units will be plac
<p>Randomize the positions of the units of the respawned group within the <a href="Core.Zone.html">Core.Zone</a>.</p>
<p>When a Respawn happens, the units of the group will be placed at random positions within the Zone (selected).</p>
<p>When a Respawn happens, the units of the group will be placed at random positions within the Zone (selected).
NOTE: InitRandomizePositionZone will not ensure, that every unit is placed within the zone!</p>
<div id= "#Functions##InitRandomizePositionZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -8512,7 +8501,7 @@ Thus, a band is created around the respawn location where the units will be plac
</div>
<div class="w3-half">
<p><code>true</code> if group is activated or <code>#nil</code> The group is not existing or alive. </p>
<p><code>true</code> if group is activated or <code>#nil</code> The group is not existing or alive.</p>
</div>
</div>
@@ -9309,7 +9298,7 @@ These settings can be provided by calling the relevant Init...() methods of the
<ul>
<li>When InitZone or InitRandomizeZones is not used, the position of the respawned group will be its current position.</li>
<li>The current alive group will always be destroyed and respawned using the template definition. </li>
<li>The current alive group will always be destroyed and respawned using the template definition.</li>
</ul>
@@ -9485,7 +9474,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
</div>
<div class="w3-half">
<p>(optional) The Speed, if no Speed is given, 80% of maximum Speed of the group is selected. </p>
<p>(optional) The Speed, if no Speed is given, 80% of maximum Speed of the group is selected.</p>
</div>
</div>
@@ -9751,7 +9740,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
</div>
<div class="w3-half">
<p>self </p>
<p>self</p>
</div>
</div>
@@ -9795,7 +9784,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
</div>
<div class="w3-half">
<p>self </p>
<p>self</p>
</div>
</div>
@@ -10114,18 +10103,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>
@@ -22630,18 +22608,7 @@ 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).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>
@@ -26730,18 +26697,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>
@@ -27366,18 +27322,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>
@@ -27619,18 +27564,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>