mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
Reduction of moose.lua sizing working now!
This commit is contained in:
FlightControl_Master
@@ -391,6 +391,12 @@ and automatically engage any airborne enemies that are within a certain range or
|
||||
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_CAP).onafterPatrol">AI_A2A_CAP:onafterPatrol(AIGroup, From, Event, To)</a></td>
|
||||
<td class="summary">
|
||||
<p>onafter State Transition for Event Patrol.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_CAP).onafterStart">AI_A2A_CAP:onafterStart(AIGroup, From, Event, To)</a></td>
|
||||
<td class="summary">
|
||||
<p>onafter State Transition for Event Patrol.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -1702,6 +1708,46 @@ The To State string.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AI_A2A_CAP).onafterStart" >
|
||||
<strong>AI_A2A_CAP:onafterStart(AIGroup, From, Event, To)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>onafter State Transition for Event Patrol.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> AIGroup </em></code>:
|
||||
The AI Group managed by the FSM.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string From </em></code>:
|
||||
The From State string.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string Event </em></code>:
|
||||
The Event string.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string To </em></code>:
|
||||
The To State string.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AI_A2A_CAP).onbeforeEngage" >
|
||||
<strong>AI_A2A_CAP:onbeforeEngage(AIGroup, From, Event, To)</strong>
|
||||
</a>
|
||||
@@ -1740,6 +1786,8 @@ The To State string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h2><a id="#(AI_A2A_GCI)" >Type <code>AI_A2A_GCI</code></a></h2>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -364,6 +364,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_GCI).onafterEngage">AI_A2A_GCI:onafterEngage(AIGroup, From, Event, To)</a></td>
|
||||
<td class="summary">
|
||||
<p>onafter State Transition for Event Patrol.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AI_A2A_GCI).onafterStart">AI_A2A_GCI:onafterStart(AIGroup, From, Event, To)</a></td>
|
||||
<td class="summary">
|
||||
<p>onafter State Transition for Event Patrol.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -1532,6 +1538,46 @@ The To State string.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AI_A2A_GCI).onafterStart" >
|
||||
<strong>AI_A2A_GCI:onafterStart(AIGroup, From, Event, To)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>onafter State Transition for Event Patrol.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> AIGroup </em></code>:
|
||||
The AI Group managed by the FSM.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string From </em></code>:
|
||||
The From State string.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string Event </em></code>:
|
||||
The Event string.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string To </em></code>:
|
||||
The To State string.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AI_A2A_GCI).onbeforeEngage" >
|
||||
<strong>AI_A2A_GCI:onbeforeEngage(AIGroup, From, Event, To)</strong>
|
||||
</a>
|
||||
|
||||
@@ -164,12 +164,6 @@
|
||||
|
||||
<p>The AI<em>CAP</em>ZONE class implements the core functions to patrol a <a href="Zone.html">Zone</a> by an AI <a href="Controllable.html">Controllable</a> or <a href="Group.html">Group</a>
|
||||
and automatically engage any airborne enemies that are within a certain range or within a certain zone.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#_NewEngageCapRoute">_NewEngageCapRoute(AIControllable)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -215,6 +209,12 @@ and automatically engage any airborne enemies that are within a certain range or
|
||||
<td class="name" nowrap="nowrap"><a href="##(AI_CAP_ZONE).EngageRange">AI_CAP_ZONE.EngageRange</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AI_CAP_ZONE).EngageRoute">AI_CAP_ZONE.EngageRoute(AI, EngageGroup, Fsm)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -512,27 +512,6 @@ Use the method <a href="AI_Cap.html##(AI_CAP_ZONE).SetEngageZone">AI<em>Cap#AI</
|
||||
<hr/>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="_NewEngageCapRoute" >
|
||||
<strong>_NewEngageCapRoute(AIControllable)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> AIControllable </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a id="#(AI_Cap)" >Type <code>AI_Cap</code></a></h2>
|
||||
@@ -631,6 +610,38 @@ Use the method <a href="AI_Cap.html##(AI_CAP_ZONE).SetEngageZone">AI<em>Cap#AI</
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AI_CAP_ZONE).EngageRoute" >
|
||||
<strong>AI_CAP_ZONE.EngageRoute(AI, EngageGroup, Fsm)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> AI </em></code>:
|
||||
AI<em>CAP#AI</em>CAP_ZONE </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> EngageGroup </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Fsm </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
|
||||
@@ -162,12 +162,6 @@
|
||||
<h1>AI<em>CAS</em>ZONE class, extends <a href="AI_Patrol.html##(AI_PATROL_ZONE)">AI<em>Patrol#AI</em>PATROL_ZONE</a></h1>
|
||||
|
||||
<p>AI<em>CAS</em>ZONE derives from the <a href="AI_Patrol.html##(AI_PATROL_ZONE)">AI<em>Patrol#AI</em>PATROL_ZONE</a>, inheriting its methods and behaviour.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#_NewEngageRoute">_NewEngageRoute(AIControllable)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -225,6 +219,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(AI_CAS_ZONE).EngageDirection">AI_CAS_ZONE.EngageDirection</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AI_CAS_ZONE).EngageRoute">AI_CAS_ZONE.EngageRoute(AI, EngageGroup, Fsm)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -531,27 +531,6 @@ It can be notified to go RTB through the <strong>RTB</strong> event.</p>
|
||||
<hr/>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="_NewEngageRoute" >
|
||||
<strong>_NewEngageRoute(AIControllable)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> AIControllable </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a id="#(AI_Cas)" >Type <code>AI_Cas</code></a></h2>
|
||||
@@ -715,6 +694,38 @@ Use the structure <a href="DCSTypes.html##(AI.Task).WeaponExpend">DCSTypes#AI.Ta
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AI_CAS_ZONE).EngageRoute" >
|
||||
<strong>AI_CAS_ZONE.EngageRoute(AI, EngageGroup, Fsm)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> AI </em></code>:
|
||||
AI<em>CAS#AI</em>CAS_ZONE </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> EngageGroup </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Fsm </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
|
||||
@@ -174,6 +174,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(BASE).CreateEventCrash">BASE:CreateEventCrash(EventTime, Initiator)</a></td>
|
||||
<td class="summary">
|
||||
<p>Creation of a Crash Event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(BASE).CreateEventTakeoff">BASE:CreateEventTakeoff(EventTime, Initiator)</a></td>
|
||||
<td class="summary">
|
||||
<p>Creation of a Takeoff Event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -881,6 +887,34 @@ The initiating object of the event.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(BASE).CreateEventTakeoff" >
|
||||
<strong>BASE:CreateEventTakeoff(EventTime, Initiator)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Creation of a Takeoff Event.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Dcs.DCSTypes.html##(Time)">Dcs.DCSTypes#Time</a> EventTime </em></code>:
|
||||
The time stamp of the event.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Dcs.DCSWrapper.Object.html##(Object)">Dcs.DCSWrapper.Object#Object</a> Initiator </em></code>:
|
||||
The initiating object of the event.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(BASE).E" >
|
||||
<strong>BASE:E(Arguments)</strong>
|
||||
</a>
|
||||
|
||||
@@ -416,6 +416,24 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).OptionRTBBingoFuel">CONTROLLABLE:OptionRTBBingoFuel(RTB)</a></td>
|
||||
<td class="summary">
|
||||
<p>Set RTB on bingo fuel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).PatrolRoute">CONTROLLABLE:PatrolRoute()</a></td>
|
||||
<td class="summary">
|
||||
<p>(GROUND) Patrol iteratively using the waypoints the for the (parent) group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).PatrolRouteRandom">CONTROLLABLE:PatrolRouteRandom(Speed, Formation, ToWaypoint)</a></td>
|
||||
<td class="summary">
|
||||
<p>(GROUND) Patrol randomly to the waypoints the for the (parent) group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).PatrolZones">CONTROLLABLE:PatrolZones(ZoneList, Speed, Formation)</a></td>
|
||||
<td class="summary">
|
||||
<p>(GROUND) Patrol randomly to the waypoints the for the (parent) group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -806,7 +824,7 @@ See below the <strong>Tasks at Waypoints</strong> section.</p>
|
||||
<h3>Tasks at Waypoints</h3>
|
||||
|
||||
<p>Special Task methods are available to set tasks at certain waypoints.
|
||||
The method <a href="##(CONTROLLABLE).SetTaskAtWaypoint">CONTROLLABLE.SetTaskAtWaypoint</a>() helps preparing a Route, embedding a Task at the Waypoint of the Route.</p>
|
||||
The method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoint</a>() helps preparing a Route, embedding a Task at the Waypoint of the Route.</p>
|
||||
|
||||
<p>This creates a Task element, with an action to call a function as part of a Wrapped Task.</p>
|
||||
|
||||
@@ -2150,6 +2168,102 @@ Warning! When you switch this option off, the airborne group will continue to fl
|
||||
<p><em><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CONTROLLABLE).PatrolRoute" >
|
||||
<strong>CONTROLLABLE:PatrolRoute()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>(GROUND) Patrol iteratively using the waypoints the for the (parent) group.</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CONTROLLABLE).PatrolRouteRandom" >
|
||||
<strong>CONTROLLABLE:PatrolRouteRandom(Speed, Formation, ToWaypoint)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>(GROUND) Patrol randomly to the waypoints the for the (parent) group.</p>
|
||||
|
||||
|
||||
<p>A random waypoint will be picked and the group will move towards that point.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> Speed </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Formation </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> ToWaypoint </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CONTROLLABLE).PatrolZones" >
|
||||
<strong>CONTROLLABLE:PatrolZones(ZoneList, Speed, Formation)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>(GROUND) Patrol randomly to the waypoints the for the (parent) group.</p>
|
||||
|
||||
|
||||
<p>A random waypoint will be picked and the group will move towards that point.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> ZoneList </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Speed </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Formation </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(CONTROLLABLE)">#CONTROLLABLE</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -3192,7 +3306,7 @@ The DCS task structure.</p>
|
||||
<p>This creates a Task element, with an action to call a function as part of a Wrapped Task.</p>
|
||||
|
||||
|
||||
<p>This Task can then be embedded at a Waypoint by calling the method <a href="##(CONTROLLABLE).SetTaskAtWaypoint">CONTROLLABLE.SetTaskAtWaypoint</a>.</p>
|
||||
<p>This Task can then be embedded at a Waypoint by calling the method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoint</a>.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
@@ -3248,7 +3362,7 @@ The variable arguments passed to the function when called! These arguments can b
|
||||
|
||||
local TaskRouteToZone = Vehicle:TaskFunction( "RouteToZone", RandomZone )
|
||||
|
||||
Vehicle:SetTaskAtWaypoint( Route, #Route, TaskRouteToZone ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.
|
||||
Vehicle:SetTaskWaypoint( Route, #Route, TaskRouteToZone ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.
|
||||
|
||||
Vehicle:Route( Route, math.random( 10, 20 ) ) -- Move after a random seconds to the Route. See the Route method for details.
|
||||
|
||||
|
||||
@@ -1151,7 +1151,6 @@ function below will use the range 1-7 just in case</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(DESIGNATE).LaserCodes" >
|
||||
<strong>DESIGNATE.LaserCodes</strong>
|
||||
</a>
|
||||
|
||||
@@ -379,7 +379,7 @@ Example code snippet:</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEventForGroup">EVENT:OnEventForGroup(GroupName, EventFunction, EventClass, EventID)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEventForGroup">EVENT:OnEventForGroup(GroupName, EventFunction, EventClass, EventID, ...)</a></td>
|
||||
<td class="summary">
|
||||
<p>Set a new listener for an S<em>EVENT</em>X event for a GROUP.</p>
|
||||
</td>
|
||||
@@ -1245,7 +1245,7 @@ The self instance of the class for which the event is.</p>
|
||||
<dt>
|
||||
|
||||
<a id="#(EVENT).OnEventForGroup" >
|
||||
<strong>EVENT:OnEventForGroup(GroupName, EventFunction, EventClass, EventID)</strong>
|
||||
<strong>EVENT:OnEventForGroup(GroupName, EventFunction, EventClass, EventID, ...)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -1276,6 +1276,11 @@ The self instance of the class for which the event is.</p>
|
||||
|
||||
<p><code><em> EventID </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> ... </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
@@ -1599,7 +1599,7 @@ A string defining the start state.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#string</em>
|
||||
<em></em>
|
||||
<a id="#(FSM)._StartState" >
|
||||
<strong>FSM._StartState</strong>
|
||||
</a>
|
||||
@@ -1898,6 +1898,7 @@ A string defining the start state.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(FSM).current" >
|
||||
<strong>FSM.current</strong>
|
||||
</a>
|
||||
|
||||
@@ -349,6 +349,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetTemplate">GROUP:GetTemplate()</a></td>
|
||||
<td class="summary">
|
||||
<p>Returns the group template from the <a href="DATABASE.html">DATABASE</a> (_DATABASE object).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(GROUP).GetTemplateRoutePoints">GROUP:GetTemplateRoutePoints()</a></td>
|
||||
<td class="summary">
|
||||
<p>Returns the group template route.points[] (the waypoints) from the <a href="DATABASE.html">DATABASE</a> (_DATABASE object).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -382,7 +388,7 @@
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(GROUP).HandleEvent">GROUP:HandleEvent(Event, EventFunction)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(GROUP).HandleEvent">GROUP:HandleEvent(Event, EventFunction, ...)</a></td>
|
||||
<td class="summary">
|
||||
<p>Subscribe to a DCS Event.</p>
|
||||
</td>
|
||||
@@ -1380,6 +1386,24 @@ The mission route defined by points.</p>
|
||||
<p><em>#table:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(GROUP).GetTemplateRoutePoints" >
|
||||
<strong>GROUP:GetTemplateRoutePoints()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Returns the group template route.points[] (the waypoints) from the <a href="DATABASE.html">DATABASE</a> (_DATABASE object).</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#table:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -1484,7 +1508,7 @@ Current Vec3 of the first DCS Unit of the GROUP.</p>
|
||||
<dt>
|
||||
|
||||
<a id="#(GROUP).HandleEvent" >
|
||||
<strong>GROUP:HandleEvent(Event, EventFunction)</strong>
|
||||
<strong>GROUP:HandleEvent(Event, EventFunction, ...)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -1503,6 +1527,11 @@ Current Vec3 of the first DCS Unit of the GROUP.</p>
|
||||
<p><code><em>#function EventFunction </em></code>:
|
||||
(optional) The function to be called when the event occurs for the GROUP.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> ... </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
@@ -346,6 +346,18 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).IlluminationBomb">COORDINATE:IlluminationBomb()</a></td>
|
||||
<td class="summary">
|
||||
<p>Creates an illumination bomb at the point.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).IsInRadius">COORDINATE:IsInRadius(ToCoordinate, Radius, Coordinate)</a></td>
|
||||
<td class="summary">
|
||||
<p>Returns if a Coordinate is in a certain Radius of this Coordinate in 2D plane using the X and Z axis.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).IsInSphere">COORDINATE:IsInSphere(ToCoordinate, Radius, Coordinate)</a></td>
|
||||
<td class="summary">
|
||||
<p>Returns if a Coordinate is in a certain radius of this Coordinate in 3D space using the X, Y and Z axis.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -1901,6 +1913,85 @@ Velocity text.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(COORDINATE).IsInRadius" >
|
||||
<strong>COORDINATE:IsInRadius(ToCoordinate, Radius, Coordinate)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Returns if a Coordinate is in a certain Radius of this Coordinate in 2D plane using the X and Z axis.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="##(COORDINATE)">#COORDINATE</a> ToCoordinate </em></code>:
|
||||
The coordinate that will be tested if it is in the radius of this coordinate.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#number Radius </em></code>:
|
||||
The radius of the circle on the 2D plane around this coordinate.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Coordinate </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#boolean:</em>
|
||||
true if in the Radius.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(COORDINATE).IsInSphere" >
|
||||
<strong>COORDINATE:IsInSphere(ToCoordinate, Radius, Coordinate)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Returns if a Coordinate is in a certain radius of this Coordinate in 3D space using the X, Y and Z axis.</p>
|
||||
|
||||
|
||||
<p>So Radius defines the radius of the a Sphere in 3D space around this coordinate.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="##(COORDINATE)">#COORDINATE</a> ToCoordinate </em></code>:
|
||||
The coordinate that will be tested if it is in the radius of this coordinate.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#number Radius </em></code>:
|
||||
The radius of the sphere in the 3D space around this coordinate.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Coordinate </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#boolean:</em>
|
||||
true if in the Sphere.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(COORDINATE).IsLOS" >
|
||||
<strong>COORDINATE:IsLOS(ToCoordinate)</strong>
|
||||
</a>
|
||||
|
||||
@@ -17,7 +17,90 @@
|
||||
<a href="index.html">index</a>
|
||||
</li></ul>
|
||||
<ul>
|
||||
<li><a href="AI_A2A.html">AI_A2A</a></li>
|
||||
<li><a href="AI_A2A_Cap.html">AI_A2A_Cap</a></li>
|
||||
<li><a href="AI_A2A_Dispatcher.html">AI_A2A_Dispatcher</a></li>
|
||||
<li><a href="AI_A2A_GCI.html">AI_A2A_GCI</a></li>
|
||||
<li><a href="AI_A2A_Patrol.html">AI_A2A_Patrol</a></li>
|
||||
<li><a href="AI_Bai.html">AI_Bai</a></li>
|
||||
<li><a href="AI_Balancer.html">AI_Balancer</a></li>
|
||||
<li><a href="AI_Cap.html">AI_Cap</a></li>
|
||||
<li><a href="AI_Cas.html">AI_Cas</a></li>
|
||||
<li><a href="AI_Formation.html">AI_Formation</a></li>
|
||||
<li><a href="AI_Patrol.html">AI_Patrol</a></li>
|
||||
<li><a href="Account.html">Account</a></li>
|
||||
<li><a href="Airbase.html">Airbase</a></li>
|
||||
<li><a href="AirbasePolice.html">AirbasePolice</a></li>
|
||||
<li><a href="Assign.html">Assign</a></li>
|
||||
<li><a href="Base.html">Base</a></li>
|
||||
<li><a href="Cargo.html">Cargo</a></li>
|
||||
<li><a href="CleanUp.html">CleanUp</a></li>
|
||||
<li><a href="Client.html">Client</a></li>
|
||||
<li><a href="CommandCenter.html">CommandCenter</a></li>
|
||||
<li><a href="Controllable.html">Controllable</a></li>
|
||||
<li><a href="DCSAirbase.html">DCSAirbase</a></li>
|
||||
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</a></li>
|
||||
<li><a href="DCSCommand.html">DCSCommand</a></li>
|
||||
<li><a href="DCSController.html">DCSController</a></li>
|
||||
<li><a href="DCSGroup.html">DCSGroup</a></li>
|
||||
<li><a href="DCSObject.html">DCSObject</a></li>
|
||||
<li><a href="DCSTask.html">DCSTask</a></li>
|
||||
<li><a href="DCSTypes.html">DCSTypes</a></li>
|
||||
<li><a href="DCSUnit.html">DCSUnit</a></li>
|
||||
<li><a href="DCSVec3.html">DCSVec3</a></li>
|
||||
<li><a href="DCSWorld.html">DCSWorld</a></li>
|
||||
<li><a href="DCSZone.html">DCSZone</a></li>
|
||||
<li><a href="DCScountry.html">DCScountry</a></li>
|
||||
<li><a href="DCStimer.html">DCStimer</a></li>
|
||||
<li><a href="DCStrigger.html">DCStrigger</a></li>
|
||||
<li><a href="Database.html">Database</a></li>
|
||||
<li><a href="Designate.html">Designate</a></li>
|
||||
<li><a href="Detection.html">Detection</a></li>
|
||||
<li><a href="DetectionManager.html">DetectionManager</a></li>
|
||||
<li><a href="Escort.html">Escort</a></li>
|
||||
<li><a href="Event.html">Event</a></li>
|
||||
<li><a href="Fsm.html">Fsm</a></li>
|
||||
<li><a href="Group.html">Group</a></li>
|
||||
<li><a href="Identifiable.html">Identifiable</a></li>
|
||||
<li><a href="Menu.html">Menu</a></li>
|
||||
<li><a href="Message.html">Message</a></li>
|
||||
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
|
||||
<li><a href="Mission.html">Mission</a></li>
|
||||
<li><a href="Movement.html">Movement</a></li>
|
||||
<li><a href="Object.html">Object</a></li>
|
||||
<li><a href="Point.html">Point</a></li>
|
||||
<li><a href="Positionable.html">Positionable</a></li>
|
||||
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
|
||||
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
|
||||
<li><a href="Radio.html">Radio</a></li>
|
||||
<li>Rat</li>
|
||||
<li><a href="Route.html">Route</a></li>
|
||||
<li><a href="Scenery.html">Scenery</a></li>
|
||||
<li><a href="ScheduleDispatcher.html">ScheduleDispatcher</a></li>
|
||||
<li><a href="Scheduler.html">Scheduler</a></li>
|
||||
<li><a href="Scoring.html">Scoring</a></li>
|
||||
<li><a href="Sead.html">Sead</a></li>
|
||||
<li><a href="Set.html">Set</a></li>
|
||||
<li><a href="Settings.html">Settings</a></li>
|
||||
<li><a href="Smoke.html">Smoke</a></li>
|
||||
<li><a href="Spawn.html">Spawn</a></li>
|
||||
<li><a href="SpawnStatic.html">SpawnStatic</a></li>
|
||||
<li><a href="Spot.html">Spot</a></li>
|
||||
<li><a href="Static.html">Static</a></li>
|
||||
<li><a href="StaticObject.html">StaticObject</a></li>
|
||||
<li><a href="Task.html">Task</a></li>
|
||||
<li><a href="Task_A2A.html">Task_A2A</a></li>
|
||||
<li><a href="Task_A2A_Dispatcher.html">Task_A2A_Dispatcher</a></li>
|
||||
<li><a href="Task_A2G.html">Task_A2G</a></li>
|
||||
<li><a href="Task_A2G_Dispatcher.html">Task_A2G_Dispatcher</a></li>
|
||||
<li><a href="Task_Cargo.html">Task_Cargo</a></li>
|
||||
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
|
||||
<li><a href="Unit.html">Unit</a></li>
|
||||
<li><a href="Utils.html">Utils</a></li>
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
<li><a href="routines.html">routines</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="content">
|
||||
@@ -106,6 +189,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).ATC">RAT.ATC</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).ATCswitch">RAT.ATCswitch</a></td>
|
||||
<td class="summary">
|
||||
<p>Enable/disable ATC if set to true/false. </p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -136,6 +225,18 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).ContinueJourney">RAT:ContinueJourney(switch)</a></td>
|
||||
<td class="summary">
|
||||
<p>Aircraft will continue their journey from their destination.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).EnableATC">RAT:EnableATC(switch)</a></td>
|
||||
<td class="summary">
|
||||
<p>Enable ATC, which manages the landing queue for RAT aircraft if they arrive simultaniously at the same airport.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).ExcludedAirports">RAT:ExcludedAirports(ports)</a></td>
|
||||
<td class="summary">
|
||||
<p>Airports, FARPs and ships explicitly excluded as departures and destinations.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -219,7 +320,19 @@
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).SetCoalition">RAT:SetCoalition(friendly)</a></td>
|
||||
<td class="summary">
|
||||
<p>Set the friendly coalitions from which the airports can be used as departure or destination.</p>
|
||||
<p>Set the friendly coalitions from which the airports can be used as departure and destination.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).SetCoalition2">RAT:SetCoalition2(id)</a></td>
|
||||
<td class="summary">
|
||||
<p>Set country of RAT group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).SetCoalitionAircraft">RAT:SetCoalitionAircraft(color)</a></td>
|
||||
<td class="summary">
|
||||
<p>Set coalition of RAT group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -466,6 +579,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT)._EngineStartup">RAT:_EngineStartup(EventData)</a></td>
|
||||
<td class="summary">
|
||||
<p>Function is executed when a unit starts its engines.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT)._Excluded">RAT:_Excluded(port)</a></td>
|
||||
<td class="summary">
|
||||
<p>Check if airport is excluded from possible departures and destinations.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -487,7 +606,7 @@
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT)._GetDestinations">RAT:_GetDestinations(q, minrange, maxrange)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT)._GetDestinations">RAT:_GetDestinations(departure, q, minrange, maxrange)</a></td>
|
||||
<td class="summary">
|
||||
<p>Get all possible destination airports depending on departure position.</p>
|
||||
</td>
|
||||
@@ -502,6 +621,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT)._InitAircraft">RAT:_InitAircraft(DCSgroup)</a></td>
|
||||
<td class="summary">
|
||||
<p>Initialize basic parameters of the aircraft based on its (template) group in the mission editor.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT)._IsFriendly">RAT:_IsFriendly(port)</a></td>
|
||||
<td class="summary">
|
||||
<p>Check if airport is friendly, i.e.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -712,6 +837,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).continuejourney">RAT.continuejourney</a></td>
|
||||
<td class="summary">
|
||||
<p>Aircraft will continue their journey, i.e. get respawned at their destination with a new random destination.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).country">RAT.country</a></td>
|
||||
<td class="summary">
|
||||
<p>Country of spawn group template.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -742,6 +873,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).destination_ports">RAT.destination_ports</a></td>
|
||||
<td class="summary">
|
||||
<p>Array containing the names of the destination airports.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).excluded_ports">RAT.excluded_ports</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -754,12 +891,6 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).friendly">RAT.friendly</a></td>
|
||||
<td class="summary">
|
||||
<p>Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).has_value">RAT:has_value(tab, val)</a></td>
|
||||
<td class="summary">
|
||||
<p>Utility function which checks if table contains a specific value.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -867,7 +998,7 @@
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(RAT).skill">RAT.skill</a></td>
|
||||
<td class="summary">
|
||||
<p>Skill of AI. </p>
|
||||
<p>Skill of AI.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -1107,6 +1238,20 @@ It is possible to restrict the minimum cruise altitude by <a href="##(RAT).SetFL
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#boolean</em>
|
||||
<a id="#(RAT).ATCswitch" >
|
||||
<strong>RAT.ATCswitch</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Enable/disable ATC if set to true/false. </p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -1207,6 +1352,50 @@ Turn journey on=true or off=false. If no value is given switch=true.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT).EnableATC" >
|
||||
<strong>RAT:EnableATC(switch)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Enable ATC, which manages the landing queue for RAT aircraft if they arrive simultaniously at the same airport.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#boolean switch </em></code>:
|
||||
true=enable ATC, false=disable ATC. </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT).ExcludedAirports" >
|
||||
<strong>RAT:ExcludedAirports(ports)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Airports, FARPs and ships explicitly excluded as departures and destinations.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string ports </em></code>:
|
||||
Name or table of names of excluded airports.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
@@ -1486,22 +1675,22 @@ Climb rate in ft/min.</p>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Set the friendly coalitions from which the airports can be used as departure or destination.</p>
|
||||
<p>Set the friendly coalitions from which the airports can be used as departure and destination.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string friendly </em></code>:
|
||||
"same"=own coalition+neutral (default), "all"=neutral+red+blue", "sameonly"=own coalition only, "blue"=blue+neutral, "blueonly"=blue, "red"=red+neutral, "redonly"=red, "neutral"=neutral.
|
||||
"same"=own coalition+neutral (default), "sameonly"=own coalition only, "neutral"=all neutral airports.
|
||||
Default is "same", so aircraft will use airports of the coalition their spawn template has plus all neutral airports.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Usages:</h3>
|
||||
<ul>
|
||||
<li><pre class="example"><code>yak:SetCoalition("all") will spawn aircraft randomly on airports of any coaliton, i.e. red, blue and neutral, regardless of its own coalition.</code></pre></li>
|
||||
<li><pre class="example"><code>yak:SetCoalition("redonly") will spawn aircraft randomly on airports belonging to the red coalition _only_.</code></pre></li>
|
||||
<li><pre class="example"><code>yak:SetCoalition("neutral") will spawn aircraft randomly on all neutral airports.</code></pre></li>
|
||||
<li><pre class="example"><code>yak:SetCoalition("sameonly") will spawn aircraft randomly on airports belonging to the same coalition only as the template.</code></pre></li>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
@@ -1509,6 +1698,56 @@ Default is "same", so aircraft will use airports of the coalition their spawn te
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT).SetCoalition2" >
|
||||
<strong>RAT:SetCoalition2(id)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Set country of RAT group.</p>
|
||||
|
||||
|
||||
<p>This overrules the coalition settings.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#number id </em></code>:
|
||||
DCS country enumerator ID. For example country.id.USA or country.id.RUSSIA.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT).SetCoalitionAircraft" >
|
||||
<strong>RAT:SetCoalitionAircraft(color)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Set coalition of RAT group.</p>
|
||||
|
||||
|
||||
<p>You can make red templates blue and vice versa.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string color </em></code>:
|
||||
Color of coalition, i.e. "red" or blue".</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT).SetCruiseAltitude" >
|
||||
<strong>RAT:SetCruiseAltitude(alt)</strong>
|
||||
</a>
|
||||
@@ -2477,6 +2716,33 @@ Group to be despawned.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT)._Excluded" >
|
||||
<strong>RAT:_Excluded(port)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Check if airport is excluded from possible departures and destinations.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string port </em></code>:
|
||||
Name of airport, FARP or ship to check.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#boolean:</em>
|
||||
true if airport is excluded and false otherwise.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT)._FLmax" >
|
||||
<strong>RAT:_FLmax(alpha, beta, d, phi, h0)</strong>
|
||||
</a>
|
||||
@@ -2559,7 +2825,7 @@ Maximal flight level in meters.</p>
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT)._GetDestinations" >
|
||||
<strong>RAT:_GetDestinations(q, minrange, maxrange)</strong>
|
||||
<strong>RAT:_GetDestinations(departure, q, minrange, maxrange)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -2573,6 +2839,12 @@ Maximal flight level in meters.</p>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a> departure </em></code>:
|
||||
Departure airport or zone.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> q </em></code>:
|
||||
Coordinate of the departure point.</p>
|
||||
|
||||
@@ -2659,6 +2931,36 @@ Group of the aircraft in the mission editor.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT)._IsFriendly" >
|
||||
<strong>RAT:_IsFriendly(port)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Check if airport is friendly, i.e.</p>
|
||||
|
||||
|
||||
<p>belongs to the right coalition.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string port </em></code>:
|
||||
Name of airport, FARP or ship to check.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#boolean:</em>
|
||||
true if airport is friendly and false otherwise.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT)._MinDistance" >
|
||||
<strong>RAT:_MinDistance(alpha, beta, h)</strong>
|
||||
</a>
|
||||
@@ -2881,7 +3183,7 @@ Departure airport if spawning at airport.</p>
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><em><a href="Coore.Zone.html##(ZONE)">Coore.Zone#ZONE</a>:</em>
|
||||
<p><em><a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>:</em>
|
||||
Departure zone if spawning in air.</p>
|
||||
|
||||
</li>
|
||||
@@ -3579,6 +3881,20 @@ Waypoints for DCS task route or spawn template.</p>
|
||||
|
||||
<p>Aircraft will continue their journey, i.e. get respawned at their destination with a new random destination.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#number</em>
|
||||
<a id="#(RAT).country" >
|
||||
<strong>RAT.country</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Country of spawn group template.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -3649,6 +3965,20 @@ Waypoints for DCS task route or spawn template.</p>
|
||||
|
||||
<p>Array containing the names of the destination airports.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(RAT).excluded_ports" >
|
||||
<strong>RAT.excluded_ports</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -3677,39 +4007,6 @@ Waypoints for DCS task route or spawn template.</p>
|
||||
|
||||
<p>Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(RAT).has_value" >
|
||||
<strong>RAT:has_value(tab, val)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Utility function which checks if table contains a specific value.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#table tab </em></code>:
|
||||
Table with elements to check.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string val </em></code>:
|
||||
The value we are looking for.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#boolean:</em>
|
||||
True if element in the list, false otherwise. </p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -3963,7 +4260,7 @@ True if element in the list, false otherwise. </p>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Skill of AI. </p>
|
||||
<p>Skill of AI.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -1241,7 +1241,7 @@ true if metric.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<em>#boolean</em>
|
||||
<a id="#(SETTINGS).Metric" >
|
||||
<strong>SETTINGS.Metric</strong>
|
||||
</a>
|
||||
|
||||
@@ -823,12 +823,6 @@ and any spaces before and after the resulting name are removed.</p>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SPAWN)._TranslateRotate">SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SPAWN).uncontrolled">SPAWN.uncontrolled</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -2769,6 +2763,9 @@ when nothing was spawned.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Overwrite unit names by default with group name.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -3166,7 +3163,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#boolean</em>
|
||||
<em></em>
|
||||
<a id="#(SPAWN).SpawnUnControlled" >
|
||||
<strong>SPAWN.SpawnUnControlled</strong>
|
||||
</a>
|
||||
@@ -3770,20 +3767,6 @@ True = Continue Scheduler</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(SPAWN).uncontrolled" >
|
||||
<strong>SPAWN.uncontrolled</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@@ -437,7 +437,6 @@ ptional) The name of the new static.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#number</em>
|
||||
<a id="#(SPAWNSTATIC).SpawnIndex" >
|
||||
<strong>SPAWNSTATIC.SpawnIndex</strong>
|
||||
</a>
|
||||
|
||||
@@ -553,7 +553,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a></em>
|
||||
<a id="#(FSM_PROCESS).Cargo" >
|
||||
<strong>FSM_PROCESS.Cargo</strong>
|
||||
</a>
|
||||
@@ -631,7 +631,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#number</em>
|
||||
<em></em>
|
||||
<a id="#(TASK_CARGO).CargoLimit" >
|
||||
<strong>TASK_CARGO.CargoLimit</strong>
|
||||
</a>
|
||||
|
||||
@@ -243,6 +243,18 @@ which are excellent tools to be reused in an OO environment!.</p>
|
||||
<td class="name" nowrap="nowrap"><a href="##(UTILS).GetMarkID">UTILS.GetMarkID()</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(UTILS).IsInRadius">UTILS.IsInRadius(InVec2, Vec2, Radius)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(UTILS).IsInSphere">UTILS.IsInSphere(InVec3, Vec3, Radius)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -666,6 +678,74 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(UTILS).IsInRadius" >
|
||||
<strong>UTILS.IsInRadius(InVec2, Vec2, Radius)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Test if a Vec2 is in a radius of another Vec2</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> InVec2 </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Vec2 </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Radius </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(UTILS).IsInSphere" >
|
||||
<strong>UTILS.IsInSphere(InVec3, Vec3, Radius)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Test if a Vec3 is in the sphere of another Vec3</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> InVec3 </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Vec3 </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Radius </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(UTILS).IsInstanceOf" >
|
||||
<strong>UTILS.IsInstanceOf(object, className)</strong>
|
||||
</a>
|
||||
|
||||
@@ -440,6 +440,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(ZONE_POLYGON_BASE).GetBoundingSquare">ZONE_POLYGON_BASE:GetBoundingSquare()</a></td>
|
||||
<td class="summary">
|
||||
<p>Get the bounding square the zone.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(ZONE_POLYGON_BASE).GetRandomCoordinate">ZONE_POLYGON_BASE:GetRandomCoordinate()</a></td>
|
||||
<td class="summary">
|
||||
<p>Return a <a href="Point.html##(COORDINATE)">Point#COORDINATE</a> object representing a random 3D point at landheight within the zone.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -504,6 +510,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(ZONE_RADIUS).GetRadius">ZONE_RADIUS:GetRadius()</a></td>
|
||||
<td class="summary">
|
||||
<p>Returns the radius of the zone.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(ZONE_RADIUS).GetRandomCoordinate">ZONE_RADIUS:GetRandomCoordinate(inner, outer)</a></td>
|
||||
<td class="summary">
|
||||
<p>Returns a <a href="Point.html##(COORDINATE)">Point#COORDINATE</a> object reflecting a random 3D location within the zone.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -1640,6 +1652,24 @@ self</p>
|
||||
<p><em><a href="##(ZONE_POLYGON_BASE.BoundingSquare)">#ZONE<em>POLYGON</em>BASE.BoundingSquare</a>:</em>
|
||||
The bounding square.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(ZONE_POLYGON_BASE).GetRandomCoordinate" >
|
||||
<strong>ZONE_POLYGON_BASE:GetRandomCoordinate()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Return a <a href="Point.html##(COORDINATE)">Point#COORDINATE</a> object representing a random 3D point at landheight within the zone.</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -1913,6 +1943,39 @@ self</p>
|
||||
<p><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a>:</em>
|
||||
The radius of the zone.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(ZONE_RADIUS).GetRandomCoordinate" >
|
||||
<strong>ZONE_RADIUS:GetRandomCoordinate(inner, outer)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Returns a <a href="Point.html##(COORDINATE)">Point#COORDINATE</a> object reflecting a random 3D location within the zone.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#number inner </em></code>:
|
||||
(optional) Minimal distance from the center of the zone. Default is 0.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#number outer </em></code>:
|
||||
(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
|
||||
Reference in New Issue
Block a user