Module Wrapper.Group

self

GROUP:AllOnGround()

Returns if all units of the group are on the ground or landed.

If all units of this group are on the ground, this function will return true, otherwise false.

Defined in:

GROUP

Return value:

#boolean:

All units on the ground result.

GROUP:CalculateThreatLevelA2G()

Calculate the maxium A2G threat level of the Group.

Defined in:

GROUP

GROUP:CopyRoute(Begin, End, Randomize, Radius)

Return the route of a group by using the Core.Database#DATABASE class.

Defined in:

GROUP

Parameters:

#number Begin

The route point from where the copy will start. The base route point is 0.

#number End

The route point where the copy will end. The End point is the last point - the End point. The last point has base 0.

#boolean Randomize

Randomization of the route, when true.

#number Radius

When randomization is on, the randomization is within the radius.

GROUP:CountInZone(Zone)

Returns the number of UNITs that are in the Zone

Defined in:

GROUP

Parameter:

Core.Zone#ZONE_BASE Zone

The zone to test.

Return value:

#number:

The number of UNITs that are in the Zone

GROUP:Destroy(GenerateEvent)

Destroys the DCS Group and all of its DCS Units.

Note that this destroy method also can raise a destroy event at run-time. So all event listeners will catch the destroy event of this group for each unit in the group. To raise these events, provide the GenerateEvent parameter.

Defined in:

GROUP

Parameter:

#boolean GenerateEvent

true if you want to generate a crash or dead event for each unit.

Usages:

-- Air unit example: destroy the Helicopter and generate a S_EVENT_CRASH for each unit in the Helicopter group.
Helicopter = GROUP:FindByName( "Helicopter" )
Helicopter:Destroy( true )

-- Ground unit example: destroy the Tanks and generate a S_EVENT_DEAD for each unit in the Tanks group.
Tanks = GROUP:FindByName( "Tanks" )
Tanks:Destroy( true )

-- Ship unit example: destroy the Ship silently.
Ship = GROUP:FindByName( "Ship" )
Ship:Destroy()

-- Destroy without event generation example.
Ship = GROUP:FindByName( "Boat" )
Ship:Destroy( false ) -- Don't generate an event upon destruction.

GROUP:Find(DCSGroup)

Find the GROUP wrapper class instance using the DCS Group.

Defined in:

GROUP

Parameter:

DCS#Group DCSGroup

The DCS Group.

Return value:

The GROUP.

GROUP:FindByName(GroupName)

Find the created GROUP using the DCS Group Name.

Defined in:

GROUP

Parameter:

#string GroupName

The DCS Group Name.

Return value:

The GROUP.

GROUP:GetCallsign()

Gets the CallSign of the first DCS Unit of the DCS Group.

Defined in:

GROUP

Return value:

#string:

The CallSign of the first DCS Unit of the DCS Group.

GROUP:GetCategory()

Returns category of the DCS Group.

Defined in:

GROUP

Return value:

DCS#Group.Category:

The category ID

GROUP:GetCategoryName()

Returns the category name of the #GROUP.

Defined in:

GROUP

Return value:

#string:

Category name = Helicopter, Airplane, Ground Unit, Ship

GROUP:GetCoalition()

Returns the coalition of the DCS Group.

Defined in:

GROUP

Return value:

DCS#coalition.side:

The coalition side of the DCS Group.

GROUP:GetCoordinate()

Returns a COORDINATE object indicating the point of the first UNIT of the GROUP within the mission.

Defined in:

GROUP

Return value:

Core.Point#COORDINATE:

The COORDINATE of the GROUP.

GROUP:GetCountry()

Returns the country of the DCS Group.

Defined in:

GROUP

Return value:

DCS#country.id:

The country identifier or nil if the DCS Group is not existing or alive.

GROUP:GetDCSDesc(n)

Returns the DCS descriptor table of the nth unit of the group.

Defined in:

GROUP

Parameter:

#number n

(Optional) The number of the unit for which the dscriptor is returned.

Return value:

DCS#Object.Desc:

The descriptor of the first unit of the group or #nil if the group does not exist any more.

GROUP:GetDCSObject()

Returns the DCS Group.

Defined in:

GROUP

Return value:

DCS#Group:

The DCS Group.

GROUP:GetDCSUnit(UnitNumber)

Returns the DCS Unit with number UnitNumber.

If the underlying DCS Unit does not exist, the method will return nil. .

Defined in:

GROUP

Parameter:

#number UnitNumber

The number of the DCS Unit to be returned.

Return value:

DCS#Unit:

The DCS Unit.

GROUP:GetDCSUnits()

Returns the DCS Units of the DCS Group.

Defined in:

GROUP

Return value:

#table:

The DCS Units.

GROUP:GetFuel()

Returns relative amount of fuel (from 0.0 to 1.0) the group has in its internal tanks.

If there are additional fuel tanks the value may be greater than 1.0.

Defined in:

GROUP

Return values:

#number:

The relative amount of fuel (from 0.0 to 1.0).

#nil:

The GROUP is not existing or alive.

GROUP:GetFuelAvg()

Returns relative amount of fuel (from 0.0 to 1.0) the group has in its internal tanks.

If there are additional fuel tanks the value may be greater than 1.0.

Defined in:

GROUP

Return values:

#number:

The relative amount of fuel (from 0.0 to 1.0).

#nil:

The GROUP is not existing or alive.

GROUP:GetFuelMin()

Return the fuel state and unit reference for the unit with the least amount of fuel in the group.

Defined in:

GROUP

Return values:

#number:

The fuel state of the unit with the least amount of fuel

#Unit:

reference to #Unit object for further processing

GROUP:GetHeading()

Returns the mean heading of every UNIT in the GROUP in degrees

Defined in:

GROUP

Return values:

#number:

mean heading of the GROUP

#nil:

The first UNIT is not existing or alive.

GROUP:GetHeight(FromGround)

Returns the average group height in meters.

Defined in:

GROUP

Parameter:

#boolean FromGround

Measure from the ground or from sea level. Provide true for measuring from the ground. false or nil if you measure from sea level.

Return value:

The height of the group or nil if is not existing or alive.

GROUP:GetInitialSize()

Returns the initial size of the DCS Group.

If some of the DCS Units of the DCS Group are destroyed, the initial size of the DCS Group is unchanged.

Defined in:

GROUP

Return value:

#number:

The DCS Group initial size.

GROUP:GetMaxHeight()

Returns the current maximum height of the group.

Each unit within the group gets evaluated, and the maximum height (= the unit which is the highest elevated) is returned.

Defined in:

GROUP

Return value:

#number:

Maximum height found.

GROUP:GetMaxVelocity()

Returns the current maximum velocity of the group.

Each unit within the group gets evaluated, and the maximum velocity (= the unit which is going the fastest) is returned.

Defined in:

GROUP

Return value:

#number:

Maximum velocity found.

GROUP:GetMinHeight()

Returns the current minimum height of the group.

Each unit within the group gets evaluated, and the minimum height (= the unit which is the lowest elevated) is returned.

Defined in:

GROUP

Return value:

#number:

Minimum height found.

GROUP:GetPlayerCount()

Get the active player count in the group.

Defined in:

GROUP

Return value:

#number:

The amount of players.

GROUP:GetPlayerName()

Gets the player name of the group.

Defined in:

GROUP

Return value:

#string:

The player name of the group.

GROUP:GetPlayerNames()

Get player names

Defined in:

GROUP

Return values:

#table:

The group has players, an array of player names is returned.

#nil:

The group has no players

GROUP:GetPlayerUnits()

Returns a list of Wrapper.Unit objects of the Wrapper.Group that are occupied by a player.

Defined in:

GROUP

Return value:

#list<Wrapper.Unit#UNIT>:

The list of player occupied Wrapper.Unit objects of the Wrapper.Group.

GROUP:GetPointVec2()

Returns a POINT_VEC2 object indicating the point in 2D of the first UNIT of the GROUP within the mission.

Defined in:

GROUP

Return values:

Core.Point#POINT_VEC2:

The 2D point vector of the first DCS Unit of the GROUP.

#nil:

The first UNIT is not existing or alive.

GROUP:GetPositionVec3()

Returns the DCS#Position3 position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.

Defined in:

GROUP

Return values:

DCS#Position:

The 3D position vectors of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetRandomVec3(Radius)

Returns a random DCS#Vec3 vector (point in 3D of the UNIT within the mission) within a range around the first UNIT of the GROUP.

Defined in:

GROUP

Parameter:

#number Radius

Return values:

The random 3D point vector around the first UNIT of the GROUP.

#nil:

The GROUP is invalid or empty

Usage:


-- If Radius is ignored, returns the DCS#Vec3 of first UNIT of the GROUP

GROUP:GetRange()

Returns the maximum range of the group.

If the group is heterogenious and consists of different units, the smallest range of all units is returned.

Defined in:

GROUP

Return value:

#number:

Range in meters.

GROUP:GetSize()

Returns current size of the DCS Group.

If some of the DCS Units of the DCS Group are destroyed the size of the DCS Group is changed.

Defined in:

GROUP

Return value:

#number:

The DCS Group size.

GROUP:GetSpeedMax()

Returns the maximum speed of the group.

If the group is heterogenious and consists of different units, the max speed of the slowest unit is returned.

Defined in:

GROUP

Return value:

#number:

Speed in km/h.

GROUP:GetTaskMission()

Return the mission template of the group.

Defined in:

GROUP

Return value:

#table:

The MissionTemplate

GROUP:GetTaskRoute()

