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

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2021-12-28 10:09:15 +00:00
parent 823c49c6a2
commit d99593df6b
53 changed files with 1174 additions and 1245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
Documentation/Wrapper.Unit.html
View File

@@ -2716,13 +2716,13 @@ If you want to obtain the complete <strong>3D position</strong> including orient
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).TaskOrbitCircle">UNIT:TaskOrbitCircle(Altitude, Speed, Coordinate)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Orbit at the current position of the first unit of the controllable at a specified alititude.</p>
<p>(AIR) Orbit at the current position of the first unit of the controllable at a specified altitude.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).TaskOrbitCircleAtVec2">UNIT:TaskOrbitCircleAtVec2(Point, Altitude, Speed)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Orbit at a specified position at a specified alititude during a specified duration with a specified speed.</p>
<p>(AIR) Orbit at a specified position at a specified altitude during a specified duration with a specified speed.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2734,7 +2734,7 @@ If you want to obtain the complete <strong>3D position</strong> including orient
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).TaskRoute">UNIT:TaskRoute(Points)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return a Misson task to follow a given route defined by Points.</p>
<p>Return a Mission task to follow a given route defined by Points.</p>
</td>
</tr>
<tr class="w3-border">
@@ -6312,7 +6312,7 @@ Note that a controllable can only have one beacon activated at a time with the e
</div>
<div class="w3-half">
<p>The ID of the unit the beacon is attached to. Usefull if more units are in one group.</p>
<p>The ID of the unit the beacon is attached to. Useful if more units are in one group.</p>
</div>
</div>
@@ -6812,7 +6812,7 @@ Note that a controllable can only have one beacon activated at a time with the e
</div>
<div class="w3-half">
<p>(Optional) Delay in seconds before the frequncy is set. Default is immediately.</p>
<p>(Optional) Delay in seconds before the frequency is set. Default is immediately.</p>
</div>
</div>
@@ -6937,17 +6937,18 @@ Note that this can only work on GROUP level, although individual UNITs can be co
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>--- This test demonstrates the use(s) of the SwitchWayPoint method of the GROUP class.
HeliGroup = GROUP:FindByName( "Helicopter" )
<pre class="example"><code>
-- This test demonstrates the use(s) of the SwitchWayPoint method of the GROUP class.
HeliGroup = GROUP:FindByName( "Helicopter" )
--- Route the helicopter back to the FARP after 60 seconds.
-- We use the SCHEDULER class to do this.
SCHEDULER:New( nil,
function( HeliGroup )
local CommandRTB = HeliGroup:CommandSwitchWayPoint( 2, 8 )
HeliGroup:SetCommand( CommandRTB )
end, { HeliGroup }, 90
)</code></pre>
-- Route the helicopter back to the FARP after 60 seconds.
-- We use the SCHEDULER class to do this.
SCHEDULER:New( nil,
function( HeliGroup )
local CommandRTB = HeliGroup:CommandSwitchWayPoint( 2, 8 )
HeliGroup:SetCommand( CommandRTB )
end, { HeliGroup }, 90
)</code></pre>
</div>
@@ -7171,7 +7172,7 @@ SCHEDULER:New( nil,
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
</div>
</div>
@@ -7459,7 +7460,7 @@ SCHEDULER:New( nil,
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
</div>
</div>
@@ -8074,7 +8075,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
<p>Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks.</p>
<p>This method returns nil to ensure polymorphic behaviour! This method needs to be overridden by GROUP or UNIT.</p>
<p>This method returns nil to ensure polymorphic behavior! This method needs to be overridden by GROUP or UNIT.</p>
<div id= "#Functions##GetFuel" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -8107,7 +8108,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
<p>Returns relative average amount of fuel (from 0.0 to 1.0) a unit or group has in its internal tanks.</p>
<p>This method returns nil to ensure polymorphic behaviour! This method needs to be overridden by GROUP or UNIT.</p>
<p>This method returns nil to ensure polymorphic behavior! This method needs to be overridden by GROUP or UNIT.</p>
<div id= "#Functions##GetFuelAve" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -8140,7 +8141,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
<p>Returns relative minimum amount of fuel (from 0.0 to 1.0) a unit or group has in its internal tanks.</p>
<p>This method returns nil to ensure polymorphic behaviour! This method needs to be overridden by GROUP or UNIT.</p>
<p>This method returns nil to ensure polymorphic behavior! This method needs to be overridden by GROUP or UNIT.</p>
<div id= "#Functions##GetFuelMin" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -11586,7 +11587,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
</div>
</div>
@@ -11721,7 +11722,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(Optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
<p>(Optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
</div>
</div>
@@ -11843,7 +11844,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(Optional) Limits maximal quantity of attack. The aicraft/controllable will not make more attacks than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
<p>(Optional) Limits maximal quantity of attack. The aircraft/controllable will not make more attacks than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
</div>
</div>
@@ -11965,7 +11966,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
</div>
</div>
@@ -12224,7 +12225,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</p>
</div>
</div>
@@ -13912,7 +13913,7 @@ Used to support CarpetBombing Task</p>
<h2><a id="#(UNIT).TaskOrbitCircle" ><strong>UNIT:TaskOrbitCircle(Altitude, Speed, Coordinate)</strong></a></h2>
</div>
<p>(AIR) Orbit at the current position of the first unit of the controllable at a specified alititude.</p>
<p>(AIR) Orbit at the current position of the first unit of the controllable at a specified altitude.</p>
<div id= "#Functions##TaskOrbitCircle" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -13982,7 +13983,7 @@ Used to support CarpetBombing Task</p>
<h2><a id="#(UNIT).TaskOrbitCircleAtVec2" ><strong>UNIT:TaskOrbitCircleAtVec2(Point, Altitude, Speed)</strong></a></h2>
</div>
<p>(AIR) Orbit at a specified position at a specified alititude during a specified duration with a specified speed.</p>
<p>(AIR) Orbit at a specified position at a specified altitude during a specified duration with a specified speed.</p>
<div id= "#Functions##TaskOrbitCircleAtVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -14085,7 +14086,7 @@ Used to support CarpetBombing Task</p>
<h2><a id="#(UNIT).TaskRoute" ><strong>UNIT:TaskRoute(Points)</strong></a></h2>
</div>
<p>Return a Misson task to follow a given route defined by Points.</p>
<p>Return a Mission task to follow a given route defined by Points.</p>
<div id= "#Functions##TaskRoute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">