Module Functional.RAT

RAT self object.

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

Define how aircraft that are spawned in uncontrolled state are activate.

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

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

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:

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

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:

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)

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

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

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)

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

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)

RAT:SetSpawnLimit(Nmax)

Set max number of groups that will be spawned.

When this limit is reached, no more RAT groups are spawned.

Defined in:

RAT

Parameter:

#number Nmax

Max number of groups. Default nil=unlimited.

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.

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:Stop(delay)

Stop RAT spawning by unhandling events, stoping schedulers etc.

Defined in:

RAT

Parameter:

#number delay

Delay before stop in seconds.

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

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

RAT:_Despawn(group, delay)

Despawn group.

The FLIGHTGROUP is despawned and stopped. The ratcraft is removed from the self.ratcraft table. Menues are removed.

Defined in:

RAT

Parameters:

Wrapper.Group#GROUP group

Group to be despawned.

#number delay

Delay in seconds before the despawn happens. Default is immidiately.

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.

Check if a given airbase has a FLIGHTCONTROL.

Defined in:

RAT

Parameter:

Wrapper.Airbase#AIRBASE airbase

The airbase.

Return value:

#boolean:

true if the airbase has a FLIGHTCONTROL.

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, uncontrolled)

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.

#boolean uncontrolled

If true, group is spawned uncontrolled.

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

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, waypointdescriptions, 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.

#table waypointdescriptions

Table with waypoint descriptions

#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:_RemoveRatcraft(ratcraft)

Remove ratcraft from self.ratcraft table.

Defined in:

RAT

Parameter:

#RAT.RatCraft ratcraft

The ratcraft to be removed.

Return value:

self

RAT:_Respawn(group, lastpos, delay)

Despawn the original group and re-spawn a new one.

Defined in:

RAT

Parameters:

Wrapper.Group#GROUP group

The group that should be respawned.

Core.Point#COORDINATE lastpos

Last known position of the group.

#number delay

Delay before despawn in seconds.

RAT:_Routeinfo(waypoints, comment, waypointdescriptions)

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.

#table waypointdescriptions

Waypoint descriptions.

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)

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.

#table:

Table of waypoint descriptions.

#table:

Table of waypoint status.

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:_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:_ZoneExists(name)

Test if a zone exists.

Defined in:

RAT

Parameter:

#string name

Return value:

#boolean:

True if zone exsits, false otherwise.

Field(s)

#RAT.ATC RAT.ATC

#boolean RAT.ATCswitch

Enable/disable ATC if set to true/false.

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

#boolean RAT.Debug

Turn debug messages on or off.

#number RAT.FLcruise

Cruise altitude of aircraft. Default FL200 for planes and F005 for helos.

#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

F10 menu items for this RAT object.

#string RAT.MenuF10

Main F10 menu.

#number RAT.Ndeparture_Airports

Number of departure airports set via SetDeparture().

#number RAT.Ndeparture_Zones

Number of departure zones set via SetDeparture.

#number RAT.Ndestination_Airports

Number of destination airports set via SetDestination().

#number RAT.Ndestination_Zones

Number of destination zones set via SetDestination().

#number RAT.NspawnMax

Max number of spawns.

#RAT.ROE RAT.ROE

#RAT.ROT RAT.ROT

#string RAT.SubMenuName

Submenu name for RAT object.

#number RAT.Tinactive

Time in seconds after which inactive units will be destroyed. Default is 300 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.

#number RAT.activate_delay

Delay in seconds before first uncontrolled group is activated. Default is 5 seconds.

#number RAT.activate_delta

Time interval in seconds between activation of uncontrolled groups. Default is 5 seconds.

#number RAT.activate_frand

Randomization factor of time interval (activate_delta) between activating uncontrolled groups. Default is 0.

#number RAT.activate_max

Maximum number of uncontrolled aircraft, which will be activated at the same time. Default is 1.

#boolean RAT.activate_uncontrolled

If true, uncontrolled are activated randomly after certain time intervals.

RAT.actype

#boolean RAT.addfriendlydepartures

Add all friendly airports to departures.

#boolean RAT.addfriendlydestinations

Add all friendly airports to destinations.

#table RAT.aircraft

Table which holds the basic aircraft properties (speed, range, ...).

#table RAT.airports

All airports of friedly coalitions.

#table RAT.airports_map

All airports available on current map (Caucasus, Nevada, Normandy, ...).

#string RAT.alias

Alias for spawned group.

#number RAT.alive

Number of groups which are alive.

#RAT.cat RAT.cat

#string RAT.category

Category of aircarft: "plane" or "heli".

#boolean RAT.checkonrunway

Aircraft are checked if they were accidentally spawned on the runway. Default is true.

#boolean RAT.checkontop

Aircraft are checked if they were accidentally spawned on top of another unit. Default is true.

#RAT.coal RAT.coal

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

#number RAT.country

Country of spawn group template.

#table RAT.ctable

Table with the valid coalitions from choice self.friendly.

Core.Zone#ZONE RAT.departure_Azone

Zone containing the departure airports.

#table RAT.departure_ports

Array containing the names of the destination airports or zones.

#boolean RAT.despawnair

If true, aircraft are despawned when they reach their destination zone. Default.

Core.Zone#ZONE RAT.destination_Azone

Zone containing the destination airports.

#table RAT.destination_ports

Array containing the names of the destination airports or zones.

#boolean RAT.destinationzone

Destination is a zone and not an airport.

#boolean RAT.eplrs

If true, turn on EPLSR datalink for the RAT group.

#table RAT.excluded_ports

Array containing the names of explicitly excluded airports.

#boolean RAT.f10menu

If true, add an F10 radiomenu for RAT. Default is false.

#number RAT.frequency

Radio frequency used by the RAT groups.

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

#number RAT.groupsize

Number of aircraft in group.

#string RAT.homebase

Home base for commute and return zone. Aircraft will always return to this base but otherwise travel in a star shaped way.

#string RAT.id

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

#boolean RAT.immortal

If true, aircraft are spawned as immortal.

RAT.index

#boolean RAT.invisible

If true aircraft are set to invisible for other AI forces.

#number RAT.landing

Landing type. Determines if we actually land at an airport or treat it as zone.

#string RAT.lid

Log identifier.

#string RAT.livery

Livery of the aircraft set by user.

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

#string RAT.modulation

Ratio modulation. Either "FM" or "AM".

#number RAT.ngroups

Number of groups to be spawned in total.

#boolean RAT.norespawn

Aircraft will not be respawned after they have finished their route.

#string RAT.onboardnum

Sets the onboard number prefix. Same as setting "TAIL #" in the mission editor.

#number RAT.onboardnum0

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

#number RAT.onrunwaymaxretry

Number of respawn retries (on ground) at other airports if a group gets accidentally spawned on the runway. Default is 3.

#number RAT.onrunwayradius

Distance (in meters) from a runway spawn point until a unit is considered to have accidentally been spawned on a runway. Default is 75 m.

#number RAT.ontopradius

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

#number RAT.parkingscanradius

Radius in meters until which parking spots are scanned for obstacles like other units, statics or scenery.

#boolean RAT.parkingscanscenery

If true, area around parking spots is scanned for scenery objects. Default is false.

#boolean RAT.parkingverysafe

If true, parking spots are considered as non-free until a possible aircraft has left and taken off. Default false.

#boolean RAT.placemarkers

Place markers of waypoints on F10 map.

#boolean RAT.radio

If true/false disables radio messages from the RAT groups.

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

Aircraft will be respawned after a crash, e.g. when they get shot down.

#boolean RAT.respawn_after_takeoff

Aircraft will be respawned directly after take-off.

#boolean RAT.respawn_at_landing

Respawn aircraft the moment they land rather than at engine shutdown.

#number RAT.respawn_delay

Delay in seconds until a repawn happens.

#boolean RAT.respawn_inair