Return the mission route of the group.

Defined in:

GROUP

Return value:

#table:

The mission route defined by points.

GROUP:GetTemplate()

Returns the group template from the DATABASE (_DATABASE object).

Defined in:

GROUP

Return value:

#table:

GROUP:GetTemplateRoutePoints()

Returns the group template route.points[] (the waypoints) from the DATABASE (_DATABASE object).

Defined in:

GROUP

Return value:

#table:

GROUP:GetTypeName()

Gets the type name of the group.

Defined in:

GROUP

Return value:

#string:

The type name of the group.

GROUP:GetUnit(UnitNumber)

Returns the UNIT wrapper class with number UnitNumber.

If the underlying DCS Unit does not exist, the method will return nil. .

Defined in:

GROUP

Parameter:

#number UnitNumber

The number of the UNIT wrapper class to be returned.

Return value:

Wrapper.Unit#UNIT:

The UNIT wrapper class.

GROUP:GetUnits()

Returns a list of Wrapper.Unit objects of the Wrapper.Group.

Defined in:

GROUP

Return value:

#list<Wrapper.Unit#UNIT>:

The list of Wrapper.Unit objects of the Wrapper.Group.

GROUP:GetVec2()

Returns the current point (Vec2 vector) of the first DCS Unit in the DCS Group.

Defined in:

GROUP

Return value:

DCS#Vec2:

Current Vec2 point of the first DCS Unit of the DCS Group.

GROUP:GetVec3()

Returns the current Vec3 vector of the first DCS Unit in the GROUP.

Defined in:

GROUP

Return value:

Current Vec3 of the first DCS Unit of the GROUP.

GROUP:GetVelocityVec3()

Returns the average velocity Vec3 vector.

Defined in:

GROUP

Return values:

The velocity Vec3 vector

#nil:

The GROUP is not existing or alive.

GROUP:HandleEvent(Event, EventFunction, ...)

Subscribe to a DCS Event.

Defined in:

GROUP

Parameters:

Core.Event#EVENTS Event

#function EventFunction

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

...

Return value:

GROUP:HasAttribute(attribute, all)

Check if at least one (or all) unit(s) has (have) a certain attribute.

See hoggit documentation.

Defined in:

GROUP

Parameters:

#string attribute

The name of the attribute the group is supposed to have. Valid attributes can be found in the "db_attributes.lua" file which is located at in "C:\Program Files\Eagle Dynamics\DCS World\Scripts\Database".

#boolean all

If true, all units of the group must have the attribute in order to return true. Default is only one unit of a heterogenious group needs to have the attribute.

Return value:

#boolean:

Group has this attribute.

GROUP:InAir()

Returns true if the first unit of the GROUP is in the air.

Defined in:

GROUP

Return value:

#boolean:

true if in the first unit of the group is in the air or #nil if the GROUP is not existing or not alive.

GROUP:InitHeading(Heading)

Set the heading for the units in degrees within the respawned group.

Defined in:

GROUP

Parameter:

#number Heading

The heading in meters.

Return value:

self

GROUP:InitHeight(Height)

Set the height for the units in meters for the respawned group.

(This is applicable for air units).

Defined in:

GROUP

Parameter:

#number Height

The height in meters.

Return value:

self

GROUP:InitRandomizePositionRadius(OuterRadius, InnerRadius)

Randomize the positions of the units of the respawned group in a circle band.

When a Respawn happens, the units of the group will be positioned at random places within the Outer and Inner radius. Thus, a band is created around the respawn location where the units will be placed at random positions.

Defined in:

GROUP

Parameters:

#boolean OuterRadius

Outer band in meters from the center.

#boolean InnerRadius

Inner band in meters from the center.

Return value:

self

GROUP:InitRandomizePositionZone(PositionZone)

Randomize the positions of the units of the respawned group within the Zone.

When a Respawn happens, the units of the group will be placed at random positions within the Zone (selected).

Defined in:

GROUP

Parameter:

#boolean PositionZone

true will randomize the positions within the Zone.

Return value:

self

GROUP:InitZone(Zone)

Set the respawn Zone for the respawned group.

Defined in:

GROUP

Parameter:

Core.Zone#ZONE Zone

The zone in meters.

Return value:

self

GROUP:IsActive()

Returns if the group is activated.

Defined in:

GROUP

Return values:

#boolean:

true if group is activated.

#nil:

The group is not existing or alive.

GROUP:IsAir()

Returns if the group is of an air category.

If the group is a helicopter or a plane, then this method will return true, otherwise false.

Defined in:

GROUP

Return value:

#boolean:

Air category evaluation result.

GROUP:IsAirPlane()

Returns if the DCS Group contains AirPlanes.

Defined in:

GROUP

Return value:

#boolean:

true if DCS Group contains AirPlanes.

GROUP:IsAlive()

Returns if the group is alive.

The Group must:

Exist at run-time.
Has at least one unit.

When the first Wrapper.Unit of the group is active, it will return true. If the first Wrapper.Unit of the group is inactive, it will return false.

Defined in:

GROUP

Return values:

#boolean:

true if the group is alive and active.

#boolean:

false if the group is alive but inactive.

#nil:

if the group does not exist anymore.

GROUP:IsAnyInZone(Zone)

Returns true if any units of the group are within a Core.Zone.

Defined in:

GROUP

Parameter:

Core.Zone#ZONE_BASE Zone

The zone to test.

Return value:

#boolean:

Returns true if any unit of the Group is within the Core.Zone#ZONE_BASE

GROUP:IsCompletelyInZone(Zone)

Returns true if all units of the group are within a Zone.

Defined in:

GROUP

Parameter:

Core.Zone#ZONE_BASE Zone

The zone to test.

Return value:

#boolean:

Returns true if the Group is completely within the Core.Zone#ZONE_BASE

GROUP:IsGround()

Returns if the DCS Group contains Ground troops.

Defined in:

GROUP

Return value:

#boolean:

true if DCS Group contains Ground troops.

GROUP:IsHelicopter()

Returns if the DCS Group contains Helicopters.

Defined in:

GROUP

Return value:

#boolean:

true if DCS Group contains Helicopters.

GROUP:IsNotInZone(Zone)

Returns true if none of the group units of the group are within a Zone.

Defined in:

GROUP

Parameter:

Core.Zone#ZONE_BASE Zone

The zone to test.

Return value:

#boolean:

Returns true if the Group is not within the Core.Zone#ZONE_BASE

GROUP:IsPartlyInZone(Zone)

Returns true if some but NOT ALL units of the group are within a Zone.

Defined in:

GROUP

Parameter:

Core.Zone#ZONE_BASE Zone

The zone to test.

Return value:

#boolean:

Returns true if the Group is partially within the Core.Zone#ZONE_BASE

GROUP:IsPartlyOrCompletelyInZone(Zone)

Returns true if part or all units of the group are within a Zone.

Defined in:

GROUP

Parameter:

Core.Zone#ZONE_BASE Zone

The zone to test.

Return value:

#boolean:

Returns true if the Group is partially or completely within the Core.Zone#ZONE_BASE.

GROUP:IsShip()

Returns if the DCS Group contains Ships.

Defined in:

GROUP

Return value:

#boolean:

true if DCS Group contains Ships.

GROUP:NewTemplate(GroupTemplate, CoalitionSide, CategoryID, CountryID)

Create a new GROUP from a given GroupTemplate as a parameter.

Note that the GroupTemplate is NOT spawned into the mission. It is merely added to the Core.Database.

Defined in:

GROUP

Parameters:

#table GroupTemplate

The GroupTemplate Structure exactly as defined within the mission editor.

DCS#coalition.side CoalitionSide

The coalition.side of the group.

DCS#Group.Category CategoryID

The Group.Category of the group.

DCS#country.id CountryID

the country.id of the group.

Return value:

self

GROUP:OnReSpawn(ReSpawnFunction)

Defined in:

GROUP

Parameter:

ReSpawnFunction

GROUP:Register(GroupName)

Create a new GROUP from an existing Group in the Mission.

Defined in:

GROUP

Parameter:

#string GroupName

The Group name

Return value:

self

GROUP:ResetEvents()

Reset the subscriptions.

Defined in:

GROUP

Return value:

GROUP:Respawn(Template, Reset)

Respawn the Wrapper.Group at a Point.

The method will setup the new group template according the Init(Respawn) settings provided for the group. These settings can be provided by calling the relevant Init...() methods of the Group.

GROUP.InitHeading: Set the heading for the units in degrees within the respawned group.
GROUP.InitHeight: Set the height for the units in meters for the respawned group. (This is applicable for air units).
GROUP.InitRandomizeHeading: Randomize the headings for the units within the respawned group.
GROUP.InitZone: Set the respawn Zone for the respawned group.
GROUP.InitRandomizeZones: Randomize the respawn Zone between one of the Zones given for the respawned group.
GROUP.InitRandomizePositionZone: Randomize the positions of the units of the respawned group within the Zone.
GROUP.InitRandomizePositionRadius: Randomize the positions of the units of the respawned group in a circle band.
GROUP.InitRandomizeTemplates: Randomize the Template for the respawned group.

Notes:

When InitZone or InitRandomizeZones is not used, the position of the respawned group will be its current position.
The current alive group will always be destroyed and respawned using the template definition.

Defined in:

GROUP

Parameters:

#table Template

(optional) The template of the Group retrieved with GROUP:GetTemplate(). If the template is not provided, the template will be retrieved of the group itself.

Reset

