diff --git a/Moose Development/Moose/Functional/RAT.lua b/Moose Development/Moose/Functional/RAT.lua new file mode 100644 index 000000000..4d7da7fcf --- /dev/null +++ b/Moose Development/Moose/Functional/RAT.lua @@ -0,0 +1,2618 @@ +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +--- **Functional** - Create random airtraffic in your missions. +-- +-- ![Banner Image](..\Presentations\RAT\RAT.png) +-- +-- ==== +-- +-- 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](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) +-- +-- ==== +-- +-- # YouTube Channel +-- +-- ### [RAT YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl1jirWIo4t4YxqN-HxjqRkL) +-- +-- === +-- +-- ### Author: **[funkyfranky](https://forums.eagle.ru/member.php?u=115026)** +-- +-- ### Contributions: **Sven van de Velde ([FlightControl](https://forums.eagle.ru/member.php?u=89536))** +-- +-- ==== +-- @module Rat + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +--- RAT class +-- @type RAT +-- @field #string ClassName Name of the Class. +-- @field #boolean debug Turn debug messages on or off. +-- @field #string alias Alias for spawned group. +-- @field #number spawndelay Delay time in seconds before first spawning happens. +-- @field #number spawninterval Interval between spawning units/groups. Note that we add a randomization of 50%. +-- @field #number coalition Coalition of spawn group template. +-- @field #string category Category of aircarft: "plane" or "heli". +-- @field #string friendly Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red. +-- @field #table ctable Table with the valid coalitons from choice self.friendly. +-- @field #table aircraft Table which holds the basic aircraft properties (speed, range, ...). +-- @field #number Vcruisemax Max cruise speed in m/s (250 m/s = 900 km/h = 486 kt) set by user. +-- @field #number Vclimb Default climb rate in ft/min. +-- @field #number 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. +-- @field #string roe ROE of spawned groups, default is weapon hold (this is a peaceful class for civil aircraft or ferry missions). Possible: "hold", "return", "free". +-- @field #string rot ROT of spawned groups, default is no reaction. Possible: "noreaction", "passive", "evade". +-- @field #string takeoff Takeoff type. 0=coldorhot. +-- @field #number mindist Min distance from departure to destination in meters. Default 5 km. +-- @field #number maxdist Max distance from departure to destination in meters. Default 5000 km. +-- @field #table airports_map All airports available on current map (Caucasus, Nevada, Normandy, ...). +-- @field #table airports All airports of friedly coalitions. +-- @field #boolean random_departure By default a random friendly airport is chosen as departure. +-- @field #boolean random_destination By default a random friendly airport is chosen as destination. +-- @field #table departure_zones Array containing the names of the departure zones. +-- @field #table departure_ports Array containing the names of the destination airports. +-- @field #table destination_ports Array containing the names of the destination airports. +-- @field #table ratcraft Array with the spawned RAT aircraft. +-- @field #number Tinactive Time in seconds after which inactive units will be destroyed. Default is 180 seconds. +-- @field #boolean reportstatus Aircraft report status. +-- @field #number statusinterval Intervall between status checks (and reports if enabled). +-- @field #boolean placemarkers Place markers of waypoints on F10 map. +-- @field #number FLuser Flight level set by users explicitly. +-- @field #number FLminuser Minimum flight level set by user. +-- @field #number FLmaxuser Maximum flight level set by user. +-- @field #boolean commute Aircraft commute between departure and destination, i.e. when respawned the departure airport becomes the new destiation. +-- @field #boolean continuejourney Aircraft will continue their journey, i.e. get respawned at their destination with a new random destination. +-- @field #number ngroups Number of groups to be spawned in total. +-- @field #number alive Number of groups which are alive. +-- @field #boolean f10menu Add an F10 menu for RAT. +-- @field #table Menu F10 menu items for this RAT object. +-- @field #string SubMenuName Submenu name for RAT object. +-- @field #boolean respawn_at_landing Respawn aircraft the moment they land rather than at engine shutdown. +-- @field #number respawn_delay Delay in seconds until repawn happens after landing. +-- @field #table markerids Array with marker IDs. +-- @extends Functional.Spawn#SPAWN + +---# RAT class, extends @{Spawn#SPAWN} +-- The RAT class implements an easy to use way to randomly fill your map with AI aircraft. +-- +-- +-- ## Airport Selection +-- +-- ![Process](..\Presentations\RAT\RAT_Airport_Selection.png) +-- +-- ### 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 +-- +-- ![Process](..\Presentations\RAT\RAT_Flight_Plan.png) +-- +-- * 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 +-- +-- ![Process](..\Presentations\RAT\RAT_Mission_Setup.png) +-- +-- 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 +-- +-- ![Process](..\Presentations\RAT\RAT_Basic_Lua_Script.png) +-- +-- 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 +-- +-- ![Process](..\Presentations\RAT\RAT_Examples_Specify_Departure_and_Destination.png) +-- +-- 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 +-- +-- ![Process](..\Presentations\RAT\RAT_Examples_Spawn_in_Air.png) +-- +-- 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 +-- +-- ![Process](..\Presentations\RAT\RAT_Examples_Misc.png) +-- +-- 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. +-- +-- +-- @field #RAT +RAT={ + ClassName = "RAT", -- Name of class: RAT = Random Air Traffic. + debug=false, -- Turn debug messages on or off. + alias=nil, -- Alias for spawned group. + spawndelay=5, -- Delay time in seconds before first spawning happens. + spawninterval=5, -- Interval between spawning units/groups. Note that we add a randomization of 50%. + coalition = nil, -- Coalition of spawn group template. + category = nil, -- Category of aircarft: "plane" or "heli". + friendly = "same", -- Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red. + ctable = {}, -- Table with the valid coalitons from choice self.friendly. + aircraft = {}, -- Table which holds the basic aircraft properties (speed, range, ...). + Vcruisemax=nil, -- Max cruise speed in set by user. + Vclimb=1500, -- Default climb rate in ft/min. + AlphaDescent=3.6, -- 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. + roe = "hold", -- ROE of spawned groups, default is weapon hold (this is a peaceful class for civil aircraft or ferry missions). Possible: "hold", "return", "free". + rot = "noreaction", -- ROT of spawned groups, default is no reaction. Possible: "noreaction", "passive", "evade". + takeoff = 0, -- Takeoff type. 0=coldorhot. + mindist = 5000, -- Min distance from departure to destination in meters. Default 5 km. + maxdist = 500000, -- Max distance from departure to destination in meters. Default 5000 km. + airports_map={}, -- All airports available on current map (Caucasus, Nevada, Normandy, ...). + airports={}, -- All airports of friedly coalitions. + random_departure=true, -- By default a random friendly airport is chosen as departure. + random_destination=true, -- By default a random friendly airport is chosen as destination. + departure_zones={}, -- Array containing the names of the departure zones. + departure_ports={}, -- Array containing the names of the departure airports. + destination_ports={}, -- Array containing the names of the destination airports. + ratcraft={}, -- Array with the spawned RAT aircraft. + Tinactive=180, -- Time in seconds after which inactive units will be destroyed. Default is 180 seconds. + reportstatus=false, -- Aircraft report status. + statusinterval=30, -- Intervall between status checks (and reports if enabled). + placemarkers=false, -- Place markers of waypoints on F10 map. + FLminuser=nil, -- Minimum flight level set by user. + FLmaxuser=nil, -- Maximum flight level set by user. + FLuser=nil, -- Flight level set by users explicitly. + commute=false, -- Aircraft commute between departure and destination, i.e. when respawned the departure airport becomes the new destiation. + continuejourney=false, -- Aircraft will continue their journey, i.e. get respawned at their destination with a new random destination. + alive=0, -- Number of groups which are alive. + ngroups=nil, -- Number of groups to be spawned in total. + f10menu=true, -- Add an F10 menu for RAT. + Menu={}, -- F10 menu items for this RAT object. + SubMenuName=nil, -- Submenu name for RAT object. + respawn_at_landing=false, -- Respawn aircraft the moment they land rather than at engine shutdown. + respawn_delay=nil, -- Delay in seconds until repawn happens after landing. + markerids={}, -- Array with marker IDs. +} + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Categories of the RAT class. +-- @list cat +-- @field #string plane Plane. +-- @field #string heli Heli. +RAT.cat={ + plane="plane", + heli="heli", +} + +--- RAT waypoint type. +-- @list wp +RAT.wp={ + coldorhot=0, + air=1, + runway=2, + hot=3, + cold=4, + climb=5, + cruise=6, + descent=7, + holding=8, + landing=9, +} + +--- RAT friendly coalitions. +-- @list coal +RAT.coal={ + same="same", + sameonly="sameonly", + all="all", + blue="blue", + blueonly="blueonly", + red="red", + redonly="redonly", + neutral="neutral", +} + +--- RAT unit conversions. +-- @list unit +RAT.unit={ + ft2meter=0.305, + kmh2ms=0.278, + FL2m=30.48, + nm2km=1.852, + nm2m=1852, +} + +--- RAT rules of engagement. +-- @list ROE +RAT.ROE={ + weaponhold="hold", + weaponfree="free", + returnfire="return", +} + +--- RAT reaction to threat. +-- @list ROT +RAT.ROT={ + evade="evade", + passive="passive", + noreaction="noreaction", +} + +--- Running number of placed markers on the F10 map. +-- @field #number markerid +RAT.markerid=0 + +--- Main F10 menu. +-- @field #string MenuF10 +RAT.MenuF10=nil + +--- Some ID to identify who we are in output of the DCS.log file. +-- @field #string id +RAT.id="RAT | " + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--TODO list: +--DONE: Add scheduled spawn. +--DONE: Add possibility to spawn in air. +--DONE: Add departure zones for air start. +--DONE: Make more functions to adjust/set RAT parameters. +--DONE: Clean up debug messages. +--DONE: Improve flight plan. Especially check FL against route length. +--DONE: Add event handlers. +--DONE: Respawn units when they have landed. +--DONE: Change ROE state. +--DONE: Make ROE state user function +--DONE: Improve status reports. +--DONE: Check compatibility with other #SPAWN functions. nope, not all! +--DONE: Add possibility to continue journey at destination. Need "place" in event data for that. +--DONE: Add enumerators and get rid off error prone string comparisons. +--DONE: Check that FARPS are not used as airbases for planes. +--DONE: Add special cases for ships (similar to FARPs). +--DONE: Add cases for helicopters. +--DONE: Add F10 menu. +--DONE: Add markers to F10 menu. +--DONE: Add respawn limit. Later... +--DONE: Make takeoff method random between cold and hot start. +--DONE: Check out uncontrolled spawning. Not now! +--DONE: Check aircraft spawning in air at Sochi after third aircraft was spawned. ==> DCS behaviour. +--DONE: Improve despawn after stationary. Might lead to despawning if many aircraft spawn at the same time. +--DONE: Check why birth event is not handled. ==> Seems to be okay if it is called _OnBirth rather than _OnBirthday. Dont know why actually!? +--DONE: Improve behaviour when no destination or departure airports were found. Leads to crash, e.g. 1184: attempt to get length of local 'destinations' (a nil value) +--DONE: Check cases where aircraft get shot down. +--DONE: Handle the case where more than 10 RAT objects are spawned. Likewise, more than 10 groups of one object. Causes problems with the number of menu items! ==> not now! +--TODO: Add custom livery choice if possible. +--TODO: When only a destination is set, it should be checked that the departure is within range. Also, that departure and destination are not the same. + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Create a new RAT object. +-- @param #RAT self +-- @param #string groupname Name of the group as defined in the mission editor. This group is serving as a template for all spawned units. +-- @param #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 #RAT Object of RAT class. +-- @return #nil If the group does not exist in the mission editor. +-- @usage yak1:RAT("RAT_YAK") will create a RAT object called "yak1". The template group in the mission editor must have the name "RAT_YAK". +-- @usage 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. +function RAT:New(groupname, alias) + + -- Welcome message. + env.info(RAT.id.."Creating new RAT object from template: "..groupname) + + -- Set alias. + alias=alias or groupname + + -- Inherit SPAWN class. + local self=BASE:Inherit(self, SPAWN:NewWithAlias(groupname, alias)) -- #RAT + + -- Alias of groupname. + self.alias=alias + + -- Get template group defined in the mission editor. + local DCSgroup=Group.getByName(groupname) + + -- Check the group actually exists. + if DCSgroup==nil then + env.error("Group with name "..groupname.." does not exist in the mission editor!") + return nil + end + + -- Set own coalition. + self.coalition=DCSgroup:getCoalition() + + -- Initialize aircraft parameters based on ME group template. + self:_InitAircraft(DCSgroup) + + -- Get all airports of current map (Caucasus, NTTR, Normandy, ...). + self:_GetAirportsOfMap() + + -- Create F10 main menu if it does not exists yet. + if self.f10menu and not RAT.MenuF10 then + RAT.MenuF10 = MENU_MISSION:New("RAT") + end + + return self +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Triggers the spawning of AI aircraft. Note that all additional options should be set before giving the spawn command. +-- @param #RAT self +-- @param #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. +function RAT:Spawn(naircraft) + + -- Number of aircraft to spawn. Default is one. + self.ngroups=naircraft or 1 + + -- Set the coalition table based on choice of self.coalition and self.friendly. + self:_SetCoalitionTable() + + -- Get all airports of this map beloning to friendly coalition(s). + self:_GetAirportsOfCoalition() + + -- Set submenuname if it has not been set by user. + if not self.SubMenuName then + self.SubMenuName=self.alias + end + + -- debug message + local text=string.format("\n******************************************************\n") + text=text..string.format("Spawning %i aircraft from template %s of type %s.\n", self.ngroups, self.SpawnTemplatePrefix, self.aircraft.type) + text=text..string.format("Alias: %s\n", self.alias) + text=text..string.format("Category: %s\n", self.category) + text=text..string.format("Friendly coalitions: %s\n", self.friendly) + text=text..string.format("Number of airports on map : %i\n", #self.airports_map) + text=text..string.format("Number of friendly airports: %i\n", #self.airports) + text=text..string.format("Min dist to destination: %4.1f\n", self.mindist) + text=text..string.format("Max dist to destination: %4.1f\n", self.maxdist) + text=text..string.format("Takeoff type: %i\n", self.takeoff) + text=text..string.format("Commute: %s\n", tostring(self.commute)) + text=text..string.format("Journey: %s\n", tostring(self.continuejourney)) + text=text..string.format("Spawn delay: %4.1f\n", self.spawndelay) + text=text..string.format("Spawn interval: %4.1f\n", self.spawninterval) + text=text..string.format("Respawn after landing: %s\n", tostring(self.respawn_at_landing)) + text=text..string.format("Respawn delay: %s\n", tostring(self.respawn_delay)) + text=text..string.format("ROE: %s\n", tostring(self.roe)) + text=text..string.format("ROT: %s\n", tostring(self.rot)) + text=text..string.format("Vclimb: %4.1f\n", self.Vclimb) + text=text..string.format("AlphaDescent: %4.2f\n", self.AlphaDescent) + text=text..string.format("Vcruisemax: %s\n", tostring(self.Vcruisemax)) + text=text..string.format("FLuser: %s\n", tostring(self.Fluser)) + text=text..string.format("FLminuser: %s\n", tostring(self.Flminuser)) + text=text..string.format("FLmaxuser: %s\n", tostring(self.Flmaxuser)) + text=text..string.format("Place markers: %s\n", tostring(self.placemarkers)) + text=text..string.format("Report status: %s\n", tostring(self.reportstatus)) + text=text..string.format("Status interval: %4.1f\n", self.statusinterval) + text=text..string.format("Time inactive: %4.1f\n", self.Tinactive) + text=text..string.format("Create F10 menu : %s\n", tostring(self.f10menu)) + text=text..string.format("F10 submenu name: %s\n", self.SubMenuName) + text=text..string.format("******************************************************\n") + env.info(RAT.id..text) + + -- Create submenus. + if self.f10menu then + self.Menu[self.SubMenuName]=MENU_MISSION:New(self.SubMenuName, RAT.MenuF10) + self.Menu[self.SubMenuName]["groups"]=MENU_MISSION:New("Groups", self.Menu[self.SubMenuName]) + MENU_MISSION_COMMAND:New("Spawn new group", self.Menu[self.SubMenuName], self._SpawnWithRoute, self) + MENU_MISSION_COMMAND:New("Delete markers", self.Menu[self.SubMenuName], self._DeleteMarkers, self) + MENU_MISSION_COMMAND:New("Status report", self.Menu[self.SubMenuName], self.Status, self, true) + end + + -- Schedule spawning of aircraft. + local Tstart=self.spawndelay + local dt=self.spawninterval + -- Ensure that interval is >= 180 seconds if spawn at runway is chosen. Aircraft need time to takeoff or the runway gets jammed. + if self.takeoff==RAT.wp.runway and not self.random_departure then + dt=math.max(dt, 180) + end + local Tstop=Tstart+dt*(self.ngroups-1) + SCHEDULER:New(nil, self._SpawnWithRoute, {self}, Tstart, dt, 0.0, Tstop) + + -- Status check and report scheduler. + SCHEDULER:New(nil, self.Status, {self}, Tstart+1, self.statusinterval) + + -- Handle events. + self:HandleEvent(EVENTS.Birth, self._OnBirth) + self:HandleEvent(EVENTS.EngineStartup, self._EngineStartup) + self:HandleEvent(EVENTS.Takeoff, self._OnTakeoff) + self:HandleEvent(EVENTS.Land, self._OnLand) + self:HandleEvent(EVENTS.EngineShutdown, self._OnEngineShutdown) + self:HandleEvent(EVENTS.Dead, self._OnDead) + self:HandleEvent(EVENTS.Crash, self._OnCrash) + -- TODO: add hit event? + +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Set the friendly coalitions from which the airports can be used as departure or destination. +-- @param #RAT self +-- @param #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. +-- @usage yak:SetCoalition("all") will spawn aircraft randomly on airports of any coaliton, i.e. red, blue and neutral, regardless of its own coalition. +-- @usage yak:SetCoalition("redonly") will spawn aircraft randomly on airports belonging to the red coalition _only_. +function RAT:SetCoalition(friendly) + if friendly:lower()=="all" then + self.friendly=RAT.coal.all + elseif friendly:lower()=="sameonly" then + self.friendly=RAT.coal.sameonly + elseif friendly:lower()=="blue" then + self.friendly=RAT.coal.blue + elseif friendly:lower()=="blueonly" then + self.friendly=RAT.coal.blueonly + elseif friendly:lower()=="red" then + self.friendly=RAT.coal.red + elseif friendly:lower()=="redonly" then + self.friendly=RAT.coal.red + elseif friendly:lower()=="blue" then + self.friendly=RAT.coal.blue + elseif friendly:lower()=="neutral" then + self.friendly=RAT.coal.neutral + else + self.friendly=RAT.coal.same + end +end + +--- 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. +-- @param #RAT self +-- @param #string type Type can be "takeoff-cold" or "cold", "takeoff-hot" or "hot", "takeoff-runway" or "runway", "air". +-- @usage RAT:Takeoff("hot") will spawn RAT objects at airports with engines started. +-- @usage RAT:Takeoff("cold") will spawn RAT objects at airports with engines off. +-- @usage RAT:Takeoff("air") will spawn RAT objects in air over random airports or within pre-defined zones. +function RAT:SetTakeoff(type) + + local _Type + if type:lower()=="takeoff-cold" or type:lower()=="cold" then + _Type=RAT.wp.cold + elseif type:lower()=="takeoff-hot" or type:lower()=="hot" then + _Type=RAT.wp.hot + elseif type:lower()=="takeoff-runway" or type:lower()=="runway" then + _Type=RAT.wp.runway + elseif type:lower()=="air" then + _Type=RAT.wp.air + else + _Type=RAT.wp.coldorhot + end + + self.takeoff=_Type +end + +--- Set possible departure ports. This can be an airport or a zone defined in the mission editor. +-- @param #RAT self +-- @param #string names Name or table of names of departure airports or zones. +-- @usage RAT:SetDeparture("Sochi-Adler") will spawn RAT objects at Sochi-Adler airport. +-- @usage RAT:SetDeparture({"Sochi-Adler", "Gudauta"}) will spawn RAT aircraft radomly at Sochi-Adler or Gudauta airport. +-- @usage 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. +function RAT:SetDeparture(names) + + -- Random departure is deactivated now that user specified departure ports. + self.random_departure=false + + if type(names)=="table" then + + -- we did get a table of names + for _,name in pairs(names) do + + if self:_AirportExists(name) then + -- If an airport with this name exists, we put it in the ports array. + table.insert(self.departure_ports, name) + else + -- If it is not an airport, we assume it is a zone. + -- We need the DCS call to determine if it's really a zone. Otherwise code will crash at some point. + local z=trigger.misc.getZone(name) + if z then + table.insert(self.departure_zones, name) + end + end + + end + + elseif type(names)=="string" then + + if self:_AirportExists(names) then + -- If an airport with this name exists, we put it in the ports array. + table.insert(self.departure_ports, names) + else + -- If it is not an airport, we assume it is a zone. + table.insert(self.departure_zones, names) + end + + else + -- error message + env.error("Input parameter must be a string or a table!") + end + +end + +--- Set name of destination airport for the AI aircraft. If no name is given an airport from the friendly coalition(s) is chosen randomly. +-- @param #RAT self +-- @param #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. +function RAT:SetDestination(names) + + -- Random departure is deactivated now that user specified departure ports. + self.random_destination=false + + if type(names)=="table" then + + for _,name in pairs(names) do + if self:_AirportExists(name) then + table.insert(self.destination_ports, name) + else + local text=string.format("Airport %s does not exist on map!", name) + env.error(text) + end + end + + elseif type(names)=="string" then + + if self:_AirportExists(names) then + self.destination_ports={names} + else + local text=string.format("Airport %s does not exist on map!", names) + env.error(text) + end + + else + -- Error message. + env.error("Input parameter must be a string or a table!") + end + +end + +--- Aircraft will continue their journey from their destination. This means they are respawned at their destination and get a new random destination. +-- @param #RAT self +-- @param #boolean switch Turn journey on=true or off=false. If no value is given switch=true. +function RAT:ContinueJourney(switch) + switch=switch or true + self.continuejourney=switch +end + +--- 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. +-- @param #RAT self +-- @param #boolean switch Turn commute on=true or off=false. If no value is given switch=true. +function RAT:Commute(switch) + switch=switch or true + self.commute=switch +end + +--- Set the delay before first group is spawned. Minimum delay is 0.5 seconds. +-- @param #RAT self +-- @param #number delay Delay in seconds. +function RAT:SetSpawnDelay(delay) + self.spawndelay=math.max(0.5, delay) +end + +--- Set the interval between spawnings of the template group. Minimum interval is 0.5 seconds. +-- @param #RAT self +-- @param #number interval Interval in seconds. +function RAT:SetSpawnInterval(interval) + self.spawninterval=math.max(0.5, interval) +end + +--- Make aircraft respawn the moment they land rather than at engine shut down. +-- @param #RAT self +-- @param #number delay (Optional) Delay in seconds until respawn happens after landing. Default is 180 seconds. +function RAT:RespawnAfterLanding(delay) + delay = delay or 180 + self.respawn_at_landing=true + self.respawn_delay=delay +end + +--- Set the time after which inactive groups will be destroyed. Default is 180 seconds. +-- @param #RAT self +-- @param #number time Time in seconds. +function RAT:TimeDestroyInactive(time) + self.Tinactive=time +end + +--- Set the maximum cruise speed of the aircraft. +-- @param #RAT self +-- @param #number speed Speed in km/h. +function RAT:SetMaxCruiseSpeed(speed) + -- Convert to m/s. + self.Vcruisemax=speed/3.6 +end + +--- Set the climb rate. Default is 1500 ft/min. This automatically sets the climb angle. +-- @param #RAT self +-- @param #number rate Climb rate in ft/min. +function RAT:SetClimbRate(rate) + self.Vclimb=rate +end + +--- Set the angle of descent. Default is 3.6 degrees, which corresponds to 3000 ft descent after one mile of travel. +-- @param #RAT self +-- @param #number angle Angle of descent in degrees. +function RAT:SetDescentAngle(angle) + self.AlphaDescent=angle +end + +--- Set rules of engagement (ROE). Default is weapon hold. This is a peaceful class. +-- @param #RAT self +-- @param #string roe "hold" = weapon hold, "return" = return fire, "free" = weapons free. +function RAT:SetROE(roe) + if roe=="return" then + self.roe=RAT.ROE.returnfire + elseif roe=="free" then + self.roe=RAT.ROE.weaponfree + else + self.roe=RAT.ROE.weaponhold + end +end + +--- Set reaction to threat (ROT). Default is no reaction, i.e. aircraft will simply ignore all enemies. +-- @param #RAT self +-- @param #string rot "noreaction" = no reaction to threats, "passive" = passive defence, "evade" = evade enemy attacks. +function RAT:SetROT(rot) + if rot=="passive" then + self.rot=RAT.ROT.passive + elseif rot=="evade" then + self.rot=RAT.ROT.evade + else + self.rot=RAT.ROT.noreaction + end +end + +--- Set the name of the F10 submenu. Default is the name of the template group. +-- @param #RAT self +-- @param #string name Submenu name. +function RAT:MenuName(name) + self.SubMenuName=tostring(name) +end + +--- 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. +-- @param #RAT self +-- @param #number dist Distance in km. +function RAT:SetMinDistance(dist) + -- Distance in meters. Absolute minimum is 500 m. + self.mindist=math.max(500, dist*1000) +end + +--- Set maximum distance between departure and destination. Default is 5000 km but aircarft range is also taken into account automatically. +-- @param #RAT self +-- @param #number dist Distance in km. +function RAT:SetMaxDistance(dist) + -- Distance in meters. + self.maxdist=dist*1000 +end + +--- Turn debug messages on or off. Default is off. +-- @param #RAT self +-- @param #boolean switch true turn messages on, false=off. +function RAT:_Debug(switch) + switch = switch or true + self.debug=switch +end + +--- Aircraft report status messages. Default is off. +-- @param #RAT self +-- @param #boolean switch true=on, false=off. +function RAT:StatusReports(switch) + switch = switch or true + self.reportstatus=switch +end + +--- Place markers of waypoints on the F10 map. Default is off. +-- @param #RAT self +-- @param #boolean switch true=yes, false=no. +function RAT:PlaceMarkers(switch) + switch = switch or true + self.placemarkers=switch +end + +--- Set flight level. Setting this value will overrule all other logic. Aircraft will try to fly at this height regardless. +-- @param #RAT self +-- @param #number height FL in hundrets of feet. E.g. FL200 = 20000 ft ASL. +function RAT:SetFL(height) + self.FLuser=height*RAT.unit.FL2m +end + +--- Set max flight level. Setting this value will overrule all other logic. Aircraft will try to fly at less than this FL regardless. +-- @param #RAT self +-- @param #number height Maximum FL in hundrets of feet. +function RAT:SetFLmax(height) + self.FLmaxuser=height*RAT.unit.FL2m +end + +--- Set min flight level. Setting this value will overrule all other logic. Aircraft will try to fly at higher than this FL regardless. +-- @param #RAT self +-- @param #number height Maximum FL in hundrets of feet. +function RAT:SetFLmin(height) + self.FLminuser=height*RAT.unit.FL2m +end + +--- 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. +-- @param #RAT self +-- @param #number height FL in hundrets of feet. E.g. FL200 = 20000 ft ASL. +function RAT:SetFLcruise(height) + self.aircraft.FLcruise=height*RAT.unit.FL2m +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Initialize basic parameters of the aircraft based on its (template) group in the mission editor. +-- @param #RAT self +-- @param Dcs.DCSWrapper.Group#Group DCSgroup Group of the aircraft in the mission editor. +function RAT:_InitAircraft(DCSgroup) + + local DCSunit=DCSgroup:getUnit(1) + local DCSdesc=DCSunit:getDesc() + local DCScategory=DCSgroup:getCategory() + local DCStype=DCSunit:getTypeName() + + -- Descriptors table of unit. + if self.debug then + self:E({"DCSdesc", DCSdesc}) + end + + -- set category + if DCScategory==Group.Category.AIRPLANE then + self.category=RAT.cat.plane + elseif DCScategory==Group.Category.HELICOPTER then + self.category=RAT.cat.heli + else + self.category="other" + env.error(RAT.id.."Group of RAT is neither airplane nor helicopter!") + end + + -- Get type of aircraft. + self.aircraft.type=DCStype + + -- inital fuel in % + self.aircraft.fuel=DCSunit:getFuel() + + -- operational range in NM converted to m + self.aircraft.Rmax = DCSdesc.range*RAT.unit.nm2m + + -- effective range taking fuel into accound and a 10% reserve + self.aircraft.Reff = self.aircraft.Rmax*self.aircraft.fuel*0.9 + + -- max airspeed from group + self.aircraft.Vmax = DCSdesc.speedMax + + -- max climb speed in m/s + self.aircraft.Vymax=DCSdesc.VyMax + + -- service ceiling in meters + self.aircraft.ceiling=DCSdesc.Hmax + + -- Default flight level (ASL). + if self.category==RAT.cat.plane then + -- For planes: FL200 = 20000 ft = 6096 m. + self.aircraft.FLcruise=200*RAT.unit.FL2m + else + -- For helos: FL005 = 500 ft = 152 m. + self.aircraft.FLcruise=005*RAT.unit.FL2m + end + + -- info message + local text=string.format("\n******************************************************\n") + text=text..string.format("Aircraft parameters:\n") + text=text..string.format("Template group = %s\n", self.SpawnTemplatePrefix) + text=text..string.format("Alias = %s\n", self.alias) + text=text..string.format("Category = %s\n", self.category) + text=text..string.format("Type = %s\n", self.aircraft.type) + text=text..string.format("Max air speed = %6.1f m/s\n", self.aircraft.Vmax) + text=text..string.format("Max climb speed = %6.1f m/s\n", self.aircraft.Vymax) + text=text..string.format("Initial Fuel = %6.1f\n", self.aircraft.fuel*100) + text=text..string.format("Max range = %6.1f km\n", self.aircraft.Rmax/1000) + text=text..string.format("Eff range = %6.1f km\n", self.aircraft.Reff/1000) + text=text..string.format("Ceiling = %6.1f km = FL%3.0f\n", self.aircraft.ceiling/1000, self.aircraft.ceiling/RAT.unit.FL2m) + text=text..string.format("FL cruise = %6.1f km = FL%3.0f\n", self.aircraft.FLcruise/1000, self.aircraft.FLcruise/RAT.unit.FL2m) + text=text..string.format("******************************************************\n") + env.info(RAT.id..text) + +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- 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. +-- @param #RAT self +-- @param #string _departure (Optional) Name of departure airbase. +-- @param #string _destination (Optional) Name of destination airbase. +function RAT:_SpawnWithRoute(_departure, _destination) + + -- Check that we don't already have more groups than we initally wanted. + --if self.alive > self.ngroups then + -- return + --end + + -- Set takeoff type. + local _takeoff=self.takeoff + if self.takeoff==RAT.wp.coldorhot then + local temp={RAT.wp.cold, RAT.wp.hot} + _takeoff=temp[math.random(2)] + end + + -- Set flight plan. + local departure, destination, waypoints = self:_SetRoute(_takeoff, _departure, _destination) + + -- Return nil if we could not find a departure destination or waypoints + if not (departure and destination and waypoints) then + return nil + end + + -- Modify the spawn template to follow the flight plan. + self:_ModifySpawnTemplate(waypoints) + + -- Actually spawn the group. + local group=self:SpawnWithIndex(self.SpawnIndex) -- Wrapper.Group#GROUP + self.alive=self.alive+1 + + -- Set ROE, default is "weapon hold". + self:_SetROE(group, self.roe) + + -- Set ROT, default is "no reaction". + self:_SetROT(group, self.rot) + + -- Init ratcraft array. + self.ratcraft[self.SpawnIndex]={} + self.ratcraft[self.SpawnIndex]["group"]=group + self.ratcraft[self.SpawnIndex]["destination"]=destination + self.ratcraft[self.SpawnIndex]["departure"]=departure + self.ratcraft[self.SpawnIndex]["waypoints"]=waypoints + self.ratcraft[self.SpawnIndex]["status"]="spawned" + self.ratcraft[self.SpawnIndex]["airborne"]=group:InAir() + -- Time and position on ground. For check if aircraft is stuck somewhere. + if group:InAir() then + self.ratcraft[self.SpawnIndex]["Tground"]=nil + self.ratcraft[self.SpawnIndex]["Pground"]=nil + self.ratcraft[self.SpawnIndex]["Tlastcheck"]=nil + else + self.ratcraft[self.SpawnIndex]["Tground"]=timer.getTime() + self.ratcraft[self.SpawnIndex]["Pground"]=group:GetCoordinate() + self.ratcraft[self.SpawnIndex]["Tlastcheck"]=timer.getTime() + end + -- Initial and current position. For calculating the travelled distance. + self.ratcraft[self.SpawnIndex]["P0"]=group:GetCoordinate() + self.ratcraft[self.SpawnIndex]["Pnow"]=group:GetCoordinate() + self.ratcraft[self.SpawnIndex]["Distance"]=0 + + -- Each aircraft gets its own takeoff type. unused? + self.ratcraft[self.SpawnIndex]["takeoff"]=_takeoff + + + -- Create submenu for this group. + if self.f10menu then + local name=self.aircraft.type.." ID "..tostring(self.SpawnIndex) + -- F10/RAT//Group X + self.Menu[self.SubMenuName].groups[self.SpawnIndex]=MENU_MISSION:New(name, self.Menu[self.SubMenuName].groups) + -- F10/RAT//Group X/Set ROE + self.Menu[self.SubMenuName].groups[self.SpawnIndex]["roe"]=MENU_MISSION:New("Set ROE", self.Menu[self.SubMenuName].groups[self.SpawnIndex]) + MENU_MISSION_COMMAND:New("Weapons hold", self.Menu[self.SubMenuName].groups[self.SpawnIndex]["roe"], self._SetROE, self, group, RAT.ROE.weaponhold) + MENU_MISSION_COMMAND:New("Weapons free", self.Menu[self.SubMenuName].groups[self.SpawnIndex]["roe"], self._SetROE, self, group, RAT.ROE.weaponfree) + MENU_MISSION_COMMAND:New("Return fire", self.Menu[self.SubMenuName].groups[self.SpawnIndex]["roe"], self._SetROE, self, group, RAT.ROE.returnfire) + -- F10/RAT//Group X/Set ROT + self.Menu[self.SubMenuName].groups[self.SpawnIndex]["rot"]=MENU_MISSION:New("Set ROT", self.Menu[self.SubMenuName].groups[self.SpawnIndex]) + MENU_MISSION_COMMAND:New("No reaction", self.Menu[self.SubMenuName].groups[self.SpawnIndex]["rot"], self._SetROT, self, group, RAT.ROT.noreaction) + MENU_MISSION_COMMAND:New("Passive defense", self.Menu[self.SubMenuName].groups[self.SpawnIndex]["rot"], self._SetROT, self, group, RAT.ROT.passive) + MENU_MISSION_COMMAND:New("Evade on fire", self.Menu[self.SubMenuName].groups[self.SpawnIndex]["rot"], self._SetROT, self, group, RAT.ROT.evade) + -- F10/RAT//Group X/ + MENU_MISSION_COMMAND:New("Despawn group", self.Menu[self.SubMenuName].groups[self.SpawnIndex], self._Despawn, self, group) + MENU_MISSION_COMMAND:New("Place markers", self.Menu[self.SubMenuName].groups[self.SpawnIndex], self._PlaceMarkers, self, waypoints) + MENU_MISSION_COMMAND:New("Status report", self.Menu[self.SubMenuName].groups[self.SpawnIndex], self.Status, self, true, self.SpawnIndex) + end + + return self.SpawnIndex + +end + +--- Respawn a group. +-- @param #RAT self +-- @param Wrapper.Group#GROUP group Group to be repawned. +function RAT:_Respawn(group) + + -- Get the spawn index from group + local index=self:GetSpawnIndexFromGroup(group) + + -- Get departure and destination from previous journey. + local departure=self.ratcraft[index].departure + local destination=self.ratcraft[index].destination + + local _departure=nil + local _destination=nil + + if self.continuejourney then + -- We continue our journey from the old departure airport. + _departure=destination:GetName() + elseif self.commute then + -- We commute between departure and destination. + _departure=destination:GetName() + _destination=departure:GetName() + end + + -- Spawn new group. + if self.respawn_delay then + SCHEDULER:New(nil, self._SpawnWithRoute, {self, _departure, _destination}, self.respawn_delay) + else + self:_SpawnWithRoute(_departure, _destination) + end + +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Set the route of the AI plane. Due to DCS landing bug, this has to be done before the unit is spawned. +-- @param #RAT self +-- @param takeoff #RAT.wp Takeoff type. +-- @param Wrapper.Airport#AIRBASE _departure (Optional) Departure airbase. +-- @param Wrapper.Airport#AIRBASE _destination (Optional) Destination airbase. +-- @return Wrapper.Airport#AIRBASE Departure airbase. +-- @return Wrapper.Airport#AIRBASE Destination airbase. +-- @return #table Table of flight plan waypoints. +-- @return #nil If no valid departure or destination airport could be found. +function RAT:_SetRoute(takeoff, _departure, _destination) + + -- Max cruise speed. + local VxCruiseMax + if self.Vcruisemax then + -- User input. + VxCruiseMax = min(self.Vcruisemax, self.aircraft.Vmax) + else + -- Max cruise speed 90% of Vmax or 900 km/h whichever is lower. + VxCruiseMax = math.min(self.aircraft.Vmax*0.90, 250) + end + + -- Min cruise speed 70% of max cruise or 600 km/h whichever is lower. + local VxCruiseMin = math.min(VxCruiseMax*0.70, 166) + + -- Cruise speed (randomized). + --local VxCruise = self:_Randomize((VxCruiseMax-VxCruiseMin)/2+VxCruiseMin, 0.3 , VxCruiseMin, VxCruiseMax) + + -- Cruise speed (randomized). Expectation value at midpoint between min and max. + local VxCruise = self:_Random_Gaussian((VxCruiseMax-VxCruiseMin)/2+VxCruiseMin, (VxCruiseMax-VxCruiseMax)/4, VxCruiseMin, VxCruiseMax) + + -- Climb speed 90% ov Vmax but max 720 km/h. + local VxClimb = math.min(self.aircraft.Vmax*0.90, 200) + + -- Descent speed 60% of Vmax but max 500 km/h. + local VxDescent = math.min(self.aircraft.Vmax*0.60, 140) + + -- Holding speed is 90% of descent speed. + local VxHolding = VxDescent*0.9 + + -- Final leg is 90% of holding speed. + local VxFinal = VxHolding*0.9 + + -- Reasonably civil climb speed Vy=1500 ft/min = 7.6 m/s but max aircraft specific climb rate. + local VyClimb=math.min(self.Vclimb*RAT.unit.ft2meter/60, self.aircraft.Vymax) + + -- Climb angle in rad. + local AlphaClimb=math.asin(VyClimb/VxClimb) + + -- Descent angle in rad. + local AlphaDescent=math.rad(self.AlphaDescent) + + + -- DEPARTURE AIRPORT + -- Departure airport or zone. + local departure=nil + if _departure then + if self:_AirportExists(_departure) then + departure=AIRBASE:FindByName(_departure) + else + local text=string.format("ERROR: Specified departure airport %s does not exist for %s!", _departure, self.alias) + env.error(RAT.id..text) + end + else + departure=self:_PickDeparture(takeoff) + end + + -- Return nil if no departure could be found. + if not departure then + local text=string.format("No valid departure airport could be found for %s.", self.alias) + MESSAGE:New(text, 60):ToAll() + env.error(RAT.id..text) + return nil + end + + -- Coordinates of departure point. + local Pdeparture + if takeoff==RAT.wp.air then + -- For an air start, we take a random point within the spawn zone. + local vec2=departure:GetRandomVec2() + --Pdeparture=COORDINATE:New(vec2.x, self.aircraft.FLcruise, vec2.y) + Pdeparture=COORDINATE:NewFromVec2(vec2) + else + Pdeparture=departure:GetCoordinate() + end + + -- Height ASL of departure point. + local H_departure + if takeoff==RAT.wp.air then + -- Departure altitude is 70% of default cruise with 30% variation and limited to 1000 m AGL (50 m for helos). + local Hmin + if self.category==RAT.cat.plane then + Hmin=1000 + else + Hmin=50 + end + H_departure=self:_Randomize(self.aircraft.FLcruise*0.7, 0.3, Pdeparture.y+Hmin, self.aircraft.FLcruise) + else + H_departure=Pdeparture.y + end + + -- DESTINATION AIRPORT + local destination=nil + if _destination then + if self:_AirportExists(_destination) then + destination=AIRBASE:FindByName(_destination) + else + local text=string.format("ERROR: Specified destination airport %s does not exist for %s!", _destination, self.alias) + env.error(RAT.id..text) + end + else + -- Get all destination airports within reach. + local destinations=self:_GetDestinations(Pdeparture, self.mindist, math.min(self.aircraft.Reff, self.maxdist)) + + local random_destination=false + if self.continuejourney and _departure then + random_destination=true + end + + -- Pick a destination airport. + destination=self:_PickDestination(destinations, random_destination) + end + + -- Return nil if no departure could be found. + if not destination then + local text=string.format("No valid destination airport could be found for %s!", self.alias) + MESSAGE:New(text, 60):ToAll() + env.error(RAT.id..text) + return nil + end + + -- Check that departure and destination are not the same. Should not happen due to mindist. + if destination:GetName()==departure:GetName() then + local text=string.format("%s: Destination and departure airport are identical. Airport %s (ID %d).", self.alias, destination:GetName(), destination:GetID()) + MESSAGE:New(text, 120):ToAll() + env.error(RAT.id..text) + end + + -- Coordinates of destination airport. + local Pdestination=destination:GetCoordinate() + -- Height ASL of destination airport. + local H_destination=Pdestination.y + + -- DESCENT/HOLDING POINT + -- Get a random point between 5 and 10 km away from the destination. + local Vholding + if self.category==RAT.cat.plane then + Vholding=destination:GetCoordinate():GetRandomVec2InRadius(10000, 5000) + else + -- For helos we set a distance between 500 to 1000 m. + Vholding=destination:GetCoordinate():GetRandomVec2InRadius(1000, 500) + end + -- Coordinates of the holding point. y is the land height at that point. + local Pholding=COORDINATE:NewFromVec2(Vholding) + + -- AGL height of holding point. + local H_holding=Pholding.y + + -- Holding point altitude. For planes between 1600 and 2400 m AGL. For helos 160 to 240 m AGL. + local h_holding + if self.category==RAT.cat.plane then + h_holding=1200 + else + h_holding=150 + end + h_holding=self:_Randomize(h_holding, 0.2) + + -- Distance from holding point to final destination. + local d_holding=Pholding:Get2DDistance(Pdestination) + + -- Height difference between departure and holding point. + local deltaH=h_holding+H_holding-H_departure + + -- GENERAL + -- Heading from departure to holding point of destination. + local heading=self:_Course(Pdeparture, Pholding) + + -- Total distance between departure and holding point near destination. + local d_total=Pdeparture:Get2DDistance(Pholding) + + -- Climb/descent angle from departure to holding point + local phi=math.atan(deltaH/d_total) + + -- Corrected climb angle. + local PhiClimb=AlphaClimb+phi + + -- Corrected descent angle. + local PhiDescent=AlphaDescent-phi + + --CRUISE + + -- Max flight level the aircraft can reach if it only climbs and immidiately descents again (i.e. no cruising part). + local FLmax=self:_FLmax(AlphaClimb, AlphaDescent, d_total, phi, H_departure) + + -- Min cruise alt is just above holding point at destination or departure height, whatever is larger. + local FLmin=math.max(H_departure, H_holding+h_holding) + + -- If the route is very short we set FLmin a bit lower than FLmax. + if FLmin>FLmax then + FLmin=FLmax*0.75 + end + + -- For helicopters we take cruise alt between 50 to 1000 meters above ground. Default cruise alt is ~150 m. + if self.category==RAT.cat.heli then + FLmin=math.max(H_departure, H_destination)+50 + FLmax=math.max(H_departure, H_destination)+1000 + end + + -- Ensure that FLmax not above 90% its service ceiling. + FLmax=math.min(FLmax, self.aircraft.ceiling*0.9) + + -- Overrule setting if user specified min/max flight level explicitly. + if self.FLminuser then + FLmin=self.FLminuser + end + if self.FLmaxuser then + FLmax=self.FLmaxuser + end + + -- Set cruise altitude: default with 100% randomization but limited to FLmin and FLmax. + --local FLcruise=self:_Randomize(self.aircraft.FLcruise, 1.0, FLmin, FLmax) + + -- Set cruise altitude. Selected from Gaussian distribution but limited to FLmin and FLmax. + local FLcruise=self:_Random_Gaussian(self.aircraft.FLcruise, (FLmax-FLmin)/4, FLmin, FLmax) + + -- Overrule setting if user specified a flight level explicitly. + if self.FLuser then + FLcruise=self.FLuser + end + + -- CLIMB + -- Height of climb relative to ASL height of departure airport. + local h_climb=FLcruise-H_departure + -- x-distance of climb part + local d_climb=h_climb/math.tan(PhiClimb) + + -- DESCENT + -- Height difference for descent form cruise alt to holding point. + local h_descent=FLcruise-(H_holding+h_holding) + -- x-distance of descent part + local d_descent=h_descent/math.tan(PhiDescent) + + -- CRUISE + -- Distance of the cruising part. This should in principle not become negative, but can happen for very short legs. + local d_cruise=d_total-d_climb-d_descent + + -- debug message + local text=string.format("\n******************************************************\n") + text=text..string.format("Template = %s\n\n", self.SpawnTemplatePrefix) + text=text..string.format("Speeds:\n") + text=text..string.format("VxCruiseMin = %6.1f m/s = %5.1f km/h\n", VxCruiseMin, VxCruiseMin*3.6) + text=text..string.format("VxCruiseMax = %6.1f m/s = %5.1f km/h\n", VxCruiseMax, VxCruiseMax*3.6) + text=text..string.format("VxCruise = %6.1f m/s = %5.1f km/h\n", VxCruise, VxCruise*3.6) + text=text..string.format("VxClimb = %6.1f m/s = %5.1f km/h\n", VxClimb, VxClimb*3.6) + text=text..string.format("VxDescent = %6.1f m/s = %5.1f km/h\n", VxDescent, VxDescent*3.6) + text=text..string.format("VxHolding = %6.1f m/s = %5.1f km/h\n", VxHolding, VxHolding*3.6) + text=text..string.format("VxFinal = %6.1f m/s = %5.1f km/h\n", VxFinal, VxFinal*3.6) + text=text..string.format("VyClimb = %6.1f m/s\n", VyClimb) + text=text..string.format("\nDistances:\n") + text=text..string.format("d_climb = %6.1f km\n", d_climb/1000) + text=text..string.format("d_cruise = %6.1f km\n", d_cruise/1000) + text=text..string.format("d_descent = %6.1f km\n", d_descent/1000) + text=text..string.format("d_holding = %6.1f km\n", d_holding/1000) + text=text..string.format("d_total = %6.1f km\n", d_total/1000) + text=text..string.format("\nHeights:\n") + text=text..string.format("H_departure = %6.1f m ASL\n", H_departure) + text=text..string.format("H_destination = %6.1f m ASL\n", H_destination) + text=text..string.format("H_holding = %6.1f m ASL\n", H_holding) + text=text..string.format("h_climb = %6.1f m\n", h_climb) + text=text..string.format("h_descent = %6.1f m\n", h_descent) + text=text..string.format("h_holding = %6.1f m\n", h_holding) + text=text..string.format("FLmin = %6.1f m ASL = FL%03d\n", FLmin, FLmin/RAT.unit.FL2m) + text=text..string.format("FLcruise = %6.1f m ASL = FL%03d\n", FLcruise, FLcruise/RAT.unit.FL2m) + text=text..string.format("FLmax = %6.1f m ASL = FL%03d\n", FLmax, FLmax/RAT.unit.FL2m) + text=text..string.format("\nAngles:\n") + text=text..string.format("Alpha climb = %6.1f Deg\n", math.deg(AlphaClimb)) + text=text..string.format("Alpha descent = %6.1f Deg\n", math.deg(AlphaDescent)) + text=text..string.format("Phi (slope) = %6.1f Deg\n", math.deg(phi)) + text=text..string.format("Heading = %6.1f Deg\n", heading) + text=text..string.format("******************************************************\n") + env.info(RAT.id..text) + + -- Ensure that cruise distance is positve. Can be slightly negative in special cases. And we don't want to turn back. + if d_cruise<0 then + d_cruise=100 + end + + -- Coordinates of route from departure (0) to cruise (1) to descent (2) to holing (3) to destination (4). + local c0=Pdeparture + local c1=c0:Translate(d_climb/2, heading) + local c2=c1:Translate(d_climb/2, heading) + local c3=c2:Translate(d_cruise, heading) + local c4=c3:Translate(d_descent/2, heading) + local c5=Pholding + local c6=Pdestination + + --Convert coordinates into route waypoints. + local wp0=self:_Waypoint(takeoff, c0, VxClimb, H_departure, departure) + local wp1=self:_Waypoint(RAT.wp.climb, c1, VxClimb, H_departure+(FLcruise-H_departure)/2) + local wp2=self:_Waypoint(RAT.wp.cruise, c2, VxCruise, FLcruise) + local wp3=self:_Waypoint(RAT.wp.cruise, c3, VxCruise, FLcruise) + local wp4=self:_Waypoint(RAT.wp.descent, c4, VxDescent, FLcruise-(FLcruise-(h_holding+H_holding))/2) + local wp5=self:_Waypoint(RAT.wp.holding, c5, VxHolding, H_holding+h_holding) + local wp6=self:_Waypoint(RAT.wp.landing, c6, VxFinal, H_destination, destination) + + -- set waypoints + local waypoints = {wp0, wp1, wp2, wp3, wp4, wp5, wp6} + + -- Place markers of waypoints on F10 map. + if self.placemarkers then + self:_PlaceMarkers(waypoints) + end + + -- some info on the route as message + self:_Routeinfo(waypoints, "Waypoint info in set_route:") + + -- return departure, destination and waypoints + return departure, destination, waypoints + +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- 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. +-- @param #RAT self +-- @param #number takeoff Takeoff type. +-- @return Wrapper.Airbase#AIRBASE Departure airport if spawning at airport. +-- @return Coore.Zone#ZONE Departure zone if spawning in air. +function RAT:_PickDeparture(takeoff) + + -- Array of possible departure airports or zones. + local departures={} + + if takeoff==RAT.wp.air then + + if self.random_departure then + + -- Air start above a random airport. + for _,airport in pairs(self.airports)do + table.insert(departures, airport:GetZone()) + end + + else + + -- Put all specified zones in table. + for _,name in pairs(self.departure_zones) do + table.insert(departures, ZONE:New(name)) + end + -- Put all specified airport zones in table. + for _,name in pairs(self.departure_ports) do + table.insert(departures, AIRBASE:FindByName(name):GetZone()) + end + + end + + else + + if self.random_departure then + + -- All friendly departure airports. + for _,airport in pairs(self.airports) do + table.insert(departures, airport) + end + + else + + -- All airports specified by user + for _,name in pairs(self.departure_ports) do + table.insert(departures, AIRBASE:FindByName(name)) + end + + end + end + + -- Select departure airport or zone. + local departure=departures[math.random(#departures)] + + local text + if departure and departure:GetName() then + if takeoff==RAT.wp.air then + text="Chosen departure zone: "..departure:GetName() + else + text="Chosen departure airport: "..departure:GetName().." (ID "..departure:GetID()..")" + end + env.info(RAT.id..text) + if self.debug then + MESSAGE:New(text, 30):ToAll() + end + else + departure=nil + end + + return departure +end + + +--- Pick destination airport. If no airport name is given an airport from the coalition is chosen randomly. +-- @param #RAT self +-- @param #table destinations Table with destination airports. +-- @param #boolean _random (Optional) Switch to activate a random selection of airports. +-- @return Wrapper.Airbase#AIRBASE Destination airport. +function RAT:_PickDestination(destinations, _random) + + -- Take destinations from user input. + if not (self.random_destination or _random) then + destinations=nil + destinations={} + -- All airports specified by user. + for _,name in pairs(self.destination_ports) do + table.insert(destinations, AIRBASE:FindByName(name)) + end + + end + + -- Randomly select one possible destination. + local destination=nil + if destinations and #destinations>0 then + destination=destinations[math.random(#destinations)] -- Wrapper.Airbase#AIRBASE + + local text="Chosen destination airport: "..destination:GetName().." (ID "..destination:GetID()..")" + env.info(RAT.id..text) + if self.debug then + MESSAGE:New(text, 30):ToAll() + end + else + env.error(RAT.id.."No destination airport found.") + end + + return destination +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Get all possible destination airports depending on departure position. +-- The list is sorted w.r.t. distance to departure position. +-- @param #RAT self +-- @param Core.Point#COORDINATE q Coordinate of the departure point. +-- @param #number minrange Minimum range to q in meters. +-- @param #number maxrange Maximum range to q in meters. +-- @return #table Table with possible destination airports. +-- @return #nil If no airports could be found. +function RAT:_GetDestinations(q, minrange, maxrange) + + minrange=minrange or self.mindist + maxrange=maxrange or self.maxdist + + -- Initialize array. + local destinations={} + + -- loop over all friendly airports + for _,airport in pairs(self.airports) do + local p=airport:GetCoordinate() + local distance=q:Get2DDistance(p) + -- check if distance form departure to destination is within min/max range + if distance>=minrange and distance<=maxrange then + table.insert(destinations, airport) + end + end + env.info(RAT.id.."Number of possible destination airports = "..#destinations) + + if #destinations > 1 then + --- Compare distance of destination airports. + -- @param Core.Point#COORDINATE a Coordinate of point a. + -- @param Core.Point#COORDINATE b Coordinate of point b. + -- @return #list Table sorted by distance. + local function compare(a,b) + local qa=q:Get2DDistance(a:GetCoordinate()) + local qb=q:Get2DDistance(b:GetCoordinate()) + return qa < qb + end + table.sort(destinations, compare) + else + env.error(RAT.id.."No possible destination airports found!") + destinations=nil + end + + -- Return table with destination airports. + return destinations + +end + + +--- Get all airports of the current map. +-- @param #RAT self +function RAT:_GetAirportsOfMap() + local _coalition + + for i=0,2 do -- cycle coalition.side 0=NEUTRAL, 1=RED, 2=BLUE + + -- set coalition + if i==0 then + _coalition=coalition.side.NEUTRAL + elseif i==1 then + _coalition=coalition.side.RED + elseif i==2 then + _coalition=coalition.side.BLUE + end + + -- get airbases of coalition + local ab=coalition.getAirbases(i) + + -- loop over airbases and put them in a table + for _,airbase in pairs(ab) do + + local _id=airbase:getID() + local _p=airbase:getPosition().p + local _name=airbase:getName() + local _myab=AIRBASE:FindByName(_name) + + -- Add airport to table. + table.insert(self.airports_map, _myab) + + if self.debug then + local text1="MOOSE: Airport ID = ".._myab:GetID().." and Name = ".._myab:GetName()..", Category = ".._myab:GetCategory()..", TypeName = ".._myab:GetTypeName() + local text2="DCS : Airport ID = "..airbase:getID().." and Name = "..airbase:getName()..", Category = "..airbase:getCategory()..", TypeName = "..airbase:getTypeName() + env.info(RAT.id..text1) + env.info(RAT.id..text2) + end + + end + + end +end + + +--- Get all "friendly" airports of the current map. +-- @param #RAT self +function RAT:_GetAirportsOfCoalition() + for _,coalition in pairs(self.ctable) do + for _,airport in pairs(self.airports_map) do + if airport:GetCoalition()==coalition then + -- Planes cannot land on FARPs. + local condition1=self.category==RAT.cat.plane and airport:GetTypeName()=="FARP" + -- Planes cannot land on ships. + local condition2=self.category==RAT.cat.plane and airport:GetCategory()==1 + if not (condition1 or condition2) then + table.insert(self.airports, airport) + end + end + end + end + + if #self.airports==0 then + local text="No possible departure/destination airports found!" + MESSAGE:New(text, 60):ToAll() + env.error(RAT.id..text) + end +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Report status of RAT groups. +-- @param #RAT self +-- @param #boolean message (Optional) Send message with report to all if true. +-- @param #number forID (Optional) Send message only for this ID. +function RAT:Status(message, forID) + + message=message or false + forID=forID or false + + -- number of ratcraft spawned. + local ngroups=#self.ratcraft + + if (message and not forID) or self.reportstatus then + local text=string.format("Alive groups of template %s: %d", self.SpawnTemplatePrefix, self.alive) + env.info(RAT.id..text) + MESSAGE:New(text, 20):ToAll() + end + + for i=1, ngroups do + + if self.ratcraft[i].group then + if self.ratcraft[i].group:IsAlive() then + + -- Gather some information. + local group=self.ratcraft[i].group --Wrapper.Group#GROUP + local prefix=self:_GetPrefixFromGroup(group) + local life=self:_GetLife(group) + local fuel=group:GetFuel()*100.0 + local airborne=group:InAir() + local coords=group:GetCoordinate() + local alt=coords.y + --local vel=group:GetVelocityKMH() + local departure=self.ratcraft[i].departure:GetName() + local destination=self.ratcraft[i].destination:GetName() + local type=self.aircraft.type + local Tnow=timer.getTime() + + -- Monitor time and distance on ground. + local Tg=0 + local Dg=0 + local dTlast=0 + local stationary=false --lets assume, we did move + if airborne then + -- Aircraft is airborne. + self.ratcraft[i]["Tground"]=nil + self.ratcraft[i]["Pground"]=nil + self.ratcraft[i]["Tlastcheck"]=nil + else + --Aircraft is on ground. + if self.ratcraft[i]["Tground"] then + -- Aircraft was already on ground. Calculate total time on ground. + Tg=Tnow-self.ratcraft[i]["Tground"] + + -- Distance on ground since last check. + Dg=coords:Get2DDistance(self.ratcraft[i]["Pground"]) + + -- Time interval since last check. + dTlast=Tnow-self.ratcraft[i]["Tlastcheck"] + + -- If more than Tinactive seconds passed since last check ==> check how much we moved meanwhile. + if dTlast > self.Tinactive then + + -- If aircraft did not move more than 50 m since last check, we call it stationary and despawn it. + --TODO: add case that the aircraft are currently starting their engines. This should not count as being stationary. + --local starting_engines=self.ratcraft[i].status=="" + if Dg<50 then + stationary=true + end + + -- Set the current time to know when the next check is necessary. + self.ratcraft[i]["Tlastcheck"]=Tnow + self.ratcraft[i]["Pground"]=coords + end + + else + -- First time we see that the aircraft is on ground. Initialize the times and position. + self.ratcraft[i]["Tground"]=Tnow + self.ratcraft[i]["Tlastcheck"]=Tnow + self.ratcraft[i]["Pground"]=coords + end + end + + -- Monitor travelled distance since last check. + local Pn=coords + local Dtravel=Pn:Get2DDistance(self.ratcraft[i]["Pnow"]) + self.ratcraft[i]["Pnow"]=Pn + + -- Add up the travelled distance. + self.ratcraft[i]["Distance"]=self.ratcraft[i]["Distance"]+Dtravel + + -- Distance remaining to destination. + local Ddestination=Pn:Get2DDistance(self.ratcraft[i].destination:GetCoordinate()) + + -- Status report. + if (forID and i==forID) or (not forID) then + local text=string.format("ID %i of group %s\n", i, prefix) + if self.commute then + text=text..string.format("%s commuting between %s and %s\n", type, departure, destination) + elseif self.continuejourney then + text=text..string.format("%s travelling from %s to %s (and continueing form there)\n", type, departure, destination) + else + text=text..string.format("%s travelling from %s to %s\n", type, departure, destination) + end + text=text..string.format("Status: %s", self.ratcraft[i].status) + if airborne then + text=text.." [airborne]\n" + else + text=text.." [on ground]\n" + end + text=text..string.format("Fuel = %3.0f %%\n", fuel) + text=text..string.format("Life = %3.0f %%\n", life) + text=text..string.format("FL%03d = %i m\n", alt/RAT.unit.FL2m, alt) + --text=text..string.format("Speed = %i km/h\n", vel) + text=text..string.format("Distance travelled = %6.1f km\n", self.ratcraft[i]["Distance"]/1000) + text=text..string.format("Distance to destination = %6.1f km", Ddestination/1000) + if not airborne then + text=text..string.format("\nTime on ground = %6.0f seconds\n", Tg) + text=text..string.format("Position change = %8.1f m since %3.0f seconds.", Dg, dTlast) + end + if self.debug then + env.info(RAT.id..text) + end + if self.reportstatus or message then + MESSAGE:New(text, 20):ToAll() + end + end + -- Despawn groups if they are on ground and don't move or are damaged. + if not airborne then + + -- Despawn unit if it did not move more then 50 m in the last 180 seconds. + if stationary then + local text=string.format("Group %s is despawned after being %4.0f seconds inaktive on ground.", self.SpawnTemplatePrefix, dTlast) + env.info(RAT.id..text) + self:_Despawn(group) + end + -- Despawn group if life is < 10% and distance travelled < 100 m. + if life<10 and Dtravel<100 then + local text=string.format("Damaged group %s is despawned. Life = %3.0f", self.SpawnTemplatePrefix, life) + self:_Despawn(group) + end + + end + end + else + if self.debug then + local text=string.format("Group %i does not exist.", i) + env.info(RAT.id..text) + end + end + end +end + +--- Get (relative) life of first unit of a group. +-- @param #RAT self +-- @param Wrapper.Group#GROUP group Group of unit. +-- @return #number Life of unit in percent. +function RAT:_GetLife(group) + local life=0.0 + if group and group:IsAlive() then + local unit=group:GetUnit(1) + if unit then + life=unit:GetLife()/unit:GetLife0()*100 + else + if self.debug then + env.error(RAT.id.."Unit does not exist in RAT_Getlife(). Returning zero.") + end + end + else + if self.debug then + env.error(RAT.id.."Group does not exist in RAT_Getlife(). Returning zero.") + end + end + return life +end + +--- Set status of group. +-- @param #RAT self +function RAT:_SetStatus(group, status) + local index=self:GetSpawnIndexFromGroup(group) + env.info(RAT.id.."Index for group "..group:GetName().." "..index.." status: "..status) + self.ratcraft[index].status=status +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Function is executed when a unit is spawned. +-- @param #RAT self +function RAT:_OnBirth(EventData) + + local SpawnGroup = EventData.IniGroup --Wrapper.Group#GROUP + + if SpawnGroup then + + -- Get the template name of the group. This can be nil if this was not a spawned group. + local EventPrefix = self:_GetPrefixFromGroup(SpawnGroup) + + if EventPrefix then + + -- Check that the template name actually belongs to this object. + if EventPrefix == self.alias then + + local text="Event: Group "..SpawnGroup:GetName().." was born." + env.info(RAT.id..text) + + -- Set status. + local status + if SpawnGroup:InAir() then + status="Just born (after air start)" + else + status="Starting engines (after birth)" + end + self:_SetStatus(SpawnGroup, status) + + end + end + else + if self.debug then + env.error("Group does not exist in RAT:_OnBirthDay().") + end + end +end + +--- Function is executed when a unit starts its engines. +-- @param #RAT self +function RAT:_EngineStartup(EventData) + + local SpawnGroup = EventData.IniGroup --Wrapper.Group#GROUP + + if SpawnGroup then + + -- Get the template name of the group. This can be nil if this was not a spawned group. + local EventPrefix = self:_GetPrefixFromGroup(SpawnGroup) + + if EventPrefix then + + -- Check that the template name actually belongs to this object. + if EventPrefix == self.alias then + + local text="Event: Group "..SpawnGroup:GetName().." started engines." + env.info(RAT.id..text) + + -- Set status. + local status + if SpawnGroup:InAir() then + status="On journey (after air start)" + else + status="Taxiing (after engines started)" + end + self:_SetStatus(SpawnGroup, status) + + end + end + + else + if self.debug then + env.error("Group does not exist in RAT:_EngineStartup().") + end + end +end + +--- Function is executed when a unit takes off. +-- @param #RAT self +function RAT:_OnTakeoff(EventData) + + local SpawnGroup = EventData.IniGroup --Wrapper.Group#GROUP + + if SpawnGroup then + + -- Get the template name of the group. This can be nil if this was not a spawned group. + local EventPrefix = self:_GetPrefixFromGroup(SpawnGroup) + + if EventPrefix then + + -- Check that the template name actually belongs to this object. + if EventPrefix == self.alias then + + local text="Event: Group "..SpawnGroup:GetName().." is airborne." + env.info(RAT.id..text) + + -- Set status. + self:_SetStatus(SpawnGroup, "On journey (after takeoff)") + + end + end + + else + if self.debug then + env.error("Group does not exist in RAT:_OnTakeoff().") + end + end +end + +--- Function is executed when a unit lands. +-- @param #RAT self +function RAT:_OnLand(EventData) + + local SpawnGroup = EventData.IniGroup --Wrapper.Group#GROUP + + if SpawnGroup then + + -- Get the template name of the group. This can be nil if this was not a spawned group. + local EventPrefix = self:_GetPrefixFromGroup(SpawnGroup) + + if EventPrefix then + + -- Check that the template name actually belongs to this object. + if EventPrefix == self.alias then + + local text="Event: Group "..SpawnGroup:GetName().." landed." + env.info(RAT.id..text) + + -- Set status. + self:_SetStatus(SpawnGroup, "Taxiing (after landing)") + + + if self.respawn_at_landing then + text="Event: Group "..SpawnGroup:GetName().." will be respawned." + env.info(RAT.id..text) + + -- Respawn group. + self:_Respawn(SpawnGroup) + end + + end + end + + else + if self.debug then + env.error("Group does not exist in RAT:_OnLand().") + end + end +end + +--- Function is executed when a unit shuts down its engines. +-- @param #RAT self +function RAT:_OnEngineShutdown(EventData) + + local SpawnGroup = EventData.IniGroup --Wrapper.Group#GROUP + + if SpawnGroup then + + -- Get the template name of the group. This can be nil if this was not a spawned group. + local EventPrefix = self:_GetPrefixFromGroup(SpawnGroup) + + if EventPrefix then + + -- Check that the template name actually belongs to this object. + if EventPrefix == self.alias then + + local text="Event: Group "..SpawnGroup:GetName().." shut down its engines." + env.info(RAT.id..text) + + -- Set status. + self:_SetStatus(SpawnGroup, "Parking (shutting down engines)") + + if not self.respawn_at_landing then + text="Event: Group "..SpawnGroup:GetName().." will be respawned." + env.info(RAT.id..text) + + -- Respawn group. + self:_Respawn(SpawnGroup) + end + + -- Despawn group. + text="Event: Group "..SpawnGroup:GetName().." will be destroyed now." + env.info(RAT.id..text) + self:_Despawn(SpawnGroup) + + end + end + + else + if self.debug then + env.error("Group does not exist in RAT:_OnEngineShutdown().") + end + end +end + +--- Function is executed when a unit is dead. +-- @param #RAT self +function RAT:_OnDead(EventData) + + local SpawnGroup = EventData.IniGroup --Wrapper.Group#GROUP + + if SpawnGroup then + + -- Get the template name of the group. This can be nil if this was not a spawned group. + local EventPrefix = self:_GetPrefixFromGroup(SpawnGroup) + + if EventPrefix then + + -- Check that the template name actually belongs to this object. + if EventPrefix == self.alias then + + local text="Event: Group "..SpawnGroup:GetName().." died." + env.info(RAT.id..text) + + -- Set status. + self:_SetStatus(SpawnGroup, "Destroyed (after dead)") + + end + end + + else + if self.debug then + env.error("Group does not exist in RAT:_OnDead().") + end + end +end + +--- Function is executed when a unit crashes. +-- @param #RAT self +function RAT:_OnCrash(EventData) + + local SpawnGroup = EventData.IniGroup --Wrapper.Group#GROUP + + if SpawnGroup then + + -- Get the template name of the group. This can be nil if this was not a spawned group. + local EventPrefix = self:_GetPrefixFromGroup(SpawnGroup) + + if EventPrefix then + + -- Check that the template name actually belongs to this object. + if EventPrefix == self.alias then + + local text="Event: Group "..SpawnGroup:GetName().." crashed." + env.info(RAT.id..text) + + -- Set status. + self:_SetStatus(SpawnGroup, "Crashed") + + --TODO: Aircraft are not respawned if they crash. Should they? + + --TODO: Maybe spawn some people at the crash site and send a distress call. + -- And define them as cargo which can be rescued. + end + end + + else + if self.debug then + env.error("Group does not exist in RAT:_OnCrash().") + end + end +end + +--- Despawn unit. Unit gets destoyed and group is set to nil. +-- Index of ratcraft array is taken from spawned group name. +-- @param #RAT self +-- @param Wrapper.Group#GROUP group Group to be despawned. +function RAT:_Despawn(group) + + local index=self:GetSpawnIndexFromGroup(group) + self.ratcraft[index].group:Destroy() + self.ratcraft[index].group=nil + + -- Decrease group alive counter. + self.alive=self.alive-1 + + -- Remove submenu for this group. + if self.f10menu then + self.Menu[self.SubMenuName]["groups"][index]:Remove() + end + + --TODO: Maybe here could be some more arrays deleted? +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Create a waypoint that can be used with the Route command. +-- @param #RAT self +-- @param #number Type Type of waypoint. +-- @param Core.Point#COORDINATE Coord 3D coordinate of the waypoint. +-- @param #number Speed Speed in m/s. +-- @param #number Altitude Altitude in m. +-- @param Wrapper.Airbase#AIRBASE Airport Airport of object to spawn. +-- @return #table Waypoints for DCS task route or spawn template. +function RAT:_Waypoint(Type, Coord, Speed, Altitude, Airport) + + -- Altitude of input parameter or y-component of 3D-coordinate. + local _Altitude=Altitude or Coord.y + + -- Land height at given coordinate. + local Hland=Coord:GetLandHeight() + + -- convert type and action in DCS format + local _Type=nil + local _Action=nil + local _alttype="RADIO" + local _AID=nil + + if Type==RAT.wp.cold then + -- take-off with engine off + _Type="TakeOffParking" + _Action="From Parking Area" + _Altitude = 2 + _alttype="RADIO" + _AID = Airport:GetID() + elseif Type==RAT.wp.hot then + -- take-off with engine on + _Type="TakeOffParkingHot" + _Action="From Parking Area Hot" + _Altitude = 2 + _alttype="RADIO" + _AID = Airport:GetID() + elseif Type==RAT.wp.runway then + -- take-off from runway + _Type="TakeOff" + _Action="From Parking Area" + _Altitude = 2 + _alttype="RADIO" + _AID = Airport:GetID() + elseif Type==RAT.wp.air then + -- air start + _Type="Turning Point" + _Action="Turning Point" + _alttype="BARO" + elseif Type==RAT.wp.climb then + _Type="Turning Point" + _Action="Turning Point" + --_Action="Fly Over Point" + _alttype="BARO" + elseif Type==RAT.wp.cruise then + _Type="Turning Point" + _Action="Turning Point" + --_Action="Fly Over Point" + _alttype="BARO" + elseif Type==RAT.wp.descent then + _Type="Turning Point" + _Action="Turning Point" + --_Action="Fly Over Point" + _alttype="BARO" + elseif Type==RAT.wp.holding then + _Type="Turning Point" + _Action="Turning Point" + --_Action="Fly Over Point" + _alttype="BARO" + elseif Type==RAT.wp.landing then + _Type="Land" + _Action="Landing" + _Altitude = 2 + _alttype="RADIO" + _AID = Airport:GetID() + else + env.error("Unknown waypoint type in RAT:Waypoint() function!") + _Type="Turning Point" + _Action="Turning Point" + _alttype="RADIO" + end + + -- some debug info about input parameters + local text=string.format("\n******************************************************\n") + text=text..string.format("Template = %s\n", self.SpawnTemplatePrefix) + text=text..string.format("Type: %i - %s\n", Type, _Type) + text=text..string.format("Action: %s\n", _Action) + text=text..string.format("Coord: x = %6.1f km, y = %6.1f km, alt = %6.1f m\n", Coord.x/1000, Coord.z/1000, Coord.y) + text=text..string.format("Speed = %6.1f m/s = %6.1f km/h = %6.1f knots\n", Speed, Speed*3.6, Speed*1.94384) + text=text..string.format("Land = %6.1f m ASL\n", Hland) + text=text..string.format("Altitude = %6.1f m (%s)\n", _Altitude, _alttype) + if Airport then + if Type==RAT.wp.air then + text=text..string.format("Zone = %s\n", Airport:GetName()) + else + text=text..string.format("Airport = %s with ID %i\n", Airport:GetName(), Airport:GetID()) + end + else + text=text..string.format("No airport/zone specified\n") + end + text=text.."******************************************************\n" + if self.debug then + env.info(RAT.id..text) + end + + -- define waypoint + local RoutePoint = {} + -- coordinates and altitude + RoutePoint.x = Coord.x + RoutePoint.y = Coord.z + RoutePoint.alt = _Altitude + -- altitude type: BARO=ASL or RADIO=AGL + RoutePoint.alt_type = _alttype + -- type + RoutePoint.type = _Type + RoutePoint.action = _Action + -- speed in m/s + RoutePoint.speed = Speed + RoutePoint.speed_locked = true + -- ETA (not used) + RoutePoint.ETA=nil + RoutePoint.ETA_locked = false + -- waypoint name (only for the mission editor) + RoutePoint.name="RAT waypoint" + if _AID then + RoutePoint.airdromeId=_AID + end + -- properties + RoutePoint.properties = { + ["vnav"] = 1, + ["scale"] = 0, + ["angle"] = 0, + ["vangle"] = 0, + ["steer"] = 2, + } + -- task + if Type==RAT.wp.holding then + -- Duration of holing. Between 10 and 170 seconds. + local Duration=self:_Randomize(90,0.9) + RoutePoint.task=self:_TaskHolding({x=Coord.x, y=Coord.z}, Altitude, Speed, Duration) + else + RoutePoint.task = {} + RoutePoint.task.id = "ComboTask" + RoutePoint.task.params = {} + RoutePoint.task.params.tasks = {} + end + + -- Return waypoint. + return RoutePoint +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Provide information about the assigned flightplan. +-- @param #RAT self +-- @param #table waypoints Waypoints of the flight plan. +-- @param #string comment Some comment to identify the provided information. +-- @return #number total Total route length in meters. +function RAT:_Routeinfo(waypoints, comment) + + local text=string.format("\n******************************************************\n") + text=text..string.format("Template = %s\n", self.SpawnTemplatePrefix) + if comment then + text=text..comment.."\n" + end + text=text..string.format("Number of waypoints = %i\n", #waypoints) + -- info on coordinate and altitude + for i=1,#waypoints do + local p=waypoints[i] + text=text..string.format("WP #%i: x = %6.1f km, y = %6.1f km, alt = %6.1f m\n", i-1, p.x/1000, p.y/1000, p.alt) + end + -- info on distance between waypoints + local total=0.0 + for i=1,#waypoints-1 do + local point1=waypoints[i] + local point2=waypoints[i+1] + local x1=point1.x + local y1=point1.y + local x2=point2.x + local y2=point2.y + local d=math.sqrt((x1-x2)^2 + (y1-y2)^2) + local heading=self:_Course(point1, point2) + total=total+d + text=text..string.format("Distance from WP %i-->%i = %6.1f km. Heading = %i.\n", i-1, i, d/1000, heading) + end + text=text..string.format("Total distance = %6.1f km\n", total/1000) + local text=string.format("******************************************************\n") + + -- send message + if self.debug then + env.info(RAT.id..text) + end + + -- return total route length in meters + return total +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- 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". +-- @param #RAT self +-- @param #table waypoints The waypoints of the AI flight plan. +function RAT:_ModifySpawnTemplate(waypoints) + + -- The 3D vector of the first waypoint, i.e. where we actually spawn the template group. + local PointVec3 = {x=waypoints[1].x, y=waypoints[1].alt, z=waypoints[1].y} + + -- Heading from first to seconds waypoints to align units in case of air start. + local heading = self:_Course(waypoints[1], waypoints[2]) + + if self:_GetSpawnIndex(self.SpawnIndex+1) then + + -- Get copy of spawn template. + local SpawnTemplate = self.SpawnGroups[self.SpawnIndex].SpawnTemplate + + if SpawnTemplate then + self:T(SpawnTemplate) + + -- Translate the position of the Group Template to the Vec3. + for UnitID = 1, #SpawnTemplate.units do + self:T('Before Translation SpawnTemplate.units['..UnitID..'].x = '..SpawnTemplate.units[UnitID].x..', SpawnTemplate.units['..UnitID..'].y = '..SpawnTemplate.units[UnitID].y) + local UnitTemplate = SpawnTemplate.units[UnitID] + local SX = UnitTemplate.x + local SY = UnitTemplate.y + local BX = SpawnTemplate.route.points[1].x + local BY = SpawnTemplate.route.points[1].y + local TX = PointVec3.x + (SX-BX) + local TY = PointVec3.z + (SY-BY) + SpawnTemplate.units[UnitID].x = TX + SpawnTemplate.units[UnitID].y = TY + SpawnTemplate.units[UnitID].alt = PointVec3.y + SpawnTemplate.units[UnitID].heading = math.rad(heading) + self:T('After Translation SpawnTemplate.units['..UnitID..'].x = '..SpawnTemplate.units[UnitID].x..', SpawnTemplate.units['..UnitID..'].y = '..SpawnTemplate.units[UnitID].y) + end + + -- Copy waypoints into spawntemplate. By this we avoid the nasty DCS "landing bug" :) + for i,wp in ipairs(waypoints) do + SpawnTemplate.route.points[i]=wp + end + + -- Also modify x,y of the template. Not sure why. + SpawnTemplate.x = PointVec3.x + SpawnTemplate.y = PointVec3.z + --SpawnTemplate.uncontrolled=true + + -- Update modified template for spawn group. + self.SpawnGroups[self.SpawnIndex].SpawnTemplate=SpawnTemplate + + self:T(SpawnTemplate) + end + end +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- Orbit at a specified position at a specified alititude with a specified speed. +-- @param #RAT self +-- @param Dcs.DCSTypes#Vec2 P1 The point to hold the position. +-- @param #number Altitude The altitude ASL at which to hold the position. +-- @param #number Speed The speed flying when holding the position in m/s. +-- @param #number Duration Duration of holding pattern in seconds. +-- @return Dcs.DCSTasking.Task#Task DCSTask +function RAT:_TaskHolding(P1, Altitude, Speed, Duration) + + --local LandHeight = land.getHeight(P1) + + --TODO: randomize P1 + -- Second point is 3 km north of P1 and 200 m for helos. + local dx=3000 + local dy=0 + if self.category==RAT.cat.heli then + dx=200 + dy=0 + end + + local P2={} + P2.x=P1.x+dx + P2.y=P1.y+dy + local Task = { + id = 'Orbit', + params = { + pattern = AI.Task.OrbitPattern.RACE_TRACK, + point = P1, + point2 = P2, + speed = Speed, + altitude = Altitude + } + } + + local DCSTask={} + DCSTask.id="ControlledTask" + DCSTask.params={} + DCSTask.params.task=Task + DCSTask.params.stopCondition={duration=Duration} + + return DCSTask +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +--- 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. +-- @param #RAT self +-- @param #number alpha Angle of climb [rad]. +-- @param #number beta Angle of descent [rad]. +-- @param #number d Distance between the two airports [m]. +-- @param #number phi Angle between departure and destination [rad]. +-- @param #number h0 Height [m] of departure airport. Note we implicitly assume that the height difference between departure and destination is negligible. +-- @return #number Maximal flight level in meters. +function RAT:_FLmax(alpha, beta, d, phi, h0) +-- Solve ASA triangle for one side (d) and two adjacent angles (alpha, beta) given. + local gamma=math.rad(180)-alpha-beta + local a=d*math.sin(alpha)/math.sin(gamma) + local b=d*math.sin(beta)/math.sin(gamma) + -- h1 and h2 should be equal. + local h1=b*math.sin(alpha) + local h2=a*math.sin(beta) + -- We also take the slope between departure and destination into account. + local h3=b*math.cos(math.pi/2-(alpha+phi)) + -- Debug message. + local text=string.format("\nFLmax = FL%3.0f = %6.1f m.\n", h1/RAT.unit.FL2m, h1) + text=text..string.format( "FLmax = FL%3.0f = %6.1f m.\n", h2/RAT.unit.FL2m, h2) + text=text..string.format( "FLmax = FL%3.0f = %6.1f m.", h3/RAT.unit.FL2m, h3) + if self.debug then + env.info(RAT.id..text) + end + return h3+h0 +end + + +--- Test if an airport exists on the current map. +-- @param #RAT self +-- @param #string name +-- @return #boolean True if airport exsits, false otherwise. +function RAT:_AirportExists(name) + for _,airport in pairs(self.airports_map) do + if airport:GetName()==name then + return true + end + end + return false +end + + +--- Set ROE for a group. +-- @param #RAT self +-- @param Wrapper.Group#GROUP group Group for which the ROE is set. +-- @param #string roe ROE of group. +function RAT:_SetROE(group, roe) + env.info(RAT.id.."Setting ROE to "..roe.." for group "..group:GetName()) + if self.roe==RAT.ROE.returnfire then + group:OptionROEReturnFire() + elseif self.roe==RAT.ROE.weaponfree then + group:OptionROEWeaponFree() + else + group:OptionROEHoldFire() + end +end + + +--- Set ROT for a group. +-- @param #RAT self +-- @param Wrapper.Group#GROUP group Group for which the ROT is set. +-- @param #string rot ROT of group. +function RAT:_SetROT(group, rot) + env.info(RAT.id.."Setting ROT to "..rot.." for group "..group:GetName()) + if self.rot==RAT.ROT.passive then + group:OptionROTPassiveDefense() + elseif self.rot==RAT.ROT.evade then + group:OptionROTEvadeFire() + else + group:OptionROTNoReaction() + end +end + + +--- Create a table with the valid coalitions for departure and destination airports. +-- @param #RAT self +function RAT:_SetCoalitionTable() + -- get all possible departures/destinations depending on coalition + if self.friendly==RAT.coal.all then + self.ctable={coalition.side.BLUE, coalition.side.RED, coalition.side.NEUTRAL} + elseif self.friendly==RAT.coal.blue then + self.ctable={coalition.side.BLUE, coalition.side.NEUTRAL} + elseif self.friendly==RAT.coal.blueonly then + self.ctable={coalition.side.BLUE} + elseif self.friendly==RAT.coal.red then + self.ctable={coalition.side.RED, coalition.side.NEUTRAL} + elseif self.friendly==RAT.coal.redonly then + self.ctable={coalition.side.RED} + elseif self.friendly==RAT.coal.neutral then + self.ctable={coalition.side.NEUTRAL} + elseif self.friendly==RAT.coal.same then + self.ctable={self.coalition, coalition.side.NEUTRAL} + elseif self.friendly==RAT.coal.sameonly then + self.ctable={self.coalition} + else + env.error("Unknown friendly coalition in _SetCoalitionTable(). Defaulting to NEUTRAL.") + self.ctable={self.coalition, coalition.side.NEUTRAL} + end +end + + +---Determine the heading from point a to point b. +--@param #RAT self +--@param Core.Point#COORDINATE a Point from. +--@param Core.Point#COORDINATE b Point to. +--@return #number Heading/angle in degrees. +function RAT:_Course(a,b) + local dx = b.x-a.x + -- take the right value for y-coordinate (if we have "alt" then "y" if not "z") + local ay + if a.alt then + ay=a.y + else + ay=a.z + end + local by + if b.alt then + by=b.y + else + by=b.z + end + local dy = by-ay + local angle = math.deg(math.atan2(dy,dx)) + if angle < 0 then + angle = 360 + angle + end + return angle +end + + +--- Randomize a value by a certain amount. +-- @param #RAT self +-- @param #number value The value which should be randomized +-- @param #number fac Randomization factor. +-- @param #number lower (Optional) Lower limit of the returned value. +-- @param #number upper (Optional) Upper limit of the returned value. +-- @return #number Randomized value. +-- @usage _Randomize(100, 0.1) returns a value between 90 and 110, i.e. a plus/minus ten percent variation. +-- @usage _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. +function RAT:_Randomize(value, fac, lower, upper) + local min + if lower then + min=math.max(value-value*fac, lower) + else + min=value-value*fac + end + local max + if upper then + max=math.min(value+value*fac, upper) + else + max=value+value*fac + end + + local r=math.random(min, max) + + -- debug info + if self.debug then + local text=string.format("Random: value = %6.2f, fac = %4.2f, min = %6.2f, max = %6.2f, r = %6.2f", value, fac, min, max, r) + env.info(RAT.id..text) + end + + return r +end + +--- Generate Gaussian pseudo-random numbers. +-- @param #number x0 Expectation value of distribution. +-- @param #number sigma (Optional) Standard deviation. Default 10. +-- @param #number xmin (Optional) Lower cut-off value. +-- @param #number xmax (Optional) Upper cut-off value. +-- @return #number Gaussian random number. +function RAT:_Random_Gaussian(x0, sigma, xmin, xmax) + + -- Standard deviation. Default 10 if not given. + sigma=sigma or 10 + + -- Uniform numbers in [0,1). We need two. + local x1=math.random() + local x2=math.random() + + -- Transform to Gaussian exp(-(x-x0)²/(2*sigma²). + local r = math.sqrt(-2*sigma*sigma * math.log(x1)) * math.cos(2*math.pi * x2)+x0 + --local r2 = math.sqrt(-2*sigma*sigma * math.log(x1)) * math.sin(2*math.pi * x2)+x0 + + -- Cut-off distribution at xmin. + if xmin then + r=math.max(r, xmin) + end + -- Cut-off distribution at xmax. + if xmax then + r=math.min(r, xmax) + end + + return r +end + +--- Place markers of the waypoints. Note we assume a very specific number and type of waypoints here. +-- @param #RAT self +-- @param #table waypoints Table with waypoints. +function RAT:_PlaceMarkers(waypoints) + self:_SetMarker("Takeoff", waypoints[1]) + self:_SetMarker("Climb", waypoints[2]) + self:_SetMarker("Begin of Cruise", waypoints[3]) + self:_SetMarker("End of Cruise", waypoints[4]) + self:_SetMarker("Descent", waypoints[5]) + self:_SetMarker("Holding Point", waypoints[6]) + self:_SetMarker("Destination", waypoints[7]) +end + + +--- Set a marker visible for all on the F10 map. +-- @param #RAT self +-- @param #string text Info text displayed at maker. +-- @param #table wp Position of marker coming in as waypoint, i.e. has x, y and alt components. +function RAT:_SetMarker(text, wp) + RAT.markerid=RAT.markerid+1 + self.markerids[#self.markerids+1]=RAT.markerid + if self.debug then + env.info(RAT.id..self.SpawnTemplatePrefix..": placing marker with ID "..RAT.markerid..": "..text) + end + -- Convert to coordinate. + local vec={x=wp.x, y=wp.alt, z=wp.y} + -- Place maker visible for all on the F10 map. + trigger.action.markToAll(RAT.markerid, text, vec) +end + +--- Delete all markers on F10 map. +-- @param #RAT self +function RAT:_DeleteMarkers() + --self:E({"self ids before: ", self.markerids}) + for k,v in ipairs(self.markerids) do + --env.info("Deleting marker id v= "..v) + trigger.action.removeMark(v) + end + for k,v in ipairs(self.markerids) do + --env.info("Removing marker k= "..k) + self.markerids[k]=nil + end + --self:E({"self ids after: ", self.markerids}) +end + +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \ No newline at end of file diff --git a/Moose Mission Setup/Moose.files b/Moose Mission Setup/Moose.files index 1f686de8b..b50c54d88 100644 --- a/Moose Mission Setup/Moose.files +++ b/Moose Mission Setup/Moose.files @@ -40,6 +40,7 @@ Functional/MissileTrainer.lua Functional/AirbasePolice.lua Functional/Detection.lua Functional/Designate.lua +Functional/RAT.lua AI/AI_Balancer.lua AI/AI_A2A.lua diff --git a/Moose Mission Setup/Moose.lua b/Moose Mission Setup/Moose.lua index 1cd7ba934..314c98d50 100644 --- a/Moose Mission Setup/Moose.lua +++ b/Moose Mission Setup/Moose.lua @@ -1,5 +1,5 @@ env.info( '*** MOOSE DYNAMIC INCLUDE START *** ' ) -env.info( 'Moose Generation Timestamp: 20170811_0800' ) +env.info( 'Moose Generation Timestamp: 20170909_1801' ) local base = _G @@ -60,6 +60,7 @@ __Moose.Include( 'Functional/MissileTrainer.lua' ) __Moose.Include( 'Functional/AirbasePolice.lua' ) __Moose.Include( 'Functional/Detection.lua' ) __Moose.Include( 'Functional/Designate.lua' ) +__Moose.Include( 'Functional/RAT.lua' ) __Moose.Include( 'AI/AI_Balancer.lua' ) __Moose.Include( 'AI/AI_A2A.lua' ) __Moose.Include( 'AI/AI_A2A_Patrol.lua' ) diff --git a/docs/Documentation/AI_A2A.html b/docs/Documentation/AI_A2A.html index 34f484bce..80b5691bd 100644 --- a/docs/Documentation/AI_A2A.html +++ b/docs/Documentation/AI_A2A.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_A2A_Cap.html b/docs/Documentation/AI_A2A_Cap.html index b93320257..e8e8a353b 100644 --- a/docs/Documentation/AI_A2A_Cap.html +++ b/docs/Documentation/AI_A2A_Cap.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_A2A_Dispatcher.html b/docs/Documentation/AI_A2A_Dispatcher.html index 93e30f590..d96ff9627 100644 --- a/docs/Documentation/AI_A2A_Dispatcher.html +++ b/docs/Documentation/AI_A2A_Dispatcher.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_A2A_GCI.html b/docs/Documentation/AI_A2A_GCI.html index 7a6e7ed7b..c4d7a8305 100644 --- a/docs/Documentation/AI_A2A_GCI.html +++ b/docs/Documentation/AI_A2A_GCI.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_A2A_Patrol.html b/docs/Documentation/AI_A2A_Patrol.html index 3e8626ebe..cbc75a2d6 100644 --- a/docs/Documentation/AI_A2A_Patrol.html +++ b/docs/Documentation/AI_A2A_Patrol.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_BAI.html b/docs/Documentation/AI_BAI.html index afa707ccf..51f70c756 100644 --- a/docs/Documentation/AI_BAI.html +++ b/docs/Documentation/AI_BAI.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html index 2f53c4846..bd6e5997f 100644 --- a/docs/Documentation/AI_Balancer.html +++ b/docs/Documentation/AI_Balancer.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_Cap.html b/docs/Documentation/AI_Cap.html index 715305e43..5973240c4 100644 --- a/docs/Documentation/AI_Cap.html +++ b/docs/Documentation/AI_Cap.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_Cas.html b/docs/Documentation/AI_Cas.html index 068b80a80..4e763f512 100644 --- a/docs/Documentation/AI_Cas.html +++ b/docs/Documentation/AI_Cas.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_Formation.html b/docs/Documentation/AI_Formation.html index 76e0fbc33..9de78a5e8 100644 --- a/docs/Documentation/AI_Formation.html +++ b/docs/Documentation/AI_Formation.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index 0892b0b07..5e8474fed 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • @@ -926,9 +927,6 @@ Use the method AIPATROLZONE.M - -

    This table contains the targets detected during patrol.

    -
    diff --git a/docs/Documentation/AI_RAT.html b/docs/Documentation/AI_RAT.html new file mode 100644 index 000000000..96a34ce57 --- /dev/null +++ b/docs/Documentation/AI_RAT.html @@ -0,0 +1,3196 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module AI_RAT

    + +
      +
    • Functional -- Create random airtraffic in your missions.
      • +
    + + +

    +Banner Image

    + +
    + +

    The documentation of the SPAWN class can be found further in this document.

    + +
    + +

    Global(s)

    + + + + + + + + + +
    RAT +

    RAT class

    +
    myid +

    Some ID to identify where we are

    +

    string myid

    +
    +

    Type RAT

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    RAT.AlphaDescent + +
    RAT.ClassName + +
    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 + +
    RAT.FLminuser + +
    RAT.FLuser + +
    RAT.Menu + +
    RAT.MenuF10 +

    Main F10 menu.

    +
    RAT:New(groupname) +

    Create a new RAT object.

    +
    RAT:PlaceMarkers(switch) +

    Place markers of waypoints on the F10 map.

    +
    RAT.RAT + +
    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 + +
    RAT.Vclimb + +
    RAT.Vcruisemax + +
    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(ids) +

    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) +

    Set the destination airport of the AI.

    +
    RAT:_PlaceMarkers(waypoints) +

    Place markers of the waypoints.

    +
    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 + +
    RAT.airports + +
    RAT.airports_map + +
    RAT.alive + +
    RAT.cat +

    RAT categories.

    +
    RAT.category + +
    RAT.coal +

    RAT friendly coalitions.

    +
    RAT.coalition + +
    RAT.commute + +
    RAT.continuejourney + +
    RAT.ctable + +
    RAT.debug + +
    RAT.departure_ports + +
    RAT.departure_zones + +
    RAT.destination_ports + +
    RAT.f10menu + +
    RAT.friendly + +
    RAT.markerid +

    Running number of placed markers on the F10 map.

    +
    RAT.markerids + +
    RAT.maxdist + +
    RAT.mindist + +
    RAT.placemarkers + +
    RAT.random_departure + +
    RAT.random_destination + +
    RAT.ratcraft + +
    RAT.reportstatus + +
    RAT.respawn_after_landing + +
    RAT.respawn_delay + +
    RAT.roe + +
    RAT.rot + +
    RAT.spawndelay + +
    RAT.spawninterval + +
    RAT.statusinterval + +
    RAT.takeoff + +
    RAT.unit +

    RAT unit conversions.

    +
    RAT.wp +

    RAT waypoint type.

    +
    + +

    Global(s)

    +
    +
    + + #RAT + +RAT + +
    +
    + +

    RAT class

    + +
    +
    +
    +
    + + #string + +myid + +
    +
    + +

    Some ID to identify where we are

    +

    string myid

    + +
    +
    +

    Type AI_RAT

    + +

    Type RAT

    + +

    RAT class

    + +

    Field(s)

    +
    +
    + + #number + +RAT.AlphaDescent + +
    +
    + + + +
    +
    +
    +
    + + #string + +RAT.ClassName + +
    +
    + + + +
    +
    +
    +
    + + +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 + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.FLminuser + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.FLuser + +
    +
    + + + +
    +
    +
    +
    + + #table + +RAT.Menu + +
    +
    + + + +
    +
    +
    +
    + + #RAT + +RAT.MenuF10 + +
    +
    + +

    Main F10 menu.

    + +
    +
    +
    +
    + + +RAT:New(groupname) + +
    +
    + +

    Create a new RAT object.

    + +

    Parameter

    +
      +
    • + +

      #string groupname : +Name of the group as defined in the mission editor. This group is serving as a template for all spawned units.

      + +
      • +
    +

    Return values

    +
      +
    1. + +

      #RAT: +Object of RAT class.

      + +
      2. +
    2. + +

      #nil: +If the group does not exist in the mission editor.

      + +
      3. +
    +

    Usage:

    + 
    yak:RAT("RAT_YAK") will create a RAT object called "yak". The template group in the mission editor must have the name "RAT_YAK".
    + +
    +
    +
    +
    + + +RAT:PlaceMarkers(switch) + +
    +
    + +

    Place markers of waypoints on the F10 map.

    + + +

    Default is off.

    + +

    Parameter

    +
      +
    • + +

      #boolean switch : +true=yes, false=no.

      + +
      • +
    +
    +
    +
    +
    + + #table + +RAT.RAT + +
    +
    + + + +
    +
    +
    +
    + + #RAT + +RAT.ROE + +
    +
    + +

    RAT rules of engagement.

    + +
    +
    +
    +
    + + #RAT + +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 ~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 reactino, "passive" = passive defence, "evade" = weapons free.

      + +
      • +
    +
    +
    +
    +
    + + +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-hot" for a start at airport with engines already running.

    + +

    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 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 + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.Vclimb + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.Vcruisemax + +
    +
    + + + +
    +
    +
    +
    + + +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

    + +

    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(ids) + +
    +
    + +

    Delete all markers on F10 map.

    + +

    Parameter

    +
      +
    • + +

      #table ids : +(Optional) Table holding the marker IDs to be deleted.

      + +
      • +
    +
    +
    +
    +
    + + +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

    + +
    +
    +
    +
    + + +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

    +
      +
    1. + +

      #table: +Table with possible destination airports.

      + +
      2. +
    2. + +

      #nil: +If no airports could be found.

      + +
      3. +
    +
    +
    +
    +
    + + +RAT:_GetLife(group) + +
    +
    + +

    Get (relative) life of first unit of a group.

    + +

    Parameter

    + +

    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

    + +
    +
    +
    +
    + + +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

    +
      +
    1. + +

      Wrapper.Airbase#AIRBASE: +Departure airport if spawning at airport.

      + +
      2. +
    2. + +

      Coore.Zone#ZONE: +Departure zone if spawning in air.

      + +
      3. +
    +
    +
    +
    +
    + + +RAT:_PickDestination(destinations, _random) + +
    +
    + +

    Set the destination airport of the AI.

    + + +

    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:_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

    + +
    +
    +
    +
    + + +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

    + +

    Return values

    +
      +
    1. + +

      Wrapper.Airport#AIRBASE: +Departure airbase.

      + +
      2. +
    2. + +

      Wrapper.Airport#AIRBASE: +Destination airbase.

      + +
      3. +
    3. + +

      #table: +Table of flight plan waypoints.

      + +
      4. +
    +
    +
    +
    +
    + + +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 + +RAT.airports + +
    +
    + + + +
    +
    +
    +
    + + #table + +RAT.airports_map + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.alive + +
    +
    + + + +
    +
    +
    +
    + + #RAT + +RAT.cat + +
    +
    + +

    RAT categories.

    + +
    +
    +
    +
    + + #string + +RAT.category + +
    +
    + + + +
    +
    +
    +
    + + #RAT + +RAT.coal + +
    +
    + +

    RAT friendly coalitions.

    + +
    +
    +
    +
    + + #number + +RAT.coalition + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.commute + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.continuejourney + +
    +
    + + + +
    +
    +
    +
    + + #table + +RAT.ctable + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.debug + +
    +
    + + + +
    +
    +
    +
    + + #table + +RAT.departure_ports + +
    +
    + + + +
    +
    +
    +
    + + #table + +RAT.departure_zones + +
    +
    + + + +
    +
    +
    +
    + + #table + +RAT.destination_ports + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.f10menu + +
    +
    + + + +
    +
    +
    +
    + + #string + +RAT.friendly + +
    +
    + + + +
    +
    +
    +
    + + #RAT + +RAT.markerid + +
    +
    + +

    Running number of placed markers on the F10 map.

    + +
    +
    +
    +
    + + #table + +RAT.markerids + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.maxdist + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.mindist + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.placemarkers + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.random_departure + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.random_destination + +
    +
    + + + +
    +
    +
    +
    + + #table + +RAT.ratcraft + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.reportstatus + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +RAT.respawn_after_landing + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.respawn_delay + +
    +
    + + + +
    +
    +
    +
    + + #string + +RAT.roe + +
    +
    + + + +
    +
    +
    +
    + + #string + +RAT.rot + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.spawndelay + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.spawninterval + +
    +
    + + + +
    +
    +
    +
    + + #number + +RAT.statusinterval + +
    +
    + + + +
    +
    +
    +
    + + #string + +RAT.takeoff + +
    +
    + + + +
    +
    +
    +
    + + #RAT + +RAT.unit + +
    +
    + +

    RAT unit conversions.

    + +
    +
    +
    +
    + + #RAT + +RAT.wp + +
    +
    + +

    RAT waypoint type.

    + +
    +
    + +

    Type list

    + +
    + +
    + + diff --git a/docs/Documentation/Account.html b/docs/Documentation/Account.html index 03560ecf6..24ae8f028 100644 --- a/docs/Documentation/Account.html +++ b/docs/Documentation/Account.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Airbase.html b/docs/Documentation/Airbase.html index d176bb9fc..8a7fde74a 100644 --- a/docs/Documentation/Airbase.html +++ b/docs/Documentation/Airbase.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/AirbasePolice.html b/docs/Documentation/AirbasePolice.html index 218a7d247..e8e042854 100644 --- a/docs/Documentation/AirbasePolice.html +++ b/docs/Documentation/AirbasePolice.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Assign.html b/docs/Documentation/Assign.html index d96b1fe01..6c594c093 100644 --- a/docs/Documentation/Assign.html +++ b/docs/Documentation/Assign.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Base.html b/docs/Documentation/Base.html index 01653547f..6432b71a8 100644 --- a/docs/Documentation/Base.html +++ b/docs/Documentation/Base.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 21b706849..e1ae98516 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • @@ -3417,7 +3418,6 @@ The range till cargo will board.

    - CARGO_UNIT.CargoCarrier diff --git a/docs/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html index 42bd588ce..4fd8e2211 100644 --- a/docs/Documentation/CleanUp.html +++ b/docs/Documentation/CleanUp.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Client.html b/docs/Documentation/Client.html index 357ccad2a..d32ac3da4 100644 --- a/docs/Documentation/Client.html +++ b/docs/Documentation/Client.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html index c707cb7f5..8ea876d0f 100644 --- a/docs/Documentation/CommandCenter.html +++ b/docs/Documentation/CommandCenter.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html index 2d5323c07..e0dc7cf43 100644 --- a/docs/Documentation/Controllable.html +++ b/docs/Documentation/Controllable.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSAirbase.html b/docs/Documentation/DCSAirbase.html index dcf1f5e56..93e67e7ed 100644 --- a/docs/Documentation/DCSAirbase.html +++ b/docs/Documentation/DCSAirbase.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSCoalitionObject.html b/docs/Documentation/DCSCoalitionObject.html index 4a748c821..2c94fdb31 100644 --- a/docs/Documentation/DCSCoalitionObject.html +++ b/docs/Documentation/DCSCoalitionObject.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSCommand.html b/docs/Documentation/DCSCommand.html index 0d24f3eea..d07008eea 100644 --- a/docs/Documentation/DCSCommand.html +++ b/docs/Documentation/DCSCommand.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSController.html b/docs/Documentation/DCSController.html index e9d27f273..890a42f82 100644 --- a/docs/Documentation/DCSController.html +++ b/docs/Documentation/DCSController.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSGroup.html b/docs/Documentation/DCSGroup.html index d2d97a479..d3cba7a00 100644 --- a/docs/Documentation/DCSGroup.html +++ b/docs/Documentation/DCSGroup.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSObject.html b/docs/Documentation/DCSObject.html index 5d492f76a..3bba8d8c8 100644 --- a/docs/Documentation/DCSObject.html +++ b/docs/Documentation/DCSObject.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSTask.html b/docs/Documentation/DCSTask.html index 38a572b55..6cfda94a4 100644 --- a/docs/Documentation/DCSTask.html +++ b/docs/Documentation/DCSTask.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSTypes.html b/docs/Documentation/DCSTypes.html index fb39414e4..c66abe0ae 100644 --- a/docs/Documentation/DCSTypes.html +++ b/docs/Documentation/DCSTypes.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSUnit.html b/docs/Documentation/DCSUnit.html index a1a88b247..22e5611cb 100644 --- a/docs/Documentation/DCSUnit.html +++ b/docs/Documentation/DCSUnit.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSVec3.html b/docs/Documentation/DCSVec3.html index e02fde38d..64bf19193 100644 --- a/docs/Documentation/DCSVec3.html +++ b/docs/Documentation/DCSVec3.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSWorld.html b/docs/Documentation/DCSWorld.html index a7269c14c..06b71260d 100644 --- a/docs/Documentation/DCSWorld.html +++ b/docs/Documentation/DCSWorld.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCSZone.html b/docs/Documentation/DCSZone.html index e659fd90f..b836990d3 100644 --- a/docs/Documentation/DCSZone.html +++ b/docs/Documentation/DCSZone.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCScountry.html b/docs/Documentation/DCScountry.html index 799258ab2..af9c6bd2a 100644 --- a/docs/Documentation/DCScountry.html +++ b/docs/Documentation/DCScountry.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCStimer.html b/docs/Documentation/DCStimer.html index 6063a6ed1..26e194aff 100644 --- a/docs/Documentation/DCStimer.html +++ b/docs/Documentation/DCStimer.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/DCStrigger.html b/docs/Documentation/DCStrigger.html index 363311917..f665a8946 100644 --- a/docs/Documentation/DCStrigger.html +++ b/docs/Documentation/DCStrigger.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html index 38a7a8f78..f8fc32284 100644 --- a/docs/Documentation/Database.html +++ b/docs/Documentation/Database.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index da55e5179..acd9d1911 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • @@ -1150,6 +1151,10 @@ function below will use the range 1-7 just in case

    +<<<<<<< HEAD + +======= +>>>>>>> master DESIGNATE.LaserCodes diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index aa6ec9489..4c6dc041c 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • @@ -4057,7 +4058,7 @@ Return false to cancel Transition.

    - #number + DETECTION_BASE.RefreshTimeInterval diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html index f6ee82ce5..fada6894a 100644 --- a/docs/Documentation/DetectionManager.html +++ b/docs/Documentation/DetectionManager.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Escort.html b/docs/Documentation/Escort.html index ebf59fcc1..a3777ce98 100644 --- a/docs/Documentation/Escort.html +++ b/docs/Documentation/Escort.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Event.html b/docs/Documentation/Event.html index 64b4bf9a0..94bc6481f 100644 --- a/docs/Documentation/Event.html +++ b/docs/Documentation/Event.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 177f34281..dc67c7520 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • @@ -1598,7 +1599,7 @@ A string defining the start state.

    - #string + FSM._StartState @@ -1897,6 +1898,7 @@ A string defining the start state.

    + FSM.current diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html index 7a3c2368b..99d00c1ce 100644 --- a/docs/Documentation/Group.html +++ b/docs/Documentation/Group.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html index bb4e93bce..9ff17c120 100644 --- a/docs/Documentation/Identifiable.html +++ b/docs/Documentation/Identifiable.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html index edded7fd7..be629eda7 100644 --- a/docs/Documentation/Menu.html +++ b/docs/Documentation/Menu.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Message.html b/docs/Documentation/Message.html index d4364cb07..d88a100d0 100644 --- a/docs/Documentation/Message.html +++ b/docs/Documentation/Message.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html index 17e2909ef..0b8a44d5b 100644 --- a/docs/Documentation/MissileTrainer.html +++ b/docs/Documentation/MissileTrainer.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html index ce693c0a0..97e6fddff 100644 --- a/docs/Documentation/Mission.html +++ b/docs/Documentation/Mission.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index 4307c3aaa..dfb86750e 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Object.html b/docs/Documentation/Object.html index e70b8ecd1..24a71b22c 100644 --- a/docs/Documentation/Object.html +++ b/docs/Documentation/Object.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index fef7b4f04..0126c087e 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index f5b1c4a9e..b5c697006 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • @@ -1836,7 +1837,6 @@ The height in meters to add to the altitude of the positionable.

    - Core.Spot#SPOT POSITIONABLE.Spot diff --git a/docs/Documentation/Process_JTAC.html b/docs/Documentation/Process_JTAC.html index 666b88494..98ccc6058 100644 --- a/docs/Documentation/Process_JTAC.html +++ b/docs/Documentation/Process_JTAC.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Process_Pickup.html b/docs/Documentation/Process_Pickup.html index a74b64401..4b9a003fc 100644 --- a/docs/Documentation/Process_Pickup.html +++ b/docs/Documentation/Process_Pickup.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/RAT.html b/docs/Documentation/RAT.html new file mode 100644 index 000000000..cbbba2eb8 --- /dev/null +++ b/docs/Documentation/RAT.html @@ -0,0 +1,3424 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module Rat

    + +
      +
    • Functional - Create random airtraffic in your missions.
      • +
    + + +

    +Banner Image

    + +
    + +

    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.
      • +
    • Can be used on all current (Caucasus, Nevada, Normandy) and future maps.
      • +
    + +

    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,
      • +
    • Destory 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.

    + +
    + +

    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:New(groupname) +

    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(ids) +

    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) +

    Set the destination airport of the AI.

    +
    RAT:_PlaceMarkers(waypoints) +

    Place markers of the waypoints.

    +
    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.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.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

    + +

    Process

    + +

    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

    + +

    Process

    + +
      +
    • A general flight plan has five main airborn 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

    + +

    Process

    + +

    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

    + +

    Process

    + +

    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

    + +

    Process

    + +

    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

    + +

    Process

    + +

    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

    + +

    Process

    + +

    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:New(groupname) + +
    +
    + +

    Create a new RAT object.

    + +

    Parameter

    +
      +
    • + +

      #string groupname : +Name of the group as defined in the mission editor. This group is serving as a template for all spawned units.

      + +
      • +
    +

    Return values

    +
      +
    1. + +

      #RAT: +Object of RAT class.

      + +
      2. +
    2. + +

      #nil: +If the group does not exist in the mission editor.

      + +
      3. +
    +

    Usage:

    + 
    yak:RAT("RAT_YAK") will create a RAT object called "yak". The template group in the mission editor must have the name "RAT_YAK".
    + +
    +
    +
    +
    + + +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-hot" for a start at airport with engines already running.

    + +

    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 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

    + +

    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(ids) + +
    +
    + +

    Delete all markers on F10 map.

    + +

    Parameter

    +
      +
    • + +

      #table ids : +(Optional) Table holding the marker IDs to be deleted.

      + +
      • +
    +
    +
    +
    +
    + + +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

    + +
    +
    +
    +
    + + +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

    +
      +
    1. + +

      #table: +Table with possible destination airports.

      + +
      2. +
    2. + +

      #nil: +If no airports could be found.

      + +
      3. +
    +
    +
    +
    +
    + + +RAT:_GetLife(group) + +
    +
    + +

    Get (relative) life of first unit of a group.

    + +

    Parameter

    + +

    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

    + +
    +
    +
    +
    + + +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

    +
      +
    1. + +

      Wrapper.Airbase#AIRBASE: +Departure airport if spawning at airport.

      + +
      2. +
    2. + +

      Coore.Zone#ZONE: +Departure zone if spawning in air.

      + +
      3. +
    +
    +
    +
    +
    + + +RAT:_PickDestination(destinations, _random) + +
    +
    + +

    Set the destination airport of the AI.

    + + +

    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:_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

    + +
    +
    +
    +
    + + +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

    + +

    Return values

    +
      +
    1. + +

      Wrapper.Airport#AIRBASE: +Departure airbase.

      + +
      2. +
    2. + +

      Wrapper.Airport#AIRBASE: +Destination airbase.

      + +
      3. +
    3. + +

      #table: +Table of flight plan waypoints.

      + +
      4. +
    +
    +
    +
    +
    + + +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, ...).

    + +
    +
    +
    +
    + + #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.

    + +
    +
    +
    +
    + + #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.

    + +
    +
    + +

    Type list

    + +
    + +
    + + diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html index dd150fc26..5fc5b4646 100644 --- a/docs/Documentation/Radio.html +++ b/docs/Documentation/Radio.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Route.html b/docs/Documentation/Route.html index d562152e5..7b9c61985 100644 --- a/docs/Documentation/Route.html +++ b/docs/Documentation/Route.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Scenery.html b/docs/Documentation/Scenery.html index 964ec5530..4529c2db6 100644 --- a/docs/Documentation/Scenery.html +++ b/docs/Documentation/Scenery.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/ScheduleDispatcher.html b/docs/Documentation/ScheduleDispatcher.html index 65a168015..a9155213d 100644 --- a/docs/Documentation/ScheduleDispatcher.html +++ b/docs/Documentation/ScheduleDispatcher.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html index e3681deff..ec5dfe8b4 100644 --- a/docs/Documentation/Scheduler.html +++ b/docs/Documentation/Scheduler.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Scoring.html b/docs/Documentation/Scoring.html index 3bf1d6c90..91b76b720 100644 --- a/docs/Documentation/Scoring.html +++ b/docs/Documentation/Scoring.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Sead.html b/docs/Documentation/Sead.html index a1ac3dd2e..409f76d29 100644 --- a/docs/Documentation/Sead.html +++ b/docs/Documentation/Sead.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html index 7b343aea0..5ea5133ca 100644 --- a/docs/Documentation/Set.html +++ b/docs/Documentation/Set.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 992d1808d..25ed412c2 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html index 230977c2e..14e4cd382 100644 --- a/docs/Documentation/Smoke.html +++ b/docs/Documentation/Smoke.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index aa863f1f4..7608c3d05 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • @@ -2755,6 +2756,9 @@ when nothing was spawned.

    + +

    By default, no InitLimit

    +
    @@ -2790,7 +2794,7 @@ when nothing was spawned.

    - + #number SPAWN.SpawnMaxGroups @@ -2807,7 +2811,7 @@ when nothing was spawned.

    - + #number SPAWN.SpawnMaxUnitsAlive @@ -3135,7 +3139,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
    - #boolean + SPAWN.SpawnUnControlled @@ -3159,7 +3163,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

    Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

    +

    When the first Spawn executes, all the Groups need to be made visible before start.

    diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index d8aa5e633..251693d35 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index ead3792db..f7f4e87fa 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html index efa72665c..04a72d991 100644 --- a/docs/Documentation/Static.html +++ b/docs/Documentation/Static.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/StaticObject.html b/docs/Documentation/StaticObject.html index 6ff504920..963e6ded9 100644 --- a/docs/Documentation/StaticObject.html +++ b/docs/Documentation/StaticObject.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html index 69575e798..c33573603 100644 --- a/docs/Documentation/Task.html +++ b/docs/Documentation/Task.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Task_A2A.html b/docs/Documentation/Task_A2A.html index 53005ee57..da59f25d5 100644 --- a/docs/Documentation/Task_A2A.html +++ b/docs/Documentation/Task_A2A.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Task_A2A_Dispatcher.html b/docs/Documentation/Task_A2A_Dispatcher.html index 6c6029eb9..10cbbda64 100644 --- a/docs/Documentation/Task_A2A_Dispatcher.html +++ b/docs/Documentation/Task_A2A_Dispatcher.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html index 841460bca..014905fb4 100644 --- a/docs/Documentation/Task_A2G.html +++ b/docs/Documentation/Task_A2G.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Task_A2G_Dispatcher.html b/docs/Documentation/Task_A2G_Dispatcher.html index 19f576d02..4c9ff113b 100644 --- a/docs/Documentation/Task_A2G_Dispatcher.html +++ b/docs/Documentation/Task_A2G_Dispatcher.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 743615651..c7e689347 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • @@ -552,7 +553,7 @@ based on the tasking capabilities defined in Task#TA
    - + Core.Cargo#CARGO FSM_PROCESS.Cargo @@ -630,7 +631,7 @@ based on the tasking capabilities defined in Task#TA
    - #number + TASK_CARGO.CargoLimit diff --git a/docs/Documentation/Task_PICKUP.html b/docs/Documentation/Task_PICKUP.html index 327fe472e..01f437f36 100644 --- a/docs/Documentation/Task_PICKUP.html +++ b/docs/Documentation/Task_PICKUP.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Unit.html b/docs/Documentation/Unit.html index 2185df762..4dc9e6940 100644 --- a/docs/Documentation/Unit.html +++ b/docs/Documentation/Unit.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html index 3fbab0987..c83693215 100644 --- a/docs/Documentation/Utils.html +++ b/docs/Documentation/Utils.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html index 67e25dafa..4525f8bc0 100644 --- a/docs/Documentation/Zone.html +++ b/docs/Documentation/Zone.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/env.html b/docs/Documentation/env.html index 09dbbfcd0..a88348417 100644 --- a/docs/Documentation/env.html +++ b/docs/Documentation/env.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html index 25dd9ab34..f84a58bb2 100644 --- a/docs/Documentation/index.html +++ b/docs/Documentation/index.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • @@ -520,6 +521,14 @@ are design patterns allowing efficient (long-lasting) processes and workflows.Radio

    Core -- The RADIO Module is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions...

    + + + + Rat + +
      +
    • Functional - Create random airtraffic in your missions.
      • +
    diff --git a/docs/Documentation/land.html b/docs/Documentation/land.html index e4a3153a4..faf8ff947 100644 --- a/docs/Documentation/land.html +++ b/docs/Documentation/land.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Documentation/routines.html b/docs/Documentation/routines.html index 18dfebc72..d055a38df 100644 --- a/docs/Documentation/routines.html +++ b/docs/Documentation/routines.html @@ -73,6 +73,7 @@
  • Process_JTAC
  • Process_Pickup
  • Radio
    • +
  • Rat
  • Route
  • Scenery
  • ScheduleDispatcher
    • diff --git a/docs/Presentations/RAT/RAT.png b/docs/Presentations/RAT/RAT.png new file mode 100644 index 000000000..1cfd25ca1 Binary files /dev/null and b/docs/Presentations/RAT/RAT.png differ diff --git a/docs/Presentations/RAT/RAT_Airport_Selection.png b/docs/Presentations/RAT/RAT_Airport_Selection.png new file mode 100644 index 000000000..505a53353 Binary files /dev/null and b/docs/Presentations/RAT/RAT_Airport_Selection.png differ diff --git a/docs/Presentations/RAT/RAT_Basic_Lua_Script.png b/docs/Presentations/RAT/RAT_Basic_Lua_Script.png new file mode 100644 index 000000000..6aacf0afb Binary files /dev/null and b/docs/Presentations/RAT/RAT_Basic_Lua_Script.png differ diff --git a/docs/Presentations/RAT/RAT_Examples_Misc.png b/docs/Presentations/RAT/RAT_Examples_Misc.png new file mode 100644 index 000000000..f6f0ba56e Binary files /dev/null and b/docs/Presentations/RAT/RAT_Examples_Misc.png differ diff --git a/docs/Presentations/RAT/RAT_Examples_Spawn_at_Zones.png b/docs/Presentations/RAT/RAT_Examples_Spawn_at_Zones.png new file mode 100644 index 000000000..95ce76ce6 Binary files /dev/null and b/docs/Presentations/RAT/RAT_Examples_Spawn_at_Zones.png differ diff --git a/docs/Presentations/RAT/RAT_Examples_Spawn_in_Air.png b/docs/Presentations/RAT/RAT_Examples_Spawn_in_Air.png new file mode 100644 index 000000000..376775bed Binary files /dev/null and b/docs/Presentations/RAT/RAT_Examples_Spawn_in_Air.png differ diff --git a/docs/Presentations/RAT/RAT_Examples_Specify_Departure_and_Destination.png b/docs/Presentations/RAT/RAT_Examples_Specify_Departure_and_Destination.png new file mode 100644 index 000000000..853eb9cbd Binary files /dev/null and b/docs/Presentations/RAT/RAT_Examples_Specify_Departure_and_Destination.png differ diff --git a/docs/Presentations/RAT/RAT_Flight_Plan.png b/docs/Presentations/RAT/RAT_Flight_Plan.png new file mode 100644 index 000000000..159c53a23 Binary files /dev/null and b/docs/Presentations/RAT/RAT_Flight_Plan.png differ diff --git a/docs/Presentations/RAT/RAT_Mission_Setup.png b/docs/Presentations/RAT/RAT_Mission_Setup.png new file mode 100644 index 000000000..b30dadb13 Binary files /dev/null and b/docs/Presentations/RAT/RAT_Mission_Setup.png differ