Aircraft are allowed to spawned in air if they cannot be respawned on ground because there is not free parking spot. Default is true.

#table RAT.return_zones

Array containing the names of the return zones.

#boolean RAT.returnzone

Zone where aircraft will fly to before returning to their departure airport.

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

RAT.sid_Activate

RAT.sid_Spawn

Start scheduled spawning.

RAT.sid_Status

Status check and report scheduler.

#string RAT.skill

Skill of AI.

#number RAT.spawndelay

Delay time in seconds before first spawning happens.

#boolean RAT.spawninitialized

If RAT:Spawn() was already called this RAT object is set to true to prevent users to call it again.

#number RAT.spawninterval

Interval between spawning units/groups. Note that we add a randomization of 50%.

#boolean RAT.starshape

If true, aircraft travel A-->B-->A-->C-->A-->D... for commute.

#RAT.status RAT.status

#number RAT.statusinterval

Intervall between status checks (and reports if enabled).

#number RAT.takeoff

Takeoff type. 0=coldorhot.

Wrapper.Group#GROUP RAT.templategroup

Group serving as template for the RAT aircraft.

Wrapper.Airbase#AIRBASE.TerminalType RAT.termtype

Type of terminal to be used when spawning at an airbase.

#boolean RAT.uncontrolled

If true aircraft are spawned in uncontrolled state and will only sit on their parking spots. They can later be activated.

#RAT.unit RAT.unit

#table RAT.version

RAT version.

#table RAT.waypointdescriptions

Table with strings for waypoint descriptions of markers.

#table RAT.waypointstatus

Table with strings of waypoint status.

#RAT.wp RAT.wp

Function(s)

RAT:GetCoordinate()

Parameter:

#number SpawnIndex

The index of the group to return.

Return value:

self

RAT:GetLastAliveGroup()

Will find the last alive Wrapper.Group object, and will return a reference to the last live Wrapper.Group object and the last Index where the last alive Wrapper.Group object has been found.

Defined in:

Return values:

Wrapper.Group#GROUP, #number:

The last alive Wrapper.Group object found, the last Index where the last alive Wrapper.Group object was found.

#nil, #nil:

When no alive Wrapper.Group object is found, #nil is returned.

Usage:


  -- Find the last alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
  local GroupPlane, Index = SpawnPlanes:GetLastAliveGroup()
  if GroupPlane then -- GroupPlane can be nil!!!
    -- Do actions with the GroupPlane object.
  end

RAT:GetNextAliveGroup(SpawnIndexStart)

Will find the next alive Wrapper.Group object from a given Index, and return a reference to the alive Wrapper.Group object and the next Index where the alive Wrapper.Group has been found.

Defined in:

Parameter:

#number SpawnIndexStart

A Index holding the start position to search from. This method can also be used to find the first alive Wrapper.Group object from the given Index.

Return values:

Wrapper.Group#GROUP, #number:

The next alive Wrapper.Group object found, the next Index where the next alive Wrapper.Group object was found.

#nil, #nil:

When no alive Wrapper.Group object is found from the start Index position, #nil is returned.

Usage:


  -- Find the first alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
  local GroupPlane, Index = SpawnPlanes:GetFirstAliveGroup()
  while GroupPlane ~= nil do
    -- Do actions with the GroupPlane object.
    GroupPlane, Index = SpawnPlanes:GetNextAliveGroup( Index )
  end

RAT:GetSpawnIndexFromGroup(SpawnGroup)

Get the index from a given group.

The function will search the name of the group for a #, and will return the number behind the #-mark.

Defined in:

#boolean AIOnOff

A value of true sets the AI On, a value of false sets the AI Off.

Return value:

The SPAWN object

RAT:InitAirbase(AirbaseName, Takeoff, TerminalType)

Set spawns to happen at a particular airbase.

Only for aircraft, of course.

Defined in:

Parameters:

#string AirbaseName

Name of the airbase.

#number Takeoff

(Optional) Takeoff type. Can be SPAWN.Takeoff.Hot (default), SPAWN.Takeoff.Cold or SPAWN.Takeoff.Runway.

#number TerminalType

(Optional) The terminal type.

Return value:

self

RAT:InitArray(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY)

Makes the groups visible before start (like a battalion).

The method will take the position of the group as the first position in the array. CAUTION: this directive will NOT work with OnSpawnGroup function.

Defined in:

Parameters:

#number SpawnAngle

The angle in degrees how the groups and each unit of the group will be positioned.

#number SpawnWidth

The amount of Groups that will be positioned on the X axis.

#number SpawnDeltaX

The space between each Group on the X-axis.

#number SpawnDeltaY

The space between each Group on the Y-axis.

Return value:

self

Usage:


  -- Define an array of Groups.
  Spawn_BE_Ground = SPAWN:New( 'BE Ground' )
                         :InitLimit( 2, 24 )
                         :InitArray( 90, 10, 100, 50 )

RAT:InitCallSign(ID, Name, Minor, Major)

[BLUE AIR only!] This method sets a specific callsign for a spawned group.

Use for a group with one unit only!

Defined in:

Parameters:

#number ID

ID of the callsign enumerator, e.g. CALLSIGN.Tanker.Texaco - - resulting in e.g. Texaco-2-1

#string Name

Name of this callsign as it cannot be determined from the ID because of the dependency on the task type of the plane, and the plane type. E.g. "Texaco"

#number Minor

Minor number, i.e. the unit number within the group, e.g 2 - resulting in e.g. Texaco-2-1

#number Major

Major number, i.e. the group number of this name, e.g. 1 - resulting in e.g. Texaco-2-1

Return value:

self

RAT:InitCategory(Category)

Sets category ID of the group.

Defined in:

Parameter:

#number Category

Category id.

Return value:

self

RAT:InitCleanUp(SpawnCleanUpInterval)

Delete groups that have not moved for X seconds - AIR ONLY!!! DO NOT USE ON GROUPS THAT DO NOT MOVE OR YOUR SERVER WILL BURN IN HELL (Pikes - April 2020) When groups are still alive and have become inactive due to damage and are unable to contribute anything, then this group will be removed at defined intervals in seconds.

Defined in:

Parameter:

#string SpawnCleanUpInterval

The interval to check for inactive groups within seconds.

Return value:

self

Usage:


  Spawn_Helicopter:InitCleanUp( 20 )  -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive.

RAT:InitCoalition(Coalition)

Sets the coalition of the spawned group.

Note that it might be necessary to also set the country explicitly!

Defined in:

Parameter:

DCS#coalition.side Coalition

Coalition of the group as number of enumerator:

Return value:

self

RAT:InitCountry(Country)

Sets the country of the spawn group.

Note that the country determines the coalition of the group depending on which country is defined to be on which side for each specific mission!

Defined in:

Parameter:

#number Country

Country id as number or enumerator:

Return value:

self

Parameters:

#number HeadingMin

The minimum or fixed heading in degrees.

#number HeadingMax

(optional) The maximum heading in degrees. This there is no maximum heading, then the heading for the group will be HeadingMin.

#number unitVar

(optional) Individual units within the group will have their heading randomized by +/- unitVar degrees. Default is zero.

Return value:

self

Usage:


mySpawner = SPAWN:New( ... )

  -- Spawn the Group with the formation rotated +100 degrees around unit #1, compared to the mission template.
  mySpawner:InitGroupHeading( 100 )

  -- Spawn the Group with the formation rotated units between +100 and +150 degrees around unit #1, compared to the mission template, and with individual units varying by +/- 10 degrees from their templated facing.
  mySpawner:InitGroupHeading( 100, 150, 10 )

  -- Spawn the Group with the formation rotated -60 degrees around unit #1, compared to the mission template, but with all units facing due north regardless of how they were laid out in the template.
  mySpawner:InitGroupHeading(-60):InitHeading(0)
  -- or
  mySpawner:InitHeading(0):InitGroupHeading(-60)