GROUP:RespawnAtCurrentAirbase(SpawnTemplate, Takeoff, Uncontrolled)

Respawn a group at an airbase.

Note that the group has to be on parking spots at the airbase already in order for this to work. So each unit of the group is respawned at exactly the same parking spot as it currently occupies.

Defined in:

GROUP

Parameters:

#table SpawnTemplate

(Optional) The spawn template for the group. If no template is given it is exacted from the group.

Core.Spawn#SPAWN.Takeoff Takeoff

(Optional) Takeoff type. Sould be either SPAWN.Takeoff.Cold or SPAWN.Takeoff.Hot. Default is SPAWN.Takeoff.Hot.

#boolean Uncontrolled

(Optional) If true, spawn in uncontrolled state.

Return value:

Wrapper.Group#GROUP:

Group spawned at airbase or nil if group could not be spawned.

GROUP:RouteRTB(RTBAirbase, Speed)

(AIR) Return the Group to an Wrapper.Airbase#AIRBASE.

The following things are to be taken into account:

The group is respawned to achieve the RTB, there may be side artefacts as a result of this. (Like weapons suddenly come back).
A group consisting out of more than one unit, may rejoin formation when respawned.
A speed can be given in km/h. If no speed is specified, the maximum speed of the first unit will be taken to return to base.
When there is no Wrapper.Airbase object specified, the group will return to the home base if the route of the group is pinned at take-off or at landing to a base.
When there is no Wrapper.Airbase object specified and the group route is not pinned to any airbase, it will return to the nearest airbase.

Defined in:

GROUP

Parameters:

Wrapper.Airbase#AIRBASE RTBAirbase

(optional) The Wrapper.Airbase to return to. If blank, the controllable will return to the nearest friendly airbase.

#number Speed

(optional) The Speed, if no Speed is given, the maximum Speed of the first unit is selected.

Return value:

GROUP:SetAIOff()

Turns the AI Off for the GROUP.

Defined in:

GROUP

Return value:

The GROUP.

GROUP:SetAIOn()

Turns the AI On for the GROUP.

Defined in:

GROUP

Return value:

The GROUP.

GROUP:SetAIOnOff(AIOnOff)

Turns the AI On or Off for the GROUP.

Defined in:

GROUP

Parameter:

#boolean AIOnOff

The value true turns the AI On, the value false turns the AI Off.

Return value:

The GROUP.

GROUP:SetTemplateCoalition(CoalitionID, Template)

Sets the CoalitionID of the group in a Template.

Defined in:

GROUP

Parameters:

DCS#coalition.side CoalitionID

The coalition ID.

Template

Return value:

#table:

GROUP:SetTemplateControlled(Controlled, Template)

Sets the controlled status in a Template.

Defined in:

GROUP

Parameters:

#boolean Controlled

true is controlled, false is uncontrolled.

Template

Return value:

#table:

GROUP:SetTemplateCountry(CountryID, Template)

Sets the CountryID of the group in a Template.

Defined in:

GROUP

Parameters:

DCS#country.id CountryID

The country ID.

Template

Return value:

#table:

GROUP:UnHandleEvent(Event)

UnSubscribe to a DCS event.

Defined in:

GROUP

Parameter:

Core.Event#EVENTS Event

Return value:

Field(s)

#string GROUP.GroupName

The name of the group.

GROUP.InitRespawnHeading

GROUP.InitRespawnHeight

GROUP.InitRespawnRandomizePositionInner

GROUP.InitRespawnRandomizePositionOuter

GROUP.InitRespawnZone

#GROUP.Takeoff GROUP.Takeoff

Function(s)

GROUP:ClearTasks()

Clear all tasks from the controllable.

Defined in:

Return value:

GROUP:CommandDoScript(DoScript)

Do Script command

Defined in:

Parameter:

#string DoScript

Return value:

DCS#DCSCommand:

GROUP:CommandStopRoute(StopRoute)

Create a stop route command, which returns a string containing the command.

Use the result in the method CONTROLLABLE.SetCommand(). A value of true will make the ground group stop, a value of false will make it continue. Note that this can only work on GROUP level, although individual UNITs can be commanded, the whole GROUP will react.

Example missions:

GRP-310

Defined in:

Parameter:

#boolean StopRoute

true if the ground unit needs to stop, false if it needs to continue to move.

Return value:

GROUP:CommandSwitchWayPoint(FromWayPoint, ToWayPoint)

Perform a switch waypoint command

Defined in:

Parameters:

#number FromWayPoint

#number ToWayPoint

Return value:

Usage:

--- This test demonstrates the use(s) of the SwitchWayPoint method of the GROUP class.
HeliGroup = GROUP:FindByName( "Helicopter" )

--- Route the helicopter back to the FARP after 60 seconds.
-- We use the SCHEDULER class to do this.
SCHEDULER:New( nil,
  function( HeliGroup )
   local CommandRTB = HeliGroup:CommandSwitchWayPoint( 2, 8 )
   HeliGroup:SetCommand( CommandRTB )
 end, { HeliGroup }, 90 
)

GROUP:CopyRoute(Begin, End, Randomize, Radius)

Return the route of a controllable by using the Core.Database#DATABASE class.

Defined in:

Parameters:

#number Begin

The route point from where the copy will start. The base route point is 0.

#number End

The route point where the copy will end. The End point is the last point - the End point. The last point has base 0.

#boolean Randomize

Randomization of the route, when true.

#number Radius

When randomization is on, the randomization is within the radius.

GROUP:EnRouteTaskAWACS()

(AIR) Aircraft will act as an AWACS for friendly units (will provide them with information about contacts).

No parameters.

Defined in:

Return value:

The DCS task structure.

GROUP:EnRouteTaskEWR()

(GROUND) Ground unit (EW-radar) will act as an EWR for friendly units (will provide them with information about contacts).

No parameters.

Defined in:

Return value:

The DCS task structure.

GROUP:EnRouteTaskEngageGroup(AttackGroup, Priority, WeaponType, WeaponExpend, AttackQty, Direction, Altitude, AttackQtyLimit)

(AIR) Engaging a controllable.

The task does not assign the target controllable to the unit/controllable to attack now; it just allows the unit/controllable to engage the target controllable as well as other assigned targets.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE AttackGroup

The Controllable to be attacked.

#number Priority

All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.

#number WeaponType

(optional) Bitmask of weapon types those allowed to use. If parameter is not defined that means no limits on weapon usage.

DCS#AI.Task.WeaponExpend WeaponExpend

