Module Rat
+
+-
+
- Functional - Create random airtraffic in your missions. +
+
+ +
The aim of the RAT class is to fill the empty DCS world with randomized air traffic and bring more life to your airports.
+ +In particular, it is designed to spawn AI air units at random airports. These units will be assigned a random flight path to another random airport on the map.
+ +Even the mission designer will not know where aircraft will be spawned and which route they follow.
+ +Features
+ +-
+
- Very simple interface. Just one unit and two lines of Lua code needed to fill your map. +
- High degree of randomization. Aircraft will spawn at random airports, have random routes and random destinations. +
- Specific departure and/or destination airports can be chosen. +
- Departure and destination airports can be restricted by coalition. +
- Planes and helicopters supported. Helicopters can also be send to FARPs and ships. +
- Units can also be spawned in air within pre-defined zones of the map. +
- Aircraft will be removed when they arrive at their destination (or get stuck on the ground). +
- When a unit is removed a new unit with a different flight plan is respawned. +
- Aircraft can report their status during the route. +
- All of the above can be customized by the user if necessary. +
- All current (Caucasus, Nevada, Normandy) and future maps are supported. +
The RAT class creates an entry in the F10 menu which allows to
+ +-
+
- Create new groups on-the-fly, i.e. at run time within the mission, +
- Destroy specific groups (e.g. if they get stuck or damaged and block a runway), +
- Request the status of all RAT aircraft or individual groups, +
- Place markers at waypoints on the F10 map for each group. +
Note that by its very nature, this class is suited best for civil or transport aircraft. However, it also works perfectly fine for military aircraft of any kind.
+ +More of the documentation include some simple examples can be found further down this page.
+ ++ +
Demo Missions
+ +ALL Demo Missions pack of the last release
+ ++ +
YouTube Channel
+ +RAT YouTube Channel
+ ++ +
Author: funkyfranky
+ +Contributions: Sven van de Velde (FlightControl)
+ ++ +
Global(s)
+| RAT | +
+RAT class, extends Spawn#SPAWN+The RAT class implements an easy to use way to randomly fill your map with AI aircraft. + |
+
Type RAT
+ | RAT.AlphaDescent | +
+ Default angle of descenti in degrees. A value of 3.6 follows the 3:1 rule of 3 miles of travel and 1000 ft descent. + |
+
| RAT.ClassName | +
+ Name of the Class. + |
+
| RAT:Commute(switch) | +
+ Aircraft will commute between their departure and destination airports. + |
+
| RAT:ContinueJourney(switch) | +
+ Aircraft will continue their journey from their destination. + |
+
| RAT.FLmaxuser | +
+ Maximum flight level set by user. + |
+
| RAT.FLminuser | +
+ Minimum flight level set by user. + |
+
| RAT.FLuser | +
+ Flight level set by users explicitly. + |
+
| RAT.Menu | +
+ F10 menu items for this RAT object. + |
+
| RAT.MenuF10 | +
+ Main F10 menu. + |
+
| RAT:MenuName(name) | +
+ Set the name of the F10 submenu. + |
+
| RAT:New(groupname, alias) | +
+ Create a new RAT object. + |
+
| RAT:PlaceMarkers(switch) | +
+ Place markers of waypoints on the F10 map. + |
+
| RAT.ROE | +
+ RAT rules of engagement. + |
+
| RAT.ROT | +
+ RAT reaction to threat. + |
+
| RAT:RespawnAfterLanding(delay) | +
+ Make aircraft respawn the moment they land rather than at engine shut down. + |
+
| RAT:SetClimbRate(rate) | +
+ Set the climb rate. + |
+
| RAT:SetCoalition(friendly) | +
+ Set the friendly coalitions from which the airports can be used as departure or destination. + |
+
| RAT:SetDeparture(names) | +
+ Set possible departure ports. + |
+
| RAT:SetDescentAngle(angle) | +
+ Set the angle of descent. + |
+
| RAT:SetDestination(names) | +
+ Set name of destination airport for the AI aircraft. + |
+
| RAT:SetFL(height) | +
+ Set flight level. + |
+
| RAT:SetFLcruise(height) | +
+ Set flight level of cruising part. + |
+
| RAT:SetFLmax(height) | +
+ Set max flight level. + |
+
| RAT:SetFLmin(height) | +
+ Set min flight level. + |
+
| RAT:SetMaxCruiseSpeed(speed) | +
+ Set the maximum cruise speed of the aircraft. + |
+
| RAT:SetMaxDistance(dist) | +
+ Set maximum distance between departure and destination. + |
+
| RAT:SetMinDistance(dist) | +
+ Set minimum distance between departure and destination. + |
+
| RAT:SetROE(roe) | +
+ Set rules of engagement (ROE). + |
+
| RAT:SetROT(rot) | +
+ Set reaction to threat (ROT). + |
+
| RAT:SetSpawnDelay(delay) | +
+ Set the delay before first group is spawned. + |
+
| RAT:SetSpawnInterval(interval) | +
+ Set the interval between spawnings of the template group. + |
+
| RAT:SetTakeoff(type) | +
+ Set takeoff type. + |
+
| RAT:Spawn(naircraft) | +
+ Triggers the spawning of AI aircraft. + |
+
| RAT:Status(message, forID) | +
+ Report status of RAT groups. + |
+
| RAT:StatusReports(switch) | +
+ Aircraft report status messages. + |
+
| RAT.SubMenuName | +
+ Submenu name for RAT object. + |
+
| RAT:TimeDestroyInactive(time) | +
+ Set the time after which inactive groups will be destroyed. + |
+
| RAT.Tinactive | +
+ Time in seconds after which inactive units will be destroyed. Default is 180 seconds. + |
+
| RAT.Vclimb | +
+ Default climb rate in ft/min. + |
+
| RAT.Vcruisemax | +
+ Max cruise speed in m/s (250 m/s = 900 km/h = 486 kt) set by user. + |
+
| RAT:_AirportExists(name) | +
+ Test if an airport exists on the current map. + |
+
| RAT:_Course(a, b) | +
+ Determine the heading from point a to point b. + |
+
| RAT:_Debug(switch) | +
+ Turn debug messages on or off. + |
+
| RAT:_DeleteMarkers() | +
+ Delete all markers on F10 map. + |
+
| RAT:_Despawn(group) | +
+ Despawn unit. + |
+
| RAT:_EngineStartup(EventData) | +
+ Function is executed when a unit starts its engines. + |
+
| RAT:_FLmax(alpha, beta, d, phi, h0) | +
+ Calculate the max flight level for a given distance and fixed climb and descent rates. + |
+
| RAT:_GetAirportsOfCoalition() | +
+ Get all "friendly" airports of the current map. + |
+
| RAT:_GetAirportsOfMap() | +
+ Get all airports of the current map. + |
+
| RAT:_GetDestinations(q, minrange, maxrange) | +
+ Get all possible destination airports depending on departure position. + |
+
| RAT:_GetLife(group) | +
+ Get (relative) life of first unit of a group. + |
+
| RAT:_InitAircraft(DCSgroup) | +
+ Initialize basic parameters of the aircraft based on its (template) group in the mission editor. + |
+
| RAT:_ModifySpawnTemplate(waypoints) | +
+ Modifies the template of the group to be spawned. + |
+
| RAT:_OnBirth(EventData) | +
+ Function is executed when a unit is spawned. + |
+
| RAT:_OnCrash(EventData) | +
+ Function is executed when a unit crashes. + |
+
| RAT:_OnDead(EventData) | +
+ Function is executed when a unit is dead. + |
+
| RAT:_OnEngineShutdown(EventData) | +
+ Function is executed when a unit shuts down its engines. + |
+
| RAT:_OnLand(EventData) | +
+ Function is executed when a unit lands. + |
+
| RAT:_OnTakeoff(EventData) | +
+ Function is executed when a unit takes off. + |
+
| RAT:_PickDeparture(takeoff) | +
+ Set the departure airport of the AI. + |
+
| RAT:_PickDestination(destinations, _random) | +
+ Pick destination airport. + |
+
| RAT:_PlaceMarkers(waypoints) | +
+ Place markers of the waypoints. + |
+
| RAT._Random_Gaussian(x0, sigma, xmin, xmax, self) | +
+ Generate Gaussian pseudo-random numbers. + |
+
| RAT:_Randomize(value, fac, lower, upper) | +
+ Randomize a value by a certain amount. + |
+
| RAT:_Respawn(group) | +
+ Respawn a group. + |
+
| RAT:_Routeinfo(waypoints, comment) | +
+ Provide information about the assigned flightplan. + |
+
| RAT:_SetCoalitionTable() | +
+ Create a table with the valid coalitions for departure and destination airports. + |
+
| RAT:_SetMarker(text, wp) | +
+ Set a marker visible for all on the F10 map. + |
+
| RAT:_SetROE(group, roe) | +
+ Set ROE for a group. + |
+
| RAT:_SetROT(group, rot) | +
+ Set ROT for a group. + |
+
| RAT:_SetRoute(Takeoff, _departure, _destination, takeoff) | +
+ Set the route of the AI plane. + |
+
| RAT:_SetStatus(group, status) | +
+ Set status of group. + |
+
| RAT:_SpawnWithRoute(_departure, _destination) | +
+ Spawn the AI aircraft with a route. + |
+
| RAT:_TaskHolding(P1, Altitude, Speed, Duration) | +
+ Orbit at a specified position at a specified alititude with a specified speed. + |
+
| RAT:_Waypoint(Type, Coord, Speed, Altitude, Airport) | +
+ Create a waypoint that can be used with the Route command. + |
+
| RAT.aircraft | +
+ Table which holds the basic aircraft properties (speed, range, ...). + |
+
| RAT.airports | +
+ All airports of friedly coalitions. + |
+
| RAT.airports_map | +
+ All airports available on current map (Caucasus, Nevada, Normandy, ...). + |
+
| RAT.alias | +
+ Alias for spawned group. + |
+
| RAT.alive | +
+ Number of groups which are alive. + |
+
| RAT.cat | ++ + | +
| RAT.category | +
+ Category of aircarft: "plane" or "heli". + |
+
| RAT.coal | +
+ RAT friendly coalitions. + |
+
| RAT.coalition | +
+ Coalition of spawn group template. + |
+
| RAT.commute | +
+ Aircraft commute between departure and destination, i.e. when respawned the departure airport becomes the new destiation. + |
+
| RAT.continuejourney | +
+ Aircraft will continue their journey, i.e. get respawned at their destination with a new random destination. + |
+
| RAT.ctable | +
+ Table with the valid coalitons from choice self.friendly. + |
+
| RAT.debug | +
+ Turn debug messages on or off. + |
+
| RAT.departure_ports | +
+ Array containing the names of the destination airports. + |
+
| RAT.departure_zones | +
+ Array containing the names of the departure zones. + |
+
| RAT.destination_ports | +
+ Array containing the names of the destination airports. + |
+
| RAT.f10menu | +
+ Add an F10 menu for RAT. + |
+
| RAT.friendly | +
+ Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red. + |
+
| RAT.id | +
+ Some ID to identify who we are in output of the DCS.log file. + |
+
| RAT.markerid | +
+ Running number of placed markers on the F10 map. + |
+
| RAT.markerids | +
+ Array with marker IDs. + |
+
| RAT.maxdist | +
+ Max distance from departure to destination in meters. Default 5000 km. + |
+
| RAT.mindist | +
+ Min distance from departure to destination in meters. Default 5 km. + |
+
| RAT.ngroups | +
+ Number of groups to be spawned in total. + |
+
| RAT.placemarkers | +
+ Place markers of waypoints on F10 map. + |
+
| RAT.random_departure | +
+ By default a random friendly airport is chosen as departure. + |
+
| RAT.random_destination | +
+ By default a random friendly airport is chosen as destination. + |
+
| RAT.ratcraft | +
+ Array with the spawned RAT aircraft. + |
+
| RAT.reportstatus | +
+ Aircraft report status. + |
+
| RAT.respawn_at_landing | +
+ Respawn aircraft the moment they land rather than at engine shutdown. + |
+
| RAT.respawn_delay | +
+ Delay in seconds until repawn happens after landing. + |
+
| RAT.roe | +
+ ROE of spawned groups, default is weapon hold (this is a peaceful class for civil aircraft or ferry missions). Possible: "hold", "return", "free". + |
+
| RAT.rot | +
+ ROT of spawned groups, default is no reaction. Possible: "noreaction", "passive", "evade". + |
+
| RAT.spawndelay | +
+ Delay time in seconds before first spawning happens. + |
+
| RAT.spawninterval | +
+ Interval between spawning units/groups. Note that we add a randomization of 50%. + |
+
| RAT.statusinterval | +
+ Intervall between status checks (and reports if enabled). + |
+
| RAT.takeoff | +
+ Takeoff type. 0=coldorhot. + |
+
| RAT.unit | +
+ RAT unit conversions. + |
+
| RAT.wp | +
+ RAT waypoint type. + |
+
Global(s)
+-
+
- + + #RAT + +RAT + + +
-
+
+
RAT class, extends Spawn#SPAWN
+The RAT class implements an easy to use way to randomly fill your map with AI aircraft.
+ + + + +Airport Selection
+ +
+ +
Default settings:
+ +-
+
- By default, aircraft are spawned at airports of their own coalition (blue or red) or neutral airports. +
- Destination airports are by default also of neutral or of the same coalition as the template group of the spawned aircraft. +
- Possible destinations are restricted by their distance to the departure airport. The maximal distance depends on the max range of spawned aircraft type and its initial fuel amount. +
The default behavior can be changed:
+ +-
+
- A specific departure and/or destination airport can be chosen. +
- Valid coalitions can be set, e.g. only red, blue or neutral, all three �colours�. +
- It is possible to start in air within a zone defined in the mission editor or within a zone above an airport of the map. +
Flight Plan
+ +
+ +
-
+
- A general flight plan has five main airborne segments: Climb, cruise, descent, holding and final approach. +
- Events monitored during the flight are: birth, engine-start, take-off, landing and engine-shutdown. +
- The default flight level (FL) is set to ~FL200, i.e. 20000 feet ASL but randomized for each aircraft. + Service ceiling of aircraft type is into account for max FL as well as the distance between departure and destination. +
- Maximal distance between destination and departure airports depends on range and initial fuel of aircraft. +
- Climb rate is set to a moderate value of ~1500 ft/min. +
- The standard descent rate follows the 3:1 rule, i.e. 1000 ft decent per 3 miles of travel. Hence, angle of descent is ~3.6 degrees. +
- A holding point is randomly selected at a distance between 5 and 10 km away from destination airport. +
- The altitude of theholding point is ~1200 m AGL. Holding patterns might or might not happen with variable duration. +
- If an aircraft is spawned in air, the procedure omitts taxi and take-off and starts with the climb/cruising part. +
- All values are randomized for each spawned aircraft. +
Mission Editor Setup
+ +
+ +
Basic mission setup is very simple and essentially a three step process:
+ +-
+
- Place your aircraft anywhere on the map. It really does not matter where you put it. +
- Give the group a good name. In the example above the group is named "RAT_YAK". +
- Activate the "LATE ACTIVATION" tick box. Note that this aircraft will not be spawned itself but serves a template for each RAT aircraft spawned when the mission starts. +
Voil�, your already done!
+ +Optionally, you can set a specific livery for the aircraft or give it some weapons. +However, the aircraft will by default not engage any enemies. Think of them as beeing on a peaceful or ferry mission.
+ +Basic Lua Script
+ +
+ +
The basic Lua script for one template group consits of two simple lines as shown in the picture above.
+ +-
+
- Line 2 creates a new RAT object "yak". The only required parameter for the constructor RAT.New() is the name of the group as defined in the mission editor. In this example it is "RAT_YAK". +
- Line 5 trigger the command to spawn the aircraft. The (optional) parameter for the RAT.Spawn() function is the number of aircraft to be spawned of this object. + By default each of these aircraft gets a random departure airport anywhere on the map and a random destination airport, which lies within range of the of the selected aircraft type. +
In this simple example aircraft are respawned with a completely new flightplan when they have reached their destination airport. +The "old" aircraft is despawned (destroyed) after it has shut-down its engines and a new aircraft of the same type is spawned at a random departure airport anywhere on the map. +Hence, the default flight plan for a RAT aircraft will be: Fly from airport A to B, get respawned at C and fly to D, get respawned at E and fly to F, ... +This ensures that you always have a constant number of AI aircraft on your map.
+ +Examples
+ +Here are a few examples, how you can modify the default settings of RAT class objects.
+ +Specify Departure and Destinations
+ +
+ +
In the picture above you find a few possibilities how to modify the default behaviour to spawn at random airports and fly to random destinations.
+ +In particular, you can specify fixed departure and/or destination airports. This is done via the RAT.SetDeparture() or RAT.SetDestination() functions, respectively.
+ +-
+
- If you only fix a specific departure airport via RAT.SetDeparture() all aircraft will be spawned at that airport and get random destination airports. +
- If you only fix the destination airport via RAT.SetDestination(), aircraft a spawned at random departure airports but will all fly to the destination airport. +
- If you fix departure and destination airports, aircraft will only travel from between those airports. + When the aircraft reaches its destination, it will be respawned at its departure and fly again to its destination. +
There is also an option that allows aircraft to "continue their journey" from their destination. This is achieved by the RAT.ContinueJourney() function. +In that case, when the aircraft arrives at its first destination it will be respawned at that very airport and get a new random destination. +So the flight plan in this case would be: Fly from airport A to B, then from B to C, then from C to D, ...
+ +It is also possible to make aircraft "commute" between two airports, i.e. flying from airport A to B and then back from B to A, etc. +This can be done by the RAT.Commute() function. Note that if no departure or destination airports are specified, the first departure and destination are chosen randomly. +Then the aircraft will fly back and forth between those two airports indefinetly.
+ + +Spawn in Air
+ +
+ +
Aircraft can also be spawned in air rather than at airports on the ground. This is done by setting RAT.SetTakeoff() to "air".
+ +By default, aircraft are spawned randomly above airports of the map.
+ +The RAT.SetDeparture() option can be used to specify zones, which have been defined in the mission editor as departure zones. +Aircraft will then be spawned at a random point within the zone or zones.
+ +Note that RAT.SetDeparture() also accepts airport names. For an air takeoff these are treated like zones with a radius of XX kilometers. +Again, aircraft are spawned at random points within these zones around the airport.
+ +Misc Options
+ +
+ +
The default "takeoff" type of RAT aircraft is that they are spawned with hot or cold engines. +The choice is random, so 50% of aircraft will be spawned with hot engines while the other 50% will be spawned with cold engines. +This setting can be changed using the RAT.SetTakeoff() function. The possible parameters for starting on ground are:
+ +-
+
- RAT.SetTakeoff("cold"), which means that all aircraft are spawned with their engines off, +
- RAT.SetTakeoff("hot"), which means that all aircraft are spawned with their engines on, +
- RAT.SetTakeoff("runway"), which means that all aircraft are spawned already at the runway ready to takeoff. + Note that in this case the default spawn intervall is set to 180 seconds in order to avoid aircraft jamms on the runway. Generally, this takeoff at runways should be used with care and problems are to be expected. +
The options RAT.SetMinDistance() and RAT.SetMaxDistance() can be used to restrict the range from departure to destination. For example
+ +-
+
- RAT.SetMinDistance(100) will cause only random destination airports to be selected which are at least 100 km away from the departure airport. +
- RAT.SetMaxDistance(150) will allow only destination airports which are less than 150 km away from the departure airport. +
Certain other options like the flight level can also be specified. However, note that this might not be a good idea for random departures and/or destinations. +For example the random route might be too short to reach that altitude, which would result in very high climb and descent rates or strange flight plans.
+ + + +
+
Type Rat
+
+ Type RAT
+
+-
+
- RAT class +
Field(s)
+-
+
- + + #number + +RAT.AlphaDescent + + +
-
+
+
Default angle of descenti in degrees. A value of 3.6 follows the 3:1 rule of 3 miles of travel and 1000 ft descent.
+ +
+
-
+
- + + #string + +RAT.ClassName + + +
-
+
+
Name of the Class.
+ +
+
-
+
- + + +RAT:Commute(switch) + + +
-
+
+
Aircraft will commute between their departure and destination airports.
+ + +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.
+ +Parameter
+-
+
-
+
+
+ +#boolean switch: +Turn commute on=true or off=false. If no value is given switch=true.
+
+ -
+
+
-
+
- + + +RAT:ContinueJourney(switch) + + +
-
+
+
Aircraft will continue their journey from their destination.
+ + +This means they are respawned at their destination and get a new random destination.
+ +Parameter
+-
+
-
+
+
+ +#boolean switch: +Turn journey on=true or off=false. If no value is given switch=true.
+
+ -
+
+
-
+
- + + #number + +RAT.FLmaxuser + + +
-
+
+
Maximum flight level set by user.
+ +
+
-
+
- + + #number + +RAT.FLminuser + + +
-
+
+
Minimum flight level set by user.
+ +
+
-
+
- + + #number + +RAT.FLuser + + +
-
+
+
Flight level set by users explicitly.
+ +
+
-
+
- + + #table + +RAT.Menu + + +
-
+
+
F10 menu items for this RAT object.
+ +
+
-
+
- + + #string + +RAT.MenuF10 + + +
-
+
+
Main F10 menu.
+ +
+
-
+
- + + +RAT:MenuName(name) + + +
-
+
+
Set the name of the F10 submenu.
+ + +Default is the name of the template group.
+ +Parameter
+-
+
-
+
+
+ +#string name: +Submenu name.
+
+ -
+
+
-
+
- + + +RAT:New(groupname, alias) + + +
-
+
+
Create a new RAT object.
+ +Parameters
+-
+
-
+
+
+ +#string groupname: +Name of the group as defined in the mission editor. This group is serving as a template for all spawned units.
+ -
+
+
+ +#string alias: +(Optional) Alias of the group. This is and optional parameter but must(!) be used if the same template group is used for more than one RAT object.
+
Return values
+-
+
-
+
+
#RAT: +Object of RAT class.
+ +
+ -
+
+
#nil: +If the group does not exist in the mission editor.
+ +
+
Usages:
+-
+
yak1:RAT("RAT_YAK") will create a RAT object called "yak1". The template group in the mission editor must have the name "RAT_YAK".
+ yak2:RAT("RAT_YAK", "Yak2") will create a RAT object "yak2". The template group in the mission editor must have the name "RAT_YAK" but the group will be called "Yak2" in e.g. the F10 menu.
+
+ -
+
+
-
+
- + + +RAT:PlaceMarkers(switch) + + +
-
+
+
Place markers of waypoints on the F10 map.
+ + +Default is off.
+ +Parameter
+-
+
-
+
+
+ +#boolean switch: +true=yes, false=no.
+
+ -
+
+
-
+
- + + + +RAT.ROE + + +
-
+
+
RAT rules of engagement.
+ +
+
-
+
- + + + +RAT.ROT + + +
-
+
+
RAT reaction to threat.
+ +
+
-
+
- + + +RAT:RespawnAfterLanding(delay) + + +
-
+
+
Make aircraft respawn the moment they land rather than at engine shut down.
+ +Parameter
+-
+
-
+
+
+ +#number delay: +(Optional) Delay in seconds until respawn happens after landing. Default is 180 seconds.
+
+ -
+
+
-
+
- + + +RAT:SetClimbRate(rate) + + +
-
+
+
Set the climb rate.
+ + +Default is 1500 ft/min. This automatically sets the climb angle.
+ +Parameter
+-
+
-
+
+
+ +#number rate: +Climb rate in ft/min.
+
+ -
+
+
-
+
- + + +RAT:SetCoalition(friendly) + + +
-
+
+
Set the friendly coalitions from which the airports can be used as departure or destination.
+ +Parameter
+-
+
-
+
+
+ +#string friendly: +"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.
+
Usages:
+-
+
yak:SetCoalition("all") will spawn aircraft randomly on airports of any coaliton, i.e. red, blue and neutral, regardless of its own coalition.
+ yak:SetCoalition("redonly") will spawn aircraft randomly on airports belonging to the red coalition _only_.
+
+ -
+
+
-
+
- + + +RAT:SetDeparture(names) + + +
-
+
+
Set possible departure ports.
+ + +This can be an airport or a zone defined in the mission editor.
+ +Parameter
+-
+
-
+
+
+ +#string names: +Name or table of names of departure airports or zones.
+
Usages:
+-
+
RAT:SetDeparture("Sochi-Adler") will spawn RAT objects at Sochi-Adler airport.
+ RAT:SetDeparture({"Sochi-Adler", "Gudauta"}) will spawn RAT aircraft radomly at Sochi-Adler or Gudauta airport.
+ 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.
+
+ -
+
+
-
+
- + + +RAT:SetDescentAngle(angle) + + +
-
+
+
Set the angle of descent.
+ + +Default is 3.6 degrees, which corresponds to 3000 ft descent after one mile of travel.
+ +Parameter
+-
+
-
+
+
+ +#number angle: +Angle of descent in degrees.
+
+ -
+
+
-
+
- + + +RAT:SetDestination(names) + + +
-
+
+
Set name of destination airport for the AI aircraft.
+ + +If no name is given an airport from the friendly coalition(s) is chosen randomly.
+ +Parameter
+-
+
-
+
+
+ +#string names: +Name of the destination airport or table of destination airports.
+
Usage:
+
+ +RAT:SetDestination("Krymsk") makes all aircraft of this RAT oject fly to Krymsk airport.
+ -
+
+
-
+
- + + +RAT:SetFL(height) + + +
-
+
+
Set flight level.
+ + +Setting this value will overrule all other logic. Aircraft will try to fly at this height regardless.
+ +Parameter
+-
+
-
+
+
+ +#number height: +FL in hundrets of feet. E.g. FL200 = 20000 ft ASL.
+
+ -
+
+
-
+
- + + +RAT:SetFLcruise(height) + + +
-
+
+
Set flight level of cruising part.
+ + +This is still be checked for consitancy with selected route and prone to radomization. +Default is FL200 for planes and FL005 for helicopters.
+ +Parameter
+-
+
-
+
+
+ +#number height: +FL in hundrets of feet. E.g. FL200 = 20000 ft ASL.
+
+ -
+
+
-
+
- + + +RAT:SetFLmax(height) + + +
-
+
+
Set max flight level.
+ + +Setting this value will overrule all other logic. Aircraft will try to fly at less than this FL regardless.
+ +Parameter
+-
+
-
+
+
+ +#number height: +Maximum FL in hundrets of feet.
+
+ -
+
+
-
+
- + + +RAT:SetFLmin(height) + + +
-
+
+
Set min flight level.
+ + +Setting this value will overrule all other logic. Aircraft will try to fly at higher than this FL regardless.
+ +Parameter
+-
+
-
+
+
+ +#number height: +Maximum FL in hundrets of feet.
+
+ -
+
+
-
+
- + + +RAT:SetMaxCruiseSpeed(speed) + + +
-
+
+
Set the maximum cruise speed of the aircraft.
+ +Parameter
+-
+
-
+
+
+ +#number speed: +Speed in km/h.
+
+ -
+
+
-
+
- + + +RAT:SetMaxDistance(dist) + + +
-
+
+
Set maximum distance between departure and destination.
+ + +Default is 5000 km but aircarft range is also taken into account automatically.
+ +Parameter
+-
+
-
+
+
+ +#number dist: +Distance in km.
+
+ -
+
+
-
+
- + + +RAT:SetMinDistance(dist) + + +
-
+
+
Set minimum distance between departure and destination.
+ + +Default is 5 km. +Minimum distance should not be smaller than maybe ~500 meters to ensure that departure and destination are different.
+ +Parameter
+-
+
-
+
+
+ +#number dist: +Distance in km.
+
+ -
+
+
-
+
- + + +RAT:SetROE(roe) + + +
-
+
+
Set rules of engagement (ROE).
+ + +Default is weapon hold. This is a peaceful class.
+ +Parameter
+-
+
-
+
+
+ +#string roe: +"hold" = weapon hold, "return" = return fire, "free" = weapons free.
+
+ -
+
+
-
+
- + + +RAT:SetROT(rot) + + +
-
+
+
Set reaction to threat (ROT).
+ + +Default is no reaction, i.e. aircraft will simply ignore all enemies.
+ +Parameter
+-
+
-
+
+
+ +#string rot: +"noreaction" = no reaction to threats, "passive" = passive defence, "evade" = evade enemy attacks.
+
+ -
+
+
-
+
- + + +RAT:SetSpawnDelay(delay) + + +
-
+
+
Set the delay before first group is spawned.
+ + +Minimum delay is 0.5 seconds.
+ +Parameter
+-
+
-
+
+
+ +#number delay: +Delay in seconds.
+
+ -
+
+
-
+
- + + +RAT:SetSpawnInterval(interval) + + +
-
+
+
Set the interval between spawnings of the template group.
+ + +Minimum interval is 0.5 seconds.
+ +Parameter
+-
+
-
+
+
+ +#number interval: +Interval in seconds.
+
+ -
+
+
-
+
- + + +RAT:SetTakeoff(type) + + +
-
+
+
Set takeoff type.
+ + +Starting cold at airport, starting hot at airport, starting at runway, starting in the air. +Default is "takeoff-coldorhot". So there is a 50% chance that the aircraft starts with cold engines and 50% that it starts with hot engines.
+ +Parameter
+-
+
-
+
+
+ +#string type: +Type can be "takeoff-cold" or "cold", "takeoff-hot" or "hot", "takeoff-runway" or "runway", "air".
+
Usages:
+-
+
RAT:Takeoff("hot") will spawn RAT objects at airports with engines started.
+ RAT:Takeoff("cold") will spawn RAT objects at airports with engines off.
+ RAT:Takeoff("air") will spawn RAT objects in air over random airports or within pre-defined zones.
+
+ -
+
+
-
+
- + + +RAT:Spawn(naircraft) + + +
-
+
+
Triggers the spawning of AI aircraft.
+ + +Note that all additional options should be set before giving the spawn command.
+ +Parameter
+-
+
-
+
+
+ +#number naircraft: +(Optional) Number of aircraft to spawn. Default is one aircraft.
+
Usage:
+
+ +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.
+ -
+
+
-
+
- + + +RAT:Status(message, forID) + + +
-
+
+
Report status of RAT groups.
+ +Parameters
+-
+
-
+
+
+ +#boolean message: +(Optional) Send message with report to all if true.
+ -
+
+
+ +#number forID: +(Optional) Send message only for this ID.
+
+ -
+
+
-
+
- + + +RAT:StatusReports(switch) + + +
-
+
+
Aircraft report status messages.
+ + +Default is off.
+ +Parameter
+-
+
-
+
+
+ +#boolean switch: +true=on, false=off.
+
+ -
+
+
-
+
- + + #string + +RAT.SubMenuName + + +
-
+
+
Submenu name for RAT object.
+ +
+
-
+
- + + +RAT:TimeDestroyInactive(time) + + +
-
+
+
Set the time after which inactive groups will be destroyed.
+ + +Default is 180 seconds.
+ +Parameter
+-
+
-
+
+
+ +#number time: +Time in seconds.
+
+ -
+
+
-
+
- + + #number + +RAT.Tinactive + + +
-
+
+
Time in seconds after which inactive units will be destroyed. Default is 180 seconds.
+ +
+
-
+
- + + #number + +RAT.Vclimb + + +
-
+
+
Default climb rate in ft/min.
+ +
+
-
+
- + + #number + +RAT.Vcruisemax + + +
-
+
+
Max cruise speed in m/s (250 m/s = 900 km/h = 486 kt) set by user.
+ +
+
-
+
- + + +RAT:_AirportExists(name) + + +
-
+
+
Test if an airport exists on the current map.
+ +Parameter
+-
+
-
+
+
+ +#string name:
+
Return value
+ +#boolean: +True if airport exsits, false otherwise.
+ +
+ -
+
+
-
+
- + + +RAT:_Course(a, b) + + +
-
+
+
Determine the heading from point a to point b.
+ +Parameters
+-
+
-
+
+
+ +Core.Point#COORDINATE a: +Point from.
+ -
+
+
+ +Core.Point#COORDINATE b: +Point to.
+
Return value
+ +#number: +Heading/angle in degrees.
+ +
+ -
+
+
-
+
- + + +RAT:_Debug(switch) + + +
-
+
+
Turn debug messages on or off.
+ + +Default is off.
+ +Parameter
+-
+
-
+
+
+ +#boolean switch: +true turn messages on, false=off.
+
+ -
+
+
-
+
- + + +RAT:_DeleteMarkers() + + +
-
+
+
Delete all markers on F10 map.
+ +
+
-
+
- + + +RAT:_Despawn(group) + + +
-
+
+
Despawn unit.
+ + +Unit gets destoyed and group is set to nil. +Index of ratcraft array is taken from spawned group name.
+ +Parameter
+-
+
-
+
+
+ +Wrapper.Group#GROUP group: +Group to be despawned.
+
+ -
+
+
-
+
- + + +RAT:_EngineStartup(EventData) + + +
-
+
+
Function is executed when a unit starts its engines.
+ +Parameter
+-
+
-
+
+
+ +EventData:
+
+ -
+
+
-
+
- + + +RAT:_FLmax(alpha, beta, d, phi, h0) + + +
-
+
+
Calculate the max flight level for a given distance and fixed climb and descent rates.
+ + +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.
+ +Parameters
+-
+
-
+
+
+ +#number alpha: +Angle of climb [rad].
+ -
+
+
+ +#number beta: +Angle of descent [rad].
+ -
+
+
+ +#number d: +Distance between the two airports [m].
+ -
+
+
+ +#number phi: +Angle between departure and destination [rad].
+ -
+
+
+ +#number h0: +Height [m] of departure airport. Note we implicitly assume that the height difference between departure and destination is negligible.
+
Return value
+ +#number: + Maximal flight level in meters.
+ +
+ -
+
+
-
+
- + + +RAT:_GetAirportsOfCoalition() + + +
-
+
+
Get all "friendly" airports of the current map.
+ +
+
-
+
- + + +RAT:_GetAirportsOfMap() + + +
-
+
+
Get all airports of the current map.
+ +
+
-
+
- + + +RAT:_GetDestinations(q, minrange, maxrange) + + +
-
+
+
Get all possible destination airports depending on departure position.
+ + +The list is sorted w.r.t. distance to departure position.
+ +Parameters
+-
+
-
+
+
+ +Core.Point#COORDINATE q: +Coordinate of the departure point.
+ -
+
+
+ +#number minrange: +Minimum range to q in meters.
+ -
+
+
+ +#number maxrange: +Maximum range to q in meters.
+
Return values
+-
+
-
+
+
#table: +Table with possible destination airports.
+ +
+ -
+
+
#nil: +If no airports could be found.
+ +
+
+ -
+
+
-
+
- + + +RAT:_GetLife(group) + + +
-
+
+
Get (relative) life of first unit of a group.
+ +Parameter
+-
+
-
+
+
+ +Wrapper.Group#GROUP group: +Group of unit.
+
Return value
+ +#number: +Life of unit in percent.
+ +
+ -
+
+
-
+
- + + +RAT:_InitAircraft(DCSgroup) + + +
-
+
+
Initialize basic parameters of the aircraft based on its (template) group in the mission editor.
+ +Parameter
+-
+
-
+
+
+ +Dcs.DCSWrapper.Group#Group DCSgroup: +Group of the aircraft in the mission editor.
+
+ -
+
+
-
+
- + + +RAT:_ModifySpawnTemplate(waypoints) + + +
-
+
+
Modifies the template of the group to be spawned.
+ + +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".
+ +Parameter
+-
+
-
+
+
+ +#table waypoints: +The waypoints of the AI flight plan.
+
+ -
+
+
-
+
- + + +RAT:_OnBirth(EventData) + + +
-
+
+
Function is executed when a unit is spawned.
+ +Parameter
+-
+
-
+
+
+ +EventData:
+
+ -
+
+
-
+
- + + +RAT:_OnCrash(EventData) + + +
-
+
+
Function is executed when a unit crashes.
+ +Parameter
+-
+
-
+
+
+ +EventData:
+
+ -
+
+
-
+
- + + +RAT:_OnDead(EventData) + + +
-
+
+
Function is executed when a unit is dead.
+ +Parameter
+-
+
-
+
+
+ +EventData:
+
+ -
+
+
-
+
- + + +RAT:_OnEngineShutdown(EventData) + + +
-
+
+
Function is executed when a unit shuts down its engines.
+ +Parameter
+-
+
-
+
+
+ +EventData:
+
+ -
+
+
-
+
- + + +RAT:_OnLand(EventData) + + +
-
+
+
Function is executed when a unit lands.
+ +Parameter
+-
+
-
+
+
+ +EventData:
+
+ -
+
+
-
+
- + + +RAT:_OnTakeoff(EventData) + + +
-
+
+
Function is executed when a unit takes off.
+ +Parameter
+-
+
-
+
+
+ +EventData:
+
+ -
+
+
-
+
- + + +RAT:_PickDeparture(takeoff) + + +
-
+
+
Set the departure airport of the AI.
+ + +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.
+ +Parameter
+-
+
-
+
+
+ +#number takeoff: +Takeoff type.
+
Return values
+-
+
-
+
+
Wrapper.Airbase#AIRBASE: +Departure airport if spawning at airport.
+ +
+ -
+
+
Coore.Zone#ZONE: +Departure zone if spawning in air.
+ +
+
+ -
+
+
-
+
- + + +RAT:_PickDestination(destinations, _random) + + +
-
+
+
Pick destination airport.
+ + +If no airport name is given an airport from the coalition is chosen randomly.
+ +Parameters
+-
+
-
+
+
+ +#table destinations: +Table with destination airports.
+ -
+
+
+ +#boolean _random: +(Optional) Switch to activate a random selection of airports.
+
Return value
+ +Wrapper.Airbase#AIRBASE: +Destination airport.
+ +
+ -
+
+
-
+
- + + +RAT:_PlaceMarkers(waypoints) + + +
-
+
+
Place markers of the waypoints.
+ + +Note we assume a very specific number and type of waypoints here.
+ +Parameter
+-
+
-
+
+
+ +#table waypoints: +Table with waypoints.
+
+ -
+
+
-
+
- + + +RAT._Random_Gaussian(x0, sigma, xmin, xmax, self) + + +
-
+
+
Generate Gaussian pseudo-random numbers.
+ +Parameters
+-
+
-
+
+
+ +#number x0: +Expectation value of distribution.
+ -
+
+
+ +#number sigma: +(Optional) Standard deviation. Default 10.
+ -
+
+
+ +#number xmin: +(Optional) Lower cut-off value.
+ -
+
+
+ +#number xmax: +(Optional) Upper cut-off value.
+ -
+
+
+ +self:
+
Return value
+ +#number: +Gaussian random number.
+ +
+ -
+
+
-
+
- + + +RAT:_Randomize(value, fac, lower, upper) + + +
-
+
+
Randomize a value by a certain amount.
+ +Parameters
+-
+
-
+
+
+ +#number value: +The value which should be randomized
+ -
+
+
+ +#number fac: +Randomization factor.
+ -
+
+
+ +#number lower: +(Optional) Lower limit of the returned value.
+ -
+
+
+ +#number upper: +(Optional) Upper limit of the returned value.
+
Return value
+ +#number: +Randomized value.
+ +Usages:
+-
+
_Randomize(100, 0.1) returns a value between 90 and 110, i.e. a plus/minus ten percent variation.
+ _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.
+
+ -
+
+
-
+
- + + +RAT:_Respawn(group) + + +
-
+
+
Respawn a group.
+ +Parameter
+-
+
-
+
+
+ +Wrapper.Group#GROUP group: +Group to be repawned.
+
+ -
+
+
-
+
- + + +RAT:_Routeinfo(waypoints, comment) + + +
-
+
+
Provide information about the assigned flightplan.
+ +Parameters
+-
+
-
+
+
+ +#table waypoints: +Waypoints of the flight plan.
+ -
+
+
+ +#string comment: +Some comment to identify the provided information.
+
Return value
+ +#number: +total Total route length in meters.
+ +
+ -
+
+
-
+
- + + +RAT:_SetCoalitionTable() + + +
-
+
+
Create a table with the valid coalitions for departure and destination airports.
+ +
+
-
+
- + + +RAT:_SetMarker(text, wp) + + +
-
+
+
Set a marker visible for all on the F10 map.
+ +Parameters
+-
+
-
+
+
+ +#string text: +Info text displayed at maker.
+ -
+
+
+ +#table wp: +Position of marker coming in as waypoint, i.e. has x, y and alt components.
+
+ -
+
+
-
+
- + + +RAT:_SetROE(group, roe) + + +
-
+
+
Set ROE for a group.
+ +Parameters
+-
+
-
+
+
+ +Wrapper.Group#GROUP group: +Group for which the ROE is set.
+ -
+
+
+ +#string roe: +ROE of group.
+
+ -
+
+
-
+
- + + +RAT:_SetROT(group, rot) + + +
-
+
+
Set ROT for a group.
+ +Parameters
+-
+
-
+
+
+ +Wrapper.Group#GROUP group: +Group for which the ROT is set.
+ -
+
+
+ +#string rot: +ROT of group.
+
+ -
+
+
-
+
- + + +RAT:_SetRoute(Takeoff, _departure, _destination, takeoff) + + +
-
+
+
Set the route of the AI plane.
+ + +Due to DCS landing bug, this has to be done before the unit is spawned.
+ +Parameters
+-
+
-
+
+
+ +takeoff#RAT.wp Takeoff: +type.
+ -
+
+
+ +Wrapper.Airport#AIRBASE _departure: +(Optional) Departure airbase.
+ -
+
+
+ +Wrapper.Airport#AIRBASE _destination: +(Optional) Destination airbase.
+ -
+
+
+ +takeoff:
+
Return values
+-
+
-
+
+
Wrapper.Airport#AIRBASE: +Departure airbase.
+ +
+ -
+
+
Wrapper.Airport#AIRBASE: +Destination airbase.
+ +
+ -
+
+
#table: +Table of flight plan waypoints.
+ +
+ -
+
+
#nil: +If no valid departure or destination airport could be found.
+ +
+
+ -
+
+
-
+
- + + +RAT:_SetStatus(group, status) + + +
-
+
+
Set status of group.
+ +Parameters
+-
+
-
+
+
+ +group:
+ -
+
+
+ +status:
+
+ -
+
+
-
+
- + + +RAT:_SpawnWithRoute(_departure, _destination) + + +
-
+
+
Spawn the AI aircraft with a route.
+ + +Sets the departure and destination airports and waypoints. +Modifies the spawn template. +Sets ROE/ROT. +Initializes the ratcraft array and group menu.
+ +Parameters
+-
+
-
+
+
+ +#string _departure: +(Optional) Name of departure airbase.
+ -
+
+
+ +#string _destination: +(Optional) Name of destination airbase.
+
+ -
+
+
-
+
- + + +RAT:_TaskHolding(P1, Altitude, Speed, Duration) + + +
-
+
+
Orbit at a specified position at a specified alititude with a specified speed.
+ +Parameters
+-
+
-
+
+
+ +Dcs.DCSTypes#Vec2 P1: +The point to hold the position.
+ -
+
+
+ +#number Altitude: +The altitude ASL at which to hold the position.
+ -
+
+
+ +#number Speed: +The speed flying when holding the position in m/s.
+ -
+
+
+ +#number Duration: +Duration of holding pattern in seconds.
+
Return value
+ +Dcs.DCSTasking.Task#Task: +DCSTask
+ +
+ -
+
+
-
+
- + + +RAT:_Waypoint(Type, Coord, Speed, Altitude, Airport) + + +
-
+
+
Create a waypoint that can be used with the Route command.
+ +Parameters
+-
+
-
+
+
+ +#number Type: +Type of waypoint.
+ -
+
+
+ +Core.Point#COORDINATE Coord: +3D coordinate of the waypoint.
+ -
+
+
+ +#number Speed: +Speed in m/s.
+ -
+
+
+ +#number Altitude: +Altitude in m.
+ -
+
+
+ +Wrapper.Airbase#AIRBASE Airport: +Airport of object to spawn.
+
Return value
+ +#table: +Waypoints for DCS task route or spawn template.
+ +
+ -
+
+
-
+
- + + #table + +RAT.aircraft + + +
-
+
+
Table which holds the basic aircraft properties (speed, range, ...).
+ +
+
-
+
- + + #table + +RAT.airports + + +
-
+
+
All airports of friedly coalitions.
+ +
+
-
+
- + + #table + +RAT.airports_map + + +
-
+
+
All airports available on current map (Caucasus, Nevada, Normandy, ...).
+ +
+
-
+
- + + #string + +RAT.alias + + +
-
+
+
Alias for spawned group.
+ +
+
-
+
- + + #number + +RAT.alive + + +
-
+
+
Number of groups which are alive.
+ +
+
-
+
- + + + +RAT.cat + + +
- + + + + +
-
+
- + + #string + +RAT.category + + +
-
+
+
Category of aircarft: "plane" or "heli".
+ +
+
-
+
- + + + +RAT.coal + + +
-
+
+
RAT friendly coalitions.
+ +
+
-
+
- + + #number + +RAT.coalition + + +
-
+
+
Coalition of spawn group template.
+ +
+
-
+
- + + #boolean + +RAT.commute + + +
-
+
+
Aircraft commute between departure and destination, i.e. when respawned the departure airport becomes the new destiation.
+ +
+
-
+
- + + #boolean + +RAT.continuejourney + + +
-
+
+
Aircraft will continue their journey, i.e. get respawned at their destination with a new random destination.
+ +
+
-
+
- + + #table + +RAT.ctable + + +
-
+
+
Table with the valid coalitons from choice self.friendly.
+ +
+
-
+
- + + #boolean + +RAT.debug + + +
-
+
+
Turn debug messages on or off.
+ +
+
-
+
- + + #table + +RAT.departure_ports + + +
-
+
+
Array containing the names of the destination airports.
+ +
+
-
+
- + + #table + +RAT.departure_zones + + +
-
+
+
Array containing the names of the departure zones.
+ +
+
-
+
- + + #table + +RAT.destination_ports + + +
-
+
+
Array containing the names of the destination airports.
+ +
+
-
+
- + + #boolean + +RAT.f10menu + + +
-
+
+
Add an F10 menu for RAT.
+ +
+
-
+
- + + #string + +RAT.friendly + + +
-
+
+
Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red.
+ +
+
-
+
- + + #string + +RAT.id + + +
-
+
+
Some ID to identify who we are in output of the DCS.log file.
+ +
+
-
+
- + + #number + +RAT.markerid + + +
-
+
+
Running number of placed markers on the F10 map.
+ +
+
-
+
- + + #table + +RAT.markerids + + +
-
+
+
Array with marker IDs.
+ +
+
-
+
- + + #number + +RAT.maxdist + + +
-
+
+
Max distance from departure to destination in meters. Default 5000 km.
+ +
+
-
+
- + + #number + +RAT.mindist + + +
-
+
+
Min distance from departure to destination in meters. Default 5 km.
+ +
+
-
+
- + + #number + +RAT.ngroups + + +
-
+
+
Number of groups to be spawned in total.
+ +
+
-
+
- + + #boolean + +RAT.placemarkers + + +
-
+
+
Place markers of waypoints on F10 map.
+ +
+
-
+
- + + #boolean + +RAT.random_departure + + +
-
+
+
By default a random friendly airport is chosen as departure.
+ +
+
-
+
- + + #boolean + +RAT.random_destination + + +
-
+
+
By default a random friendly airport is chosen as destination.
+ +
+
-
+
- + + #table + +RAT.ratcraft + + +
-
+
+
Array with the spawned RAT aircraft.
+ +
+
-
+
- + + #boolean + +RAT.reportstatus + + +
-
+
+
Aircraft report status.
+ +
+
-
+
- + + #boolean + +RAT.respawn_at_landing + + +
-
+
+
Respawn aircraft the moment they land rather than at engine shutdown.
+ +
+
-
+
- + + #number + +RAT.respawn_delay + + +
-
+
+
Delay in seconds until repawn happens after landing.
+ +
+
-
+
- + + #string + +RAT.roe + + +
-
+
+
ROE of spawned groups, default is weapon hold (this is a peaceful class for civil aircraft or ferry missions). Possible: "hold", "return", "free".
+ +
+
-
+
- + + #string + +RAT.rot + + +
-
+
+
ROT of spawned groups, default is no reaction. Possible: "noreaction", "passive", "evade".
+ +
+
-
+
- + + #number + +RAT.spawndelay + + +
-
+
+
Delay time in seconds before first spawning happens.
+ +
+
-
+
- + + #number + +RAT.spawninterval + + +
-
+
+
Interval between spawning units/groups. Note that we add a randomization of 50%.
+ +
+
-
+
- + + #number + +RAT.statusinterval + + +
-
+
+
Intervall between status checks (and reports if enabled).
+ +
+
-
+
- + + #string + +RAT.takeoff + + +
-
+
+
Takeoff type. 0=coldorhot.
+ +
+
-
+
- + + + +RAT.unit + + +
-
+
+
RAT unit conversions.
+ +
+
-
+
- + + + +RAT.wp + + +
-
+
+
RAT waypoint type.
+ +
+