RAT:InitGrouping(Grouping)

When spawning a new group, make the grouping of the units according the InitGrouping setting.

Defined in:

Parameter:

#number Grouping

Indicates the maximum amount of units in the group.

Return value:

RAT:InitHeading(HeadingMin, HeadingMax)

Defines the Heading for the new spawned units.

The heading can be given as one fixed degree, or can be randomized between minimum and maximum degrees.

Defined in:

Parameters:

#number HeadingMin

The minimum or fixed heading in degrees.

#number HeadingMax

(optional) The maximum heading in degrees. This there is no maximum heading, then the heading will be fixed for all units using minimum heading.

Return value:

self

Usage:


  Spawn = SPAWN:New( ... )

  -- Spawn the units pointing to 100 degrees.
  Spawn:InitHeading( 100 )

  -- Spawn the units pointing between 100 and 150 degrees.
  Spawn:InitHeading( 100, 150 )

RAT:InitHiddenOnMFD()

Hide the group on MFDs (visible to game master slots!).

Defined in:

Return value:

The SPAWN object

RAT:InitHiddenOnMap(OnOff)

Hide the group on the map view (visible to game master slots!).

Defined in:

Parameter:

#boolean OnOff

Defaults to true

Return value:

The SPAWN object

RAT:InitHiddenOnPlanner()

Hide the group on planner (visible to game master slots!).

Defined in:

Return value:

The SPAWN object

RAT:InitKeepUnitNames(KeepUnitNames)

Keeps the unit names as defined within the mission editor, but note that anything after a # mark is ignored, and any spaces before and after the resulting name are removed.

IMPORTANT! This method MUST be the first used after :New !!!

Defined in:

Parameter:

#boolean KeepUnitNames

(optional) If true, the unit names are kept, false or not provided create new unit names.

Return value:

self

RAT:InitLateActivated(LateActivated)

Flags that the spawned groups must be spawned late activated.

Defined in:

Parameter:

#boolean LateActivated

(optional) If true, the spawned groups are late activated.

Return value:

self

RAT:InitLimit(SpawnMaxUnitsAlive, SpawnMaxGroups)

Stops any more repeat spawns from happening once the UNIT count of Alive units, spawned by the same SPAWN object, exceeds the first parameter.

Also can stop spawns from happening once a total GROUP still alive is met. Exceptionally powerful when combined with SpawnSchedule for Respawning. Note that this method is exceptionally important to balance the performance of the mission. Depending on the machine etc, a mission can only process a maximum amount of units. If the time interval must be short, but there should not be more Units or Groups alive than a maximum amount of units, then this method should be used... When a SPAWN.New is executed and the limit of the amount of units alive is reached, then no new spawn will happen of the group, until some of these units of the spawn object will be destroyed.

Defined in:

Parameters:

#number SpawnMaxUnitsAlive

The maximum amount of units that can be alive at runtime.

#number SpawnMaxGroups

The maximum amount of groups that can be spawned. When the limit is reached, then no more actual spawns will happen of the group. This parameter is useful to define a maximum amount of airplanes, ground troops, helicopters, ships etc within a supply area. This parameter accepts the value 0, which defines that there are no maximum group limits, but there are limits on the maximum of units that can be alive at the same time.

Return value:

self

Usage:


  -- NATO helicopters engaging in the battle field.
  -- This helicopter group consists of one Unit. So, this group will SPAWN maximum 2 groups simultaneously within the DCSRTE.
  -- There will be maximum 24 groups spawned during the whole mission lifetime. 
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )

RAT:InitLivery(Livery)

Sets livery of the group.

Defined in:

Parameter:

#string Livery

Livery name. Note that this is not necessarily the same name as displayed in the mission editor.

Return value:

self

RAT:InitModex(modex, prefix, postfix)

Sets the modex of the first unit of the group.

If more units are in the group, the number is increased by one with every unit.

Defined in:

Parameters:

#number modex

Modex of the first unit.

#string prefix

(optional) String to prefix to modex, e.g. for French AdA Modex, eg. -L-102 then "-L-" would be the prefix.

#string postfix

(optional) String to postfix to modex, example tbd.

Return value:

self

RAT:InitPositionCoordinate(Coordinate)

This method sets a spawn position for the group that is different from the location of the template.

Defined in:

Parameter:

Core.Point#COORDINATE Coordinate

The position to spawn from

Return value:

self

RAT:InitPositionVec2(Vec2)

This method sets a spawn position for the group that is different from the location of the template.

Defined in:

Parameter:

DCS#Vec2 Vec2

The position to spawn from

Return value:

self

RAT:InitRadioCommsOnOff(switch)

Sets the radio communication on or off.

Same as checking/unchecking the COMM box in the mission editor.

Defined in:

Parameter:

#number switch

If true (or nil), enables the radio communication. If false, disables the radio for the spawned group.

Return value:

self

RAT:InitRadioFrequency(frequency)

Sets the radio frequency of the group.

Defined in:

Parameter:

#number frequency

The frequency in MHz.

Return value:

self

RAT:InitRadioModulation(modulation)

Set radio modulation.

Default is AM.

Defined in:

Parameter:

#string modulation

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

Return value:

self

RAT:InitRandomizeCallsign()

[AIR/Fighter only!] This method randomizes the callsign for a new group.

Defined in:

Return value:

self

RAT:InitRandomizePosition(RandomizePosition, OuterRadius, InnerRadius)

Randomizes the position of Wrapper.Groups that are spawned within a radius band, given an Outer and Inner radius, from the point that the spawn happens.

Defined in:

Parameters:

#boolean RandomizePosition

If true, SPAWN will perform the randomization of the Wrapper.Groups position between a given outer and inner radius.

DCS#Distance OuterRadius

(optional) The outer radius in meters where the new group will be spawned.

DCS#Distance InnerRadius

(optional) The inner radius in meters where the new group will NOT be spawned.

Return value:

RAT:InitRandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius, SpawnHeight)

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

This is very useful to define extra variation of the behavior of groups.

Defined in:

Parameters:

#number SpawnStartPoint

is the waypoint where the randomization begins. Note that the StartPoint = 0 equaling the point where the group is spawned.

#number SpawnEndPoint

is the waypoint where the randomization ends counting backwards. This parameter is useful to avoid randomization to end at a waypoint earlier than the last waypoint on the route.

#number SpawnRadius

is the radius in meters in which the randomization of the new waypoints, with the original waypoint of the original template located in the middle ...

#number SpawnHeight

(optional) Specifies the additional height in meters that can be added to the base height specified at each waypoint in the ME.

Return value:

Usage:


  -- NATO helicopters engaging in the battle field.
  -- The KA-50 has waypoints Start point ( =0 or SP ), 1, 2, 3, 4, End point (= 5 or DP).
  -- Waypoints 2 and 3 will only be randomized. The others will remain on their original position with each new spawn of the helicopter.
  -- The randomization of waypoint 2 and 3 will take place within a radius of 2000 meters.
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute( 2, 2, 2000 )

RAT:InitRandomizeTemplate(SpawnTemplatePrefixTable)

This method is rather complicated to understand.

But I'll try to explain. This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, but they will all follow the same Template route and have the same prefix name. In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

Defined in:

Parameter:

#list<#string> SpawnTemplatePrefixTable

A table with the names of the groups defined within the mission editor, from which one will be chosen when a new group will be spawned.

Return value:

Usage:


  -- NATO Tank Platoons invading Gori.
  -- Choose between 13 different 'US Tank Platoon' configurations for each new SPAWN the Group to be spawned for the
  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SpawnTemplatePrefixes.
  -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
  -- with a limit set of maximum 12 Units alive simultaneously  and 150 Groups to be spawned during the whole mission.
  Spawn_US_Platoon = { 'US Tank Platoon 1', 'US Tank Platoon 2', 'US Tank Platoon 3', 'US Tank Platoon 4', 'US Tank Platoon 5',
                       'US Tank Platoon 6', 'US Tank Platoon 7', 'US Tank Platoon 8', 'US Tank Platoon 9', 'US Tank Platoon 10',
                       'US Tank Platoon 11', 'US Tank Platoon 12', 'US Tank Platoon 13' }
  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )

RAT:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes)

Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.

This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, but they will all follow the same Template route and have the same prefix name. In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

Defined in:

Parameter:

#string SpawnTemplatePrefixes

A string or a list of string that contains the prefixes of the groups that are possible unit representatives of the group to be spawned.

Return value:

Usage:


 -- NATO Tank Platoons invading Gori.

  -- Choose between different 'US Tank Platoon Templates' configurations to be spawned for the
  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.

  -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
  -- with a limit set of maximum 12 Units alive simultaneously  and 150 Groups to be spawned during the whole mission.

  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )

RAT:InitRandomizeTemplateSet(SpawnTemplateSet)

Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.

Defined in:

Parameter:

Core.Set#SET_GROUP SpawnTemplateSet

A SET_GROUP object set, that contains the groups that are possible unit representatives of the group to be spawned.

Return value:

Usage:


  -- NATO Tank Platoons invading Gori.

  -- Choose between different 'US Tank Platoon Template' configurations to be spawned for the
  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.

  -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
  -- with a limit set of maximum 12 Units alive simultaneously  and 150 Groups to be spawned during the whole mission.

  Spawn_US_PlatoonSet = SET_GROUP:New():FilterPrefixes( "US Tank Platoon Templates" ):FilterOnce()

  -- Now use the Spawn_US_PlatoonSet to define the templates using InitRandomizeTemplateSet.
  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )

RAT:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius)

Randomizes the UNITs that are spawned within a radius band given an Outer and Inner radius.

Defined in:

Parameters:

#boolean RandomizeUnits

If true, SPAWN will perform the randomization of the Wrapper.Unit#UNITs position within the group between a given outer and inner radius.

DCS#Distance OuterRadius

(optional) The outer radius in meters where the new group will be spawned.

DCS#Distance InnerRadius

(optional) The inner radius in meters where the new group will NOT be spawned.

Return value:

Usage:


  -- NATO helicopters engaging in the battle field.
  -- UNIT positions of this group will be randomized around the base unit #1 in a circle of 50 to 500 meters.
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeUnits( true, 500, 50 )

RAT:InitRandomizeZones(SpawnZoneTable)

This method provides the functionality to randomize the spawning of the Groups at a given list of zones of different types.

Defined in:

Parameter:

#table SpawnZoneTable

A table with Core.Zone objects. If this table is given, then each spawn will be executed within the given list of Core.Zones objects.

Return value:

self

Usage:


   -- Create a zone table of the 2 zones.
   ZoneTable = { ZONE:New( "Zone1" ), ZONE:New( "Zone2" ) }

   Spawn_Vehicle_1 = SPAWN:New( "Spawn Vehicle 1" )
                          :InitLimit( 10, 10 )
                          :InitRandomizeRoute( 1, 1, 200 )
                          :InitRandomizeZones( ZoneTable )
                          :SpawnScheduled( 5, .5 )

RAT:InitRepeat()

For planes and helicopters, when these groups go home and land on their home airbases and FARPs, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.

This method is used to re-spawn automatically (so no extra call is needed anymore) the same group after it has landed. This will enable a spawned group to be re-spawned after it lands, until it is destroyed... Note: When the group is respawned, it will re-spawn from the original airbase where it took off. So ensure that the routes for groups that respawn, always return to the original airbase, or players may get confused ...

Defined in:

Return value:

self

Usage:


  -- RU Su-34 - AI Ship Attack
  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
                      :Schedule( 2, 3, 1800, 0.4 )
                      :SpawnUncontrolled()
                      :InitRandomizeRoute( 1, 1, 3000 )
                      :InitRepeatOnEngineShutDown()

RAT:InitRepeatOnEngineShutDown()

Respawn after landing when its engines have shut down.

Defined in:

Return value:

self

Usage:


  -- RU Su-34 - AI Ship Attack
  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
                      :SpawnUncontrolled()
                      :InitRandomizeRoute( 1, 1, 3000 )
                      :InitRepeatOnEngineShutDown()
                      :Spawn()

RAT:InitRepeatOnLanding()

Respawn group after landing.

Defined in:

Return value:

self

Usage:


  -- RU Su-34 - AI Ship Attack
  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
                      :InitRandomizeRoute( 1, 1, 3000 )
                      :InitRepeatOnLanding()
                      :Spawn()


  -- NATO helicopter group of three units engaging in the battle field.
  local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitAbsolutePositions(Positions)

RAT:InitSetUnitRelativePositions(Positions)

Spawn the UNITs of this group with individual relative positions to unit #1 and individual headings.

Defined in:

Parameter:

#table Positions

Table of positions, needs to one entry per unit in the group(!). The table contains one table each for each unit, with x,y, and optionally z relative positions, and optionally an individual heading.

Return value:

Usage:


  -- NATO helicopter group of three units engaging in the battle field.
  local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitRelativePositions(Positions)

Creates the main object to spawn a Wrapper.Group defined in the DCS ME.

Defined in:

Parameter:

#string SpawnTemplatePrefix

is the name of the Group in the ME that defines the Template. Each new group will have the name starting with SpawnTemplatePrefix.

Return value:

Usages:

-- NATO helicopters engaging in the battle field.
Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )

local Plane = SPAWN:New( "Plane" ) -- Creates a new local variable that can initiate new planes with the name "Plane#ddd" using the template "Plane" as defined within the ME.

RAT:NewFromTemplate(SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPrefix, NoMooseNamingPostfix)

Creates a new SPAWN instance to create new groups based on the provided template.

This will also register the template for future use.

Defined in:

Parameters:

#table SpawnTemplate

is the Template of the Group. This must be a valid Group Template structure - see Hoggit Wiki!

#string SpawnTemplatePrefix

[Mandatory] is the name of the template and the prefix of the GROUP on spawn. The name in the template will be overwritten!

#string SpawnAliasPrefix

[Optional] is the prefix that will be given to the GROUP on spawn.

#boolean NoMooseNamingPostfix

[Optional] If true, skip the Moose naming additions (like groupname#001-01) - but you need to ensure yourself no duplicate group names exist!

Return value:

self

Usage:

-- Spawn a P51 Mustang from scratch
local ttemp =  
  {
      ["modulation"] = 0,
      ["tasks"] = 
      {
      }, -- end of ["tasks"]
      ["task"] = "Reconnaissance",
      ["uncontrolled"] = false,
      ["route"] = 
      {
          ["points"] = 
          {
              [1] = 
              {
                  ["alt"] = 2000,
                  ["action"] = "Turning Point",
                  ["alt_type"] = "BARO",
                  ["speed"] = 125,
                  ["task"] = 
                  {
                      ["id"] = "ComboTask",
                      ["params"] = 
                      {
                          ["tasks"] = 
                          {
                          }, -- end of ["tasks"]
                      }, -- end of ["params"]
                  }, -- end of ["task"]
                  ["type"] = "Turning Point",
                  ["ETA"] = 0,
                  ["ETA_locked"] = true,
                  ["y"] = 666285.71428571,
                  ["x"] = -312000,
                  ["formation_template"] = "",
                  ["speed_locked"] = true,
              }, -- end of [1]
          }, -- end of ["points"]
      }, -- end of ["route"]
      ["groupId"] = 1,
      ["hidden"] = false,
      ["units"] = 
      {
          [1] = 
          {
              ["alt"] = 2000,
              ["alt_type"] = "BARO",
              ["livery_id"] = "USAF 364th FS",
              ["skill"] = "High",
              ["speed"] = 125,
              ["type"] = "TF-51D",
              ["unitId"] = 1,
              ["psi"] = 0,
              ["y"] = 666285.71428571,
              ["x"] = -312000,
              ["name"] = "P51-1-1",
              ["payload"] = 
              {
                  ["pylons"] = 
                  {
                  }, -- end of ["pylons"]
                  ["fuel"] = 340.68,
                  ["flare"] = 0,
                  ["chaff"] = 0,
                  ["gun"] = 100,
              }, -- end of ["payload"]
              ["heading"] = 0,
              ["callsign"] = 
              {
                  [1] = 1,
                  [2] = 1,
                  ["name"] = "Enfield11",
                  [3] = 1,
              }, -- end of ["callsign"]
              ["onboard_num"] = "010",
          }, -- end of [1]
      }, -- end of ["units"]
      ["y"] = 666285.71428571,
      ["x"] = -312000,
      ["name"] = "P51",
      ["communication"] = true,
      ["start_time"] = 0,
      ["frequency"] = 124,
  } 


local mustang = SPAWN:NewFromTemplate(ttemp,"P51D")
-- you MUST set the next three:
mustang:InitCountry(country.id.FRANCE)
mustang:InitCategory(Group.Category.AIRPLANE)
mustang:InitCoalition(coalition.side.BLUE)
mustang:OnSpawnGroup(
  function(grp)
    MESSAGE:New("Group Spawned: "..grp:GetName(),15,"SPAWN"):ToAll()
  end
)
mustang:Spawn()

RAT:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix)

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

Defined in:

Parameters:

#string SpawnTemplatePrefix

is the name of the Group in the ME that defines the Template.

#string SpawnAliasPrefix

is the name that will be given to the Group at runtime.

Return value:

self

Usages:

-- NATO helicopters engaging in the battle field.
Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )

local PlaneWithAlias = SPAWN:NewWithAlias( "Plane", "Bomber" ) -- Creates a new local variable that can instantiate new planes with the name "Bomber#ddd" using the template "Plane" as defined within the ME.

RAT:OnSpawnGroup(SpawnCallBackFunction, SpawnFunctionArguments, ...)

Allows to place a CallFunction hook when a new group spawns.

The provided method will be called when a new group is spawned, including its given parameters. The first parameter of the SpawnFunction is the Wrapper.Group#GROUP that was spawned.

Defined in:

Parameters:

#function SpawnCallBackFunction

The function to be called when a group spawns.

SpawnFunctionArguments

A random amount of arguments to be provided to the function when the group spawns.

...

Return value:

Usage:


   -- Declare SpawnObject and call a function when a new Group is spawned.
   local SpawnObject = SPAWN:New( "SpawnObject" )
                            :InitLimit( 2, 10 )
                            :OnSpawnGroup( function( SpawnGroup )
                                SpawnGroup:E( "I am spawned" )
                                end
                              )
                            :SpawnScheduled( 300, 0.3 )

RAT:ParkAircraft(SpawnAirbase, TerminalType, Parkingdata, SpawnIndex)

Will park a group at an Wrapper.Airbase.

Defined in:

Parameters:

Wrapper.Airbase#AIRBASE SpawnAirbase

The Wrapper.Airbase where to spawn the group.

Wrapper.Airbase#AIRBASE.TerminalType TerminalType

(optional) The terminal type the aircraft should be spawned at. See Wrapper.Airbase#AIRBASE.TerminalType.

#table Parkingdata

(optional) Table holding the coordinates and terminal ids for all units of the group. Spawning will be forced to happen at exactily these spots!

SpawnIndex

Return value:

#nil:

Nothing is returned!

RAT:ParkAtAirbase(SpawnAirbase, TerminalType, Parkingdata)

Will park a group at an Wrapper.Airbase.

This method is mostly advisable to be used if you want to simulate parking units at an airbase and be visible. Note that each point in the route assigned to the spawning group is reset to the point of the spawn.

All groups that are in the spawn collection and that are alive, and not in the air, are parked.

The Wrapper.Airbase#AIRBASE object must refer to a valid airbase known in the sim. You can use the following enumerations to search for the pre-defined airbases on the current known maps of DCS:

Wrapper.Airbase#AIRBASE.Caucasus: The airbases on the Caucasus map.
Wrapper.Airbase#AIRBASE.Nevada: The airbases on the Nevada (NTTR) map.
Wrapper.Airbase#AIRBASE.Normandy: The airbases on the Normandy map.

Use the method Wrapper.Airbase#AIRBASE.FindByName() to retrieve the airbase object. The known AIRBASE objects are automatically imported at mission start by MOOSE. Therefore, there isn't any New() constructor defined for AIRBASE objects.

Ships and FARPs are added within the mission, and are therefore not known. For these AIRBASE objects, there isn't an Wrapper.Airbase#AIRBASE enumeration defined. You need to provide the exact name of the airbase as the parameter to the Wrapper.Airbase#AIRBASE.FindByName() method!

Defined in:

Parameters:

Wrapper.Airbase#AIRBASE SpawnAirbase

The Wrapper.Airbase where to spawn the group.

Wrapper.Airbase#AIRBASE.TerminalType TerminalType

(optional) The terminal type the aircraft should be spawned at. See Wrapper.Airbase#AIRBASE.TerminalType.

#table Parkingdata

(optional) Table holding the coordinates and terminal ids for all units of the group. Spawning will be forced to happen at exactily these spots!

Return value:

#nil:

Nothing is returned!

Usage:

  Spawn_Plane = SPAWN:New( "Plane" )
  Spawn_Plane:ParkAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ) )

  Spawn_Heli = SPAWN:New( "Heli")

  Spawn_Heli:ParkAtAirbase( AIRBASE:FindByName( "FARP Cold" ) )

  Spawn_Heli:ParkAtAirbase( AIRBASE:FindByName( "Carrier" ) )

  Spawn_Plane:ParkAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), AIRBASE.TerminalType.OpenBig )

The Wrapper.Airbase#AIRBASE object must refer to a valid airbase known in the sim. You can use the following enumerations to search for the pre-defined airbases on the current known maps of DCS:

Wrapper.Airbase#AIRBASE.Caucasus: The airbases on the Caucasus map.
Wrapper.Airbase#AIRBASE.Nevada: The airbases on the Nevada (NTTR) map.
Wrapper.Airbase#AIRBASE.Normandy: The airbases on the Normandy map.

Defined in:

Parameters:

Wrapper.Airbase#AIRBASE SpawnAirbase

The Wrapper.Airbase where to spawn the group.

#SPAWN.Takeoff Takeoff

(optional) The location and takeoff method. Default is Hot.

#number TakeoffAltitude

(optional) The altitude above the ground.

Wrapper.Airbase#AIRBASE.TerminalType TerminalType

(optional) The terminal type the aircraft should be spawned at. See Wrapper.Airbase#AIRBASE.TerminalType.

#boolean EmergencyAirSpawn

(optional) If true (default), groups are spawned in air if there is no parking spot at the airbase. If false, nothing is spawned if no parking spot is available.

#table Parkingdata

(optional) Table holding the coordinates and terminal ids for all units of the group. Spawning will be forced to happen at exactly these spots!

Return value:

The group that was spawned or nil when nothing was spawned.

Usage:


  Spawn_Plane = SPAWN:New( "Plane" )
  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold )
  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Hot )
  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Runway )

  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold )

  Spawn_Heli = SPAWN:New( "Heli")

  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Cold" ), SPAWN.Takeoff.Cold )
  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Hot" ), SPAWN.Takeoff.Hot )
  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Runway" ), SPAWN.Takeoff.Runway )
  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Air" ), SPAWN.Takeoff.Air )

  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold )

  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold, nil, AIRBASE.TerminalType.OpenBig )

RAT:SpawnAtParkingSpot(Airbase, Spots, Takeoff)

Spawn a group on an Wrapper.Airbase at a specific parking spot.

Defined in:

Parameters:

Wrapper.Airbase#AIRBASE Airbase

The Wrapper.Airbase where to spawn the group.

#table Spots

Table of parking spot IDs. Note that these in general are different from the numbering in the mission editor!

#SPAWN.Takeoff Takeoff

(Optional) Takeoff type, i.e. either SPAWN.Takeoff.Cold or SPAWN.Takeoff.Hot. Default is Hot.

Return value:

The group that was spawned or nil when nothing was spawned.

RAT:SpawnFromCoordinate(Coordinate, SpawnIndex)

Will spawn a group from a Coordinate in 3D space.

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. Note that each point in the route assigned to the spawning group is reset to the point of the spawn. You can use the returned group to further define the route to be followed.

Defined in:

Parameters:

Core.Point#Coordinate Coordinate

The Coordinate coordinates where to spawn the group.

#number SpawnIndex

(optional) The index which group to spawn within the given zone.

Return value:

that was spawned or #nil if nothing was spawned.

RAT:SpawnFromPointVec2(PointVec2, MinHeight, MaxHeight, SpawnIndex)

Will spawn a group from a POINT_VEC2 in 3D space.

This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. Note that each point in the route assigned to the spawning group is reset to the point of the spawn. You can use the returned group to further define the route to be followed.

Defined in:

Parameters:

Core.Point#POINT_VEC2 PointVec2

The PointVec2 coordinates where to spawn the group.

#number MinHeight

(optional) The minimum height to spawn an airborne group into the zone.

#number MaxHeight

(optional) The maximum height to spawn an airborne group into the zone.

#number SpawnIndex

(optional) The index which group to spawn within the given zone.

Return value:

that was spawned or #nil if nothing was spawned.

Usage:


  local SpawnPointVec2 = ZONE:New( ZoneName ):GetPointVec2() 

  -- Spawn at the zone center position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2 )

  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2, 2000, 4000 )

RAT:SpawnFromPointVec3(PointVec3, SpawnIndex)

Will spawn a group from a PointVec3 in 3D space.

Defined in:

Parameters:

Core.Point#POINT_VEC3 PointVec3

The PointVec3 coordinates where to spawn the group.

#number SpawnIndex

(optional) The index which group to spawn within the given zone.

Return value:

that was spawned or #nil if nothing was spawned.

Usage:


  local SpawnPointVec3 = ZONE:New( ZoneName ):GetPointVec3( 2000 ) -- Get the center of the ZONE object at 2000 meters from the ground.

  -- Spawn at the zone center position at 2000 meters from the ground!
  SpawnAirplanes:SpawnFromPointVec3( SpawnPointVec3 )

RAT:SpawnFromStatic(HostStatic, MinHeight, MaxHeight, SpawnIndex)

Will spawn a group from a hosting static.

This method is mostly advisable to be used if you want to simulate spawning from buldings and structures (static buildings). You can use the returned group to further define the route to be followed.

Defined in:

Parameters:

Wrapper.Static#STATIC HostStatic

The static dropping or unloading the group.

#number MinHeight

(optional) The minimum height to spawn an airborne group into the zone.

#number MaxHeight

(optional) The maximum height to spawn an airborne group into the zone.

#number SpawnIndex

(optional) The index which group to spawn within the given zone.

Return value:

that was spawned or #nil if nothing was spawned.

Usage:


  local SpawnStatic = STATIC:FindByName( StaticName )

  -- Spawn from the static position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnFromStatic( SpawnStatic )

  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 )

RAT:SpawnFromUnit(HostUnit, MinHeight, MaxHeight, SpawnIndex)

Will spawn a group from a hosting unit.

This method is mostly advisable to be used if you want to simulate spawning from air units, like helicopters, which are dropping infantry into a defined Landing Zone. Note that each point in the route assigned to the spawning group is reset to the point of the spawn. You can use the returned group to further define the route to be followed.

Defined in:

Parameters:

Wrapper.Unit#UNIT HostUnit

The air or ground unit dropping or unloading the group.

#number MinHeight

(optional) The minimum height to spawn an airborne group into the zone.

#number MaxHeight

(optional) The maximum height to spawn an airborne group into the zone.

#number SpawnIndex

(optional) The index which group to spawn within the given zone.

Return values:

that was spawned.

#nil:

Nothing was spawned.

Usage:


  local SpawnStatic = STATIC:FindByName( StaticName )

  -- Spawn from the static position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnFromUnit( SpawnStatic )

  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 )

RAT:SpawnFromVec2(Vec2, MinHeight, MaxHeight, SpawnIndex)

Will spawn a group from a Vec2 in 3D space.

Defined in:

Parameters:

DCS#Vec2 Vec2

The Vec2 coordinates where to spawn the group.

#number MinHeight

(optional) The minimum height to spawn an airborne group into the zone.

#number MaxHeight

(optional) The maximum height to spawn an airborne group into the zone.

#number SpawnIndex

(optional) The index which group to spawn within the given zone.

Return value:

that was spawned or #nil if nothing was spawned.

Usage:


  local SpawnVec2 = ZONE:New( ZoneName ):GetVec2()

  -- Spawn at the zone center position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnFromVec2( SpawnVec2 )

  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 )

RAT:SpawnFromVec3(Vec3, SpawnIndex)

Will spawn a group from a Vec3 in 3D space.

Defined in:

Parameters:

DCS#Vec3 Vec3

The Vec3 coordinates where to spawn the group.

#number SpawnIndex

(optional) The index which group to spawn within the given zone.

Return value:

that was spawned or #nil if nothing was spawned.

RAT:SpawnGroupName(SpawnIndex)

Will return the SpawnGroupName either with with a specific count number or without any count.

Defined in:

Parameter:

#number SpawnIndex

Is the number of the Group that is to be spawned.

Return value:

#string:

SpawnGroupName

RAT:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)

Will spawn a Group within a given Core.Zone.

The Core.Zone can be of any type derived from Core.Zone#ZONE_BASE. Once the Wrapper.Group is spawned within the zone, the Wrapper.Group will continue on its route. The first waypoint (where the group is spawned) is replaced with the zone location coordinates.

Defined in:

Parameters:

Core.Zone#ZONE Zone

The zone where the group is to be spawned.

#boolean RandomizeGroup

(optional) Randomization of the Wrapper.Group position in the zone.

#number MinHeight

(optional) The minimum height to spawn an airborne group into the zone.

#number MaxHeight

(optional) The maximum height to spawn an airborne group into the zone.

#number SpawnIndex

(optional) The index which group to spawn within the given zone.

Return value:

that was spawned or #nil if nothing was spawned.

Usage:


  local SpawnZone = ZONE:New( ZoneName )

  -- Spawn at the zone center position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnInZone( SpawnZone )

  -- Spawn in the zone at a random position at the height specified in the Me of the group template.
  SpawnAirplanes:SpawnInZone( SpawnZone, true )

  -- Spawn in the zone at a random position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnInZone( SpawnZone, true, 2000, 4000 )

  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnInZone( SpawnZone, false, 2000, 4000 )

  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnInZone( SpawnZone, nil, 2000, 4000 )

RAT:SpawnScheduleStart()

Will re-start the spawning scheduler.

Note: This method is only required to be called when the schedule was stopped.

Defined in:

Return value:

RAT:SpawnScheduleStop()

Will stop the scheduled spawning scheduler.

Defined in:

Return value:

RAT:SpawnScheduled(SpawnTime, SpawnTimeVariation, WithDelay)

Spawns new groups at varying time intervals.

This is useful if you want to have continuity within your missions of certain (AI) groups to be present (alive) within your missions. WARNING - Setting a very low SpawnTime heavily impacts your mission performance and CPU time, it is NOT useful to check the alive state of an object every split second! Be reasonable and stay at 15 seconds and above!

Defined in:

Parameters:

#number SpawnTime

The time interval defined in seconds between each new spawn of new groups.

#number SpawnTimeVariation

The variation to be applied on the defined time interval between each new spawn. The variation is a number between 0 and 1, representing the % of variation to be applied on the time interval.

#boolean WithDelay

Do not spawn the first group immediately, but delay the spawn as per the calculation below. Effectively the same as #InitDelayOn().

Return value:

self

Usage:

-- NATO helicopters engaging in the battle field.
-- The time interval is set to SPAWN new helicopters between each 600 seconds, with a time variation of 50%.
-- The time variation in this case will be between 450 seconds and 750 seconds.
-- This is calculated as follows:
--      Low limit:   600 * ( 1 - 0.5 / 2 ) = 450
--      High limit:  600 * ( 1 + 0.5 / 2 ) = 750
-- Between these two values, a random amount of seconds will be chosen for each new spawn of the helicopters.
Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):SpawnScheduled( 600, 0.5 )

RAT:SpawnWithIndex(SpawnIndex, NoBirth)

Will spawn a group with a specified index number.

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

Defined in:

Parameters:

#string SpawnIndex

The index of the group to be spawned.

NoBirth

Return value:

The group that was spawned. You can use this group for further actions.

RAT:StopRepeat()

Stop the SPAWN InitRepeat function (EVENT handler for takeoff, land and engine shutdown)

Defined in:

Return value:

self

Usage:

         local spawn = SPAWN:New("Template Group")
           :InitRepeatOnEngineShutDown()
         local plane = spawn:Spawn() -- it is important that we keep the SPAWN object and do not overwrite it with the resulting GROUP object by just calling :Spawn()
         
         -- later on
         spawn:StopRepeat()

RAT:_CountAliveUnits()

Defined in:

Return value:

RAT:_GetTemplate(SpawnTemplatePrefix)

Defined in:

Parameters:

#string SpawnTemplatePrefix

#number SpawnIndex

Return value:

self

RAT:_RandomizeRoute(SpawnIndex)

Private method randomizing the routes.

Defined in:

Parameter:

#number SpawnIndex

The index of the group to be spawned.

Return value:

RAT:_RandomizeTemplate(SpawnIndex)

Private method that randomizes the template of the group.

Defined in:

Parameter:

#number SpawnIndex

Return value:

self

RAT:_RandomizeZones(SpawnIndex)

Private method that randomizes the Core.Zones where the Group will be spawned.

Defined in:

Parameter:

#number SpawnIndex

Return value:

self

RAT:_Scheduler()

This function is called automatically by the Spawning scheduler.

It is the internal worker method SPAWNing new Groups on the defined time intervals.

Defined in:

RAT:_SetInitialPosition(SpawnIndex)

Private method that sets the DCS#Vec2 where the Group will be spawned.

Defined in:

Parameter:

#number SpawnIndex

Return value:

self

RAT:_SpawnCleanUpScheduler()

Schedules the CleanUp of Groups

Defined in:

Return value:

#boolean:

True = Continue Scheduler

RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

Defined in:

Parameters:

SpawnIndex

SpawnRootX

SpawnRootY

SpawnX

SpawnY

SpawnAngle

Field(s)

#RAT.ATC RAT.ATC

#boolean RAT.ATCswitch

Enable/disable ATC if set to true/false.

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

#boolean RAT.Debug

Turn debug messages on or off.

#number RAT.FLcruise

Cruise altitude of aircraft. Default FL200 for planes and F005 for helos.

#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

F10 menu items for this RAT object.

#string RAT.MenuF10

Main F10 menu.

#number RAT.Ndeparture_Airports

Number of departure airports set via SetDeparture().

#number RAT.Ndeparture_Zones

Number of departure zones set via SetDeparture.

#number RAT.Ndestination_Airports

Number of destination airports set via SetDestination().

#number RAT.Ndestination_Zones

Number of destination zones set via SetDestination().

#number RAT.NspawnMax

Max number of spawns.

#RAT.ROE RAT.ROE

#RAT.ROT RAT.ROT

#string RAT.SubMenuName

Submenu name for RAT object.

#number RAT.Tinactive

Time in seconds after which inactive units will be destroyed. Default is 300 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.

#number RAT.activate_delay

Delay in seconds before first uncontrolled group is activated. Default is 5 seconds.

#number RAT.activate_delta

Time interval in seconds between activation of uncontrolled groups. Default is 5 seconds.

#number RAT.activate_frand

Randomization factor of time interval (activate_delta) between activating uncontrolled groups. Default is 0.

#number RAT.activate_max

Maximum number of uncontrolled aircraft, which will be activated at the same time. Default is 1.

#boolean RAT.activate_uncontrolled

If true, uncontrolled are activated randomly after certain time intervals.

RAT.actype

#boolean RAT.addfriendlydepartures

Add all friendly airports to departures.

#boolean RAT.addfriendlydestinations

Add all friendly airports to destinations.

#table RAT.aircraft

Table which holds the basic aircraft properties (speed, range, ...).

#table RAT.airports

All airports of friedly coalitions.

#table RAT.airports_map

All airports available on current map (Caucasus, Nevada, Normandy, ...).

#string RAT.alias

Alias for spawned group.

#number RAT.alive

Number of groups which are alive.

#RAT.cat RAT.cat

#string RAT.category

Category of aircarft: "plane" or "heli".

#boolean RAT.checkonrunway

Aircraft are checked if they were accidentally spawned on the runway. Default is true.

#boolean RAT.checkontop

Aircraft are checked if they were accidentally spawned on top of another unit. Default is true.

#RAT.coal RAT.coal

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

#number RAT.country

Country of spawn group template.

#table RAT.ctable

Table with the valid coalitions from choice self.friendly.

Core.Zone#ZONE RAT.departure_Azone

Zone containing the departure airports.

#table RAT.departure_ports

Array containing the names of the destination airports or zones.

#boolean RAT.despawnair

If true, aircraft are despawned when they reach their destination zone. Default.

Core.Zone#ZONE RAT.destination_Azone

Zone containing the destination airports.

#table RAT.destination_ports

Array containing the names of the destination airports or zones.

#boolean RAT.destinationzone

Destination is a zone and not an airport.

#boolean RAT.eplrs

If true, turn on EPLSR datalink for the RAT group.

#table RAT.excluded_ports

Array containing the names of explicitly excluded airports.

#boolean RAT.f10menu

If true, add an F10 radiomenu for RAT. Default is false.

#number RAT.frequency

Radio frequency used by the RAT groups.

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

#number RAT.groupsize

Number of aircraft in group.

#string RAT.homebase

Home base for commute and return zone. Aircraft will always return to this base but otherwise travel in a star shaped way.

#string RAT.id

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

#boolean RAT.immortal

If true, aircraft are spawned as immortal.

RAT.index

#boolean RAT.invisible

If true aircraft are set to invisible for other AI forces.

#number RAT.landing

Landing type. Determines if we actually land at an airport or treat it as zone.

#string RAT.lid

Log identifier.

#string RAT.livery

Livery of the aircraft set by user.

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

#string RAT.modulation

Ratio modulation. Either "FM" or "AM".

#number RAT.ngroups

Number of groups to be spawned in total.

#boolean RAT.norespawn

Aircraft will not be respawned after they have finished their route.

#string RAT.onboardnum

Sets the onboard number prefix. Same as setting "TAIL #" in the mission editor.

#number RAT.onboardnum0

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

#number RAT.onrunwaymaxretry

Number of respawn retries (on ground) at other airports if a group gets accidentally spawned on the runway. Default is 3.

#number RAT.onrunwayradius

Distance (in meters) from a runway spawn point until a unit is considered to have accidentally been spawned on a runway. Default is 75 m.

#number RAT.ontopradius

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

#number RAT.parkingscanradius

Radius in meters until which parking spots are scanned for obstacles like other units, statics or scenery.

#boolean RAT.parkingscanscenery

If true, area around parking spots is scanned for scenery objects. Default is false.

#boolean RAT.parkingverysafe

If true, parking spots are considered as non-free until a possible aircraft has left and taken off. Default false.

#boolean RAT.placemarkers

Place markers of waypoints on F10 map.

#boolean RAT.radio

If true/false disables radio messages from the RAT groups.

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

Aircraft will be respawned after a crash, e.g. when they get shot down.

#boolean RAT.respawn_after_takeoff

Aircraft will be respawned directly after take-off.

#boolean RAT.respawn_at_landing

Respawn aircraft the moment they land rather than at engine shutdown.

#number RAT.respawn_delay

Delay in seconds until a repawn happens.

#boolean RAT.respawn_inair

Aircraft are allowed to spawned in air if they cannot be respawned on ground because there is not free parking spot. Default is true.

#table RAT.return_zones

Array containing the names of the return zones.

#boolean RAT.returnzone

Zone where aircraft will fly to before returning to their departure airport.

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

RAT.sid_Activate

RAT.sid_Spawn

Start scheduled spawning.

RAT.sid_Status

Status check and report scheduler.

#string RAT.skill

Skill of AI.

#number RAT.spawndelay

Delay time in seconds before first spawning happens.

#boolean RAT.spawninitialized

If RAT:Spawn() was already called this RAT object is set to true to prevent users to call it again.

#number RAT.spawninterval

Interval between spawning units/groups. Note that we add a randomization of 50%.

#boolean RAT.starshape

If true, aircraft travel A-->B-->A-->C-->A-->D... for commute.

#RAT.status RAT.status

#number RAT.statusinterval

Intervall between status checks (and reports if enabled).

#number RAT.takeoff

Takeoff type. 0=coldorhot.

Wrapper.Group#GROUP RAT.templategroup

Group serving as template for the RAT aircraft.

Wrapper.Airbase#AIRBASE.TerminalType RAT.termtype

Type of terminal to be used when spawning at an airbase.

#boolean RAT.uncontrolled

If true aircraft are spawned in uncontrolled state and will only sit on their parking spots. They can later be activated.

#RAT.unit RAT.unit

#table RAT.version

RAT version.

#table RAT.waypointdescriptions

Table with strings for waypoint descriptions of markers.

#table RAT.waypointstatus

Table with strings of waypoint status.

#RAT.wp RAT.wp

Function(s)

RAT: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.

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

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

Defined in:

Parameter:

Arguments

A #table or any field.

RAT:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

RAT:EventRemoveAll()

Remove all subscribed events

Defined in:

RAT: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.

RAT: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.

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

RAT: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.

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

RAT: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.

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

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

Core.Event#EVENTDATA EventData

The EventData structure.

RAT: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.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RAT: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.

RAT: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.

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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.

RAT: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.

RAT: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.

RAT:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

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

RAT: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.

#number Level

RAT:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

RAT:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

RAT: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 )

RAT:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

RAT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event

Type RAT.ATC

RAT ATC.

Field(s)

#number RAT.ATC.Nclearance

Number of flights that get landing clearance simultaniously. Default 2.

#number RAT.ATC.T0

Time stamp [sec, timer.getTime()] when ATC was initialized.

#table RAT.ATC.airport

List of airports.

#number RAT.ATC.delay

Delay between landing flights in seconds. Default 240 sec.

#table RAT.ATC.flight

List of flights.

#boolean RAT.ATC.init

True if ATC was initialized.

#boolean RAT.ATC.messages

If true, ATC sends messages.

#number RAT.ATC.onfinal

Enumerator onfinal=100.

#number RAT.ATC.unregistered

Enumerator for unregistered flights unregistered=-1.

Function(s)

Type RAT.AtcAirport

Data structure a RAT ATC airbase object.

Field(s)

#number RAT.AtcAirport.Nonfinal

Number of flights on final.

#number RAT.AtcAirport.Tlastclearance

Time stamp when last flight started final approach.

#boolean RAT.AtcAirport.busy

Whether airport is busy.

#table RAT.AtcAirport.onfinal

List of flights on final.

#table RAT.AtcAirport.queue

Queue.

#number RAT.AtcAirport.traffic

Number of flights that landed (just for stats).

Function(s)

Type RAT.AtcFlight

Data structure a RAT ATC airbase object.

Field(s)

#number RAT.AtcFlight.Tarrive

Time stamp when flight arrived at holding.

#number RAT.AtcFlight.Tonfinal

Datastructure of a spawned RAT group.

Field(s)

#number RAT.RatCraft.Distance

Distance travelled in meters.

Core.Point#COORDINATE RAT.RatCraft.Pnow

Current position.

#boolean RAT.RatCraft.active

Whether the group is active or uncontrolled.

#boolean RAT.RatCraft.airborne

Whether this group is airborne.

Wrapper.Airbase#AIRBASE RAT.RatCraft.departure

Departure place of this group. Can also be a ZONE.

#boolean RAT.RatCraft.despawnme

Despawn group if true in the next status update.

Wrapper.Airbase#AIRBASE RAT.RatCraft.destination

Destination of this group. Can also be a ZONE.

Ops.FlightGroup#FLIGHTGROUP RAT.RatCraft.flightgroup

The flight group.

Wrapper.Group#Group RAT.RatCraft.group

The aircraft group.

#number RAT.RatCraft.index

Spawn index.

#number RAT.RatCraft.landing

Laning type.

#string RAT.RatCraft.livery

Livery of the group.

#number RAT.RatCraft.nrespawn

Number of respawns.

#number RAT.RatCraft.nunits

Number of units.

#string RAT.RatCraft.status

Status of the group.

#number RAT.RatCraft.takeoff

Takeoff type.

#table RAT.RatCraft.waypoints

Waypoints.

#table RAT.RatCraft.wpdesc

Waypoint descriptins.

#table RAT.RatCraft.wpstatus

Waypoint status.

Function(s)

Type RAT.cat

Categories of the RAT class.

Field(s)

#string RAT.cat.heli

Heli.

#string RAT.cat.plane

Plane.

Function(s)

Type RAT.coal

RAT friendly coalitions.

Field(s)

#string RAT.coal.neutral

#string RAT.coal.same

#string RAT.coal.sameonly

Function(s)

Type RAT.status

RAT aircraft status.

Field(s)

#string RAT.status.Climb

#string RAT.status.Cruise

#string RAT.status.Departure

Waypoint states.

#string RAT.status.Descent

#string RAT.status.DescentHolding

#string RAT.status.Destination

#string RAT.status.EventBirth

#string RAT.status.EventBirthAir

Event states.

#string RAT.status.EventCrash

#string RAT.status.EventDead

#string RAT.status.EventEngineShutdown

#string RAT.status.EventEngineStart

#string RAT.status.EventEngineStartAir

#string RAT.status.EventLand

#string RAT.status.EventTakeoff

#string RAT.status.Holding

#string RAT.status.Spawned

#string RAT.status.Uncontrolled

Spawn states.

#string RAT.status.Uturn

Function(s)

Type RAT.unit

RAT unit conversions.

Field(s)

#number RAT.unit.FL2m

#number RAT.unit.ft2meter

#number RAT.unit.kmh2ms

#number RAT.unit.nm2km

#number RAT.unit.nm2m

Function(s)

Type RAT.wp

RAT waypoint type.

Field(s)

#number RAT.wp.air

#number RAT.wp.climb

#number RAT.wp.cold

#number RAT.wp.coldorhot

#number RAT.wp.cruise

#number RAT.wp.descent

#number RAT.wp.finalwp

#number RAT.wp.holding

#number RAT.wp.hot

#number RAT.wp.landing

#number RAT.wp.runway

Function(s)

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:

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:

RATMANAGER object

RATMANAGER:SetTcheck(dt)

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.

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

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:

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:

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.

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.

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.

Core.Event#EVENTDATA EventData

The EventData structure.

RATMANAGER:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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.

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

The main event handling function...

This function captures all events generated for the class.

Defined in: