weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2026-07-21 00:35:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto commit by GitHub Actions Workflow

Browse Source
This commit is contained in:
MooseBotter
2026-03-03 05:28:32 +00:00
parent 0a27b01164
commit 0ceb44c82a
84 changed files with 3045 additions and 3109 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/Wrapper.Unit.html
+68 -58
View File
@@ -3140,7 +3140,7 @@ If you want to obtain the complete <strong>3D position</strong> including orient
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).TaskBombingRunway">UNIT:TaskBombingRunway(Airbase, WeaponType, WeaponExpend, AttackQty, Direction, GroupAttack)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UNIT).TaskBombingRunway">UNIT:TaskBombingRunway(Airbase, WeaponType, (, AttackQty, Direction, GroupAttack, WeaponExpend)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Delivering weapon on the runway.</p>
</td>
@@ -5015,7 +5015,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>Power of the explosion in kg TNT. Default 100 kg TNT.</p>
<p>(Optional) Power of the explosion in kg TNT. Default 100 kg TNT.</p>
</div>
</div>
@@ -8554,7 +8554,7 @@ Note that a controllable can only have one beacon activated at a time with the e
</div>
<div class="w3-half">
<p>Link4 Frequency in MHz, e.g. 336 (defaults to 336 MHz)</p>
<p>(Optional) Link4 Frequency in MHz, e.g. 336 (defaults to 336 MHz)</p>
</div>
</div>
@@ -8934,7 +8934,7 @@ Note that a controllable can only have one beacon activated at a time with the e
</div>
<div class="w3-half">
<p>The number value the group will be referred to as. Only valid numbers are 1-9. For example Uzi <strong>5</strong>-1. Default 1.</p>
<p>(Optional) The number value the group will be referred to as. Only valid numbers are 1-9. For example Uzi <strong>5</strong>-1. Default 1.</p>
</div>
</div>
@@ -9007,7 +9007,7 @@ Note that a controllable can only have one beacon activated at a time with the e
</div>
<div class="w3-half">
<p>Radio modulation. Default <code>radio.modulation.AM</code>.</p>
<p>(Optional) Radio modulation. Default <code>radio.modulation.AM</code>.</p>
</div>
</div>
@@ -9093,7 +9093,7 @@ Note that a controllable can only have one beacon activated at a time with the e
</div>
<div class="w3-half">
<p>Radio modulation. Default <code>radio.modulation.AM</code>.</p>
<p>(Optional) Radio modulation. Default <code>radio.modulation.AM</code>.</p>
</div>
</div>
@@ -9333,7 +9333,7 @@ Note that a controllable can only have one beacon activated at a time with the e
</div>
<div class="w3-half">
<p>Set to true for on and false for off. Defaults to true.</p>
<p>(Optional) Set to true for on and false for off. Defaults to true.</p>
</div>
</div>
@@ -9679,7 +9679,7 @@ Note that this can only work on GROUP level, although individual UNITs can be co
</div>
<div class="w3-half">
<p>Array of target categories allowed to engage. Default <code>{"Ships"}</code>.</p>
<p>(Optional) Array of target categories allowed to engage. Default <code>{"Ships"}</code>.</p>
</div>
</div>
@@ -9736,7 +9736,7 @@ Note that this can only work on GROUP level, although individual UNITs can be co
</div>
<div class="w3-half">
<p>Array of target categories allowed to engage. Default <code>{"Air"}</code>.</p>
<p>(Optional) Array of target categories allowed to engage. Default <code>{"Air"}</code>.</p>
</div>
</div>
@@ -9980,7 +9980,7 @@ See <a href="https://wiki.hoggitworld.com/view/DCS_task_engageGroup">hoggit</a>.
</div>
<div class="w3-half">
<p>Array of target categories allowed to engage.</p>
<p>(Optional) Array of target categories allowed to engage. Defaults to {"Air"}.</p>
</div>
</div>
@@ -9993,7 +9993,7 @@ See <a href="https://wiki.hoggitworld.com/view/DCS_task_engageGroup">hoggit</a>.
</div>
<div class="w3-half">
<p>All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Default 0.</p>
<p>(Optional) All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Default 0.</p>
</div>
</div>
@@ -10276,7 +10276,7 @@ See <a href="https://wiki.hoggitworld.com/view/DCS_task_fac">hoggit</a>.</p>
</div>
<div class="w3-half">
<p>Frequency in MHz. Default 133 MHz.</p>
<p>(Optional) Frequency in MHz. Default 133 MHz.</p>
</div>
</div>
@@ -10289,7 +10289,7 @@ See <a href="https://wiki.hoggitworld.com/view/DCS_task_fac">hoggit</a>.</p>
</div>
<div class="w3-half">
<p>Radio modulation. Default <code>radio.modulation.AM</code>.</p>
<p>(Optional) Radio modulation. Default <code>radio.modulation.AM</code>.</p>
</div>
</div>
@@ -10328,7 +10328,7 @@ See <a href="https://wiki.hoggitworld.com/view/DCS_task_fac">hoggit</a>.</p>
</div>
<div class="w3-half">
<p>All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.</p>
<p>(Optional) All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Defaults to 0.</p>
</div>
</div>
@@ -10519,7 +10519,7 @@ See <a href="https://wiki.hoggitworld.com/view/DCS_task_fac_engageGroup">hoggit<
</div>
<div class="w3-half">
<p>Array of target categories allowed to engage. Default <code>{"Air Defence"}</code>.</p>
<p>(Optional) Array of target categories allowed to engage. Default <code>{"Air Defence"}</code>.</p>
</div>
</div>
@@ -11976,7 +11976,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
</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>
<p>(Optional) If true start up the IR Marker immediately. Else you need to call <code>myobject:EnableIRMarker()</code> later on.</p>
</div>
</div>
@@ -11989,7 +11989,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
</div>
<div class="w3-half">
<p>(Optionally) Run this IR Marker for the given number of seconds, then stop. Use in conjunction with EnableImmediately. Defaults to 60 seconds.</p>
<p>(Optional) Run this IR Marker for the given number of seconds, then stop. Use in conjunction with EnableImmediately. Defaults to 60 seconds.</p>
</div>
</div>
@@ -12486,7 +12486,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
</div>
<div class="w3-half">
<p>Can be - 0=Never on, 1=if locked by radar, 2=if detected by radar, 3=always on, defaults to 1</p>
<p>(Optional) Can be - 0=Never on, 1=if locked by radar, 2=if detected by radar, 3=always on, defaults to 1</p>
</div>
</div>
@@ -12662,7 +12662,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
</div>
<div class="w3-half">
<p>Engage range limit in percent (a number between 0 and 100). Default 100.</p>
<p>(Optional) Engage range limit in percent (a number between 0 and 100). Default 100.</p>
</div>
</div>
@@ -12753,7 +12753,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
</div>
<div class="w3-half">
<p>Can be zero to 100 meters. Defaults to 50 meters.</p>
<p>(Optional) Can be zero to 100 meters. Defaults to 50 meters.</p>
</div>
</div>
@@ -13579,7 +13579,7 @@ If <strong>at least one</strong> detection method is specified, only the methods
</div>
<div class="w3-half">
<p>true if RTB on bingo fuel (default), false if no RTB on bingo fuel.
<p>(Optional) true if RTB on bingo fuel (default), false if no RTB on bingo fuel.
Warning! When you switch this option off, the airborne group will continue to fly until all fuel has been consumed, and will crash.</p>
</div>
@@ -13924,7 +13924,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>Delay in seconds before the group progresses to the next route point. Default 1 sec.</p>
<p>(Optional) Delay in seconds before the group progresses to the next route point. Default 1 sec.</p>
</div>
</div>
@@ -13937,7 +13937,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>Max. delay in seconds. Actual delay is randomly chosen between DelayMin and DelayMax. Default equal to DelayMin.</p>
<p>(Optional) Max. delay in seconds. Actual delay is randomly chosen between DelayMin and DelayMax. Default equal to DelayMin.</p>
</div>
</div>
@@ -14062,7 +14062,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>Speed of the controllable, default 20</p>
<p>(Optional) Speed of the controllable, default 20</p>
</div>
</div>
@@ -14075,7 +14075,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>Radius of the relocation zone, default 500</p>
<p>(Optional) Radius of the relocation zone, default 500</p>
</div>
</div>
@@ -14088,7 +14088,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>If true, route on road (less problems with AI way finding), default true</p>
<p>(Optional) If true, route on road (less problems with AI way finding), default true</p>
</div>
</div>
@@ -14101,7 +14101,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>If true and onroad is set, take a shorter route - if available - off road, default false</p>
<p>(Optional) If true and onroad is set, take a shorter route - if available - off road, default false</p>
</div>
</div>
@@ -14114,7 +14114,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>Formation string as in the mission editor, e.g. "Vee", "Diamond", "Line abreast", etc. Defaults to "Off Road"</p>
<p>(Optional) Formation string as in the mission editor, e.g. "Vee", "Diamond", "Line abreast", etc. Defaults to "Off Road"</p>
</div>
</div>
@@ -14127,7 +14127,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(optional) If true, try up to 50 times to get a coordinate on land.SurfaceType.LAND. Note - this descriptor value is not reliably implemented on all maps.</p>
<p>(Optional) If true, try up to 50 times to get a coordinate on land.SurfaceType.LAND. Note - this descriptor value is not reliably implemented on all maps.</p>
</div>
</div>
@@ -15352,7 +15352,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>Table of attribute names for which AI reports contact. Defaults to {"Air"}. See <a href="https://wiki.hoggitworld.com/view/DCS_enum_attributes">Hoggit Wiki</a></p>
<p>(Optional) Table of attribute names for which AI reports contact. Defaults to {"Air"}. See <a href="https://wiki.hoggitworld.com/view/DCS_enum_attributes">Hoggit Wiki</a></p>
</div>
</div>
@@ -15396,7 +15396,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>Table of attribute names for which AI reports contact. Defaults to {"Air"}, see <a href="https://wiki.hoggitworld.com/view/DCS_enum_attributes">Hoggit Wiki</a></p>
<p>(Optional) Table of attribute names for which AI reports contact. Defaults to {"Air"}, see <a href="https://wiki.hoggitworld.com/view/DCS_enum_attributes">Hoggit Wiki</a></p>
</div>
</div>
@@ -15440,7 +15440,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>Table of attribute names for which AI reports contact. Defaults to {"Air"}, see <a href="https://wiki.hoggitworld.com/view/DCS_enum_attributes">Hoggit Wiki</a></p>
<p>(Optional) Table of attribute names for which AI reports contact. Defaults to {"Air"}, see <a href="https://wiki.hoggitworld.com/view/DCS_enum_attributes">Hoggit Wiki</a></p>
</div>
</div>
@@ -18712,7 +18712,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UNIT).TaskBombingRunway" ><strong>UNIT:TaskBombingRunway(Airbase, WeaponType, WeaponExpend, AttackQty, Direction, GroupAttack)</strong></a></h2>
<h2><a id="#(UNIT).TaskBombingRunway" ><strong>UNIT:TaskBombingRunway(Airbase, WeaponType, (, AttackQty, Direction, GroupAttack, WeaponExpend)</strong></a></h2>
</div>
<p>(AIR) Delivering weapon on the runway.</p>
@@ -18761,7 +18761,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(optional) Bitmask of weapon types those allowed to use. See <a href="https://wiki.hoggitworld.com/view/DCS_enum_weapon_flag">DCS enum weapon flag</a>. Default 2147485694 = AnyBomb (GuidedBomb + AnyUnguidedBomb).</p>
<p>(Optional) Bitmask of weapon types those allowed to use. See <a href="https://wiki.hoggitworld.com/view/DCS_enum_weapon_flag">DCS enum weapon flag</a>. Default 2147485694 = AnyBomb (GuidedBomb + AnyUnguidedBomb).</p>
</div>
</div>
@@ -18769,12 +18769,12 @@ Warning! When you switch this option off, the airborne group will continue to fl
<div class="w3-half">
<p>
<a href="DCS.html##(AI.Task.WeaponExpend)">DCS#AI.Task.WeaponExpend</a>
<strong><strong>WeaponExpend</strong></strong>
<strong><strong>(</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Enum AI.Task.WeaponExpend that defines how much munitions the AI will expend per attack run. Default "ALL".</p>
<p>ptional) WeaponExpend Enum AI.Task.WeaponExpend that defines how much munitions the AI will expend per attack run. Default "ALL".</p>
</div>
</div>
@@ -18787,7 +18787,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>Number of times the group will attack if the target. Default 1.</p>
<p>(Optional) Number of times the group will attack if the target. Default 1.</p>
</div>
</div>
@@ -18800,7 +18800,7 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.</p>
<p>(Optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.</p>
</div>
</div>
@@ -18813,10 +18813,20 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
<div class="w3-half">
<p>(optional) Flag indicates that the target must be engaged by all aircrafts of the controllable. Has effect only if the task is assigned to a group and not to a single aircraft.</p>
<p>(Optional) Flag indicates that the target must be engaged by all aircrafts of the controllable. Has effect only if the task is assigned to a group and not to a single aircraft.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>WeaponExpend</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
@@ -19258,7 +19268,7 @@ return DCS#Task</p>
</div>
<div class="w3-half">
<p>Task index. Default 1.</p>
<p>(Optional) Task index. Default 1.</p>
</div>
</div>
@@ -19320,7 +19330,7 @@ The controllable has to be an infantry group!</p>
</div>
<div class="w3-half">
<p>Radius in meters. Default 200 m.</p>
<p>(Optional) Radius in meters. Default 200 m.</p>
</div>
</div>
@@ -19546,7 +19556,7 @@ The unit / controllable will also protect that controllable from threats of spec
</div>
<div class="w3-half">
<p>Array of AttributeName that is contains threat categories allowed to engage. Default {"Air"}. See https://wiki.hoggit.us/view/DCS_enum_attributes</p>
<p>(Optional) Array of AttributeName that is contains threat categories allowed to engage. Default {"Air"}. See https://wiki.hoggit.us/view/DCS_enum_attributes</p>
</div>
</div>
@@ -19608,7 +19618,7 @@ It's important to note that depending on the type of unit that is being assigned
</div>
<div class="w3-half">
<p>Bitmask of weapon types, which are allowed to use.</p>
<p>(Optional) Bitmask of weapon types, which are allowed to use. Defaults tp ENUMS.WeaponFlag.AutoDCS.</p>
</div>
</div>
@@ -19621,7 +19631,7 @@ It's important to note that depending on the type of unit that is being assigned
</div>
<div class="w3-half">
<p>(Optional) Designation type.</p>
<p>(Optional) Designation type. Defaults to Auto.</p>
</div>
</div>
@@ -19647,7 +19657,7 @@ It's important to note that depending on the type of unit that is being assigned
</div>
<div class="w3-half">
<p>Frequency in MHz used to communicate with the FAC. Default 133 MHz.</p>
<p>(Optional) Frequency in MHz used to communicate with the FAC. Default 133 MHz.</p>
</div>
</div>
@@ -19660,7 +19670,7 @@ It's important to note that depending on the type of unit that is being assigned
</div>
<div class="w3-half">
<p>Modulation of radio for communication. Default 0=AM.</p>
<p>(Optional) Modulation of radio for communication. Default 0=AM.</p>
</div>
</div>
@@ -19795,7 +19805,7 @@ It's important to note that depending on the type of unit that is being assigned
</div>
<div class="w3-half">
<p>Altitude is above mean sea level. Default is above ground level.</p>
<p>(Optional) Altitude is above mean sea level. Default is above ground level.</p>
</div>
</div>
@@ -20704,7 +20714,7 @@ The unit / controllable will also protect that controllable from threats of spec
</div>
<div class="w3-half">
<p>Altitude in meters of the orbit pattern. Default y component of Coord.</p>
<p>(Optional) Altitude in meters of the orbit pattern. Default y component of Coord.</p>
</div>
</div>
@@ -20717,7 +20727,7 @@ The unit / controllable will also protect that controllable from threats of spec
</div>
<div class="w3-half">
<p>Speed [m/s] flying the orbit pattern. Default 128 m/s = 250 knots.</p>
<p>(Optional) Speed [m/s] flying the orbit pattern. Default 128 m/s = 250 knots.</p>
</div>
</div>
@@ -21089,7 +21099,7 @@ A given formation can be given.</p>
</div>
<div class="w3-half">
<p>The speed in m/s. Default is 5.555 m/s = 20 km/h.</p>
<p>(Optional) The speed in m/s. Default is 5.555 m/s = 20 km/h.</p>
</div>
</div>
@@ -21166,7 +21176,7 @@ A given formation can be given.</p>
</div>
<div class="w3-half">
<p>The speed in m/s. Default is 5.555 m/s = 20 km/h.</p>
<p>(Optional) The speed in m/s. Default is 5.555 m/s = 20 km/h.</p>
</div>
</div>
@@ -22023,7 +22033,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
</div>
<div class="w3-half">
<p>Power of the explosion in kg TNT. Default 100 kg TNT.</p>
<p>(Optional) Power of the explosion in kg TNT. Default 100 kg TNT.</p>
</div>
</div>
@@ -23094,7 +23104,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un
</div>
<div class="w3-half">
<p>Offset in the direction "the nose" of the unit is pointing in meters. Default 0 m.</p>
<p>(Optional) Offset in the direction "the nose" of the unit is pointing in meters. Default 0 m.</p>
</div>
</div>
@@ -23107,7 +23117,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un
</div>
<div class="w3-half">
<p>Offset "above" the unit in meters. Default 0 m.</p>
<p>(Optional) Offset "above" the unit in meters. Default 0 m.</p>
</div>
</div>
@@ -23120,7 +23130,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un
</div>
<div class="w3-half">
<p>Offset in the direction "the wing" of the unit is pointing in meters. z>0 starboard, z&lt;0 port. Default 0 m.</p>
<p>Optional) Offset in the direction "the wing" of the unit is pointing in meters. z>0 starboard, z&lt;0 port. Default 0 m.</p>
</div>
</div>
@@ -23667,7 +23677,7 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
<div class="w3-half">
<p>Offset along the world x-axis in meters. Default 0 m.</p>
<p>(Optional) Offset along the world x-axis in meters. Default 0 m.</p>
</div>
</div>
@@ -23680,7 +23690,7 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
<div class="w3-half">
<p>Offset along the world y-axis in meters. Default 0 m.</p>
<p>(Optional) Offset along the world y-axis in meters. Default 0 m.</p>
</div>
</div>
@@ -23693,7 +23703,7 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
<div class="w3-half">
<p>Offset along the world z-axis in meters. Default 0 m.</p>
<p>(Optional) Offset along the world z-axis in meters. Default 0 m.</p>
</div>
</div>