(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.

#number AttackQty

(optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.

DCS#Azimuth Direction

(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.

DCS#Distance Altitude

(optional) Desired attack start altitude. Controllable/aircraft will make its attacks from the altitude. If the altitude is too low or too high to use weapon aircraft/controllable will choose closest altitude to the desired attack start altitude. If the desired altitude is defined controllable/aircraft will not attack from safe altitude.

#boolean AttackQtyLimit

(optional) The flag determines how to interpret attackQty parameter. If the flag is true then attackQty is a limit on maximal attack quantity for "AttackGroup" and "AttackUnit" tasks. If the flag is false then attackQty is a desired attack quantity for "Bombing" and "BombingRunway" tasks.

Return value:

The DCS task structure.

GROUP:EnRouteTaskEngageTargets(Distance, TargetTypes, Priority)

(AIR) Engaging targets of defined types.

Defined in:

Parameters:

DCS#Distance Distance

Maximal distance from the target to a route leg. If the target is on a greater distance it will be ignored.

DCS#AttributeNameArray TargetTypes

Array of target categories allowed to engage.

#number Priority

All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.

Return value:

The DCS task structure.

GROUP:EnRouteTaskEngageTargetsInZone(Vec2, Radius, TargetTypes, Priority)

(AIR) Engaging a targets of defined types at circle-shaped zone.

Defined in:

Parameters:

DCS#Vec2 Vec2

2D-coordinates of the zone.

DCS#Distance Radius

Radius of the zone.

DCS#AttributeNameArray TargetTypes

Array of target categories allowed to engage.

#number Priority

All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.

Return value:

The DCS task structure.

GROUP:EnRouteTaskEngageUnit(EngageUnit, Priority, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, Visible, ControllableAttack)

(AIR) Search and attack the Unit.

Defined in:

Parameters:

Wrapper.Unit#UNIT EngageUnit

The UNIT.

#number Priority

(optional) All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.

#boolean GroupAttack

(optional) If true, all units in the group will attack the Unit when found.

DCS#AI.Task.WeaponExpend WeaponExpend

(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.

#number AttackQty

DCS#Azimuth Direction

DCS#Distance Altitude

(optional) Desired altitude to perform the unit engagement.

#boolean Visible

(optional) Unit must be visible.

#boolean ControllableAttack

(optional) Flag indicates that the target must be engaged by all aircrafts of the controllable. Has effect only if the task is assigned to a controllable, not to a single aircraft.

Return value:

The DCS task structure.

GROUP:EnRouteTaskFAC(Radius, Priority)

(AIR + GROUND) The task makes the controllable/unit a FAC and lets the FAC to choose a targets (enemy ground controllable) around as well as other assigned targets.

The killer is player-controlled allied CAS-aircraft that is in contact with the FAC. If the task is assigned to the controllable lead unit will be a FAC.

Defined in:

Parameters:

DCS#Distance Radius

The maximal distance from the FAC to a target.

#number Priority

All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.

Return value:

The DCS task structure.

GROUP:EnRouteTaskFAC_EngageGroup(AttackGroup, Priority, WeaponType, Designation, Datalink)

(AIR + GROUND) The task makes the controllable/unit a FAC and lets the FAC to choose the target (enemy ground controllable) as well as other assigned targets.

The killer is player-controlled allied CAS-aircraft that is in contact with the FAC. If the task is assigned to the controllable lead unit will be a FAC.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE AttackGroup

Target CONTROLLABLE.

#number Priority

All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.

#number WeaponType

Bitmask of weapon types those allowed to use. If parameter is not defined that means no limits on weapon usage.

DCS#AI.Task.Designation Designation

(optional) Designation type.

#boolean Datalink

(optional) Allows to use datalink to send the target information to attack aircraft. Enabled by default.

Return value:

The DCS task structure.

GROUP:EnRouteTaskTanker()

(AIR) Aircraft will act as a tanker for friendly units.

No parameters.

Defined in:

Return value:

The DCS task structure.

GROUP:GetDetectedTargets(DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)

Return the detected targets of the controllable.

The optional parametes specify the detection methods that can be applied. If no detection method is given, the detection will use all the available methods by default.

Defined in:

Parameters:

#boolean DetectVisual

(optional)

#boolean DetectOptical

(optional)

#boolean DetectRadar

(optional)

#boolean DetectIRST

(optional)

#boolean DetectRWR

(optional)

#boolean DetectDLINK

(optional)

Return value:

#table:

DetectedTargets

GROUP:GetFuel()

Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks.

This method returns nil to ensure polymorphic behaviour! This method needs to be overridden by GROUP or UNIT.

Defined in:

Return value:

#nil:

The CONTROLLABLE is not existing or alive.

GROUP:GetFuelAve()

Returns relative average amount of fuel (from 0.0 to 1.0) a unit or group has in its internal tanks.

This method returns nil to ensure polymorphic behaviour! This method needs to be overridden by GROUP or UNIT.

Defined in:

Return value:

#nil:

The CONTROLLABLE is not existing or alive.

GROUP:GetFuelMin()

Returns relative minimum amount of fuel (from 0.0 to 1.0) a unit or group has in its internal tanks.

This method returns nil to ensure polymorphic behaviour! This method needs to be overridden by GROUP or UNIT.

Defined in:

Return value:

#nil:

The CONTROLLABLE is not existing or alive.

GROUP:GetLife()

Returns the health.

Dead controllables have health <= 1.0.

Defined in:

Return values:

#number:

The controllable health value (unit or group average).

#nil:

The controllable is not existing or alive.

GROUP:GetLife0()

Returns the initial health.

Defined in:

Return values:

#number:

The controllable health value (unit or group average).

#nil:

The controllable is not existing or alive.

GROUP:GetTaskMission()

Return the mission template of the controllable.

Defined in:

Return value:

#table:

The MissionTemplate TODO: Rework the method how to retrieve a template ...

GROUP:GetTaskRoute()

Return the mission route of the controllable.

Defined in:

Return value:

#table:

The mission route defined by points.

GROUP:GetWayPoints()

Get the current WayPoints set with the WayPoint functions( Note that the WayPoints can be nil, although there ARE waypoints).

Defined in:

Return value:

#table:

WayPoints If WayPoints is given, then return the WayPoints structure.

GROUP:HasTask()

Checking the Task Queue of the controllable.

Returns false if no task is on the queue. true if there is a task.

Defined in:

Return value:

self

GROUP:IsAirPlane()

Returns if the Controllable contains AirPlanes.

Defined in:

Return value:

#boolean:

true if Controllable contains AirPlanes.

GROUP:IsTargetDetected(DCSObject, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)

Defined in:

Parameters:

DCSObject

DetectVisual

DetectOptical

DetectRadar

DetectIRST

DetectRWR

DetectDLINK

GROUP:New(ControllableName)

Create a new CONTROLLABLE from a DCSControllable

Defined in:

Parameter:

#string ControllableName

The DCS Controllable name

Return value:

self

GROUP:OptionAlarmStateAuto()

Alarm state to Auto: AI will automatically switch alarm states based on the presence of threats.

The AI kind of cheats in this regard.

Defined in:

Return value:

self

GROUP:OptionAlarmStateGreen()

Alarm state to Green: Group is not combat ready.

Sensors are stowed if possible.

Defined in:

Return value:

self

GROUP:OptionAlarmStateRed()

Alarm state to Red: Group is combat ready and actively searching for targets.

Defined in:

Return value:

self

GROUP:OptionROEHoldFire()

Holding weapons.

Defined in:

Return value:

self

GROUP:OptionROEHoldFirePossible()

Can the CONTROLLABLE hold their weapons?

Defined in:

Return value:

#boolean:

GROUP:OptionROEOpenFire()

Openfire.

Defined in:

Return value:

self

GROUP:OptionROEOpenFirePossible()

Can the CONTROLLABLE attack designated targets?

Defined in:

Return value:

#boolean:

GROUP:OptionROEReturnFire()

Return fire.

Defined in:

Return value:

self

GROUP:OptionROEReturnFirePossible()

Can the CONTROLLABLE attack returning on enemy fire?

Defined in:

Return value:

#boolean:

GROUP:OptionROEWeaponFree()

Weapon free.

Defined in:

Return value:

self

GROUP:OptionROEWeaponFreePossible()

Can the CONTROLLABLE attack targets of opportunity?

Defined in:

Return value:

#boolean:

GROUP:OptionROTEvadeFire()

Evade on fire.

Defined in:

Return value:

self

GROUP:OptionROTEvadeFirePossible()

Can the CONTROLLABLE evade on enemy fire?

Defined in:

Return value:

#boolean:

GROUP:OptionROTNoReaction()

No evasion on enemy threats.

Defined in:

Return value:

self

GROUP:OptionROTNoReactionPossible()

Can the CONTROLLABLE ignore enemy fire?

Defined in:

Return value:

#boolean:

GROUP:OptionROTPassiveDefense()

Evasion passive defense.

Defined in:

Return value:

self

GROUP:OptionROTPassiveDefensePossible()

Can the CONTROLLABLE evade using passive defenses?

Defined in:

Return value:

#boolean:

GROUP:OptionROTVertical()

Evade on fire using vertical manoeuvres.

Defined in:

Return value:

self

GROUP:OptionROTVerticalPossible()

Can the CONTROLLABLE evade on fire using vertical manoeuvres?

Defined in:

Return value:

#boolean:

GROUP:OptionRTBAmmo(WeaponsFlag)

Set RTB on ammo.

Defined in:

Parameter:

#boolean WeaponsFlag

Weapons.flag enumerator.

Return value:

self

GROUP:OptionRTBBingoFuel(RTB)

Set RTB on bingo fuel.

Defined in:

Parameter:

#boolean RTB

true if RTB on bingo fuel (default), false if no RTB on bingo fuel. Warning! When you switch this option off, the airborne group will continue to fly until all fuel has been consumed, and will crash.

Return value:

self

GROUP:PatrolRoute()

(GROUND) Patrol iteratively using the waypoints the for the (parent) group.

Defined in:

Return value:

GROUP:PatrolRouteRandom(Speed, Formation, ToWaypoint)

(GROUND) Patrol randomly to the waypoints the for the (parent) group.

A random waypoint will be picked and the group will move towards that point.

Defined in:

Parameters:

#number Speed

Speed in km/h.

#string Formation

The formation the group uses.

Core.Point#COORDINATE ToWaypoint

The waypoint where the group should move to.

Return value:

GROUP:PatrolZones(ZoneList, Speed, Formation)

(GROUND) Patrol randomly to the waypoints the for the (parent) group.

A random waypoint will be picked and the group will move towards that point.

Defined in:

Parameters:

#table ZoneList

Table of zones.

#number Speed

Speed in km/h the group moves at.

#string Formation

(Optional) Formation the group should use.

Return value:

GROUP:PopCurrentTask()

Popping current Task from the controllable.

Defined in:

Return value:

self

GROUP:PushTask(DCSTask, WaitTime)

Pushing Task on the queue from the controllable.

Defined in:

Parameters:

DCSTask

WaitTime

Return value:

self

GROUP:Route(Route, DelaySeconds)

Make the controllable to follow a given route.

Defined in:

Parameters:

#table Route

A table of Route Points.

#number DelaySeconds

(Optional) Wait for the specified seconds before executing the Route. Default is one second.

Return value:

The CONTROLLABLE.

GROUP:RouteAirTo(ToCoordinate, AltType, Type, Action, Speed, DelaySeconds)

Make the AIR Controllable fly towards a specific point.

Defined in:

Parameters:

Core.Point#COORDINATE ToCoordinate

A Coordinate to drive to.

Core.Point#COORDINATE.RoutePointAltType AltType

The altitude type.

Core.Point#COORDINATE.RoutePointType Type

The route point type.

Core.Point#COORDINATE.RoutePointAction Action

The route point action.

#number Speed

(optional) Speed in km/h. The default speed is 500 km/h.

#number DelaySeconds

Wait for the specified seconds before executing the Route.

Return value:

The CONTROLLABLE.

GROUP:RouteGroundOnRailRoads(ToCoordinate, Speed, DelaySeconds)

Make the TRAIN Controllable to drive towards a specific point using railroads.

Defined in:

Parameters:

Core.Point#COORDINATE ToCoordinate

A Coordinate to drive to.

#number Speed

(Optional) Speed in km/h. The default speed is 20 km/h.

#number DelaySeconds

(Optional) Wait for the specified seconds before executing the Route. Default is one second.

Return value:

The CONTROLLABLE.

GROUP:RouteGroundOnRoad(ToCoordinate, Speed, DelaySeconds, OffRoadFormation)

Make the GROUND Controllable to drive towards a specific point using (mostly) roads.

Defined in:

Parameters:

Core.Point#COORDINATE ToCoordinate

A Coordinate to drive to.

#number Speed

(Optional) Speed in km/h. The default speed is 20 km/h.

#number DelaySeconds

(Optional) Wait for the specified seconds before executing the Route. Default is one second.

#string OffRoadFormation

(Optional) The formation at initial and final waypoint. Default is "Off Road".

Return value:

The CONTROLLABLE.

GROUP:RouteGroundTo(ToCoordinate, Speed, Formation, DelaySeconds)

Make the GROUND Controllable to drive towards a specific point.

Defined in:

Parameters:

Core.Point#COORDINATE ToCoordinate

A Coordinate to drive to.

#number Speed

(optional) Speed in km/h. The default speed is 20 km/h.

#string Formation

(optional) The route point Formation, which is a text string that specifies exactly the Text in the Type of the route point, like "Vee", "Echelon Right".

#number DelaySeconds

Wait for the specified seconds before executing the Route.

Return value:

The CONTROLLABLE.

GROUP:RoutePush(Route, DelaySeconds)

Make the controllable to push follow a given route.

Defined in:

Parameters:

#table Route

A table of Route Points.

#number DelaySeconds

(Optional) Wait for the specified seconds before executing the Route. Default is one second.

Return value:

The CONTROLLABLE.

GROUP:RouteResume()

Resumes the movement of the vehicle on the route.

Defined in:

Return value:

GROUP:RouteStop()

Stops the movement of the vehicle on the route.

Defined in:

Return value:

GROUP:RouteToVec2(Point, Speed)

(AIR + GROUND) Make the Controllable move to fly to a given point.

Defined in:

Parameters:

DCS#Vec3 Point

The destination point in Vec3 format.

#number Speed

The speed [m/s] to travel.

Return value:

self

GROUP:RouteToVec3(Point, Speed)

(AIR + GROUND) Make the Controllable move to a given point.

Defined in:

Parameters:

DCS#Vec3 Point

The destination point in Vec3 format.

#number Speed

The speed [m/s] to travel.

Return value:

self

GROUP:SetCommand(DCSCommand)

Executes a command action

Defined in:

Parameter:

DCS#Command DCSCommand

Return value:

self

GROUP:SetTask(DCSTask, WaitTime)

Clearing the Task Queue and Setting the Task on the queue from the controllable.

Defined in:

Parameters:

#DCS.Task DCSTask

DCS Task array.

#number WaitTime

Time in seconds, before the task is set.

Return value:

self

GROUP:SetTaskWaypoint(Waypoint, Task)

Set a Task at a Waypoint using a Route list.

Defined in:

Parameters:

#table Waypoint

The Waypoint!

DCS#Task Task

The Task structure to be executed!

Return value:

GROUP:StartUncontrolled(delay)

Give an uncontrolled air controllable the start command.

Defined in:

Parameter:

#number delay

(Optional) Delay before start command in seconds.

Return value:

self

GROUP:TaskAttackGroup(AttackGroup, WeaponType, WeaponExpend, AttackQty, Direction, Altitude, AttackQtyLimit)

(AIR) Attack a Controllable.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE AttackGroup

The Controllable to be attacked.

#number WeaponType

(optional) Bitmask of weapon types those allowed to use. If parameter is not defined that means no limits on weapon usage.

DCS#AI.Task.WeaponExpend WeaponExpend

(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.

#number AttackQty

DCS#Azimuth Direction

DCS#Distance Altitude

#boolean AttackQtyLimit

Return value:

The DCS task structure.

GROUP:TaskAttackMapObject(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType)

(AIR) Attacking the map object (building, structure, e.t.c).

Defined in:

Parameters:

DCS#Vec2 Vec2

2D-coordinates of the point to deliver weapon at.

#boolean GroupAttack

(optional) If true, all units in the group will attack the Unit when found.

DCS#AI.Task.WeaponExpend WeaponExpend

(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.

#number AttackQty

DCS#Azimuth Direction

#number Altitude

(optional) The altitude from where to attack.

#number WeaponType

(optional) The WeaponType.

Return value:

The DCS task structure.

GROUP:TaskAttackUnit(AttackUnit, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, Visible, WeaponType)

(AIR) Attack the Unit.

Defined in:

Parameters:

Wrapper.Unit#UNIT AttackUnit

The UNIT.

#boolean GroupAttack

(optional) If true, all units in the group will attack the Unit when found.

DCS#AI.Task.WeaponExpend WeaponExpend

(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.

#number AttackQty

DCS#Azimuth Direction

#number Altitude

(optional) The altitude from where to attack.

#boolean Visible

(optional) not a clue.

#number WeaponType

(optional) The WeaponType.

Return value:

The DCS task structure.

GROUP:TaskBombing(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType, Divebomb)

(AIR) Delivering weapon at the point on the ground.

Defined in:

Parameters:

DCS#Vec2 Vec2

2D-coordinates of the point to deliver weapon at.

#boolean GroupAttack

(optional) If true, all units in the group will attack the Unit when found.

DCS#AI.Task.WeaponExpend WeaponExpend

(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.

#number AttackQty

DCS#Azimuth Direction

#number Altitude

(optional) The altitude from where to attack.

#number WeaponType

(optional) The WeaponType.

#boolean Divebomb

(optional) Perform dive bombing. Default false.

Return value:

The DCS task structure.

GROUP:TaskBombingRunway(Airbase, WeaponType, WeaponExpend, AttackQty, Direction, ControllableAttack)

(AIR) Delivering weapon on the runway.

Defined in:

Parameters:

Wrapper.Airbase#AIRBASE Airbase

Airbase to attack.

#number WeaponType

(optional) Bitmask of weapon types those allowed to use. If parameter is not defined that means no limits on weapon usage.

DCS#AI.Task.WeaponExpend WeaponExpend

(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.

#number AttackQty

DCS#Azimuth Direction

#boolean ControllableAttack

(optional) Flag indicates that the target must be engaged by all aircrafts of the controllable. Has effect only if the task is assigned to a controllable, not to a single aircraft.

Return value:

The DCS task structure.

GROUP:TaskCombo(DCSTasks)

Return a Combo Task taking an array of Tasks.

Defined in:

Parameter:

DCS#TaskArray DCSTasks

Array of DCSTasking.Task#Task

Return value:

GROUP:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint)

Return a condition section for a controlled task.

Defined in:

Parameters:

DCS#Time time

#string userFlag

#boolean userFlagValue

#string condition

DCS#Time duration

#number lastWayPoint

return DCS#Task

GROUP:TaskControlled(DCSTask, DCSStopCondition)

Return a Controlled Task taking a Task and a TaskCondition.

Defined in:

Parameters:

DCS#Task DCSTask

DCS#DCSStopCondition DCSStopCondition

Return value:

GROUP:TaskEmbarkToTransport(Point, Radius)

Move to a defined Vec2 Point, and embark to a controllable when arrived within a defined Radius.

Defined in:

Parameters:

DCS#Vec2 Point

The point where to wait.

#number Radius

The radius of the embarking zone around the Point.

Return value:

The DCS task structure.

GROUP:TaskEmbarking(Point, Duration, EmbarkingControllable)

(AIR) Move the controllable to a Vec2 Point, wait for a defined duration and embark a controllable.

Defined in:

Parameters:

DCS#Vec2 Point

The point where to wait.

#number Duration

The duration in seconds to wait.

#CONTROLLABLE EmbarkingControllable

The controllable to be embarked.

Return value:

The DCS task structure

GROUP:TaskEscort(FollowControllable, Vec3, LastWaypointIndex, EngagementDistance, TargetTypes)

(AIR) Escort another airborne controllable.

The unit / controllable will follow lead unit of another controllable, wingmens of both controllables will continue following their leaders. The unit / controllable will also protect that controllable from threats of specified types.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE FollowControllable

The controllable to be escorted.

DCS#Vec3 Vec3

Position of the unit / lead unit of the controllable relative lead unit of another controllable in frame reference oriented by course of lead unit of another controllable. If another controllable is on land the unit / controllable will orbit around.

#number LastWaypointIndex

Detach waypoint of another controllable. Once reached the unit / controllable Follow task is finished.

#number EngagementDistance

Maximal distance from escorted controllable to threat. If the threat is already engaged by escort escort will disengage if the distance becomes greater than 1.5 * engagementDistMax.

DCS#AttributeNameArray TargetTypes

Array of AttributeName that is contains threat categories allowed to engage.

Return value:

The DCS task structure.

GROUP:TaskFAC_AttackGroup(AttackGroup, WeaponType, Designation, Datalink)

(AIR + GROUND) The task makes the controllable/unit a FAC and orders the FAC to control the target (enemy ground controllable) destruction.

The killer is player-controlled allied CAS-aircraft that is in contact with the FAC. If the task is assigned to the controllable lead unit will be a FAC.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE AttackGroup

Target CONTROLLABLE.

#number WeaponType

Bitmask of weapon types those allowed to use. If parameter is not defined that means no limits on weapon usage.

DCS#AI.Task.Designation Designation

(optional) Designation type.

#boolean Datalink

(optional) Allows to use datalink to send the target information to attack aircraft. Enabled by default.

Return value:

The DCS task structure.

GROUP:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType)

(GROUND) Fire at a VEC2 point until ammunition is finished.

Defined in:

Parameters:

DCS#Vec2 Vec2

The point to fire at.

DCS#Distance Radius

The radius of the zone to deploy the fire at.

#number AmmoCount

(optional) Quantity of ammunition to expand (omit to fire until ammunition is depleted).

#number WeaponType

(optional) Enum for weapon type ID. This value is only required if you want the group firing to use a specific weapon, for instance using the task on a ship to force it to fire guided missiles at targets within cannon range. See http://wiki.hoggit.us/view/DCS_enum_weapon_flag

Return value:

The DCS task structure.

GROUP:TaskFollow(FollowControllable, Vec3, LastWaypointIndex)

(AIR) Following another airborne controllable.

The unit / controllable will follow lead unit of another controllable, wingmens of both controllables will continue following their leaders. If another controllable is on land the unit / controllable will orbit around.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE FollowControllable

The controllable to be followed.

DCS#Vec3 Vec3

#number LastWaypointIndex

Detach waypoint of another controllable. Once reached the unit / controllable Follow task is finished.

Return value:

The DCS task structure.

GROUP:TaskFunction(FunctionString, ...)

This creates a Task element, with an action to call a function as part of a Wrapped Task.

This Task can then be embedded at a Waypoint by calling the method CONTROLLABLE.SetTaskWaypoint.

Defined in:

Parameters:

#string FunctionString

The function name embedded as a string that will be called.

...

The variable arguments passed to the function when called! These arguments can be of any type!

Return value:

Usage:


 local ZoneList = { 
   ZONE:New( "ZONE1" ), 
   ZONE:New( "ZONE2" ), 
   ZONE:New( "ZONE3" ), 
   ZONE:New( "ZONE4" ), 
   ZONE:New( "ZONE5" ) 
 }
 
 GroundGroup = GROUP:FindByName( "Vehicle" )
 
 --- @param Wrapper.Group#GROUP GroundGroup
 function RouteToZone( Vehicle, ZoneRoute )
 
   local Route = {}
   
   Vehicle:E( { ZoneRoute = ZoneRoute } )
   
   Vehicle:MessageToAll( "Moving to zone " .. ZoneRoute:GetName(), 10 )
 
   -- Get the current coordinate of the Vehicle
   local FromCoord = Vehicle:GetCoordinate()
   
   -- Select a random Zone and get the Coordinate of the new Zone.
   local RandomZone = ZoneList[ math.random( 1, #ZoneList ) ] -- Core.Zone#ZONE
   local ToCoord = RandomZone:GetCoordinate()
   
   -- Create a "ground route point", which is a "point" structure that can be given as a parameter to a Task
   Route[#Route+1] = FromCoord:WaypointGround( 72 )
   Route[#Route+1] = ToCoord:WaypointGround( 60, "Vee" )
   
   local TaskRouteToZone = Vehicle:TaskFunction( "RouteToZone", RandomZone )
   
   Vehicle:SetTaskWaypoint( Route[#Route], TaskRouteToZone ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.
 
   Vehicle:Route( Route, math.random( 10, 20 ) ) -- Move after a random seconds to the Route. See the Route method for details.
   
 end
   
   RouteToZone( GroundGroup, ZoneList[1] )

GROUP:TaskGroundOnRailRoads(ToCoordinate, Speed)

Make a task for a TRAIN Controllable to drive towards a specific point using railroad.

Defined in:

Parameters:

Core.Point#COORDINATE ToCoordinate

A Coordinate to drive to.

#number Speed

(Optional) Speed in km/h. The default speed is 20 km/h.

Return value:

Task

GROUP:TaskGroundOnRoad(ToCoordinate, Speed, OffRoadFormation, Shortcut, FromCoordinate)

Make a task for a GROUND Controllable to drive towards a specific point using (mostly) roads.

Defined in:

Parameters:

Core.Point#COORDINATE ToCoordinate

A Coordinate to drive to.

#number Speed

(Optional) Speed in km/h. The default speed is 20 km/h.

#string OffRoadFormation

(Optional) The formation at initial and final waypoint. Default is "Off Road".

#boolean Shortcut

(Optional) If true, controllable will take the direct route if the path on road is 10x longer or path on road is less than 5% of total path.

Core.Point#COORDINATE FromCoordinate

(Optional) Explicit initial coordinate. Default is the position of the controllable.

Return values:

Task.

#boolean:

If true, path on road is possible. If false, task will route the group directly to its destination.

GROUP:TaskHold()

(GROUND) Hold ground controllable from moving.

Defined in:

Return value:

The DCS task structure.

GROUP:TaskHoldPosition(Duration)

(AIR) Hold position at the current position of the first unit of the controllable.

Defined in:

Parameter:

#number Duration

The maximum duration in seconds to hold the position.

Return value:

self

GROUP:TaskLandAtVec2(Point, Duration)

(AIR HELICOPTER) Landing at the ground.

For helicopters only.

Defined in:

Parameters:

DCS#Vec2 Point

The point where to land.

#number Duration

The duration in seconds to stay on the ground.

Return value:

self

GROUP:TaskLandAtZone(Zone, Duration, RandomPoint)

(AIR) Land the controllable at a @{Core.Zone#ZONE_RADIUS).

Defined in:

Parameters:

Core.Zone#ZONE Zone

The zone where to land.

#number Duration

The duration in seconds to stay on the ground.

RandomPoint

Return value:

self

GROUP:TaskMission(TaskMission)

(AIR + GROUND) Return a mission task from a mission template.

Defined in:

Parameter:

#table TaskMission

A table containing the mission task.

Return value:

GROUP:TaskOrbitCircle(Altitude, Speed, Coordinate)

(AIR) Orbit at the current position of the first unit of the controllable at a specified alititude.

Defined in:

Parameters:

#number Altitude

The altitude [m] to hold the position.

#number Speed

The speed [m/s] flying when holding the position.

Core.Point#COORDINATE Coordinate

The coordinate where to orbit.

Return value:

self

GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed)

(AIR) Orbit at a specified position at a specified alititude during a specified duration with a specified speed.

Defined in:

Parameters:

DCS#Vec2 Point

The point to hold the position.

#number Altitude

The altitude [m] to hold the position.

#number Speed

The speed [m/s] flying when holding the position.

Return value:

self

GROUP:TaskRefueling()

(AIR) Refueling from the nearest tanker.

No parameters.

Defined in:

Return value:

The DCS task structure.

GROUP:TaskRoute(Points)

Return a Misson task to follow a given route defined by Points.

Defined in:

Parameter:

#table Points

A table of route points.

Return value:

GROUP:TaskRouteToVec2(Vec2, Speed, Formation)

(GROUND) Route the controllable to a given Vec2.

A speed can be given in km/h. A given formation can be given.

Defined in:

Parameters:

DCS#Vec2 Vec2

The Vec2 where to route to.

#number Speed

The speed in m/s. Default is 5.555 m/s = 20 km/h.

Base#FORMATION Formation

The formation string.

GROUP:TaskRouteToZone(Zone, Randomize, Speed, Formation)

(AIR + GROUND) Route the controllable to a given zone.

The controllable final destination point can be randomized. A speed can be given in km/h. A given formation can be given.

Defined in:

Parameters:

Core.Zone#ZONE Zone

The zone where to route to.

#boolean Randomize

Defines whether to target point gets randomized within the Zone.

#number Speed

The speed in m/s. Default is 5.555 m/s = 20 km/h.

Base#FORMATION Formation

The formation string.

GROUP:TaskWrappedAction(DCSCommand, Index)

Return a WrappedAction Task taking a Command.

Defined in:

Parameters:

DCS#Command DCSCommand

Index

Return value:

GROUP:WayPointExecute(WayPoint, WaitTime)

Executes the WayPoint plan.

The function gets a WayPoint parameter, that you can use to restart the mission at a specific WayPoint. Note that when the WayPoint parameter is used, the new start mission waypoint of the controllable will be 1!

Defined in:

Parameters:

#number WayPoint

The WayPoint from where to execute the mission.

#number WaitTime

The amount seconds to wait before initiating the mission.

Return value:

GROUP:WayPointFunction(WayPoint, WayPointIndex, WayPointFunction, ...)

Registers a waypoint function that will be executed when the controllable moves over the WayPoint.

Defined in:

Parameters:

#number WayPoint

The waypoint number. Note that the start waypoint on the route is WayPoint 1!

#number WayPointIndex

When defining multiple WayPoint functions for one WayPoint, use WayPointIndex to set the sequence of actions.

#function WayPointFunction

The waypoint function to be called when the controllable moves over the waypoint. The waypoint function takes variable parameters.

...

Return value:

GROUP:WayPointInitialize(WayPoints)

Retrieve the controllable mission and allow to place function hooks within the mission waypoint plan.

Use the method Wrapper.Controllable#CONTROLLABLE to define the hook functions for specific waypoints. Use the method @{Controllable@CONTROLLABLE:WayPointExecute) to start the execution of the new mission plan. Note that when WayPointInitialize is called, the Mission of the controllable is RESTARTED!

Defined in:

Parameter:

#table WayPoints

If WayPoints is given, then use the route.

Return value:

GROUP:_GetController()

Get the controller for the CONTROLLABLE.

Defined in:

Return value:

DCS#Controller:

Field(s)

#string GROUP.GroupName

The name of the group.

GROUP.InitRespawnHeading

GROUP.InitRespawnHeight

GROUP.InitRespawnRandomizePositionInner

GROUP.InitRespawnRandomizePositionOuter

GROUP.InitRespawnZone

#GROUP.Takeoff GROUP.Takeoff

Function(s)

GROUP:AddCargo(Cargo)

Add cargo.

Defined in:

Parameter:

Core.Cargo#CARGO Cargo

Return value:

GROUP:CargoItemCount()

Get cargo item count.

Defined in:

Return value:

Core.Cargo#CARGO:

Cargo

GROUP:ClearCargo()

Clear all cargo.

Defined in:

GROUP:Destroy(GenerateEvent)

Destroys the POSITIONABLE.

Defined in:

Parameter:

#boolean GenerateEvent

(Optional) true if you want to generate a crash or dead event for the unit.

Return value:

#nil:

The DCS Unit is not existing or alive.

Usages:

-- Air unit example: destroy the Helicopter and generate a S_EVENT_CRASH for each unit in the Helicopter group.
Helicopter = UNIT:FindByName( "Helicopter" )
Helicopter:Destroy( true )

-- Ground unit example: destroy the Tanks and generate a S_EVENT_DEAD for each unit in the Tanks group.
Tanks = UNIT:FindByName( "Tanks" )
Tanks:Destroy( true )

-- Ship unit example: destroy the Ship silently.
Ship = STATIC:FindByName( "Ship" )
Ship:Destroy()

-- Destroy without event generation example.
Ship = STATIC:FindByName( "Boat" )
Ship:Destroy( false ) -- Don't generate an event upon destruction.

GROUP:Flare(FlareColor)

Signal a flare at the position of the POSITIONABLE.

Defined in:

Parameter:

Utilities.Utils#FLARECOLOR FlareColor

GROUP:FlareGreen()

Signal a green flare at the position of the POSITIONABLE.

Defined in:

GROUP:FlareRed()

Signal a red flare at the position of the POSITIONABLE.

Defined in:

GROUP:FlareWhite()

Signal a white flare at the position of the POSITIONABLE.

Defined in:

GROUP:FlareYellow()

Signal a yellow flare at the position of the POSITIONABLE.

Defined in:

GROUP:GetAltitude()

Returns the altitude of the POSITIONABLE.

Defined in:

Return values:

DCS#Distance:

The altitude of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetAoA()

Returns the Angle of Attack of a positionable.

Defined in:

Return value:

#number:

Angle of attack in degrees.

GROUP:GetBeacon()

Create a Core.Radio#BEACON, to allow this POSITIONABLE to broadcast beacon signals

Defined in:

Return value:

Core.Radio#RADIO:

Radio

GROUP:GetBoundingBox()

Get the bounding box of the underlying POSITIONABLE DCS Object.

Defined in:

Return values:

DCS#Box3:

The bounding box of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetBoundingRadius(mindist)

Get the bounding radius of the underlying POSITIONABLE DCS Object.

Defined in:

Parameter:

#number mindist

(Optional) If bounding box is smaller than this value, mindist is returned.

Return value:

DCS#Distance:

The bounding radius of the POSITIONABLE or #nil if the POSITIONABLE is not existing or alive.

GROUP:GetCargo()

Get all contained cargo.

Defined in:

Return value:

GROUP:GetCargoBayFreeWeight()

Get Cargo Bay Free Weight in kg.

Defined in:

Return value:

#number:

CargoBayFreeWeight

GROUP:GetClimbAnge()

Returns the unit's climb or descent angle.

Defined in:

Return value:

#number:

Climb or descent angle in degrees.

GROUP:GetCoordinate()

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

Defined in:

Return value:

Core.Point#COORDINATE:

The COORDINATE of the POSITIONABLE.

GROUP:GetHeading()

Returns the POSITIONABLE heading in degrees.

Defined in:

Return values:

#number:

The POSITIONABLE heading

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetHeight()

Returns the POSITIONABLE height in meters.

Defined in:

Return values:

The height of the positionable.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetLaserCode()

Get the last assigned laser code

Defined in:

Return value:

#number:

The laser code

GROUP:GetMessage(Message, Duration, Name)

Returns a message with the callsign embedded (if there is one).

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

Return value:

Core.Message#MESSAGE:

GROUP:GetMessageText(Message, Name)

Returns the message text with the callsign embedded (if there is one).

Defined in:

Parameters:

#string Message

The message text

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

Return value:

#string:

The message text

GROUP:GetMessageType(Message, MessageType, Name)

Returns a message of a specified type with the callsign embedded (if there is one).

Defined in:

Parameters:

#string Message

The message text

Core.Message#MESSAGE MessageType

MessageType The message type.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

Return value:

Core.Message#MESSAGE:

GROUP:GetOrientation()

Returns a {@DCS#Vec3} table of the objects current orientation in 3D space.

X, Y, Z values are unit vectors defining the objects orientation. X is the orientation parallel to the movement of the object, Z perpendicular and Y vertical orientation.

Defined in:

Return values:

X orientation, i.e. parallel to the direction of movement.

Y orientation, i.e. vertical.

Z orientation, i.e. perpendicular to the direction of movement.

GROUP:GetOrientationX()

Returns a {@DCS#Vec3} table of the objects current X orientation in 3D space, i.e.

along the direction of movement.

Defined in:

Return value:

X orientation, i.e. parallel to the direction of movement.

GROUP:GetOrientationY()

Returns a {@DCS#Vec3} table of the objects current Y orientation in 3D space, i.e.

vertical orientation.

Defined in:

Return value:

Y orientation, i.e. vertical.

GROUP:GetOrientationZ()

Returns a {@DCS#Vec3} table of the objects current Z orientation in 3D space, i.e.

perpendicular to direction of movement.

Defined in:

Return value:

Z orientation, i.e. perpendicular to movement.

GROUP:GetPitch()

Returns the pitch angle of a unit.

Defined in:

Return value:

#number:

Pitch ange in degrees.

GROUP:GetPointVec2()

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

Defined in:

Return values:

Core.Point#POINT_VEC2:

The 2D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetPointVec3()

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

Defined in:

Return values:

Core.Point#POINT_VEC3:

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetPosition()

Returns a pos3 table of the objects current position and orientation in 3D space.

X, Y, Z values are unit vectors defining the objects orientation. Coordinates are dependent on the position of the maps origin.

Defined in:

Return value:

DCS#Position:

Table consisting of the point and orientation tables.

GROUP:GetPositionVec3()

Returns the DCS#Position3 position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.

Defined in:

Return values:

DCS#Position:

The 3D position vectors of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetRadio()

Create a Core.Radio#RADIO, to allow radio transmission for this POSITIONABLE.

Set parameters with the methods provided, then use RADIO:Broadcast() to actually broadcast the message

Defined in:

Return value:

Core.Radio#RADIO:

Radio

GROUP:GetRandomVec3(Radius)

Returns a random DCS#Vec3 vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.

Defined in:

Parameter:

#number Radius

Return values:

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

Usage:


-- If Radius is ignored, returns the DCS#Vec3 of first UNIT of the GROUP

GROUP:GetRoll()

Returns the roll angle of a unit.

Defined in:

Return value:

#number:

Pitch ange in degrees.

GROUP:GetSize()

Defined in:

GROUP:GetSpot()

Get the Spot

Defined in:

Return value:

Core.Spot#SPOT:

The Spot

GROUP:GetVec2()

Returns the DCS#Vec2 vector indicating the point in 2D of the POSITIONABLE within the mission.

Defined in:

Return values:

DCS#Vec2:

The 2D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetVec3()

Returns the DCS#Vec3 vector indicating the 3D vector of the POSITIONABLE within the mission.

Defined in:

Return values:

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetVelocity()

Returns the a Velocity object from the positionable.

Defined in:

Return values:

Core.Velocity#VELOCITY:

Velocity The Velocity object.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetVelocityKMH()

Returns the POSITIONABLE velocity in km/h.

Defined in:

Return value:

#number:

The velocity in km/h

GROUP:GetVelocityMPS()

Returns the POSITIONABLE velocity in meters per second.

Defined in:

Return value:

#number:

The velocity in meters per second.

GROUP:GetVelocityVec3()

Returns the POSITIONABLE velocity Vec3 vector.

Defined in:

Return values:

The velocity Vec3 vector

#nil:

The POSITIONABLE is not existing or alive.

GROUP:GetYaw()

Returns the yaw angle of a unit.

Defined in:

Return value:

#number:

Yaw ange in degrees.

GROUP:HasCargo(Cargo)

Returns if carrier has given cargo.

Defined in:

Parameter:

Cargo

Return value:

Core.Cargo#CARGO:

Cargo

GROUP:InAir()

Returns true if the POSITIONABLE is in the air.

Polymorphic, is overridden in GROUP and UNIT.

Defined in:

Return values:

#boolean:

true if in the air.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:IsAboveRunway()

Returns if the Positionable is located above a runway.

Defined in:

Return values:

#boolean:

true if Positionable is above a runway.

#nil:

The POSITIONABLE is not existing or alive.

GROUP:IsAir()

Returns if the unit is of an air category.

If the unit is a helicopter or a plane, then this method will return true, otherwise false.

Defined in:

Return value:

#boolean:

Air category evaluation result.

GROUP:IsCargoEmpty()

Is cargo bay empty.

Defined in:

GROUP:IsGround()

Returns if the unit is of an ground category.

If the unit is a ground vehicle or infantry, this method will return true, otherwise false.

Defined in:

Return value:

#boolean:

Ground category evaluation result.

GROUP:IsLasing()

Check if the POSITIONABLE is lasing a target

Defined in:

Return value:

#boolean:

true if it is lasing a target

GROUP:LaseOff()

Stop Lasing a POSITIONABLE

Defined in:

Return value:

GROUP:LaseUnit(Target, LaserCode, Duration)

Start Lasing a POSITIONABLE

Defined in:

Parameters:

#POSITIONABLE Target

#number LaserCode

#number Duration

Return value:

Core.Spot#SPOT:

GROUP:Message(Message, Duration, Name)

Send a message to the players in the Wrapper.Group.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:MessageToAll(Message, Duration, Name)

Send a message to all coalitions.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:MessageToBlue(Message, Duration, Name)

Send a message to the blue coalition.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:MessageToClient(Message, Duration, Client, Name)

Send a message to a client.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

Wrapper.Client#CLIENT Client

The client object receiving the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:MessageToCoalition(Message, Duration, MessageCoalition, Name)

Send a message to a coalition.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

DCS#coalition MessageCoalition

The Coalition receiving the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:MessageToGroup(Message, Duration, MessageGroup, Name)

Send a message to a Wrapper.Group.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

Wrapper.Group#GROUP MessageGroup

The GROUP object receiving the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:MessageToRed(Message, Duration, Name)

Send a message to the red coalition.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)

Send a message to a Core.Set#SET_GROUP.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

Core.Set#SET_GROUP MessageSetGroup

The SET_GROUP collection receiving the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:MessageTypeToCoalition(Message, MessageType, MessageCoalition, Name)

Send a message to a coalition.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

Core.Message#MESSAGE.Type MessageType

The message type that determines the duration.

DCS#coalition MessageCoalition

The Coalition receiving the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)

Send a message of a message type to a Wrapper.Group.

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

Defined in:

Parameters:

#string Message

The message text

Core.Message#MESSAGE.Type MessageType

The message type that determines the duration.

Wrapper.Group#GROUP MessageGroup

The GROUP object receiving the message.

#string Name

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

GROUP:New(PositionableName)

Create a new POSITIONABLE from a DCSPositionable

Defined in:

Parameter:

#string PositionableName

The POSITIONABLE name

Return value:

self

GROUP:RemoveCargo(Cargo)

Remove cargo.

Defined in:

Parameter:

Core.Cargo#CARGO Cargo

Return value:

GROUP:SetCargoBayWeightLimit(WeightLimit)

Set Cargo Bay Weight Limit in kg.

Defined in:

Parameter:

#number WeightLimit

GROUP:Smoke(SmokeColor, Range, AddHeight)

Smoke the POSITIONABLE.

Defined in:

Parameters:

Utilities.Utils#SMOKECOLOR SmokeColor

The color to smoke to positionable.

#number Range

The range in meters to randomize the smoking around the positionable.

#number AddHeight

The height in meters to add to the altitude of the positionable.

GROUP:SmokeBlue()

Smoke the POSITIONABLE Blue.

Defined in:

GROUP:SmokeGreen()

Smoke the POSITIONABLE Green.

Defined in:

GROUP:SmokeOrange()

Smoke the POSITIONABLE Orange.

Defined in:

GROUP:SmokeRed()

Smoke the POSITIONABLE Red.

Defined in:

GROUP:SmokeWhite()

Smoke the POSITIONABLE White.

Defined in:

Field(s)

#string GROUP.GroupName

The name of the group.

GROUP.InitRespawnHeading

GROUP.InitRespawnHeight

GROUP.InitRespawnRandomizePositionInner

GROUP.InitRespawnRandomizePositionOuter

GROUP.InitRespawnZone

#GROUP.Takeoff GROUP.Takeoff

Function(s)

GROUP:GetCallsign()

Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

Defined in:

Return value:

#string:

The CallSign of the IDENTIFIABLE.

GROUP:GetCategory()

Returns category of the DCS Identifiable.

Defined in:

Return value:

DCS#Object.Category:

The category ID

GROUP:GetCategoryName()

Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.

Defined in:

Return value:

#string:

The DCS Identifiable Category Name

GROUP:GetCoalition()

Returns coalition of the Identifiable.

Defined in:

Return values:

DCS#coalition.side:

The side of the coalition.

#nil:

The DCS Identifiable is not existing or alive.

GROUP:GetCoalitionName()

Returns the name of the coalition of the Identifiable.

Defined in:

Return values:

#string:

The name of the coalition.

#nil:

The DCS Identifiable is not existing or alive.

GROUP:GetCountry()

Returns country of the Identifiable.

Defined in:

Return values:

DCS#country.id:

The country identifier.

#nil:

The DCS Identifiable is not existing or alive.

GROUP:GetCountryName()

Returns country name of the Identifiable.

Defined in:

Return value:

#string:

Name of the country.

GROUP:GetDesc()

Returns Identifiable descriptor.

Descriptor type depends on Identifiable category.

Defined in:

Return values:

DCS#Object.Desc:

The Identifiable descriptor.

#nil:

The DCS Identifiable is not existing or alive.

GROUP:GetName()

Returns DCS Identifiable object name.

The function provides access to non-activated objects too.

Defined in:

Return values:

#string:

The name of the DCS Identifiable.

#nil:

The DCS Identifiable is not existing or alive.

GROUP:GetThreatLevel()

Defined in:

GROUP:GetTypeName()

Returns the type name of the DCS Identifiable.

Defined in:

Return values:

#string:

The type name of the DCS Identifiable.

#nil:

The DCS Identifiable is not existing or alive.

GROUP:HasAttribute(AttributeName)

Check if the Object has the attribute.

Defined in:

Parameter:

#string AttributeName

The attribute name.

Return values:

#boolean:

true if the attribute exists.

#nil:

The DCS Identifiable is not existing or alive.

GROUP:IsAlive()

Returns if the Identifiable is alive.

If the Identifiable is not alive, nil is returned.
If the Identifiable is alive, true is returned.

Defined in:

Return values:

#boolean:

true if Identifiable is alive.

#nil:

if the Identifiable is not existing or is not alive.

GROUP:New(IdentifiableName)

Create a new IDENTIFIABLE from a DCSIdentifiable

Defined in:

Parameter:

#string IdentifiableName

The DCS Identifiable name

Return value:

#IDENTIFIABLE:

self

Field(s)

#string GROUP.GroupName

The name of the group.

GROUP.InitRespawnHeading

GROUP.InitRespawnHeight

GROUP.InitRespawnRandomizePositionInner

GROUP.InitRespawnRandomizePositionOuter

GROUP.InitRespawnZone

#GROUP.Takeoff GROUP.Takeoff

Function(s)

GROUP:Destroy()

Destroys the OBJECT.

Defined in:

Wrapper.Object#OBJECT

Return values:

#boolean:

true if the object is destroyed.

#nil:

The DCS Unit is not existing or alive.

GROUP:GetID()

Returns the unit's unique identifier.

Defined in:

Wrapper.Object#OBJECT

Return value:

DCS#Object.ID:

ObjectID or #nil if the DCS Object is not existing or alive. Note that the ID is passed as a string and not a number.

GROUP:New(ObjectName, Test)

Create a new OBJECT from a DCSObject

Defined in:

Wrapper.Object#OBJECT

Parameters:

DCS#Object ObjectName

The Object name

Test

Return value:

#OBJECT:

self

Field(s)

#string GROUP.GroupName

The name of the group.

GROUP.InitRespawnHeading

GROUP.InitRespawnHeight

GROUP.InitRespawnRandomizePositionInner

GROUP.InitRespawnRandomizePositionOuter

GROUP.InitRespawnZone

#GROUP.Takeoff GROUP.Takeoff

Function(s)

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

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

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

GROUP:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

GROUP:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

GROUP:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

GROUP:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

GROUP:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

GROUP:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

GROUP:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

GROUP:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

GROUP:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

GROUP:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

GROUP:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

GROUP:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

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

GROUP:GetEventPriority()

Get the Class 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 Event processing Priority.

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

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

FromClass

Return value:

GROUP:GetState(Object, Key)

Get a Value given a Key from the Object.

Note that if the Object is destroyed, nillified 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.

GROUP:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS Event

#function EventFunction

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

Return value:

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

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

GROUP:IsInstanceOf(ClassName)

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

Examples:

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

GROUP:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

GROUP:New()

BASE constructor.

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

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

Defined in:

Return value:

GROUP:OnEvent(EventData)

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventBaseCaptured(EventData)

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

initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventCrash(EventData)

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

initiator : The unit that has crashed

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventDead(EventData)

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship 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.

GROUP:OnEventMissionEnd(EventData)

Occurs when a mission ends

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventMissionStart(EventData)

Occurs when a mission starts

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventPlayerLeaveUnit(EventData)

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

initiator : The unit that the player left.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventRefueling(EventData)

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. initiator : The unit that was doing the shooing.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventShootingStart(EventData)

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

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooing. target: The unit that is being targeted.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

GROUP:OnEventTakeoff(EventData)

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

initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

#number:

The ScheduleID of the planned schedule.

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

#number:

The ScheduleID of the planned schedule.

GROUP:ScheduleStop(SchedulerFunction)

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

GROUP:SetEventPriority(EventPriority)

Set the Class 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 Event processing Priority.

Return value:

self

GROUP: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, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

GROUP:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

GROUP:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

GROUP:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

GROUP:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

GROUP:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

GROUP:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

GROUP:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

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

GROUP:UnHandleEvent(Event)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS Event

Return value:

GROUP:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

GROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

GROUP:onEvent(event)

TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class. @param #BASE self @param DCS#Event event

Defined in: