Module Functional.RAT

RAT self object.

RAT:ATC_Delay(time)

Delay between granting landing clearance for simultanious landings.

This setting effects all RAT objects and groups!

Defined in:

RAT

Parameter:

#number time

Delay time when the next aircraft will get landing clearance event if the previous one did not land yet. Default is 240 sec.

Return value:

RAT self object.

RAT:ATC_Messages(switch)

Turn messages from ATC on or off.

Default is on. This setting effects all RAT objects and groups!

Defined in:

RAT

Parameter:

#boolean switch

Enable (true) or disable (false) messages from ATC.

Return value:

RAT self object.

RAT:ActivateUncontrolled(maxactivated, delay, delta, frand)

Activate uncontrolled aircraft.

Defined in:

RAT

Parameters:

#number maxactivated

Maximal numnber of activated aircraft. Absolute maximum will be the number of spawned groups. Default is 1.

#number delay

Time delay in seconds before (first) aircraft is activated. Default is 1 second.

#number delta

Time difference in seconds before next aircraft is activated. Default is 1 second.

#number frand

Factor [0,...,1] for randomization of time difference between aircraft activations. Default is 0, i.e. no randomization.

Return value:

RAT self object.

RAT:AddFriendlyAirportsToDepartures()

Add all friendly airports to the list of possible departures.

Defined in:

RAT

Return value:

RAT self object.

RAT:AddFriendlyAirportsToDestinations()

Add all friendly airports to the list of possible destinations

Defined in:

RAT

Return value:

RAT self object.

RAT:ChangeAircraft(actype)

Change aircraft type.

This is a dirty hack which allows to change the aircraft type of the template group. Note that all parameters like cruise speed, climb rate, range etc are still taken from the template group which likely leads to strange behaviour.

Defined in:

RAT

Parameter:

#string actype

Type of aircraft which is spawned independent of the template group. Use with care and expect problems!

Return value:

RAT self object.

RAT:CheckOnRunway(switch, radius, distance)

Check if aircraft have accidentally been spawned on the runway.

If so they will be removed immediatly.

Defined in:

RAT

Parameters:

#boolean switch

If true, check is performed. If false, this check is omitted.

#number radius

Distance in meters until a unit is considered to have spawned accidentally on the runway. Default is 75 m.

distance

Return value:

RAT self object.

RAT:CheckOnTop(switch, radius)

Check if aircraft have accidentally been spawned on top of each other.

If yes, they will be removed immediately.

Defined in:

RAT

Parameters:

#boolean switch

If true, check is performed. If false, this check is omitted.

#number radius

Radius in meters until which a unit is considered to be on top of each other. Default is 2 m.

Return value:

RAT self object.

RAT:ClearForLanding(name)

Clear flight for landing.

Sets tigger value to 1.

Defined in:

RAT

Parameter:

#string name

Name of flight to be cleared for landing.

RAT:Commute(starshape)

Aircraft will commute between their departure and destination airports or zones.

Defined in:

RAT

Parameter:

#boolean starshape

If true, keep homebase, i.e. travel A-->B-->A-->C-->A-->D... instead of A-->B-->A-->B-->A...

Return value:

RAT self object.

RAT:ContinueJourney()

Aircraft will continue their journey from their destination.

This means they are respawned at their destination and get a new random destination.

Defined in:

RAT

Return value:

RAT self object.

RAT:Debugmode()

Enable debug mode.

More output in dcs.log file and onscreen messages to all.

Defined in:

RAT

Return value:

RAT self object.

RAT:DestinationZone()

Destinations are treated as zones.

Aircraft will not land but rather be despawned when they reach a random point in the zone.

Defined in:

RAT

Return value:

RAT self object.

RAT:EnableATC(switch)

Enable ATC, which manages the landing queue for RAT aircraft if they arrive simultaniously at the same airport.

Defined in:

RAT

Parameter:

#boolean switch

Enable ATC (true) or Disable ATC (false). No argument means ATC enabled.

Return value:

RAT self object.

RAT:ExcludedAirports(ports)

Airports, FARPs and ships explicitly excluded as departures and destinations.

Defined in:

RAT

Parameter:

#string ports

Name or table of names of excluded airports.

Return value:

RAT self object.

RAT:GetStatus(group)

Get status of group.

Defined in:

RAT

Parameter:

Wrapper.Group#GROUP group

Group.

Return value:

#string:

status Status of group.

RAT:Immortal()

Aircraft are immortal.

Defined in:

RAT

Return value:

RAT self object.

RAT:Invisible()

Aircraft are invisible.

Defined in:

RAT

Return value:

RAT self object.

RAT:Livery(skins)

Set livery of aircraft.

If more than one livery is specified in a table, the actually used one is chosen randomly from the selection.

Defined in:

RAT

Parameter:

#table skins

Name of livery or table of names of liveries.

Return value:

RAT self object.

RAT:MenuName(name)

Set the name of the F10 submenu.

Default is the name of the template group.

Defined in:

RAT

Parameter:

#string name

Submenu name.

Return value:

RAT self object.

RAT:New(groupname, alias)

Create a new RAT object.

Defined in:

RAT

Parameters:

#string groupname

Name of the group as defined in the mission editor. This group is serving as a template for all spawned units.

#string alias

(Optional) Alias of the group. This is and optional parameter but must(!) be used if the same template group is used for more than one RAT object.

Return value:

Object of RAT class or nil if the group does not exist in the mission editor.

Usages:

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

yak2:RAT("RAT_YAK", "Yak2") will create a RAT object "yak2". The template group in the mission editor must have the name "RAT_YAK" but the group will be called "Yak2" in e.g. the F10 menu.

RAT:NoRespawn()

Aircraft will not get respawned when they finished their route.

Defined in:

RAT

Return value:

RAT self object.

RAT:ParkingSpotDB(switch)

Put parking spot coordinates in a data base for future use of aircraft.

(Obsolete! API function will be removed soon.)

Defined in:

RAT

Parameter:

#boolean switch

If true, parking spots are memorized. This is also the default setting.

Return value:

RAT self object.

RAT:PlaceMarkers(switch)

Place markers of waypoints on the F10 map.

Default is off.

Defined in:

RAT

Parameter:

#boolean switch

true=yes, false=no.

Return value:

RAT self object.

RAT:RadioFrequency(frequency)

Set radio frequency.

Defined in:

RAT

Parameter:

#number frequency

Radio frequency.

Return value:

RAT self object.

RAT:RadioMenuOFF()

Radio menu Off.

This is the default setting.

Defined in:

RAT

Return value:

RAT self object.

RAT:RadioMenuON()

Radio menu On.

Default is off.

Defined in:

RAT

Return value:

RAT self object.

RAT:RadioModulation(modulation)

Set radio modulation.

Default is AM.

Defined in:

RAT

Parameter:

#string modulation

Either "FM" or "AM". If no value is given, modulation is set to AM.

Return value:

RAT self object.

RAT:RadioOFF()

Disable Radio.

Overrules the ME setting.

Defined in:

RAT

Return value:

RAT self object.

RAT:RadioON()

Enable Radio.

Overrules the ME setting.

Defined in:

RAT

Return value:

RAT self object.

RAT:RespawnAfterCrashOFF()

Aircraft will not be respawned after they crashed or get shot down.

Defined in:

RAT

Return value:

RAT self object.

RAT:RespawnAfterCrashON()

Aircraft will be respawned after they crashed or get shot down.

This is the default behavior.

Defined in:

RAT

Return value:

RAT self object.

RAT:RespawnAfterLanding(delay)

Make aircraft respawn the moment they land rather than at engine shut down.

Defined in:

RAT

Parameter:

#number delay

(Optional) Delay in seconds until respawn happens after landing. Default is 180 seconds. Minimum is 1.0 seconds.

Return value:

RAT self object.

RAT:RespawnAfterTakeoff()

Aircraft will be respawned directly after take-off.

Defined in:

RAT

Return value:

RAT self object.

RAT:RespawnInAirAllowed()

If aircraft cannot be spawned on parking spots, it is allowed to spawn them in air above the same airport.

Note that this is also the default behavior.

Defined in:

RAT

Return value:

RAT self object.

RAT:RespawnInAirNotAllowed()

If aircraft cannot be spawned on parking spots, it is NOT allowed to spawn them in air.

This has only impact if aircraft are supposed to be spawned on the ground (and not in a zone).

Defined in:

RAT

Return value:

RAT self object.

RAT:ReturnZone()

Aircraft will fly to a random point within a zone and then return to its departure airport or zone.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetAISkill(skill)

Set skill of AI aircraft.

Default is "High".

Defined in:

RAT

Parameter:

#string skill

Skill, options are "Average", "Good", "High", "Excellent" and "Random". Parameter is case insensitive.

Return value:

RAT self object.

RAT:SetClimbRate(rate)

Set the climb rate.

This automatically sets the climb angle.

Defined in:

RAT

Parameter:

#number rate

Climb rate in ft/min. Default is 1500 ft/min. Minimum is 100 ft/min. Maximum is 15,000 ft/min.

Return value:

RAT self object.

RAT:SetCoalition(friendly)

Set the friendly coalitions from which the airports can be used as departure and destination.

Defined in:

RAT

Parameter:

#string friendly

"same"=own coalition+neutral (default), "sameonly"=own coalition only, "neutral"=all neutral airports. Default is "same", so aircraft will use airports of the coalition their spawn template has plus all neutral airports.

Return value:

RAT self object.

Usages:

yak:SetCoalition("neutral") will spawn aircraft randomly on all neutral airports.

yak:SetCoalition("sameonly") will spawn aircraft randomly on airports belonging to the same coalition only as the template.

RAT:SetCoalitionAircraft(color)

Set coalition of RAT group.

You can make red templates blue and vice versa. Note that a country is also set automatically if it has not done before via RAT:SetCountry.

For blue, the country is set to USA.
For red, the country is set to RUSSIA.
For neutral, the country is set to SWITZERLAND.

This is important, since it is ultimately the COUNTRY that determines the coalition of the aircraft. You can set the country explicitly via the RAT:SetCountry() function if necessary.

Defined in:

RAT

Parameter:

#string color

Color of coalition, i.e. "red" or blue" or "neutral".

Return value:

RAT self object.

RAT:SetCountry(id)

Set country of RAT group.

See DCS_enum_country.

This overrules the coalition settings. So if you want your group to be of a specific coalition, you have to set a country that is part of that coalition.

Defined in:

RAT

Parameter:

DCS#country.id id

DCS country enumerator ID. For example country.id.USA or country.id.RUSSIA.

Return value:

RAT self object.

RAT:SetCruiseAltitude(alt)

Set cruising altitude.

This is still be checked for consitancy with selected route and prone to radomization.

Defined in:

RAT

Parameter:

#number alt

Cruising altitude ASL in meters.

Return value:

RAT self object.

RAT:SetDeparture(departurenames)

Set possible departure ports.

This can be an airport or a zone.

Defined in:

RAT

Parameter:

#string departurenames

Name or table of names of departure airports or zones.

Return value:

RAT self object.

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, or within a zone around Gudauta airport. Note that this also requires RAT:takeoff("air") to be set.

RAT:SetDeparturesFromZone(zone)

Include all airports which lie in a zone as possible destinations.

Defined in:

RAT

Parameter:

Core.Zone#ZONE zone

Zone in which the departure airports lie. Has to be a MOOSE zone.

Return value:

RAT self object.

RAT:SetDescentAngle(angle)

Set the angle of descent.

Default is 3.6 degrees, which corresponds to 3000 ft descent after one mile of travel.

Defined in:

RAT

Parameter:

#number angle

Angle of descent in degrees. Minimum is 0.5 deg. Maximum 50 deg.

Return value:

RAT self object.

RAT:SetDespawnAirOFF()

Aircraft that reach their destination zone are not despawned.

They will probably go the the nearest airbase and try to land.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetDestination(destinationnames)

Set name of destination airports or zones for the AI aircraft.

Defined in:

RAT

Parameter:

#string destinationnames

Name of the destination airport or table of destination airports.

Return value:

RAT self object.

Usage:

RAT:SetDestination("Krymsk") makes all aircraft of this RAT oject fly to Krymsk airport.

RAT:SetDestinationsFromZone(zone)

Include all airports which lie in a zone as possible destinations.

Defined in:

RAT

Parameter:

Core.Zone#ZONE zone

Zone in which the destination airports lie. Has to be a MOOSE zone.

Return value:

RAT self object.

RAT:SetEPLRS(switch)

Turn EPLRS datalink on/off.

Defined in:

RAT

Parameter:

#boolean switch

If true (or nil), turn EPLRS on.

Return value:

RAT self object.

RAT:SetFL(FL)

Set flight level.

Setting this value will overrule all other logic. Aircraft will try to fly at this height regardless.

Defined in:

RAT

Parameter:

#number FL

Fight Level in hundrets of feet. E.g. FL200 = 20000 ft ASL.

Return value:

RAT self object.

RAT:SetFLcruise(FL)

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.

Defined in:

RAT

Parameter:

#number FL

Flight level in hundrets of feet. E.g. FL200 = 20000 ft ASL.

Return value:

RAT self object.

RAT:SetFLmax(FL)

Set max flight level.

Setting this value will overrule all other logic. Aircraft will try to fly at less than this FL regardless.

Defined in:

RAT

Parameter:

#number FL

Maximum Fight Level in hundrets of feet.

Return value:

RAT self object.

RAT:SetFLmin(FL)

Set min flight level.

Setting this value will overrule all other logic. Aircraft will try to fly at higher than this FL regardless.

Defined in:

RAT

Parameter:

#number FL

Maximum Fight Level in hundrets of feet.

Return value:

RAT self object.

RAT:SetMaxCruiseAltitude(alt)

Set max cruising altitude above sea level.

Defined in:

RAT

Parameter:

#number alt

Altitude ASL in meters.

Return value:

RAT self object.

RAT:SetMaxCruiseSpeed(speed)

Set the maximum cruise speed of the aircraft.

Defined in:

RAT

Parameter:

#number speed

Speed in km/h.

Return value:

RAT self object.

RAT:SetMaxDistance(dist)

Set maximum distance between departure and destination.

Default is 5000 km but aircarft range is also taken into account automatically.

Defined in:

RAT

Parameter:

#number dist

Distance in km.

Return value:

RAT self object.

RAT:SetMaxRespawnTriedWhenSpawnedOnRunway(n)

Number of tries to respawn an aircraft in case it has accitentally been spawned on runway.

Defined in:

RAT

Parameter:

#number n

Number of retries. Default is 3.

Return value:

RAT self object.

RAT:SetMinCruiseAltitude(alt)

Set min cruising altitude above sea level.

Defined in:

RAT

Parameter:

#number alt

Altitude ASL in meters.

Return value:

RAT self object.

RAT:SetMinDistance(dist)

Set minimum distance between departure and destination.

Default is 5 km. Minimum distance should not be smaller than maybe ~100 meters to ensure that departure and destination are different.

Defined in:

RAT

Parameter:

#number dist

Distance in km.

Return value:

RAT self object.

RAT:SetOnboardNum(tailnumprefix, zero)

Set onboard number prefix.

Same as setting "TAIL #" in the mission editor. Note that if you dont use this function, the values defined in the template group of the ME are taken.

Defined in:

RAT

Parameters:

#string tailnumprefix

String of the tail number prefix. If flight consists of more than one aircraft, two digits are appended automatically, i.e. 001, 002, ...

#number zero

(Optional) Starting value of the automatically appended numbering of aircraft within a flight. Default is 0.

Return value:

RAT self object.

RAT:SetParkingScanRadius(radius)

Set the scan radius around parking spots.

Parking spot is considered to be occupied if any obstacle is found with the radius.

Defined in:

RAT

Parameter:

#number radius

Radius in meters. Default 50 m.

Return value:

RAT self object.

RAT:SetParkingScanSceneryOFF()

Disables scanning for scenery objects around parking spots which might block the spot.

This is also the default setting.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetParkingScanSceneryON()

Enables scanning for scenery objects around parking spots which might block the spot.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetParkingSpotSafeOFF()

A parking spot is free as soon as possible aircraft has left the place.

This is the default.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetParkingSpotSafeON()

A parking spot is not free until a possible aircraft has left and taken off.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetROE(roe)

Set rules of engagement (ROE).

Default is weapon hold. This is a peaceful class.

Defined in:

RAT

Parameter:

#string roe

"hold" = weapon hold, "return" = return fire, "free" = weapons free.

Return value:

RAT self object.

RAT:SetROT(rot)

Set reaction to threat (ROT).

Default is no reaction, i.e. aircraft will simply ignore all enemies.

Defined in:

RAT

Parameter:

#string rot

"noreaction" = no reaction to threats, "passive" = passive defence, "evade" = evade enemy attacks.

Return value:

RAT self object.

RAT:SetRespawnDelay(delay)

Sets the delay between despawning and respawning aircraft.

Defined in:

RAT

Parameter:

#number delay

Delay in seconds until respawn happens. Default is 1 second. Minimum is 1 second.

Return value:

RAT self object.

RAT:SetSpawnDelay(delay)

Set the delay before first group is spawned.

Defined in:

RAT

Parameter:

#number delay

Delay in seconds. Default is 5 seconds. Minimum delay is 0.5 seconds.

Return value:

RAT self object.

RAT:SetSpawnInterval(interval)

Set the interval between spawnings of the template group.

Defined in:

RAT

Parameter:

#number interval

Interval in seconds. Default is 5 seconds. Minimum is 0.5 seconds.

Return value:

RAT self object.

RAT:SetTakeoff(type)

Set takeoff type.

Starting cold at airport, starting hot at airport, starting at runway, starting in the air. Default is "takeoff-coldorhot". So there is a 50% chance that the aircraft starts with cold engines and 50% that it starts with hot engines.

Defined in:

RAT

Parameter:

#string type

Type can be "takeoff-cold" or "cold", "takeoff-hot" or "hot", "takeoff-runway" or "runway", "air".

Return value:

RAT self object.

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:SetTakeoffAir()

Set takeoff type to air.

Aircraft will spawn in the air.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetTakeoffCold()

Set takeoff type cold.

Aircraft will spawn at a parking spot with engines off.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetTakeoffColdOrHot()

Set takeoff type to cold or hot.

Aircraft will spawn at a parking spot with 50:50 change of engines on or off.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetTakeoffHot()

Set takeoff type to hot.

Aircraft will spawn at a parking spot with engines on.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetTakeoffRunway()

Set takeoff type to runway.

Aircraft will spawn directly on the runway.

Defined in:

RAT

Return value:

RAT self object.

RAT:SetTerminalType(termtype)

Set the terminal type the aircraft use when spawning at an airbase.

See DCS_func_getParking. Note that some additional terminal types have been introduced. Check Wrapper.Airbase#AIRBASE class for details. Also note that only airports which have this kind of terminal are possible departures and/or destinations.

Defined in:

RAT

Parameter:

Wrapper.Airbase#AIRBASE.TerminalType termtype

Type of terminal. Use enumerator AIRBASE.TerminalType.XXX.

Return value:

RAT self object.

Usage:

c17=RAT:New("C-17 BIG Plane")
c17:SetTerminalType(AIRBASE.TerminalType.OpenBig) -- Only very big parking spots are used.
c17:Spawn(5)

RAT:Spawn(naircraft)

Triggers the spawning of AI aircraft.

Note that all additional options should be set before giving the spawn command.

Defined in:

RAT

Parameter:

#number naircraft

(Optional) Number of aircraft to spawn. Default is one aircraft.

Return value:

#boolean:

True if spawning was successful or nil if nothing was spawned.

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

RAT:Status(message, forID)

Report status of RAT groups.

Defined in:

RAT

Parameters:

#boolean message

(Optional) Send message with report to all if true.

#number forID

(Optional) Send message only for this ID.

RAT:StatusReports(switch)

Aircraft report status update messages along the route.

Defined in:

RAT

Parameter:

#boolean switch

Swtich reports on (true) or off (false). No argument is on.

Return value:

RAT self object.

RAT:TimeDestroyInactive(time)

Set the time after which inactive groups will be destroyed.

Defined in:

RAT

Parameter:

#number time

Time in seconds. Default is 600 seconds = 10 minutes. Minimum is 60 seconds.

Return value:

RAT self object.

RAT:Uncontrolled()

Spawn aircraft in uncontrolled state.

Aircraft will only sit at their parking spots. They can be activated randomly by the RAT:ActivateUncontrolled() function.

Defined in:

RAT

Return value:

RAT self object.

RAT:_ATCAddFlight(name, dest)

Adds andd initializes a new flight after it was spawned.

Defined in:

RAT

Parameters:

#string name

Group name of the flight.

#string dest

Name of the destination airport.

RAT:_ATCCheck()

Main ATC function.

Updates the landing queue of all airports and inceases holding time for all flights.

Defined in:

RAT

RAT:_ATCClearForLanding(airport, flight)

Giving landing clearance for aircraft by setting user flag.

Defined in:

RAT

Parameters:

#string airport

Name of destination airport.

#string flight

Group name of flight, which gets landing clearence.

RAT:_ATCDelFlight(t, entry)

Deletes a flight from ATC lists after it landed.

Defined in:

RAT

Parameters:

#table t

Table.

#string entry

Flight name which shall be deleted.

RAT:_ATCFlightLanded(name)

Takes care of organisational stuff after a plane has landed.

Defined in:

RAT

Parameter:

#string name

Group name of flight.

RAT:_ATCInit(airports_map)

Initializes the ATC arrays and starts schedulers.

Defined in:

RAT

Parameter:

#table airports_map

List of all airports of the map.

RAT:_ATCQueue()

Creates a landing queue for all flights holding at airports.

Aircraft with longest holding time gets first permission to land.

Defined in:

RAT

RAT:_ATCRegisterFlight(name, time)

Registers a flight once it is near its holding point at the final destination.

Defined in:

RAT

Parameters:

#string name

Group name of the flight.

#number time

Time the fight first registered.

RAT:_ATCStatus()

ATC status report about flights.

Defined in:

RAT

RAT:_ActivateUncontrolled()

Randomly activates an uncontrolled aircraft.

Defined in:

RAT

RAT:_AddFriendlyAirports(ports)

Add names of all friendly airports to possible departure or destination airports if they are not already in the list.

Defined in:

RAT

Parameter:

#table ports

List of departure or destination airports/zones that will be added.

RAT:_AirportExists(name)

Test if an airport exists on the current map.

Defined in:

RAT

Parameter:

#string name

Return value:

#boolean:

True if airport exsits, false otherwise.

RAT:_AnticipatedGroupName(index)

Anticipated group name from alias and spawn index.

Defined in:

RAT

Parameter:

#number index

Spawnindex of group if given or self.SpawnIndex+1 by default.

Return value:

#string:

Name the group will get after it is spawned.

RAT:_CheckConsistency()

Function checks consistency of user input and automatically adjusts parameters if necessary.

Defined in:

RAT

RAT:_CheckOnTop(group, distmin)

Find aircraft that have accidentally been spawned on top of each other.

Defined in:

RAT

Parameters:

Wrapper.Group#GROUP group

Units of this group will be checked.

#number distmin

Allowed distance in meters between units. Units with a distance smaller than this number are considered to be on top of each other.

Return value:

#boolean:

True if group was destroyed because it was on top of another unit. False if otherwise.

RAT:_CommandImmortal(group, switch)

Set RAT group to be (im-)mortal.

Defined in:

RAT

Parameters:

Wrapper.Group#GROUP group

Group to be set (im-)mortal.

#boolean switch

True enables immortality, false disables it.

RAT:_CommandInvisible(group, switch)

Set RAT group to (in-)visible for other AI forces.

Defined in:

RAT

Parameters:

Wrapper.Group#GROUP group

Group to be set (in)visible.

#boolean switch

If true, the group is invisible. If false the group will be visible.

RAT:_CommandStartUncontrolled(group)

Start uncontrolled aircraft group.

Defined in:

RAT

Parameter:

Wrapper.Group#GROUP group

Group to be activated.

RAT:_Course(a, b)

Determine the heading from point a to point b.

Defined in:

RAT

Parameters:

Core.Point#COORDINATE a

Point from.

Core.Point#COORDINATE b

Point to.

Return value:

#number:

Heading/angle in degrees.

RAT:_CreateEventDead(EventTime, Initiator)

Create a Dead event.

Defined in:

RAT

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

RAT:_Debug(switch)

Turn debug messages on or off.

Default is off.

Defined in:

RAT

Parameter:

#boolean switch

Turn debug on=true or off=false. No argument means on.

Return value:

RAT self object.

RAT:_DeleteMarkers()

Delete all markers on F10 map.

Defined in:

RAT

RAT:_Despawn(group, delay)

Despawn unit.

Unit gets destoyed and group is set to nil. Index of ratcraft array is taken from spawned group name.

Defined in:

RAT

Parameters:

Wrapper.Group#GROUP group

Group to be despawned.

#number delay

Delay in seconds before the despawn happens.

RAT:_Destroy(group)

Destroys the RAT DCS group and all of its DCS units.

Note that this raises a DEAD event at run-time. So all event listeners will catch the DEAD event of this DCS group.

Defined in:

RAT

Parameter:

Wrapper.Group#GROUP group

The RAT group to be destroyed.

RAT:_Excluded(port)

Check if airport is excluded from possible departures and destinations.

Defined in:

RAT

Parameter:

#string port

Name of airport, FARP or ship to check.

Return value:

#boolean:

true if airport is excluded and false otherwise.

RAT:_GetAirportsInZone(zone)

Find airports within a zone.

Defined in:

RAT

Parameter:

Core.Zone#ZONE zone

Return value:

list Table with airport names that lie within the zone.

RAT:_GetAirportsOfCoalition()

Get all "friendly" airports of the current map.

Fills the self.airports{} table.

Defined in:

RAT

RAT:_GetAirportsOfMap()

Get all airports of the current map.

Defined in:

RAT

RAT:_GetLife(group)

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

Defined in:

RAT

Parameter:

Wrapper.Group#GROUP group

Group of unit.

Return value:

#number:

Life of unit in percent.

RAT:_GetObjectSize(unit)

Get aircraft dimensions length, width, height.

Defined in:

RAT

Parameter:

Wrapper.Unit#UNIT unit

The unit which is we want the size of.

Return value:

#number:

Size, i.e. max(length,width) of unit.

RAT:_Heading(course)

Determine the heading for an aircraft to be entered in the route template.

Defined in:

RAT

Parameter:

#number course

The course between two points in degrees.

Return value:

#number:

heading Heading in rad.

RAT:_InitAircraft(DCSgroup)

Initialize basic parameters of the aircraft based on its (template) group in the mission editor.

Defined in:

RAT

Parameter:

DCS#Group DCSgroup

Group of the aircraft in the mission editor.

RAT:_IsFriendly(port)

Check if airport is friendly, i.e.

belongs to the right coalition.

Defined in:

RAT

Parameter:

#string port

Name of airport, FARP or ship to check.

Return value:

#boolean:

true if airport is friendly and false otherwise.

RAT:_MinDistance(alpha, beta, ha, hb)

Calculate minimum distance between departure and destination for given minimum flight level and climb/decent rates.

Defined in:

RAT

Parameters:

#number alpha

Angle of climb [rad].

#number beta

Angle of descent [rad].

#number ha

Height difference between departure and cruise altiude.

#number hb

Height difference between cruise altitude and destination.

Return values:

#number:

d1 Minimum distance for climb phase to reach cruise altitude.

#number:

d2 Minimum distance for descent phase to reach destination height.

#number:

dtot Minimum total distance to climb and descent.

RAT:_ModifySpawnTemplate(waypoints, livery, spawnplace, departure, takeoff, parkingdata)

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

Defined in:

RAT

Parameters:

#table waypoints

The waypoints of the AI flight plan.

#string livery

(Optional) Livery of the aircraft. All members of a flight will get the same livery.

Core.Point#COORDINATE spawnplace

(Optional) Place where spawning should happen. If not present, first waypoint is taken.

Wrapper.Airbase#AIRBASE departure

Departure airbase or zone.

#number takeoff

Takeoff type.

#table parkingdata

Parking data, i.e. parking spot coordinates and terminal ids for all units of the group.

Return value:

#boolean:

True if modification was successful or nil if not, e.g. when no parking space was found and spawn in air is disabled.

RAT:_NameInList(liste, name)

Check if a name/string is in a list or not.

Defined in:

RAT

Parameters:

#table liste

List of names to be checked.

#string name

Name to be checked for.

RAT:_OnBirth(EventData)

Function is executed when a unit is spawned.

Defined in:

RAT

Parameter:

Core.Event#EVENTDATA EventData

RAT:_OnCrash(EventData)

Function is executed when a unit crashes.

Defined in:

RAT

Parameter:

Core.Event#EVENTDATA EventData

RAT:_OnDead(EventData)

Function is executed when a unit is dead.

Defined in:

RAT

Parameter:

Core.Event#EVENTDATA EventData

RAT:_OnDeadOrCrash(EventData)

Function is executed when a unit is dead or crashes.

Defined in:

RAT

Parameter:

Core.Event#EVENTDATA EventData

RAT:_OnEngineShutdown(EventData)

Function is executed when a unit shuts down its engines.

Defined in:

RAT

Parameter:

Core.Event#EVENTDATA EventData

RAT:_OnEngineStartup(EventData)

Function is executed when a unit starts its engines.

Defined in:

RAT

Parameter:

Core.Event#EVENTDATA EventData

RAT:_OnHit(EventData)

Function is executed when a unit is hit.

Defined in:

RAT

Parameter:

Core.Event#EVENTDATA EventData

RAT:_OnLand(EventData)

Function is executed when a unit lands.

Defined in:

RAT

Parameter:

Core.Event#EVENTDATA EventData

RAT:_OnTakeoff(EventData)

Function is executed when a unit takes off.

Defined in:

RAT

Parameter:

Core.Event#EVENTDATA 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.

Defined in:

RAT

Parameter:

#number takeoff

Takeoff type.

Return values:

Departure airport if spawning at airport.

Core.Zone#ZONE:

Departure zone if spawning in air.

RAT:_PickDestination(departure, q, minrange, maxrange, random, landing)

Pick destination airport or zone depending on departure position.

Defined in:

RAT

Parameters:

Wrapper.Airbase#AIRBASE departure

Departure airport or zone.

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.

#boolean random

Destination is randomly selected from friendly airport (true) or from destinations specified by user input (false).

#number landing

Number indicating whether we land at a destination airport or fly to a zone object.

Return value:

destination Destination airport or zone.

RAT:_PlaceMarkers(waypoints, index)

Place markers of the waypoints.

Note we assume a very specific number and type of waypoints here.

Defined in:

RAT

Parameters:

#table waypoints

Table with waypoints.

#number index

Spawn index of group.

RAT:_Randomize(value, fac, lower, upper)

Randomize a value by a certain amount.

Defined in:

RAT

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(index, lastpos, delay)

Respawn a group.

Defined in:

RAT

Parameters:

#number index

Spawn index.

Core.Point#COORDINATE lastpos

Last known position of the group.

#number delay

Delay before respawn

RAT:_Routeinfo(waypoints, comment)

Provide information about the assigned flightplan.

Defined in:

RAT

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.

Defined in:

RAT

RAT:_SetMarker(text, wp, index)

Set a marker visible for all on the F10 map.

Defined in:

RAT

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.

#number index

Spawn index of group.

RAT:_SetROE(group, roe)

Set ROE for a group.

Defined in:

RAT

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.

Defined in:

RAT

Parameters:

Wrapper.Group#GROUP group

Group for which the ROT is set.

#string rot

ROT of group.

RAT:_SetRoute(takeoff, landing, _departure, _destination, _waypoint)

Set the route of the AI plane.

Due to DCS landing bug, this has to be done before the unit is spawned.

Defined in:

RAT

Parameters:

#number takeoff

Takeoff type. Could also be air start.

#number landing

Landing type. Could also be a destination in air.

Wrapper.Airbase#AIRBASE _departure

(Optional) Departure airbase.

Wrapper.Airbase#AIRBASE _destination

(Optional) Destination airbase.

#table _waypoint

Initial waypoint.

Return values:

Departure airbase.

Destination airbase.

#table:

Table of flight plan waypoints.

#nil:

If no valid departure or destination airport could be found.

RAT:_SetStatus(group, status)

Set status of group.

Defined in:

RAT

Parameters:

Wrapper.Group#GROUP group

Group.

#string status

Status of group.

RAT:_SpawnWithRoute(_departure, _destination, _takeoff, _landing, _livery, _waypoint, _lastpos, _nrespawn, parkingdata)

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.

Defined in:

RAT

Parameters:

#string _departure

(Optional) Name of departure airbase.

#string _destination

(Optional) Name of destination airbase.

#number _takeoff

Takeoff type id.

#number _landing

Landing type id.

#string _livery

Livery to use for this group.

#table _waypoint

First waypoint to be used (for continue journey, commute, etc).

Core.Point#COORDINATE _lastpos

(Optional) Position where the aircraft will be spawned.

#number _nrespawn

Number of already performed respawn attempts (e.g. spawning on runway bug).

#table parkingdata

Explicitly specify the parking spots when spawning at an airport.

Return value:

#number:

Spawn index.

RAT:_SpawnWithRouteTimer(arg)

Delayed spawn function called by scheduler.

Defined in:

RAT

Parameter:

#table arg

Parameters: arg.self, arg.departure, arg.destination, arg.takeoff, arg.landing, arg.livery, arg.lastwp, arg.lastpos

RAT:_TaskFunction(FunctionString, ...)

Task function.

Defined in:

RAT

Parameters:

#string FunctionString

Name of the function to be called.

...

RAT:_TaskHolding(P1, Altitude, Speed, Duration)

Orbit at a specified position at a specified alititude with a specified speed.

Defined in:

RAT

Parameters:

DCS#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#Task:

DCSTask

RAT:_Waypoint(index, description, Type, Coord, Speed, Altitude, Airport)

Create a waypoint that can be used with the Route command.

Defined in:

RAT

Parameters:

#number index

Running index of waypoints. Starts with 1 which is normally departure/spawn waypoint.

#string description

Descrition of Waypoint.

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

RAT._WaypointFunction(group, rat, wp)

Function which is called after passing every waypoint.

Info on waypoint is given and special functions are executed.

Defined in:

RAT

Parameters:

Wrapper.Group#GROUP group

Group of aircraft.

#RAT rat

RAT object.

#number wp

Waypoint index. Running number of the waypoints. Determines the actions to be executed.

RAT:_ZoneExists(name)

Test if a zone exists.

Defined in:

RAT

Parameter:

#string name

Return value:

#boolean:

True if zone exsits, false otherwise.

Type RATMANAGER

RATMANAGER class

Field(s)

#string RATMANAGER.ClassName

Name of the Class.

#boolean RATMANAGER.Debug

If true, be more verbose on output in DCS.log file.

#number RATMANAGER.Tcheck

Time interval in seconds between checking of alive groups.

#table RATMANAGER.alive

Number of currently alive groups.

#number RATMANAGER.dTspawn

Time interval in seconds between spawns of groups.

#string RATMANAGER.id

Some ID to identify who we are in output of the DCS.log file.

Core.Scheduler#SCHEDULER RATMANAGER.manager

Scheduler managing the RAT objects.

#number RATMANAGER.managerid

Managing scheduler id.

#table RATMANAGER.min

Minimum number of RAT groups alive.

#string RATMANAGER.name

Name (alias) of RAT object.

#number RATMANAGER.nrat

Number of RAT objects.

#number RATMANAGER.ntot

Total number of active RAT groups.

#table RATMANAGER.rat

Array holding RAT objects etc.

Function(s)

RATMANAGER:Add(ratobject, min)

Adds a RAT object to the RAT manager.

Parameter min specifies the limit how many RAT groups are at least alive.

Defined in:

RATMANAGER

Parameters:

#RAT ratobject

RAT object to be managed.

#number min

Minimum number of groups for this RAT object. Default is 1.

Return value:

RATMANAGER self object.

RATMANAGER:New(ntot)

Creates a new RATMANAGER object.

Defined in:

RATMANAGER

Parameter:

#number ntot

Total number of RAT flights.

Return value:

RATMANAGER object

RATMANAGER:SetTcheck(dt)

Sets the time interval between checks of alive RAT groups.

Default is 60 seconds.

Defined in:

RATMANAGER

Parameter:

#number dt

Time interval in seconds.

Return value:

RATMANAGER self object.

RATMANAGER:SetTspawn(dt)

Sets the time interval between spawning of groups.

Defined in:

RATMANAGER

Parameter:

#number dt

Time interval in seconds. Default is 1 second.

Return value:

RATMANAGER self object.

RATMANAGER:Start(delay)

Starts the RAT manager and spawns the initial random number RAT groups for each RAT object.

Defined in:

RATMANAGER

Parameter:

#number delay

Time delay in seconds after which the RAT manager is started. Default is 5 seconds.

Return value:

RATMANAGER self object.

RATMANAGER:Stop(delay)

Stops the RAT manager.

Defined in:

RATMANAGER

Parameter:

#number delay

Delay in seconds before the manager is stopped. Default is 1 second.

Return value:

RATMANAGER self object.

RATMANAGER:_Count()

Counts the number of alive RAT objects.

Defined in:

RATMANAGER

RATMANAGER:_Manage()

Manager function.

Calculating the number of current groups and respawning new groups if necessary.

Defined in:

RATMANAGER

RATMANAGER:_RollDice(nrat, ntot, min, alive)

Rolls the dice for the number of necessary spawns.

Defined in:

RATMANAGER

Parameters:

#number nrat

Number of RAT objects.

#number ntot

Total number of RAT flights.

#table min

Minimum number of groups for each RAT object.

#table alive

Number of alive groups of each RAT object.

RATMANAGER:_Spawn(RATMANAGER, i)

Instantly starts the RAT manager and spawns the initial random number RAT groups for each RAT object.

Defined in:

RATMANAGER

Parameters:

#RATMANAGER RATMANAGER

self object.

#number i

Index.

RATMANAGER:_Start()

Instantly starts the RAT manager and spawns the initial random number RAT groups for each RAT object.

Defined in:

RATMANAGER

Return value:

RATMANAGER self object.

RATMANAGER:_Stop()

Instantly stops the RAT manager by terminating its scheduler.

Defined in:

RATMANAGER

Return value:

RATMANAGER self object.

Field(s)

#string RATMANAGER.ClassName

Name of the Class.

#boolean RATMANAGER.Debug

If true, be more verbose on output in DCS.log file.

#number RATMANAGER.Tcheck

Time interval in seconds between checking of alive groups.

#table RATMANAGER.alive

Number of currently alive groups.

#number RATMANAGER.dTspawn

Time interval in seconds between spawns of groups.

#string RATMANAGER.id

Some ID to identify who we are in output of the DCS.log file.

Core.Scheduler#SCHEDULER RATMANAGER.manager

Scheduler managing the RAT objects.

#number RATMANAGER.managerid

Managing scheduler id.

#table RATMANAGER.min

Minimum number of RAT groups alive.

#string RATMANAGER.name

Name (alias) of RAT object.

#number RATMANAGER.nrat

Number of RAT objects.

#number RATMANAGER.ntot

Total number of active RAT groups.

#table RATMANAGER.rat

Array holding RAT objects etc.

Function(s)

RATMANAGER:ClearState(Object, StateName)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

RATMANAGER:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

RATMANAGER:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

RATMANAGER:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

RATMANAGER:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

RATMANAGER:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

RATMANAGER:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

RATMANAGER:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

RATMANAGER:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

RATMANAGER:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

RATMANAGER:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

RATMANAGER:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

RATMANAGER:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RATMANAGER:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

RATMANAGER:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

RATMANAGER:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RATMANAGER:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RATMANAGER:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RATMANAGER:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

RATMANAGER:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

RATMANAGER:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

RATMANAGER:GetEventPriority()

Get the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Core.Event processing Priority.

RATMANAGER:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

RATMANAGER:GetState(Object, Key)

Get a Value given a Key from the Object.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

RATMANAGER:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

RATMANAGER:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RATMANAGER:Inherit(Child, Parent)

This is the worker method to inherit from a parent class.

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

RATMANAGER:IsInstanceOf(ClassName)

This is the worker method to check if an object is an (sub)instance of a class.

Examples:

ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

RATMANAGER:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

RATMANAGER:New()

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end

Defined in:

Return value:

RATMANAGER:OnEvent(EventData)

Occurs when an Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventBDA(EventData)

BDA.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventBaseCaptured(EventData)

Occurs when a ground unit captures either an airbase or a farp.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventCrash(EventData)

Occurs when any aircraft crashes into the ground and is completely destroyed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventDead(EventData)

Occurs when an object is dead.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventDetailedFailure(EventData)

Unknown precisely what creates this event, likely tied into newer damage model.

Will update this page when new information become available.

initiator: The unit that had the failure.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventDynamicCargoLoaded(EventData)

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventDynamicCargoUnloaded(EventData)

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventKill(EventData)

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator: The unit that killed the target
target: Target Object
weapon: Weapon Object

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventLandingAfterEjection(EventData)

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
subplace: is always 0 for unknown reasons.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventLandingQualityMark(EventData)

Landing quality mark.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventMissionEnd(EventData)

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventMissionStart(EventData)

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventNewDynamicCargo(EventData)

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventParatrooperLanding(EventData)

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventPlayerEnterAircraft(EventData)

Occurs when a player enters a slot and takes control of an aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventPlayerLeaveUnit(EventData)

Occurs when any player relieves control of a unit to the AI.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventRefueling(EventData)

Occurs when an aircraft connects with a tanker and begins taking on fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventScore(EventData)

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventShootingStart(EventData)

Occurs when any unit begins firing a weapon that has a high rate of fire.

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventTakeoff(EventData)

Occurs when an aircraft takes off from an airbase, farp, or ship.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventTriggerZone(EventData)

Trigger zone.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:ScheduleOnce(Start, SchedulerFunction, ...)

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

RATMANAGER:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

RATMANAGER:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

RATMANAGER:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

RATMANAGER:SetState(Object, Key, Value)

Set a state or property of the Object given a Key and a Value.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

Return value:

The Value set.

RATMANAGER:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RATMANAGER:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RATMANAGER:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RATMANAGER:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

RATMANAGER:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

RATMANAGER:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

RATMANAGER:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

RATMANAGER:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

RATMANAGER:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

RATMANAGER:TraceOnOff(TraceOnOff)

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:


  -- Switch the tracing On
  BASE:TraceOnOff( true )

  -- Switch the tracing Off
  BASE:TraceOnOff( false )

RATMANAGER:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

RATMANAGER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

RATMANAGER:_Serialize(Arguments)

(Internal) Serialize arguments

Defined in:

Parameter:

#table Arguments

Return value:

#string:

Text

RATMANAGER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

RATMANAGER:onEvent(event)

The main event handling function...

This function captures all events generated for the class.

Defined in: