mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
3197 lines
61 KiB
HTML
3197 lines
61 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html>
|
|
<head>
|
|
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="product">
|
|
<div id="product_logo"></div>
|
|
<div id="product_name"><big><b></b></big></div>
|
|
<div id="product_description"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="navigation">
|
|
<h2>Modules</h2>
|
|
<ul><li>
|
|
<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>AI_RAT</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><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">
|
|
<h1>Module <code>AI_RAT</code></h1>
|
|
|
|
<ul>
|
|
<li><strong>Functional</strong> -- Create random airtraffic in your missions.</li>
|
|
</ul>
|
|
|
|
|
|
<p>
|
|
<img src="..\Presentations\RAT\RAT.png" alt="Banner Image"/></p>
|
|
|
|
<hr/>
|
|
|
|
<p>The documentation of the SPAWN class can be found further in this document.</p>
|
|
|
|
<hr/>
|
|
|
|
<h2>Global(s)</h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#RAT">RAT</a></td>
|
|
<td class="summary">
|
|
<p>RAT class</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#myid">myid</a></td>
|
|
<td class="summary">
|
|
<p>Some ID to identify where we are</p>
|
|
<h1>string myid</h1>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a id="#(RAT)">Type <code>RAT</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).AlphaDescent">RAT.AlphaDescent</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).ClassName">RAT.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).Commute">RAT:Commute(switch)</a></td>
|
|
<td class="summary">
|
|
<p>Aircraft will commute between their departure and destination airports.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<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).FLmaxuser">RAT.FLmaxuser</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).FLminuser">RAT.FLminuser</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).FLuser">RAT.FLuser</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).Menu">RAT.Menu</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).MenuF10">RAT.MenuF10</a></td>
|
|
<td class="summary">
|
|
<p>Main F10 menu.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).New">RAT:New(groupname)</a></td>
|
|
<td class="summary">
|
|
<p>Create a new RAT object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).PlaceMarkers">RAT:PlaceMarkers(switch)</a></td>
|
|
<td class="summary">
|
|
<p>Place markers of waypoints on the F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).RAT">RAT.RAT</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).ROE">RAT.ROE</a></td>
|
|
<td class="summary">
|
|
<p>RAT rules of engagement.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).ROT">RAT.ROT</a></td>
|
|
<td class="summary">
|
|
<p>RAT reaction to threat.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).RespawnAfterLanding">RAT:RespawnAfterLanding(delay)</a></td>
|
|
<td class="summary">
|
|
<p>Make aircraft respawn the moment they land rather than at engine shut down.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetClimbRate">RAT:SetClimbRate(rate)</a></td>
|
|
<td class="summary">
|
|
<p>Set the climb rate.</p>
|
|
</td>
|
|
</tr>
|
|
<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>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetDeparture">RAT:SetDeparture(names)</a></td>
|
|
<td class="summary">
|
|
<p>Set possible departure ports.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetDescentAngle">RAT:SetDescentAngle(angle)</a></td>
|
|
<td class="summary">
|
|
<p>Set the angle of descent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetDestination">RAT:SetDestination(names)</a></td>
|
|
<td class="summary">
|
|
<p>Set name of destination airport for the AI aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetFL">RAT:SetFL(height)</a></td>
|
|
<td class="summary">
|
|
<p>Set flight level.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetFLcruise">RAT:SetFLcruise(height)</a></td>
|
|
<td class="summary">
|
|
<p>Set flight level of cruising part.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetFLmax">RAT:SetFLmax(height)</a></td>
|
|
<td class="summary">
|
|
<p>Set max flight level.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetFLmin">RAT:SetFLmin(height)</a></td>
|
|
<td class="summary">
|
|
<p>Set min flight level.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetMaxCruiseSpeed">RAT:SetMaxCruiseSpeed(speed)</a></td>
|
|
<td class="summary">
|
|
<p>Set the maximum cruise speed of the aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetMaxDistance">RAT:SetMaxDistance(dist)</a></td>
|
|
<td class="summary">
|
|
<p>Set maximum distance between departure and destination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetMinDistance">RAT:SetMinDistance(dist)</a></td>
|
|
<td class="summary">
|
|
<p>Set minimum distance between departure and destination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetROE">RAT:SetROE(roe)</a></td>
|
|
<td class="summary">
|
|
<p>Set rules of engagement (ROE).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetROT">RAT:SetROT(rot)</a></td>
|
|
<td class="summary">
|
|
<p>Set reaction to threat (ROT).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetSpawnDelay">RAT:SetSpawnDelay(delay)</a></td>
|
|
<td class="summary">
|
|
<p>Set the delay before first group is spawned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetSpawnInterval">RAT:SetSpawnInterval(interval)</a></td>
|
|
<td class="summary">
|
|
<p>Set the interval between spawnings of the template group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SetTakeoff">RAT:SetTakeoff(type)</a></td>
|
|
<td class="summary">
|
|
<p>Set takeoff type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).Spawn">RAT:Spawn(naircraft)</a></td>
|
|
<td class="summary">
|
|
<p>Triggers the spawning of AI aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).Status">RAT:Status(message, forID)</a></td>
|
|
<td class="summary">
|
|
<p>Report status of RAT groups.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).StatusReports">RAT:StatusReports(switch)</a></td>
|
|
<td class="summary">
|
|
<p>Aircraft report status messages.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).SubMenuName">RAT.SubMenuName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).Vclimb">RAT.Vclimb</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).Vcruisemax">RAT.Vcruisemax</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._AirportExists">RAT:_AirportExists(name)</a></td>
|
|
<td class="summary">
|
|
<p>Test if an airport exists on the current map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._Course">RAT:_Course(a, b)</a></td>
|
|
<td class="summary">
|
|
<p>Determine the heading from point a to point b.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._Debug">RAT:_Debug(switch)</a></td>
|
|
<td class="summary">
|
|
<p>Turn debug messages on or off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._DeleteMarkers">RAT:_DeleteMarkers(ids)</a></td>
|
|
<td class="summary">
|
|
<p>Delete all markers on F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._Despawn">RAT:_Despawn(group)</a></td>
|
|
<td class="summary">
|
|
<p>Despawn unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<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)._FLmax">RAT:_FLmax(alpha, beta, d, phi, h0)</a></td>
|
|
<td class="summary">
|
|
<p>Calculate the max flight level for a given distance and fixed climb and descent rates.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._GetAirportsOfCoalition">RAT:_GetAirportsOfCoalition()</a></td>
|
|
<td class="summary">
|
|
<p>Get all "friendly" airports of the current map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._GetAirportsOfMap">RAT:_GetAirportsOfMap()</a></td>
|
|
<td class="summary">
|
|
<p>Get all airports of the current map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._GetDestinations">RAT:_GetDestinations(q, minrange, maxrange)</a></td>
|
|
<td class="summary">
|
|
<p>Get all possible destination airports depending on departure position.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._GetLife">RAT:_GetLife(group)</a></td>
|
|
<td class="summary">
|
|
<p>Get (relative) life of first unit of a group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<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)._ModifySpawnTemplate">RAT:_ModifySpawnTemplate(waypoints)</a></td>
|
|
<td class="summary">
|
|
<p>Modifies the template of the group to be spawned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._OnBirth">RAT:_OnBirth(EventData)</a></td>
|
|
<td class="summary">
|
|
<p>Function is executed when a unit is spawned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._OnCrash">RAT:_OnCrash(EventData)</a></td>
|
|
<td class="summary">
|
|
<p>Function is executed when a unit crashes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._OnDead">RAT:_OnDead(EventData)</a></td>
|
|
<td class="summary">
|
|
<p>Function is executed when a unit is dead.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._OnEngineShutdown">RAT:_OnEngineShutdown(EventData)</a></td>
|
|
<td class="summary">
|
|
<p>Function is executed when a unit shuts down its engines.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._OnLand">RAT:_OnLand(EventData)</a></td>
|
|
<td class="summary">
|
|
<p>Function is executed when a unit lands.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._OnTakeoff">RAT:_OnTakeoff(EventData)</a></td>
|
|
<td class="summary">
|
|
<p>Function is executed when a unit takes off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._PickDeparture">RAT:_PickDeparture(takeoff)</a></td>
|
|
<td class="summary">
|
|
<p>Set the departure airport of the AI.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._PickDestination">RAT:_PickDestination(destinations, _random)</a></td>
|
|
<td class="summary">
|
|
<p>Set the destination airport of the AI.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._PlaceMarkers">RAT:_PlaceMarkers(waypoints)</a></td>
|
|
<td class="summary">
|
|
<p>Place markers of the waypoints.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._Randomize">RAT:_Randomize(value, fac, lower, upper)</a></td>
|
|
<td class="summary">
|
|
<p>Randomize a value by a certain amount.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._Respawn">RAT:_Respawn(group)</a></td>
|
|
<td class="summary">
|
|
<p>Respawn a group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._Routeinfo">RAT:_Routeinfo(waypoints, comment)</a></td>
|
|
<td class="summary">
|
|
<p>Provide information about the assigned flightplan.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._SetCoalitionTable">RAT:_SetCoalitionTable()</a></td>
|
|
<td class="summary">
|
|
<p>Create a table with the valid coalitions for departure and destination airports.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._SetMarker">RAT:_SetMarker(text, wp)</a></td>
|
|
<td class="summary">
|
|
<p>Set a marker visible for all on the F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._SetROE">RAT:_SetROE(group, roe)</a></td>
|
|
<td class="summary">
|
|
<p>Set ROE for a group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._SetROT">RAT:_SetROT(group, rot)</a></td>
|
|
<td class="summary">
|
|
<p>Set ROT for a group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._SetRoute">RAT:_SetRoute(Takeoff, _departure, _destination, takeoff)</a></td>
|
|
<td class="summary">
|
|
<p>Set the route of the AI plane.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._SetStatus">RAT:_SetStatus(group, status)</a></td>
|
|
<td class="summary">
|
|
<p>Set status of group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._SpawnWithRoute">RAT:_SpawnWithRoute(_departure, _destination)</a></td>
|
|
<td class="summary">
|
|
<p>Spawn the AI aircraft with a route.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._TaskHolding">RAT:_TaskHolding(P1, Altitude, Speed, Duration)</a></td>
|
|
<td class="summary">
|
|
<p>Orbit at a specified position at a specified alititude with a specified speed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT)._Waypoint">RAT:_Waypoint(Type, Coord, Speed, Altitude, Airport)</a></td>
|
|
<td class="summary">
|
|
<p>Create a waypoint that can be used with the Route command.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).aircraft">RAT.aircraft</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).airports">RAT.airports</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).airports_map">RAT.airports_map</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).alive">RAT.alive</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).cat">RAT.cat</a></td>
|
|
<td class="summary">
|
|
<p>RAT categories.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).category">RAT.category</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).coal">RAT.coal</a></td>
|
|
<td class="summary">
|
|
<p>RAT friendly coalitions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).coalition">RAT.coalition</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).commute">RAT.commute</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).continuejourney">RAT.continuejourney</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).ctable">RAT.ctable</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).debug">RAT.debug</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).departure_ports">RAT.departure_ports</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).departure_zones">RAT.departure_zones</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).destination_ports">RAT.destination_ports</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).f10menu">RAT.f10menu</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).friendly">RAT.friendly</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).markerid">RAT.markerid</a></td>
|
|
<td class="summary">
|
|
<p>Running number of placed markers on the F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).markerids">RAT.markerids</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).maxdist">RAT.maxdist</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).mindist">RAT.mindist</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).placemarkers">RAT.placemarkers</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).random_departure">RAT.random_departure</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).random_destination">RAT.random_destination</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).ratcraft">RAT.ratcraft</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).reportstatus">RAT.reportstatus</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).respawn_after_landing">RAT.respawn_after_landing</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).respawn_delay">RAT.respawn_delay</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).roe">RAT.roe</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).rot">RAT.rot</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).spawndelay">RAT.spawndelay</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).spawninterval">RAT.spawninterval</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).statusinterval">RAT.statusinterval</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).takeoff">RAT.takeoff</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).unit">RAT.unit</a></td>
|
|
<td class="summary">
|
|
<p>RAT unit conversions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(RAT).wp">RAT.wp</a></td>
|
|
<td class="summary">
|
|
<p>RAT waypoint type.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2>Global(s)</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(RAT)">#RAT</a></em>
|
|
<a id="RAT" >
|
|
<strong>RAT</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>RAT class</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="myid" >
|
|
<strong>myid</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Some ID to identify where we are</p>
|
|
<h1>string myid</h1>
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a id="#(AI_RAT)" >Type <code>AI_RAT</code></a></h2>
|
|
|
|
<h2><a id="#(RAT)" >Type <code>RAT</code></a></h2>
|
|
|
|
<p>RAT class </p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).AlphaDescent" >
|
|
<strong>RAT.AlphaDescent</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(RAT).ClassName" >
|
|
<strong>RAT.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).Commute" >
|
|
<strong>RAT:Commute(switch)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Aircraft will commute between their departure and destination airports.</p>
|
|
|
|
|
|
<p>Note, this option is not available if aircraft are spawned in air since they don't have a valid departure airport to fly back to.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean switch </em></code>:
|
|
Turn commute on=true or off=false. If no value is given switch=true.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).ContinueJourney" >
|
|
<strong>RAT:ContinueJourney(switch)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Aircraft will continue their journey from their destination.</p>
|
|
|
|
|
|
<p>This means they are respawned at their destination and get a new random destination.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean switch </em></code>:
|
|
Turn journey on=true or off=false. If no value is given switch=true.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).FLmaxuser" >
|
|
<strong>RAT.FLmaxuser</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).FLminuser" >
|
|
<strong>RAT.FLminuser</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).FLuser" >
|
|
<strong>RAT.FLuser</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).Menu" >
|
|
<strong>RAT.Menu</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(RAT)">#RAT</a></em>
|
|
<a id="#(RAT).MenuF10" >
|
|
<strong>RAT.MenuF10</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Main F10 menu.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).New" >
|
|
<strong>RAT:New(groupname)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Create a new RAT object.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string groupname </em></code>:
|
|
Name of the group as defined in the mission editor. This group is serving as a template for all spawned units.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return values</h3>
|
|
<ol>
|
|
<li>
|
|
|
|
<p><em><a href="##(RAT)">#RAT</a>:</em>
|
|
Object of RAT class.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><em>#nil:</em>
|
|
If the group does not exist in the mission editor.</p>
|
|
|
|
</li>
|
|
</ol>
|
|
<h3>Usage:</h3>
|
|
<pre class="example"><code>yak:RAT("RAT_YAK") will create a RAT object called "yak". The template group in the mission editor must have the name "RAT_YAK".</code></pre>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).PlaceMarkers" >
|
|
<strong>RAT:PlaceMarkers(switch)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Place markers of waypoints on the F10 map.</p>
|
|
|
|
|
|
<p>Default is off.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean switch </em></code>:
|
|
true=yes, false=no.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).RAT" >
|
|
<strong>RAT.RAT</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(RAT)">#RAT</a></em>
|
|
<a id="#(RAT).ROE" >
|
|
<strong>RAT.ROE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>RAT rules of engagement.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(RAT)">#RAT</a></em>
|
|
<a id="#(RAT).ROT" >
|
|
<strong>RAT.ROT</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>RAT reaction to threat.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).RespawnAfterLanding" >
|
|
<strong>RAT:RespawnAfterLanding(delay)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Make aircraft respawn the moment they land rather than at engine shut down.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number delay </em></code>:
|
|
(Optional) Delay in seconds until respawn happens after landing. Default is 180 seconds.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetClimbRate" >
|
|
<strong>RAT:SetClimbRate(rate)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the climb rate.</p>
|
|
|
|
|
|
<p>Default is 1500 ft/min. This automatically sets the climb angle.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number rate </em></code>:
|
|
Climb rate in ft/min.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetCoalition" >
|
|
<strong>RAT:SetCoalition(friendly)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the friendly coalitions from which the airports can be used as departure or 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.
|
|
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>
|
|
</ul>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetDeparture" >
|
|
<strong>RAT:SetDeparture(names)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set possible departure ports.</p>
|
|
|
|
|
|
<p>This can be an airport or a zone defined in the mission editor.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string names </em></code>:
|
|
Name or table of names of departure airports or zones.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Usages:</h3>
|
|
<ul>
|
|
<li><pre class="example"><code>RAT:SetDeparture("Sochi-Adler") will spawn RAT objects at Sochi-Adler airport.</code></pre></li>
|
|
<li><pre class="example"><code>RAT:SetDeparture({"Sochi-Adler", "Gudauta"}) will spawn RAT aircraft radomly at Sochi-Adler or Gudauta airport.</code></pre></li>
|
|
<li><pre class="example"><code>RAT:SetDeparture({"Zone A", "Gudauta"}) will spawn RAT aircraft in air randomly within Zone A, which has to be defined in the mission editor, or within a zone around Gudauta airport. Note that this also requires RAT:takeoff("air") to be set.</code></pre></li>
|
|
</ul>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetDescentAngle" >
|
|
<strong>RAT:SetDescentAngle(angle)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the angle of descent.</p>
|
|
|
|
|
|
<p>Default is 3.6 degrees, which corresponds to 3000 ft descent after one mile of travel.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number angle </em></code>:
|
|
Angle of descent in degrees.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetDestination" >
|
|
<strong>RAT:SetDestination(names)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set name of destination airport for the AI aircraft.</p>
|
|
|
|
|
|
<p>If no name is given an airport from the friendly coalition(s) is chosen randomly.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string names </em></code>:
|
|
Name of the destination airport or table of destination airports.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Usage:</h3>
|
|
<pre class="example"><code>RAT:SetDestination("Krymsk") makes all aircraft of this RAT oject fly to Krymsk airport.</code></pre>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetFL" >
|
|
<strong>RAT:SetFL(height)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set flight level.</p>
|
|
|
|
|
|
<p>Setting this value will overrule all other logic. Aircraft will try to fly at this height regardless.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number height </em></code>:
|
|
FL in hundrets of feet. E.g. FL200 = 20000 ft ASL.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetFLcruise" >
|
|
<strong>RAT:SetFLcruise(height)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set flight level of cruising part.</p>
|
|
|
|
|
|
<p>This is still be checked for consitancy with selected route and prone to radomization.
|
|
Default is FL200 for planes and FL005 for helicopters.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number height </em></code>:
|
|
FL in hundrets of feet. E.g. FL200 = 20000 ft ASL.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetFLmax" >
|
|
<strong>RAT:SetFLmax(height)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set max flight level.</p>
|
|
|
|
|
|
<p>Setting this value will overrule all other logic. Aircraft will try to fly at less than this FL regardless.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number height </em></code>:
|
|
Maximum FL in hundrets of feet.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetFLmin" >
|
|
<strong>RAT:SetFLmin(height)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set min flight level.</p>
|
|
|
|
|
|
<p>Setting this value will overrule all other logic. Aircraft will try to fly at higher than this FL regardless.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number height </em></code>:
|
|
Maximum FL in hundrets of feet.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetMaxCruiseSpeed" >
|
|
<strong>RAT:SetMaxCruiseSpeed(speed)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the maximum cruise speed of the aircraft.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number speed </em></code>:
|
|
Speed in km/h.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetMaxDistance" >
|
|
<strong>RAT:SetMaxDistance(dist)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set maximum distance between departure and destination.</p>
|
|
|
|
|
|
<p>Default is 5000 km but aircarft range is also taken into account automatically.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number dist </em></code>:
|
|
Distance in km.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetMinDistance" >
|
|
<strong>RAT:SetMinDistance(dist)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set minimum distance between departure and destination.</p>
|
|
|
|
|
|
<p>Default is 5 km.
|
|
Minimum distance should not be smaller than ~500(?) meters to ensure that departure and destination are different.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number dist </em></code>:
|
|
Distance in km.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetROE" >
|
|
<strong>RAT:SetROE(roe)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set rules of engagement (ROE).</p>
|
|
|
|
|
|
<p>Default is weapon hold. This is a peaceful class.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string roe </em></code>:
|
|
"hold" = weapon hold, "return" = return fire, "free" = weapons free.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetROT" >
|
|
<strong>RAT:SetROT(rot)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set reaction to threat (ROT).</p>
|
|
|
|
|
|
<p>Default is no reaction, i.e. aircraft will simply ignore all enemies.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string rot </em></code>:
|
|
"noreaction = no reactino, "passive" = passive defence, "evade" = weapons free.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetSpawnDelay" >
|
|
<strong>RAT:SetSpawnDelay(delay)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the delay before first group is spawned.</p>
|
|
|
|
|
|
<p>Minimum delay is 0.5 seconds.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number delay </em></code>:
|
|
Delay in seconds.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetSpawnInterval" >
|
|
<strong>RAT:SetSpawnInterval(interval)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the interval between spawnings of the template group.</p>
|
|
|
|
|
|
<p>Minimum interval is 0.5 seconds.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number interval </em></code>:
|
|
Interval in seconds.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).SetTakeoff" >
|
|
<strong>RAT:SetTakeoff(type)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set takeoff type.</p>
|
|
|
|
|
|
<p>Starting cold at airport, starting hot at airport, starting at runway, starting in the air.
|
|
Default is "takeoff-hot" for a start at airport with engines already running.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string type </em></code>:
|
|
Type can be "takeoff-cold" or "cold", "takeoff-hot" or "hot", "takeoff-runway" or "runway", "air".</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Usages:</h3>
|
|
<ul>
|
|
<li><pre class="example"><code>RAT:Takeoff("hot") will spawn RAT objects at airports with engines started.</code></pre></li>
|
|
<li><pre class="example"><code>RAT:Takeoff("cold") will spawn RAT objects at airports with engines off.</code></pre></li>
|
|
<li><pre class="example"><code>RAT:Takeoff("air") will spawn RAT objects in air over random airports or within pre-defined zones. </code></pre></li>
|
|
</ul>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).Spawn" >
|
|
<strong>RAT:Spawn(naircraft)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Triggers the spawning of AI aircraft.</p>
|
|
|
|
|
|
<p>Note that all additional options should be set before giving the spawn command.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number naircraft </em></code>:
|
|
(Optional) Number of aircraft to spawn. Default is one aircraft.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Usage:</h3>
|
|
<pre class="example"><code>yak:Spawn(5) will spawn five aircraft. By default aircraft will spawn at neutral and red airports if the template group is part of the red coaliton.</code></pre>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).Status" >
|
|
<strong>RAT:Status(message, forID)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Report status of RAT groups.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean message </em></code>:
|
|
(Optional) Send message if true.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number forID </em></code>:
|
|
(Optional) Send message only for this ID.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT).StatusReports" >
|
|
<strong>RAT:StatusReports(switch)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Aircraft report status messages.</p>
|
|
|
|
|
|
<p>Default is off.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean switch </em></code>:
|
|
true=on, false=off.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(RAT).SubMenuName" >
|
|
<strong>RAT.SubMenuName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).Vclimb" >
|
|
<strong>RAT.Vclimb</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).Vcruisemax" >
|
|
<strong>RAT.Vcruisemax</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._AirportExists" >
|
|
<strong>RAT:_AirportExists(name)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Test if an airport exists on the current map.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string name </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#boolean:</em>
|
|
True if airport exsits, false otherwise. </p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._Course" >
|
|
<strong>RAT:_Course(a, b)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Determine the heading from point a to point b.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> a </em></code>:
|
|
Point from.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> b </em></code>:
|
|
Point to.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
Heading/angle in degrees. </p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._Debug" >
|
|
<strong>RAT:_Debug(switch)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Turn debug messages on or off.</p>
|
|
|
|
|
|
<p>Default is off.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean switch </em></code>:
|
|
true turn messages on, false=off.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._DeleteMarkers" >
|
|
<strong>RAT:_DeleteMarkers(ids)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Delete all markers on F10 map.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#table ids </em></code>:
|
|
(Optional) Table holding the marker IDs to be deleted.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._Despawn" >
|
|
<strong>RAT:_Despawn(group)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Despawn unit.</p>
|
|
|
|
|
|
<p>Unit gets destoyed and group is set to nil.
|
|
Index of ratcraft array is taken from spawned group name.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> group </em></code>:
|
|
Group to be despawned.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._EngineStartup" >
|
|
<strong>RAT:_EngineStartup(EventData)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Function is executed when a unit starts its engines.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> EventData </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._FLmax" >
|
|
<strong>RAT:_FLmax(alpha, beta, d, phi, h0)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Calculate the max flight level for a given distance and fixed climb and descent rates.</p>
|
|
|
|
|
|
<p>In other words we have a distance between two airports and want to know how high we
|
|
can climb before we must descent again to arrive at the destination without any level/cruising part.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number alpha </em></code>:
|
|
Angle of climb [rad].</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number beta </em></code>:
|
|
Angle of descent [rad].</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number d </em></code>:
|
|
Distance between the two airports [m].</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number phi </em></code>:
|
|
Angle between departure and destination [rad].</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number h0 </em></code>:
|
|
Height [m] of departure airport. Note we implicitly assume that the height difference between departure and destination is negligible.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
Maximal flight level in meters.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._GetAirportsOfCoalition" >
|
|
<strong>RAT:_GetAirportsOfCoalition()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get all "friendly" airports of the current map.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._GetAirportsOfMap" >
|
|
<strong>RAT:_GetAirportsOfMap()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get all airports of the current map.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._GetDestinations" >
|
|
<strong>RAT:_GetDestinations(q, minrange, maxrange)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get all possible destination airports depending on departure position.</p>
|
|
|
|
|
|
<p>The list is sorted w.r.t. distance to departure position.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> q </em></code>:
|
|
Coordinate of the departure point.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number minrange </em></code>:
|
|
Minimum range to q in meters.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number maxrange </em></code>:
|
|
Maximum range to q in meters.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return values</h3>
|
|
<ol>
|
|
<li>
|
|
|
|
<p><em>#table:</em>
|
|
Table with possible destination airports.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><em>#nil:</em>
|
|
If no airports could be found.</p>
|
|
|
|
</li>
|
|
</ol>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._GetLife" >
|
|
<strong>RAT:_GetLife(group)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get (relative) life of first unit of a group.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> group </em></code>:
|
|
Group of unit.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
Life of unit in percent.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._InitAircraft" >
|
|
<strong>RAT:_InitAircraft(DCSgroup)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Initialize basic parameters of the aircraft based on its (template) group in the mission editor.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSWrapper.Group.html##(Group)">Dcs.DCSWrapper.Group#Group</a> DCSgroup </em></code>:
|
|
Group of the aircraft in the mission editor.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._ModifySpawnTemplate" >
|
|
<strong>RAT:_ModifySpawnTemplate(waypoints)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Modifies the template of the group to be spawned.</p>
|
|
|
|
|
|
<p>In particular, the waypoints of the group's flight plan are copied into the spawn template.
|
|
This allows to spawn at airports and also land at other airports, i.e. circumventing the DCS "landing bug".</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#table waypoints </em></code>:
|
|
The waypoints of the AI flight plan.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._OnBirth" >
|
|
<strong>RAT:_OnBirth(EventData)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Function is executed when a unit is spawned.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> EventData </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._OnCrash" >
|
|
<strong>RAT:_OnCrash(EventData)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Function is executed when a unit crashes.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> EventData </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._OnDead" >
|
|
<strong>RAT:_OnDead(EventData)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Function is executed when a unit is dead.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> EventData </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._OnEngineShutdown" >
|
|
<strong>RAT:_OnEngineShutdown(EventData)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Function is executed when a unit shuts down its engines.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> EventData </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._OnLand" >
|
|
<strong>RAT:_OnLand(EventData)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Function is executed when a unit lands.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> EventData </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._OnTakeoff" >
|
|
<strong>RAT:_OnTakeoff(EventData)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Function is executed when a unit takes off.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> EventData </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._PickDeparture" >
|
|
<strong>RAT:_PickDeparture(takeoff)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the departure airport of the AI.</p>
|
|
|
|
|
|
<p>If no airport name is given explicitly an airport from the coalition is chosen randomly.
|
|
If takeoff style is set to "air", we use zones around the airports or the zones specified by user input.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number takeoff </em></code>:
|
|
Takeoff type.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return values</h3>
|
|
<ol>
|
|
<li>
|
|
|
|
<p><em><a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>:</em>
|
|
Departure airport if spawning at airport.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><em><a href="Coore.Zone.html##(ZONE)">Coore.Zone#ZONE</a>:</em>
|
|
Departure zone if spawning in air.</p>
|
|
|
|
</li>
|
|
</ol>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._PickDestination" >
|
|
<strong>RAT:_PickDestination(destinations, _random)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the destination airport of the AI.</p>
|
|
|
|
|
|
<p>If no airport name is given an airport from the coalition is chosen randomly.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#table destinations </em></code>:
|
|
Table with destination airports.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#boolean _random </em></code>:
|
|
Optional switch to activate a random selection of airports.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>:</em>
|
|
Destination airport.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._PlaceMarkers" >
|
|
<strong>RAT:_PlaceMarkers(waypoints)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Place markers of the waypoints.</p>
|
|
|
|
|
|
<p>Note we assume a very specific number and type of waypoints here.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#table waypoints </em></code>:
|
|
Table with waypoints.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._Randomize" >
|
|
<strong>RAT:_Randomize(value, fac, lower, upper)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Randomize a value by a certain amount.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number value </em></code>:
|
|
The value which should be randomized</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number fac </em></code>:
|
|
Randomization factor.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number lower </em></code>:
|
|
(Optional) Lower limit of the returned value.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number upper </em></code>:
|
|
(Optional) Upper limit of the returned value.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
Randomized value.</p>
|
|
|
|
<h3>Usages:</h3>
|
|
<ul>
|
|
<li><pre class="example"><code>_Randomize(100, 0.1) returns a value between 90 and 110, i.e. a plus/minus ten percent variation.</code></pre></li>
|
|
<li><pre class="example"><code>_Randomize(100, 0.5, nil, 120) returns a value between 50 and 120, i.e. a plus/minus fivty percent variation with upper bound 120.</code></pre></li>
|
|
</ul>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._Respawn" >
|
|
<strong>RAT:_Respawn(group)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Respawn a group.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> group </em></code>:
|
|
Group to be repawned.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._Routeinfo" >
|
|
<strong>RAT:_Routeinfo(waypoints, comment)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Provide information about the assigned flightplan.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#table waypoints </em></code>:
|
|
Waypoints of the flight plan.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string comment </em></code>:
|
|
Some comment to identify the provided information.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
total Total route length in meters.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._SetCoalitionTable" >
|
|
<strong>RAT:_SetCoalitionTable()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Create a table with the valid coalitions for departure and destination airports.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._SetMarker" >
|
|
<strong>RAT:_SetMarker(text, wp)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set a marker visible for all on the F10 map.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string text </em></code>:
|
|
Info text displayed at maker.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#table wp </em></code>:
|
|
Position of marker coming in as waypoint, i.e. has x, y and alt components.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._SetROE" >
|
|
<strong>RAT:_SetROE(group, roe)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set ROE for a group.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> group </em></code>:
|
|
Group for which the ROE is set.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string roe </em></code>:
|
|
ROE of group.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._SetROT" >
|
|
<strong>RAT:_SetROT(group, rot)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set ROT for a group.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> group </em></code>:
|
|
Group for which the ROT is set.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string rot </em></code>:
|
|
ROT of group.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._SetRoute" >
|
|
<strong>RAT:_SetRoute(Takeoff, _departure, _destination, takeoff)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the route of the AI plane.</p>
|
|
|
|
|
|
<p>Due to DCS landing bug, this has to be done before the unit is spawned.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="takeoff.html##(RAT.wp)">takeoff#RAT.wp</a> Takeoff </em></code>:
|
|
type.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Airport.html##(AIRBASE)">Wrapper.Airport#AIRBASE</a> _departure </em></code>:
|
|
(Optional) Departure airbase.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Airport.html##(AIRBASE)">Wrapper.Airport#AIRBASE</a> _destination </em></code>:
|
|
(Optional) Destination airbase.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> takeoff </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return values</h3>
|
|
<ol>
|
|
<li>
|
|
|
|
<p><em><a href="Wrapper.Airport.html##(AIRBASE)">Wrapper.Airport#AIRBASE</a>:</em>
|
|
Departure airbase.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><em><a href="Wrapper.Airport.html##(AIRBASE)">Wrapper.Airport#AIRBASE</a>:</em>
|
|
Destination airbase.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><em>#table:</em>
|
|
Table of flight plan waypoints. </p>
|
|
|
|
</li>
|
|
</ol>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._SetStatus" >
|
|
<strong>RAT:_SetStatus(group, status)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set status of group.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> group </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> status </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._SpawnWithRoute" >
|
|
<strong>RAT:_SpawnWithRoute(_departure, _destination)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Spawn the AI aircraft with a route.</p>
|
|
|
|
|
|
<p>Sets the departure and destination airports and waypoints.
|
|
Modifies the spawn template.
|
|
Sets ROE/ROT.
|
|
Initializes the ratcraft array and group menu.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string _departure </em></code>:
|
|
(Optional) Name of departure airbase.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string _destination </em></code>:
|
|
(Optional) Name of destination airbase.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._TaskHolding" >
|
|
<strong>RAT:_TaskHolding(P1, Altitude, Speed, Duration)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Orbit at a specified position at a specified alititude with a specified speed.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Dcs.DCSTypes.html##(Vec2)">Dcs.DCSTypes#Vec2</a> P1 </em></code>:
|
|
The point to hold the position.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Altitude </em></code>:
|
|
The altitude ASL at which to hold the position.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Speed </em></code>:
|
|
The speed flying when holding the position in m/s.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Duration </em></code>:
|
|
Duration of holding pattern in seconds.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="Dcs.DCSTasking.Task.html##(Task)">Dcs.DCSTasking.Task#Task</a>:</em>
|
|
DCSTask</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(RAT)._Waypoint" >
|
|
<strong>RAT:_Waypoint(Type, Coord, Speed, Altitude, Airport)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Create a waypoint that can be used with the Route command.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number Type </em></code>:
|
|
Type of waypoint.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> Coord </em></code>:
|
|
3D coordinate of the waypoint.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Speed </em></code>:
|
|
Speed in m/s.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Altitude </em></code>:
|
|
Altitude in m.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a> Airport </em></code>:
|
|
Airport of object to spawn.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#table:</em>
|
|
Waypoints for DCS task route or spawn template.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).aircraft" >
|
|
<strong>RAT.aircraft</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).airports" >
|
|
<strong>RAT.airports</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).airports_map" >
|
|
<strong>RAT.airports_map</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).alive" >
|
|
<strong>RAT.alive</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(RAT)">#RAT</a></em>
|
|
<a id="#(RAT).cat" >
|
|
<strong>RAT.cat</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>RAT categories.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(RAT).category" >
|
|
<strong>RAT.category</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(RAT)">#RAT</a></em>
|
|
<a id="#(RAT).coal" >
|
|
<strong>RAT.coal</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>RAT friendly coalitions.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).coalition" >
|
|
<strong>RAT.coalition</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(RAT).commute" >
|
|
<strong>RAT.commute</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(RAT).continuejourney" >
|
|
<strong>RAT.continuejourney</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).ctable" >
|
|
<strong>RAT.ctable</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(RAT).debug" >
|
|
<strong>RAT.debug</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).departure_ports" >
|
|
<strong>RAT.departure_ports</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).departure_zones" >
|
|
<strong>RAT.departure_zones</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).destination_ports" >
|
|
<strong>RAT.destination_ports</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(RAT).f10menu" >
|
|
<strong>RAT.f10menu</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(RAT).friendly" >
|
|
<strong>RAT.friendly</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(RAT)">#RAT</a></em>
|
|
<a id="#(RAT).markerid" >
|
|
<strong>RAT.markerid</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Running number of placed markers on the F10 map.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).markerids" >
|
|
<strong>RAT.markerids</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).maxdist" >
|
|
<strong>RAT.maxdist</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).mindist" >
|
|
<strong>RAT.mindist</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(RAT).placemarkers" >
|
|
<strong>RAT.placemarkers</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(RAT).random_departure" >
|
|
<strong>RAT.random_departure</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(RAT).random_destination" >
|
|
<strong>RAT.random_destination</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#table</em>
|
|
<a id="#(RAT).ratcraft" >
|
|
<strong>RAT.ratcraft</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(RAT).reportstatus" >
|
|
<strong>RAT.reportstatus</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(RAT).respawn_after_landing" >
|
|
<strong>RAT.respawn_after_landing</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).respawn_delay" >
|
|
<strong>RAT.respawn_delay</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(RAT).roe" >
|
|
<strong>RAT.roe</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(RAT).rot" >
|
|
<strong>RAT.rot</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).spawndelay" >
|
|
<strong>RAT.spawndelay</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).spawninterval" >
|
|
<strong>RAT.spawninterval</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(RAT).statusinterval" >
|
|
<strong>RAT.statusinterval</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(RAT).takeoff" >
|
|
<strong>RAT.takeoff</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(RAT)">#RAT</a></em>
|
|
<a id="#(RAT).unit" >
|
|
<strong>RAT.unit</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>RAT unit conversions.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(RAT)">#RAT</a></em>
|
|
<a id="#(RAT).wp" >
|
|
<strong>RAT.wp</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>RAT waypoint type.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(list)" >Type <code>list</code></a></h2>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|