Module Wrapper.Client

self

CLIENT:AddPlayer(PlayerName)

Add player name.

Defined in:

CLIENT

Parameter:

#string PlayerName

Name of the player.

Return value:

self

CLIENT:Alive(CallBackFunction, ...)

Checks for a client alive event and calls a function on a continuous basis.

The CLIENT found in the _DATABASE.

CLIENT:FindByName(ClientName, ClientBriefing, Error)

Finds a CLIENT from the _DATABASE using the relevant Client Unit Name.

As an optional parameter, a briefing text can be given also.

Defined in:

CLIENT

Parameters:

#string ClientName

Name of the DCS Unit as defined within the Mission Editor.

#string ClientBriefing

Text that describes the briefing of the mission when a Player logs into the Client.

#boolean Error

A flag that indicates whether an error should be raised if the CLIENT cannot be found. By default an error will be raised.

Return value:

Usage:

-- Create new Clients.
 local Mission = MISSIONSCHEDULER.AddMission( 'Russia Transport Troops SA-6', 'Operational', 'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 'Russia' )
 Mission:AddGoal( DeploySA6TroopsGoal )

 Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*HOT-Deploy Troops 1' ):Transport() )
 Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 3' ):Transport() )
 Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*HOT-Deploy Troops 2' ):Transport() )
 Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 4' ):Transport() )

CLIENT:FindByPlayerName(Name)

Finds a CLIENT from the _DATABASE using the relevant player name.

Defined in:

CLIENT

Parameter:

#string Name

Name of the player

Return value:

or nil if not found

CLIENT:GetClientGroupDCSUnit()

Returns the DCSUnit of the CLIENT.

Defined in:

CLIENT

Return value:

DCS#Unit:

CLIENT:GetClientGroupID()

Get the group ID of the client.

Defined in:

CLIENT

Return value:

#number:

DCS#Group ID.

CLIENT:GetClientGroupName()

Get the name of the group of the client.

Defined in:

CLIENT

Return value:

#string:

CLIENT:GetClientGroupUnit()

Returns the UNIT of the CLIENT.

Defined in:

CLIENT

Return value:

Wrapper.Unit#UNIT:

The client UNIT or nil.

CLIENT:GetDCSGroup()

Return the DCSGroup of a Client.

This function is modified to deal with a couple of bugs in DCS 1.5.3

Defined in:

CLIENT

Return value:

DCS#Group:

The group of the Client.

CLIENT:GetPlayer()

Get name of player.

Defined in:

CLIENT

Return value:

#string:

Player name or nil.

CLIENT:GetPlayerInfo(Attribute)

[Multi-Player Server] Return a table of attributes from CLIENT.

If optional attribute is present, only that value is returned.

Defined in:

CLIENT

Parameter:

#string Attribute

(Optional) The attribute to obtain. List see below.

Return value:

#table:

PlayerInfo or nil if it cannot be found

Usage:

Returned table holds these attributes:

         'id'    : player ID
         'name'  : player name
         'side'  : 0 - spectators, 1 - red, 2 - blue
         'slot'  : slot ID of the player or 
         'ping'  : ping of the player in ms
         'ipaddr': IP address of the player, SERVER ONLY
         'ucid'  : Unique Client Identifier, SERVER ONLY

CLIENT:Message(Message, MessageDuration, MessageCategory, MessageInterval, MessageID)

The main message driver for the CLIENT.

This function displays various messages to the Player logged into the CLIENT through the DCS World Messaging system.

Defined in:

CLIENT

Parameters:

#string Message

is the text describing the message.

#number MessageDuration

is the duration in seconds that the Message should be displayed.

#string MessageCategory

is the category of the message (the title).

#number MessageInterval

is the interval in seconds between the display of the Core.Message#MESSAGE when the CLIENT is in the air.

#string MessageID

is the identifier of the message when displayed with intervals.

CLIENT:Register(ClientName)

Transport defines that the Client is a Transport.

Transports show cargo.

Defined in:

CLIENT

Parameter:

#string ClientName

Name of the client unit.

Return value:

self

CLIENT:RemovePlayer(PlayerName)

Remove player.

Defined in:

CLIENT

Parameter:

#string PlayerName

Name of the player.

Return value:

self

CLIENT:RemovePlayers()

Remove all players.

Defined in:

CLIENT

Return value:

self

CLIENT:Reset(ClientName)

Resets a CLIENT.

Defined in:

CLIENT

Parameter:

#string ClientName

Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.

CLIENT:ShowBriefing()

Show the briefing of a CLIENT.

Defined in:

CLIENT

Return value:

self

CLIENT:ShowCargo()

Shows the AI.AI_Cargo#CARGO contained within the CLIENT to the player as a message.

The AI.AI_Cargo#CARGO is shown using the Core.Message#MESSAGE distribution system.

Defined in:

CLIENT

CLIENT:ShowMissionBriefing(MissionBriefing)

Show the mission briefing of a MISSION to the CLIENT.

Defined in:

CLIENT

Parameter:

#string MissionBriefing

Return value:

self

CLIENT:Transport()

Transport defines that the Client is a Transport.

Transports show cargo.

Defined in:

CLIENT

Return value:

self

CLIENT:_AliveCheckScheduler(SchedulerName)

@param #CLIENT self

Defined in:

CLIENT

Parameter:

SchedulerName

Field(s)

CLIENT.AliveCheckScheduler

#string CLIENT.ClassName

Name of the class.

#boolean CLIENT.ClientAlive

Client alive.

#boolean CLIENT.ClientAlive2

Client alive 2.

#string CLIENT.ClientBriefing

Briefing.

#boolean CLIENT.ClientBriefingShown

#function CLIENT.ClientCallBack

Callback function.

#number CLIENT.ClientGroupID

Group ID of the client.

#string CLIENT.ClientGroupName

Group name.

#string CLIENT.ClientName

Name of the client.

#table CLIENT.ClientParameters

Parameters of the callback function.

#boolean CLIENT.ClientTransport

#boolean CLIENT.MessageSwitch

Message switch.

#table CLIENT.Players

Player table.

Core.Point#COORDINATE CLIENT.SpawnCoord

Spawn coordinate from the template.

#table CLIENT._Menus

Function(s)

CLIENT:EnableEmission(switch)

GROUND - Switch on/off radar emissions of a unit.

Defined in:

Parameter:

#boolean switch

If true, emission is enabled. If false, emission is disabled.

Return value:

self

CLIENT:Explode(power, delay)

Triggers an explosion at the coordinates of the unit.

Defined in:

Parameters:

#number power

Power of the explosion in kg TNT. Default 100 kg TNT.

#number delay

(Optional) Delay of explosion in seconds.

Return value:

self

CLIENT:Find(DCSUnit)

Finds a UNIT from the _DATABASE using a DCSUnit object.

Defined in:

Parameter:

DCS#Unit DCSUnit

An existing DCS Unit object reference.

Return value:

self

CLIENT:FindAllByMatching(Pattern)

Find all UNIT objects matching using patterns.

Note that this is a lot slower than :FindByName()!

Defined in:

Parameter:

#string Pattern

The pattern to look for. Refer to LUA patterns for regular expressions in LUA.

Return value:

#table:

Units Table of matching #UNIT objects found

Usage:

         -- Find all group with a partial group name
         local unittable = UNIT:FindAllByMatching( "Apple" )
         -- will return all units with "Apple" in the name
         
         -- using a pattern
         local unittable = UNIT:FindAllByMatching( ".%d.%d$" )
         -- will return the all units found ending in "-1-1" to "-9-9", but not e.g. "-10-1" or "-1-10"

CLIENT:FindByMatching(Pattern)

Find the first(!) UNIT matching using patterns.

Note that this is a lot slower than :FindByName()!

Defined in:

Parameter:

#string Pattern

The pattern to look for. Refer to LUA patterns for regular expressions in LUA.

Return value:

The UNIT.

Usage:

         -- Find a group with a partial group name
         local unit = UNIT:FindByMatching( "Apple" )
         -- will return e.g. a group named "Apple-1-1"
         
         -- using a pattern
         local unit = UNIT:FindByMatching( ".%d.%d$" )
         -- will return the first group found ending in "-1-1" to "-9-9", but not e.g. "-10-1"

CLIENT:FindByName(UnitName)

Find a UNIT in the _DATABASE using the name of an existing DCS Unit.

Defined in:

Parameter:

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

CLIENT:GetAmmo()

Returns the Unit's ammunition.

Defined in:

Return value:

DCS#Unit.Ammo:

Table with ammuntion of the unit (or nil). This can be a complex table!

CLIENT:GetAmmunition()

Get the number of ammunition and in particular the number of shells, rockets, bombs and missiles a unit currently has.

Defined in:

Return values:

#number:

Total amount of ammo the unit has left. This is the sum of shells, rockets, bombs and missiles.

#number:

Number of shells left. Shells include MG ammunition, AP and HE shells, and artillery shells where applicable.

#number:

Number of rockets left.

#number:

Number of bombs left.

#number:

Number of missiles left.

#number:

Number of artillery shells left (with explosive mass, included in shells; HE will also be reported as artillery shells for tanks)

Return value:

Wrapper.Client#CLIENT:

#number:

Value of the animation argument [-1, 1]. If draw argument value is invalid for the unit in question a value of 0 will be returned.

CLIENT:GetFuel()

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

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

Defined in:

Return value:

#number:

The relative amount of fuel (from 0.0 to 1.0) or nil if the DCS Unit is not existing or alive.

CLIENT:GetGroup()

Returns the unit's group if it exists and nil otherwise.

#number:

The Unit's initial health value or 0 if unit does not exist any more.

CLIENT:GetLifeRelative()

CLIENT:GetPlayerName()

Returns name of the player that control the unit or nil if the unit is controlled by A.I.

Defined in:

Return values:

#string:

Player Name

#nil:

The DCS Unit is not existing or alive.

CLIENT:GetPrefix()

Returns the prefix name of the DCS Unit.

A prefix name is a part of the name before a '#'-sign. DCS Units spawned with the Core.Spawn#SPAWN class contain a '#'-sign to indicate the end of the (base) DCS Unit name. The spawn sequence number and unit number are contained within the name after the '#' sign.

Defined in:

Return values:

#string:

The name of the DCS Unit.

#nil:

The DCS Unit is not existing or alive.

CLIENT:GetRadar()

Returns two values:

First value indicates if at least one of the unit's radar(s) is on.

Second value is the object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.

Defined in:

Return values:

#boolean:

Indicates if at least one of the unit's radar(s) is on.

DCS#Object:

The object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.

CLIENT:GetRange()

Returns the unit's max range in meters derived from the DCS descriptors.

For ground units it will return a range of 10,000 km as they have no real range.

Defined in:

Return value:

#number:

Range in meters.

CLIENT:GetSTN()

Get Link16 STN or SADL TN and other datalink info from Unit, if any.

Defined in:

Return values:

#string:

STN STN or TN Octal as string, or nil if not set/capable.

#string:

VCL Voice Callsign Label or nil if not set/capable.

Return value:

#number:

Fuel of unit in kg.

CLIENT:GetTemplatePayload()

Get the payload table from a unit's template.

The payload table has elements:

pylons
fuel
chaff
gun

Defined in:

Return value:

#table:

Payload table (deep copy) or #nil.

CLIENT:GetTemplatePylons()

Get the pylons table from a unit's template.

This can be a complex table depending on the weapons the unit is carrying.

Defined in:

Return value:

#table:

Table of pylons (deepcopy) or #nil.

CLIENT:GetThreatLevel()

Returns the Unit's A2G threat level on a scale from 1 to 10 ...

Depending on the era and the type of unit, the following threat levels are foreseen:

Modern:

Threat level 0: Unit is unarmed.
Threat level 1: Unit is infantry.
Threat level 2: Unit is an infantry vehicle.
Threat level 3: Unit is ground artillery.
Threat level 4: Unit is a tank.
Threat level 5: Unit is a modern tank or ifv with ATGM.
Threat level 6: Unit is a AAA.
Threat level 7: Unit is a SAM or manpad, IR guided.
Threat level 8: Unit is a Short Range SAM, radar guided.
Threat level 9: Unit is a Medium Range SAM, radar guided.
Threat level 10: Unit is a Long Range SAM, radar guided.

Cold:

Threat level 0: Unit is unarmed.
Threat level 1: Unit is infantry.
Threat level 2: Unit is an infantry vehicle.
Threat level 3: Unit is ground artillery.
Threat level 4: Unit is a tank.
Threat level 5: Unit is a modern tank or ifv with ATGM.
Threat level 6: Unit is a AAA.
Threat level 7: Unit is a SAM or manpad, IR guided.
Threat level 8: Unit is a Short Range SAM, radar guided.
Threat level 10: Unit is a Medium Range SAM, radar guided.

Korea:

Threat level 0: Unit is unarmed.
Threat level 1: Unit is infantry.
Threat level 2: Unit is an infantry vehicle.
Threat level 3: Unit is ground artillery.
Threat level 5: Unit is a tank.
Threat level 6: Unit is a AAA.
Threat level 7: Unit is a SAM or manpad, IR guided.
Threat level 10: Unit is a Short Range SAM, radar guided.

WWII:

Threat level 0: Unit is unarmed.
Threat level 1: Unit is infantry.
Threat level 2: Unit is an infantry vehicle.
Threat level 3: Unit is ground artillery.
Threat level 5: Unit is a tank.
Threat level 7: Unit is FLAK.
Threat level 10: Unit is AAA.

Defined in:

Return values:

#number:

Number between 0 (low threat level) and 10 (high threat level).

#string:

Some text.

CLIENT:GetUnitCategory()

Returns the category of the #UNIT from descriptor.

Returns one of

Unit.Category.AIRPLANE
Unit.Category.HELICOPTER
Unit.Category.GROUND_UNIT
Unit.Category.SHIP
Unit.Category.STRUCTURE

Returns if the unit has sensors of a certain type.

Defined in:

Parameter:

...

Return value:

#boolean:

returns true if the unit has specified types of sensors. This function is more preferable than Unit.getSensors() if you don't want to get information about all the unit's sensors, and just want to check if the unit has specified types of sensors.

CLIENT:InAir(NoHeloCheck)

Returns true if the UNIT is in the air.

Defined in:

Parameter:

#boolean NoHeloCheck

If true, no additonal checks for helos are performed.

Return value:

#boolean:

Return true if in the air or #nil if the UNIT is not existing or alive.

CLIENT:IsActive()

Returns if the unit is activated.

Defined in:

Return value:

#boolean:

true if Unit is activated. nil The DCS Unit is not existing or alive.

CLIENT:IsAlive()

Returns if the Unit is alive.

If the Unit is not alive/existent, nil is returned.
If the Unit is alive and active, true is returned.
If the Unit is alive but not active, false` is returned.

Defined in:

Return value:

#boolean:

Returns true if Unit is alive and active, false if it exists but is not active and nil if the object does not exist or DCS isExist function returns false.

CLIENT:IsAmmoSupply()

Check if the unit can supply ammo.

Currently, we have

M 818
Ural-375
ZIL-135

Returns if a unit is detecting the TargetUnit.

Defined in:

Parameter:

#UNIT TargetUnit

Return value:

#boolean:

true If the TargetUnit is detected by the unit, otherwise false.

CLIENT:IsExist()

Returns if the unit is exists in the mission.

If not even the DCS unit object does exist, nil is returned.
If the unit object exists, the value of the DCS API function isExist is returned.

Defined in:

Return value:

#boolean:

Returns true if unit exists in the mission.

CLIENT:IsFriendly(FriendlyCoalition)

Returns if the unit is a friendly unit.

Defined in:

Parameter:

FriendlyCoalition

Return value:

#boolean:

IsFriendly evaluation result.

CLIENT:IsFuelSupply()

Check if the unit can supply fuel.

Currently, we have

M978 HEMTT Tanker
ATMZ-5
ATMZ-10
ATZ-5

This list needs to be extended, if DCS adds other units capable of supplying fuel.

Defined in:

Return value:

#boolean:

If true, unit can supply fuel.

CLIENT:IsLOS(TargetUnit)

Returns if a unit has Line of Sight (LOS) with the TargetUnit.

Defined in:

CLIENT:IsShip()

Returns if the unit is of a ship category.

If the unit is a ship, this method will return true, otherwise false.

Defined in:

Return value:

#boolean:

Ship category evaluation result.

CLIENT:IsTanker()

Check if the unit is a tanker.

Also retrieves the refuelling system (boom or probe) if applicable.

Defined in:

Return values:

#boolean:

If true, unit is a tanker (checks for the attribute "Tankers").

#number:

Refueling system (if any): 0=boom, 1=probe.

CLIENT:KnowUnit(TargetUnit, TypeKnown, DistanceKnown)

Return values:

true If the other DCS Unit is within the radius of the 2D point of the DCS Unit.

#nil:

The DCS Unit is not existing or alive.

CLIENT:ReSpawnAt(Coordinate, Heading)

Respawn the Wrapper.Unit using a (tweaked) template of the parent Group.

This function will:

Get the current position and heading of the group.
When the unit is alive, it will tweak the template x, y and heading coordinates of the group and the embedded units to the current units positions.
Then it will respawn the re-modelled group.

Defined in:

Parameters:

Core.Point#COORDINATE Coordinate

The position where to Spawn the new Unit at.

#number Heading

The heading of the unit respawn.

CLIENT:Register(UnitName)

Create a new UNIT from DCSUnit.

Defined in:

Parameter:

#string UnitName

The name of the DCS unit.

Return value:

self

CLIENT:ResetEvents()

Reset the subscriptions.

Defined in:

Return value:

CLIENT:SetUnitInternalCargo(mass)

Sets the Unit's Internal Cargo Mass, in kg

Defined in:

Parameter:

#number mass

to set cargo to

Return value:

self

CLIENT:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

self

Field(s)

CLIENT.AliveCheckScheduler

#string CLIENT.ClassName

Name of the class.

#boolean CLIENT.ClientAlive

Client alive.

#boolean CLIENT.ClientAlive2

Client alive 2.

#string CLIENT.ClientBriefing

Briefing.

#boolean CLIENT.ClientBriefingShown

#function CLIENT.ClientCallBack

Callback function.

#number CLIENT.ClientGroupID

Group ID of the client.

#string CLIENT.ClientGroupName

Group name.

#string CLIENT.ClientName

Name of the client.

#table CLIENT.ClientParameters

Parameters of the callback function.

#boolean CLIENT.ClientTransport

#boolean CLIENT.MessageSwitch

Message switch.

#table CLIENT.Players

Player table.

Core.Point#COORDINATE CLIENT.SpawnCoord

Spawn coordinate from the template.

#table CLIENT._Menus

Function(s)

CLIENT:ClearTasks()

Clear all tasks from the controllable.

Defined in:

Return value:

CLIENT:CommandActivateACLS(UnitID, Name, Delay)

Activate ACLS system of the CONTROLLABLE.

The controllable should be an aircraft carrier! Also needs Link4 to work.

Defined in:

Parameters:

#number UnitID

(Optional) The DCS UNIT ID of the unit the ACLS system is attached to. Defaults to the UNIT itself.

#string Name

(Optional) Name of the ACLS Beacon

#number Delay

(Optional) Delay in seconds before the ICLS is activated.

Return value:

self

CLIENT:CommandActivateBeacon(Type, System, Frequency, UnitID, Channel, ModeChannel, AA, Callsign, Bearing, Delay)

Give the CONTROLLABLE the command to activate a beacon.

See DCS_command_activateBeacon on Hoggit. For specific beacons like TACAN use the more convenient #BEACON class. Note that a controllable can only have one beacon activated at a time with the execption of ICLS.

Defined in:

Parameters:

Core.Beacon#BEACON.Type Type

Beacon type (VOR, DME, TACAN, RSBN, ILS etc).

Core.Beacon#BEACON.System System

Beacon system (VOR, DME, TACAN, RSBN, ILS etc).

#number Frequency

Frequency in Hz the beacon is running on. Use UTILS.TACANToFrequency to generate a frequency for TACAN beacons.

#number UnitID

The ID of the unit the beacon is attached to. Useful if more units are in one group.

#number Channel

Channel the beacon is using. For, e.g. TACAN beacons.

#string ModeChannel

The TACAN mode of the beacon, i.e. "X" or "Y".

#boolean AA

If true, create and Air-Air beacon. IF nil, automatically set if CONTROLLABLE depending on whether unit is and aircraft or not.

#string Callsign

Morse code identification callsign.

#boolean Bearing

If true, beacon provides bearing information - if supported by the unit the beacon is attached to.

#number Delay

(Optional) Delay in seconds before the beacon is activated.

Return value:

self

CLIENT:CommandActivateICLS(Channel, UnitID, Callsign, Delay)

Activate ICLS system of the CONTROLLABLE.

The controllable should be an aircraft carrier!

Defined in:

Parameters:

#number Channel

ICLS channel.

#number UnitID

The DCS UNIT ID of the unit the ICLS system is attached to. Useful if more units are in one group.

#string Callsign

Morse code identification callsign.

#number Delay

(Optional) Delay in seconds before the ICLS is activated.

Return value:

self

CLIENT:CommandActivateLink4(Frequency, UnitID, Callsign, Delay)

Activate LINK4 system of the CONTROLLABLE.

The controllable should be an aircraft carrier!

Defined in:

Parameters:

#number Frequency

Link4 Frequency in MHz, e.g. 336 (defaults to 336 MHz)

#number UnitID

(Optional) The DCS UNIT ID of the unit the LINK4 system is attached to. Defaults to the UNIT itself.

#string Callsign

(Optional) Morse code identification callsign.

#number Delay

(Optional) Delay in seconds before the LINK4 is activated.

Return value:

self

CLIENT:CommandDeactivateACLS(Delay)

CLIENT:CommandDoScript(DoScript)

Do Script command

Defined in:

Parameter:

#string DoScript

Return value:

DCS#DCSCommand:

CLIENT:CommandEPLRS(SwitchOnOff, Delay)

Set EPLRS of the CONTROLLABLE on/off.

See DCS command EPLRS

Defined in:

Parameters:

#boolean SwitchOnOff

If true (or nil) switch EPLRS on. If false switch off.

#number Delay

(Optional) Delay in seconds before the callsign is set. Default is immediately.

Return value:

self

CLIENT:CommandSetCallsign(CallName, CallNumber, Delay)

Set callsign of the CONTROLLABLE.

See DCS command setCallsign

Defined in:

Parameters:

DCS#CALLSIGN CallName

Number corresponding the the callsign identifier you wish this group to be called.

#number CallNumber

The number value the group will be referred to as. Only valid numbers are 1-9. For example Uzi 5-1. Default 1.

#number Delay

(Optional) Delay in seconds before the callsign is set. Default is immediately.

Return value:

self

CLIENT:CommandSetFrequency(Frequency, Modulation, Power, Delay)

Set radio frequency.

See DCS command SetFrequency

Defined in:

Parameters:

#number Frequency

Radio frequency in MHz.

#number Modulation

Radio modulation. Default radio.modulation.AM.

#number Power

(Optional) Power of the Radio in Watts. Defaults to 10.

#number Delay

(Optional) Delay in seconds before the frequency is set. Default is immediately.

Return value:

self

CLIENT:CommandSetFrequencyForUnit(Frequency, Modulation, Power, UnitID, Delay)

[AIR] Set radio frequency.

See DCS command SetFrequencyForUnit

Defined in:

Parameters:

#number Frequency

Radio frequency in MHz.

#number Modulation

Radio modulation. Default radio.modulation.AM.

#number Power

(Optional) Power of the Radio in Watts. Defaults to 10.

#UnitID UnitID

(Optional, if your object is a UNIT) The UNIT ID this is for.

#number Delay

(Optional) Delay in seconds before the frequency is set. Default is immediately.

Return value:

self

CLIENT:CommandSetUnlimitedFuel(OnOff, Delay)

Set unlimited fuel.

See DCS command Unlimited Fuel.

Defined in:

Parameters:

#boolean OnOff

Set unlimited fuel on = true or off = false.

#number Delay

(Optional) Set the option only after x seconds.

Return value:

self

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

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

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

CLIENT:DisableIRMarker()

[GROUND] Disable the IR marker.

Defined in:

Return value:

self

CLIENT:DisableIRMarkerForGroup()

[GROUND] Disable the IR markers for a whole group.

Defined in:

Return value:

self

CLIENT:EnRouteTaskAWACS()

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

No parameters. hoggit.

Defined in:

Return value:

The DCS task structure.

CLIENT:EnRouteTaskAntiShip(TargetTypes, Priority)

(AIR) Enroute anti-ship task.

Defined in:

Parameters:

DCS#AttributeNameArray TargetTypes

Array of target categories allowed to engage. Default {"Ships"}.

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

Return value:

The DCS task structure.

CLIENT:EnRouteTaskCAP(TargetTypes, Priority)

(AIR) Enroute CAP task.

Defined in:

Parameters:

DCS#AttributeNameArray TargetTypes

Array of target categories allowed to engage. Default {"Air"}.

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

Return value:

The DCS task structure.

CLIENT:EnRouteTaskEWR()

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

No parameters. See hoggit.

Defined in:

Return value:

The DCS task structure.

CLIENT: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. See hoggit.

Defined in:

Parameters:

#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 aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/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.

CLIENT: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. Default 0.

Return value:

The DCS task structure.

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

(Optional) Array of target categories allowed to engage. Default {"Air"}.

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

Return value:

The DCS task structure.

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

(AIR) Search and attack the Unit.

See hoggit.

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.

CLIENT:EnRouteTaskFAC(Frequency, Modulation, CallsignID, CallsignNumber, 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.

Assigns the controlled group to act as a Forward Air Controller or JTAC. Any detected targets will be assigned as targets to the player via the JTAC radio menu. Target designation is set to auto and is dependent on the circumstances. See hoggit.

Defined in:

Parameters:

#number Frequency

Frequency in MHz. Default 133 MHz.

#number Modulation

Radio modulation. Default radio.modulation.AM.

#number CallsignID

CallsignID, e.g. CALLSIGN.JTAC.Anvil for ground or CALLSIGN.Aircraft.Ford for air.

#number CallsignNumber

Callsign first number, e.g. 2 for Ford-2.

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

CLIENT:EnRouteTaskFAC_EngageGroup(AttackGroup, Priority, WeaponType, Designation, Datalink, CallsignID, CallsignNumber, Frequency, Modulation)

(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. See hoggit.

Defined in:

Parameters:

#CONTROLLABLE AttackGroup

Target CONTROLLABLE.

#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. Default is 0.

#number WeaponType

(Optional) Bitmask of weapon types those allowed to use. Default is "Auto".

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.

#number CallsignID

CallsignID, e.g. CALLSIGN.JTAC.Anvil for ground or CALLSIGN.Aircraft.Ford for air.

#number CallsignNumber

Callsign first number, e.g. 2 for Ford-2.

Frequency

Modulation

Return value:

The DCS task structure.

CLIENT:EnRouteTaskSEAD(TargetTypes, Priority)

(AIR) Enroute SEAD task.

Defined in:

Parameters:

DCS#AttributeNameArray TargetTypes

Array of target categories allowed to engage. Default {"Air Defence"}.

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

Return value:

The DCS task structure.

CLIENT:EnRouteTaskTanker()

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

No parameters. See hoggit.

Defined in:

(Optional) If false, do not include optically detected targets.

#boolean DetectRadar

(Optional) If false, do not include targets detected by radar.

#boolean DetectIRST

(Optional) If false, do not include targets detected by IRST.

#boolean DetectRWR

(Optional) If false, do not include targets detected by RWR.

#boolean DetectDLINK

(Optional) If false, do not include targets detected by data link.

Return value:

Core.Set#SET_GROUP:

Set of detected groups.

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

Return the detected targets of the controllable.

The optional parameters 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

CLIENT:GetDetectedUnitSet(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. If at least one detection method is specified, only the methods set to true will be used.

Defined in:

Parameters:

#boolean DetectVisual

(Optional) If false, do not include visually detected targets.

#boolean DetectOptical

(Optional) If false, do not include optically detected targets.

#boolean DetectRadar

(Optional) If false, do not include targets detected by radar.

#boolean DetectIRST

(Optional) If false, do not include targets detected by IRST.

#boolean:

true if Controllable contains AirPlanes.

CLIENT:IsGroupDetected(Group, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)

Check if a certain GROUP is detected by the controllable.

Defined in:

Parameters:

Wrapper.Group#GROUP Group

The group that is supposed to be detected.

#boolean DetectVisual

(Optional) If false, do not include visually detected targets.

#boolean DetectOptical

(Optional) If false, do not include optically detected targets.

#boolean DetectRadar

(Optional) If false, do not include targets detected by radar.

#boolean DetectIRST

(Optional) If false, do not include targets detected by IRST.

#boolean DetectRWR

Check if a DCS object (unit or static) is detected by the controllable.

Note that after a target is detected it remains "detected" for a certain amount of time, even if the controllable cannot "see" the target any more with it's sensors. 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. If at least one detection method is specified, only the methods set to true will be used.

Defined in:

Parameters:

DCS#Object DCSObject

The DCS object that is checked.

#boolean DetectVisual

(Optional) If false, do not include visually detected targets.

#boolean DetectOptical

(Optional) If false, do not include optically detected targets.

#boolean DetectRadar

(Optional) If false, do not include targets detected by radar.

#boolean DetectIRST

(Optional) If false, do not include targets detected by IRST.

#boolean DetectRWR

(Optional) If false, do not include targets detected by RWR.

#boolean DetectDLINK

(Optional) If false, do not include targets detected by data link.

Return values:

#boolean:

true if target is detected.

#boolean:

true if target is currently visible by line of sight. Target must be detected (first parameter returns true).

#boolean:

true if target type is known. Target must be detected (first parameter returns true).

#boolean:

true if distance to target is known. Target must be detected (first parameter returns true).

#number:

Mission time in seconds when target was last detected. Only present if the target is currently not visible (second parameter returns false) otherwise nil is returned.

Last known position vector of the target. Only present if the target is currently not visible (second parameter returns false) otherwise nil is returned.

Last known velocity vector of the target. Only present if the target is currently not visible (second parameter returns false) otherwise nil is returned.

CLIENT:IsUnitDetected(Unit, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)

Check if a certain UNIT is detected by 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. If at least one detection method is specified, only the methods set to true will be used.

Defined in:

Parameters:

Wrapper.Unit#UNIT Unit

The unit that is supposed to be detected.

#boolean DetectVisual

(Optional) If false, do not include visually detected targets.

#boolean DetectOptical

(Optional) If false, do not include optically detected targets.

#boolean DetectRadar

(Optional) If false, do not include targets detected by radar.

#boolean DetectIRST

(Optional) If false, do not include targets detected by IRST.

#boolean DetectRWR

(Optional) If false, do not include targets detected by RWR.

#boolean DetectDLINK

(Optional) If false, do not include targets detected by data link.

Return values:

#boolean:

true if target is detected.

#boolean:

true if target is currently visible by line of sight. Target must be detected (first parameter returns true).

#boolean:

true if target type is known. Target must be detected (first parameter returns true).

#boolean:

true if distance to target is known. Target must be detected (first parameter returns true).

#number:

Mission time in seconds when target was last detected. Only present if the target is currently not visible (second parameter returns false) otherwise nil is returned.

Last known position vector of the target. Only present if the target is currently not visible (second parameter returns false) otherwise nil is returned.

Last known velocity vector of the target. Only present if the target is currently not visible (second parameter returns false) otherwise nil is returned.

CLIENT:New(ControllableName)

Create a new CONTROLLABLE from a DCSControllable

Defined in:

Parameter:

#string ControllableName

The DCS Controllable name

Return value:

self

CLIENT:NewIRMarker(EnableImmediately, Runtime)

[GROUND] Create and enable a new IR Marker for the given controllable UNIT or GROUP.

Defined in:

Parameters:

#boolean EnableImmediately

(Optionally) If true start up the IR Marker immediately. Else you need to call myobject:EnableIRMarker() later on.

#number Runtime

(Optionally) Run this IR Marker for the given number of seconds, then stop. Use in conjunction with EnableImmediately.

Return value:

self

CLIENT:OptionAAAttackRange(range)

Sets Controllable Option for A2A attack range for AIR FIGHTER units.

Defined in:

Parameter:

#number range

Defines the range

Return value:

self

Usage:

Range can be one of MAX_RANGE = 0, NEZ_RANGE = 1, HALF_WAY_RMAX_NEZ = 2, TARGET_THREAT_EST = 3, RANDOM_RANGE = 4. Defaults to 3. See: https://wiki.hoggitworld.com/view/DCS_option_missileAttack

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

CLIENT:OptionAlarmStateGreen()

Return value:

self

CLIENT:OptionECM(ECMvalue)

[Air] Defines the usage of Electronic Counter Measures by airborne forces.

Defined in:

Parameter:

Defined in:

Return value:

self

CLIENT:OptionEngageRange(EngageRange)

Defines the range at which a GROUND unit/group is allowed to use its weapons automatically.

Defined in:

Parameter:

#number EngageRange

Engage range limit in percent (a number between 0 and 100). Default 100.

Return value:

self

CLIENT:OptionEvasionOfARM(Seconds)

[Ground] Allows AI radar units to take defensive actions to avoid anti radiation missiles.

Units are allowed to shut radar off and displace.

Defined in:

Parameter:

#number Seconds

Can be - nil, 0 or false = switch off this option, any positive number = number of seconds the escape sequency runs.

Return value:

self

CLIENT:OptionFormationInterval(meters)

[Ground] Option that defines the vehicle spacing when in an on road and off road formation.

Defined in:

Parameter:

self

CLIENT:OptionROE(ROEvalue)

Set option for Rules of Engagement (ROE).

Defined in:

Parameter:

#number ROEvalue

ROE value. See ENUMS.ROE.

Return value:

self

CLIENT:OptionROEHoldFire()

Weapons Hold: AI will hold fire under all circumstances.

Defined in:

Return value:

self

CLIENT:OptionROEHoldFirePossible()

Can the CONTROLLABLE hold their weapons?

Defined in:

Return value:

#boolean:

CLIENT:OptionROEOpenFireWeaponFreePossible()

Return value:

[Air] Make an airplane or helicopter patrol between two points in a racetrack - resulting in a much tighter track around the start and end points.

Defined in:

Parameters:

Core.Point#COORDINATE Point1

Start point.

Core.Point#COORDINATE Point2

End point.

#number Altitude

(Optional) Altitude in meters. Defaults to the altitude of the coordinate.

#number Speed

(Optional) Speed in kph. Defaults to 500 kph.

#number Formation

(Optional) Formation to take, e.g. ENUMS.Formation.FixedWing.Trail.Close, also see Hoggit Wiki.

#boolean AGL

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

#number DelayMin

Delay in seconds before the group progresses to the next route point. Default 1 sec.

#number DelayMax

Max. delay in seconds. Actual delay is randomly chosen between DelayMin and DelayMax. Default equal to DelayMin.

Return value:

CLIENT:PopCurrentTask()

Popping current Task from the controllable.

Defined in:

Return value:

self

CLIENT:PushTask(DCSTask, WaitTime)

Pushing Task on the queue from the controllable.

Defined in:

Parameters:

DCSTask

WaitTime

Return value:

self

CLIENT:RelocateGroundRandomInRadius(speed, radius, onroad, shortcut, formation, onland)

(GROUND) Relocate controllable to a random point within a given radius; use e.g.for evasive actions; Note that not all ground controllables can actually drive, also the alarm state of the controllable might stop it from moving.

Defined in:

Parameters:

#number speed

Speed of the controllable, default 20

#number radius

Radius of the relocation zone, default 500

#boolean onroad

If true, route on road (less problems with AI way finding), default true

#boolean shortcut

If true and onroad is set, take a shorter route - if available - off road, default false

#string formation

Formation string as in the mission editor, e.g. "Vee", "Diamond", "Line abreast", etc. Defaults to "Off Road"

#boolean onland

(optional) If true, try up to 50 times to get a coordinate on land.SurfaceType.LAND. Note - this descriptor value is not reliably implemented on all maps.

Return value:

self

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

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

CLIENT:RouteGroundOnRailRoads(ToCoordinate, Speed, DelaySeconds, WaypointFunction, WaypointFunctionArguments)

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.

#function WaypointFunction

(Optional) Function called when passing a waypoint. First parameters of the function are the #CONTROLLABLE object, the number of the waypoint and the total number of waypoints.

#table WaypointFunctionArguments

(Optional) List of parameters passed to the WaypointFunction.

Return value:

The CONTROLLABLE.

CLIENT:RouteGroundOnRoad(ToCoordinate, Speed, DelaySeconds, OffRoadFormation, WaypointFunction, WaypointFunctionArguments)

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

#function WaypointFunction

(Optional) Function called when passing a waypoint. First parameters of the function are the #CONTROLLABLE object, the number of the waypoint and the total number of waypoints.

#table WaypointFunctionArguments

(Optional) List of parameters passed to the WaypointFunction.

Return value:

The CONTROLLABLE.

CLIENT:RouteGroundTo(ToCoordinate, Speed, Formation, DelaySeconds, WaypointFunction, WaypointFunctionArguments)

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.

#function WaypointFunction

(Optional) Function called when passing a waypoint. First parameters of the function are the #CONTROLLABLE object, the number of the waypoint and the total number of waypoints.

#table WaypointFunctionArguments

(Optional) List of parameters passed to the WaypointFunction.

Return value:

The CONTROLLABLE.

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

Parameters:

DCS#Vec3 Point

The destination point in Vec3 format.

#number Speed

The speed [m/s] to travel.

Return value:

self

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

CLIENT:SetAltitude(Altitude, Keep, AltType)

[AIR] Sets the controlled aircraft group to fly at the specified altitude in meters.

Defined in:

Parameters:

#number Altitude

Altitude in meters.

#boolean Keep

(Optional) When set to true, will maintain the altitude on passing waypoints. If not present or false, the controlled group will return to the altitude as defined by their route.

#string AltType

(Optional) Specifies the altitude type used. If nil, the altitude type of the current waypoint will be used. Accepted values are "BARO" and "RADIO".

Return value:

self

CLIENT:SetCommand(DCSCommand)

Executes a command action for the CONTROLLABLE.

Defined in:

Parameter:

DCS#Command DCSCommand

The command to be executed.

Return value:

self

CLIENT:SetOption(OptionID, OptionValue)

Set option.

Defined in:

Parameters:

#number OptionID

ID/Type of the option.

#number OptionValue

Value of the option

Return value:

self

CLIENT:SetOptionRadarUsing(Option)

[AIR] Set how the AI uses the onboard radar.

Defined in:

Parameter:

Here: never.

#number Speed

Speed in meters per second

#boolean Keep

(Optional) When set to true, will maintain the speed on passing waypoints. If not present or false, the controlled group will return to the speed as defined by their route.

Return value:

self

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

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

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

CLIENT:TaskAerobatics()

Return an empty task shell for Aerobatics.

Defined in:

Return value:

Usage:

       local plane = GROUP:FindByName("Aerial-1")
       -- get a task shell
       local aerotask = plane:TaskAerobatics()
       -- add a series of maneuvers
       aerotask = plane:TaskAerobaticsHorizontalEight(aerotask,1,5000,850,true,false,1,70)
       aerotask = plane:TaskAerobaticsWingoverFlight(aerotask,1,0,0,true,true,20)
       aerotask = plane:TaskAerobaticsLoop(aerotask,1,0,0,false,true)
       -- set the task
       plane:SetTask(aerotask)

CLIENT:TaskAerobaticsAileronRoll(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, Side, RollRate, TurnAngle, FixAngle)

Add an aerobatics entry of type "AILERON_ROLL" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number Side

(Optional) On which side to fly, 0 == left, 1 == right side, defaults to 0.

#number RollRate

(Optional) How many degrees to roll per sec(?), can be between 15 and 450, defaults to 90.

#number TurnAngle

(Optional) Angles to turn overall, defaults to 360.

#number FixAngle

(Optional) No idea what this does, can be between 0 and 180 degrees, defaults to 180.

Return value:

CLIENT:TaskAerobaticsBarrelRoll(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, Side, RollRate, TurnAngle)

Add an aerobatics entry of type "BARREL_ROLL" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number Side

(Optional) On which side to fly, 0 == left, 1 == right side, defaults to 0.

#number RollRate

(Optional) How many degrees to roll per sec(?), can be between 15 and 450, defaults to 90.

#number TurnAngle

(Optional) Turn angle, defaults to 360 degrees.

Return value:

CLIENT:TaskAerobaticsCandle(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately)

Add an aerobatics entry of type "CANDLE" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

Return value:

CLIENT:TaskAerobaticsClimb(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, Angle, FinalAltitude)

Add an aerobatics entry of type "CLIMB" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number Angle

(Optional) Angle to climb. Can be between 15 and 90 degrees. Defaults to 45 degrees.

#number FinalAltitude

(Optional) Altitude to climb to in meters. Defaults to 5000m.

Return value:

CLIENT:TaskAerobaticsDive(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, Angle, FinalAltitude)

Add an aerobatics entry of type "DIVE" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 5000.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number Angle

(Optional) With how many degrees to dive, defaults to 45. Can be 15 to 90 degrees.

#number FinalAltitude

(Optional) Final altitude in meters, defaults to 1000.

Return value:

CLIENT:TaskAerobaticsEdgeFlight(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, FlightTime, Side)

Add an aerobatics entry of type "EDGE_FLIGHT" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number FlightTime

(Optional) Time to fly this manoever in seconds, defaults to 10.

#number Side

(Optional) On which side to fly, 0 == left, 1 == right side, defaults to 0.

Return value:

CLIENT:TaskAerobaticsForcedTurn(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, TurnAngle, Side, FlightTime, MinSpeed)

Add an aerobatics entry of type "FORCED_TURN" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number TurnAngle

(Optional) Angles to turn, defaults to 360.

#number Side

(Optional) On which side to fly, 0 == left, 1 == right side, defaults to 0.

#number FlightTime

(Optional) Flight time in seconds for thos maneuver. Defaults to 30.

#number MinSpeed

(Optional) Minimum speed to keep in kph, defaults to 250 kph.

Return value:

CLIENT:TaskAerobaticsHammerhead(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, Side)

Add an aerobatics entry of type "HAMMERHEAD" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number Side

(Optional) On which side to fly, 0 == left, 1 == right side, defaults to 0.

Return value:

CLIENT:TaskAerobaticsHorizontalEight(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, Side, RollDeg)

Add an aerobatics entry of type "HORIZONTAL_EIGHT" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number Side

(Optional) On which side to fly, 0 == left, 1 == right side, defaults to 0.

#number RollDeg

(Optional) Roll degrees for Roll 1 and 2, defaults to 60.

Return value:

CLIENT:TaskAerobaticsImmelmann(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately)

Add an aerobatics entry of type "IMMELMAN" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

Return value:

CLIENT:TaskAerobaticsLoop(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately)

Add an aerobatics entry of type "LOOP" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

Return value:

CLIENT:TaskAerobaticsMilitaryTurn(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately)

Add an aerobatics entry of type "MILITARY_TURN" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

Return value:

CLIENT:TaskAerobaticsSkewedLoop(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, Side, RollDeg)

Add an aerobatics entry of type "SKEWED_LOOP" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number Side

(Optional) On which side to fly, 0 == left, 1 == right side, defaults to 0.

#number RollDeg

(Optional) Roll degrees for Roll 1 and 2, defaults to 60.

Return value:

CLIENT:TaskAerobaticsSpiral(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, TurnAngle, Roll, Side, UpDown, Angle)

Add an aerobatics entry of type "SPIRAL" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number TurnAngle

(Optional) Turn angle, defaults to 360 degrees.

#number Roll

(Optional) Roll to take, defaults to 60 degrees.

#number Side

(Optional) On which side to fly, 0 == left, 1 == right side, defaults to 0.

#number UpDown

(Optional) Spiral upwards (1) or downwards (0). Defaults to 0 - downwards.

#number Angle

(Optional) Angle to spiral. Can be between 15 and 90 degrees. Defaults to 45 degrees.

Return value:

CLIENT:TaskAerobaticsSplitS(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, FinalSpeed)

Add an aerobatics entry of type "SPLIT_S" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number FinalSpeed

(Optional) Final speed to reach in KPH. Defaults to 500 kph.

Return value:

CLIENT:TaskAerobaticsStraightFlight(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, FlightTime)

Add an aerobatics entry of type "STRAIGHT_FLIGHT" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number FlightTime

(Optional) Time to fly this manoever in seconds, defaults to 10.

Return value:

CLIENT:TaskAerobaticsTurn(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, Side, RollDeg, Pull, Angle)

Add an aerobatics entry of type "TURN" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number Side

(Optional) On which side to fly, 0 == left, 1 == right side, defaults to 0.

#number RollDeg

(Optional) Roll degrees for Roll 1 and 2, defaults to 60.

#number Pull

(Optional) How many Gs to pull in this, defaults to 2.

#number Angle

(Optional) How many degrees to turn, defaults to 180.

Return value:

CLIENT:TaskAerobaticsWingoverFlight(TaskAerobatics, Repeats, InitAltitude, InitSpeed, UseSmoke, StartImmediately, FlightTime)

Add an aerobatics entry of type "WINGOVER_FLIGHT" to the Aerobatics Task.

Defined in:

Parameters:

DCS#Task TaskAerobatics

The Aerobatics Task

#number Repeats

(Optional) The number of repeats, defaults to 1.

#number InitAltitude

(Optional) Starting altitude in meters, defaults to 0.

#number InitSpeed

(Optional) Starting speed in KPH, defaults to 0.

#boolean UseSmoke

(Optional) Using smoke, defaults to false.

#boolean StartImmediately

(Optional) If true, start immediately and ignore InitAltitude and InitSpeed.

#number FlightTime

(Optional) Time to fly this manoever in seconds, defaults to 10.

Return value:

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

(AIR + GROUND) Attack a Controllable.

Defined in:

Parameters:

Wrapper.Group#GROUP AttackGroup

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

#boolean GroupAttack

(Optional) If true, attack as group.

Return value:

The DCS task structure.

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

(AIR) Attacking the map object (building, structure, etc).

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 will choose expend on its own discretion.

#number AttackQty

(Optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/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.

#number Altitude

(Optional) The altitude [meters] from where to attack. Default 30 m.

#number WeaponType

(Optional) The WeaponType. Default Auto=1073741822.

Return value:

The DCS task structure.

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

(AIR + GROUND) Attack the Unit.

Defined in:

Parameters:

Wrapper.Unit#UNIT AttackUnit

The UNIT to be attacked

#boolean GroupAttack

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

DCS#AI.Task.WeaponExpend WeaponExpend

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

#number AttackQty

(Optional) Limits maximal quantity of attack. The aircraft/controllable will not make more attacks than allowed even if the target controllable not destroyed and the aircraft/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.

#number Altitude

(Optional) The (minimum) altitude in meters from where to attack. Default is altitude of unit to attack but at least 1000 m.

#number WeaponType

(optional) The WeaponType. See DCS Enumerator Weapon Type on Hoggit.

Return value:

The DCS task structure.

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

CLIENT:TaskBombingRunway(Airbase, WeaponType, WeaponExpend, AttackQty, Direction, GroupAttack)

(AIR) Delivering weapon on the runway.

See hoggit

Make sure the aircraft has the following role:

CAS
Ground Attack
Runway Attack
Anti-Ship Strike
AFAC
Pinpoint Strike

Defined in:

Parameters:

Wrapper.Airbase#AIRBASE Airbase

Airbase to attack.

#number WeaponType

(optional) Bitmask of weapon types those allowed to use. See DCS enum weapon flag. Default 2147485694 = AnyBomb (GuidedBomb + AnyUnguidedBomb).

DCS#AI.Task.WeaponExpend WeaponExpend

Enum AI.Task.WeaponExpend that defines how much munitions the AI will expend per attack run. Default "ALL".

#number AttackQty

Number of times the group will attack if the target. Default 1.

DCS#Azimuth Direction

#boolean GroupAttack

(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 group and not to a single aircraft.

Return value:

The DCS task structure.

CLIENT:TaskCarpetBombing(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType, CarpetLength)

(AIR) Delivering weapon via CarpetBombing (all bombers in formation release at same time) 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 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.

#number CarpetLength

(optional) default to 500 m.

Return value:

The DCS task structure.

CLIENT:TaskCombo(DCSTasks)

Return a Combo Task taking an array of Tasks.

Defined in:

Parameter:

DCS#TaskArray DCSTasks

Array of DCSTasking.Task#Task

Return value:

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

Return a condition section for a controlled task.

Defined in:

Parameters:

DCS#Time time

DCS mission time.

#string userFlag

Name of the user flag.

#boolean userFlagValue

User flag value true or false. Could also be numeric, i.e. either 0=false or 1=true. Other numeric values don't work!

#string condition

Lua string.

DCS#Time duration

Duration in seconds.

#number lastWayPoint

Last waypoint. return DCS#Task

CLIENT:TaskControlled(DCSTask, DCSStopCondition)

Return a Controlled Task taking a Task and a TaskCondition.

Defined in:

Parameters:

DCS#Task DCSTask

DCS#DCSStopCondition DCSStopCondition

Return value:

CLIENT:TaskDisembarking(Coordinate, GroupSetToDisembark)

Specifies the location infantry groups that is being transported by helicopters will be unloaded at.

Used in conjunction with the EmbarkToTransport task.

Defined in:

Parameters:

Core.Point#COORDINATE Coordinate

Coordinates where AI is expecting to be picked up.

GroupSetToDisembark

Return value:

Embark to transport task.

CLIENT:TaskEPLRS(SwitchOnOff, idx)

Set EPLRS data link on/off.

Defined in:

Parameters:

#boolean SwitchOnOff

If true (or nil) switch EPLRS on. If false switch off.

#number idx

Task index. Default 1.

Return value:

#table:

Task wrapped action.

CLIENT:TaskEmbarkToTransport(Coordinate, Radius, UnitType)

Used in conjunction with the embarking task for a transport helicopter group.

The Ground units will move to the specified location and wait to be picked up by a helicopter. The helicopter will then fly them to their dropoff point defined by another task for the ground forces; DisembarkFromTransport task. The controllable has to be an infantry group!

Defined in:

Parameters:

Core.Point#COORDINATE Coordinate

Coordinates where AI is expecting to be picked up.

#number Radius

Radius in meters. Default 200 m.

#string UnitType

The unit type name of the carrier, e.g. "UH-1H". Must not be specified.

Return value:

Embark to transport task.

CLIENT:TaskEmbarking(Coordinate, GroupSetForEmbarking, Duration, Distribution)

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

Defined in:

Parameters:

Core.Point#COORDINATE Coordinate

The point where to pickup the troops.

Core.Set#SET_GROUP GroupSetForEmbarking

Set of groups to embark.

#number Duration

(Optional) The maximum duration in seconds to wait until all groups have embarked.

#table Distribution

(Optional) Distribution used to put the infantry groups into specific carrier units.

Return value:

The DCS task structure.

CLIENT:TaskEmptyTask()

Return an Empty Task.

Defined in:

Return value:

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

#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 Escort task is finished.

#number EngagementDistance

Maximal distance from escorted controllable to threat in meters. 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. Default {"Air"}. See https://wiki.hoggit.us/view/DCS_enum_attributes

Return value:

The DCS task structure.

CLIENT:TaskFAC_AttackGroup(AttackGroup, WeaponType, Designation, Datalink, Frequency, Modulation, CallsignName, CallsignNumber)

(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. It's important to note that depending on the type of unit that is being assigned the task (AIR or GROUND), you must choose the correct type of callsign enumerator. For airborne controllables use CALLSIGN.Aircraft and for ground based use CALLSIGN.JTAC enumerators.

Defined in:

Parameters:

Wrapper.Group#GROUP AttackGroup

Target GROUP object.

#number WeaponType

Bitmask of weapon types, which are allowed to use.

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.

#number Frequency

Frequency in MHz used to communicate with the FAC. Default 133 MHz.

#number Modulation

Modulation of radio for communication. Default 0=AM.

#number CallsignName

Callsign enumerator name of the FAC. (CALLSIGN.Aircraft.{name} for airborne controllables, CALLSIGN.JTACS.{name} for ground units)

#number CallsignNumber

Callsign number, e.g. Axeman-1.

Return value:

The DCS task structure.

CLIENT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType, Altitude, ASL)

(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

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

CLIENT:TaskGroundEscort(FollowControllable, LastWaypointIndex, OrbitDistance, TargetTypes)

(AIR/HELO) Escort a ground controllable.

The unit / controllable will follow lead unit of the other controllable, additional units of both controllables will continue following their leaders. The unit / controllable will also protect that controllable from threats of specified types.

Defined in:

Parameters:

#CONTROLLABLE FollowControllable

The controllable to be escorted.

#number LastWaypointIndex

(optional) Detach waypoint of another controllable. Once reached the unit / controllable Escort task is finished.

#number OrbitDistance

(optional) Maximum distance helo will orbit around the ground unit in meters. Defaults to 2000 meters.

DCS#AttributeNameArray TargetTypes

(optional) Array of AttributeName that is contains threat categories allowed to engage. Default {"Ground vehicles"}. See https://wiki.hoggit.us/view/DCS_enum_attributes

Return value:

The DCS task structure.

CLIENT:TaskGroundOnRailRoads(ToCoordinate, Speed, WaypointFunction, WaypointFunctionArguments)

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.

#function WaypointFunction

(Optional) Function called when passing a waypoint. First parameters of the function are the #CONTROLLABLE object, the number of the waypoint and the total number of waypoints.

#table WaypointFunctionArguments

(Optional) List of parameters passed to the WaypointFunction.

Return value:

Task

CLIENT:TaskGroundOnRoad(ToCoordinate, Speed, OffRoadFormation, Shortcut, FromCoordinate, WaypointFunction, WaypointFunctionArguments)

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.

#function WaypointFunction

(Optional) Function called when passing a waypoint. First parameters of the function are the #CONTROLLABLE object, the number of the waypoint and the total number of waypoints.

#table WaypointFunctionArguments

(Optional) List of parameters passed to the WaypointFunction.

Return values:

Task.

#boolean:

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

CLIENT:TaskHold()

(GROUND) Hold ground controllable from moving.

Defined in:

Return value:

The DCS task structure.

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

CLIENT:TaskLandAtVec2(Vec2, Duration, CombatLanding, DirectionAfterLand)

(AIR HELICOPTER) Landing at the ground.

For helicopters only.

Defined in:

Parameters:

DCS#Vec2 Vec2

The point where to land.

#number Duration

The duration in seconds to stay on the ground.

#boolean CombatLanding

(optional) If true, set the Combat Landing option.

#number DirectionAfterLand

(optional) Heading after landing in degrees.

Return value:

self

CLIENT:TaskLandAtZone(Zone, Duration, RandomPoint, CombatLanding, DirectionAfterLand)

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

#boolean RandomPoint

(optional) If true,land at a random point inside of the zone.

#boolean CombatLanding

(optional) If true, set the Combat Landing option.

#number DirectionAfterLand

(optional) Heading after landing in degrees.

Return value:

The DCS task structure.

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

#number LastWptNumber

(optional) Waypoint of carrier group that when reached, ends the recovery tanker task

Return value:

The DCS task structure.

CLIENT:TaskRefueling()

(AIR) Refueling from the nearest tanker.

No parameters.

Defined in:

Return value:

The DCS task structure.

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

DCS mission task. Has entries .id="Mission", params, were params has entries airborne and route, which is a table of points.

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

Core.Base#FORMATION Formation

The formation string.

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

Core.Base#FORMATION Formation

The formation string.

CLIENT:TaskStrafing(Vec2, AttackQty, Length, WeaponType, WeaponExpend, Direction, GroupAttack)

(AIR) Strafe the point on the ground.

Defined in:

Parameters:

DCS#Vec2 Vec2

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

#number AttackQty

#number Length

(optional) Length of the strafing area.

#number WeaponType

(optional) The WeaponType. WeaponType is a number associated with a corresponding weapons flags

DCS#AI.Task.WeaponExpend WeaponExpend

(optional) Determines how much ammunition will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion, e.g. AI.Task.WeaponExpend.ALL.

DCS#Azimuth Direction

#boolean GroupAttack

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

Return value:

The DCS task structure.

Usage:

local attacker = GROUP:FindByName("Aerial-1")
local attackVec2 = ZONE:New("Strafe Attack"):GetVec2()
-- Attack with any cannons = 805306368, 4 runs, strafe a field of 200 meters
local task = attacker:TaskStrafing(attackVec2,4,200,805306368,AI.Task.WeaponExpend.ALL)
attacker:SetTask(task,2)

CLIENT:TaskWrappedAction(DCSCommand, Index)

Return a WrappedAction Task taking a Command.

Defined in:

Parameters:

DCS#Command DCSCommand

Index

Return value:

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

self

Usage:

Intended Workflow is:
mygroup:WayPointInitialize()
mygroup:WayPointFunction( WayPoint, WayPointIndex, WayPointFunction, ... )
mygroup:WayPointExecute()

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

self

Usage:

Intended Workflow is:
mygroup:WayPointInitialize()
mygroup:WayPointFunction( WayPoint, WayPointIndex, WayPointFunction, ... )
mygroup:WayPointExecute()

CLIENT:WayPointInitialize(WayPoints)

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

Use the method CONTROLLABLE.WayPointFunction() to define the hook functions for specific waypoints. Use the method 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:

self

Usage:

Intended Workflow is:
mygroup:WayPointInitialize()
mygroup:WayPointFunction( WayPoint, WayPointIndex, WayPointFunction, ... )
mygroup:WayPointExecute()

CLIENT:_GetController()

Get the controller for the CONTROLLABLE.

Defined in:

Return value:

DCS#Controller:

CLIENT:_MarkerBlink()

[Internal] This method is called by the scheduler after enabling the IR marker.

Defined in:

Return value:

self

CLIENT.___PassingWaypoint(controllable, n, N, waypointfunction, ...)

Task function when controllable passes a waypoint.

Defined in:

Parameters:

#CONTROLLABLE controllable

The controllable object.

#number n

Current waypoint number passed.

#number N

Total number of waypoints.

#function waypointfunction

Function called when a waypoint is passed.

...

Field(s)

CLIENT.AliveCheckScheduler

#string CLIENT.ClassName

Name of the class.

#boolean CLIENT.ClientAlive

Client alive.

#boolean CLIENT.ClientAlive2

Client alive 2.

#string CLIENT.ClientBriefing

Briefing.

#boolean CLIENT.ClientBriefingShown

#function CLIENT.ClientCallBack

Callback function.

#number CLIENT.ClientGroupID

Group ID of the client.

#string CLIENT.ClientGroupName

Group name.

#string CLIENT.ClientName

Name of the client.

#table CLIENT.ClientParameters

Parameters of the callback function.

#boolean CLIENT.ClientTransport

#boolean CLIENT.MessageSwitch

Message switch.

#table CLIENT.Players

Player table.

Core.Point#COORDINATE CLIENT.SpawnCoord

Spawn coordinate from the template.

#table CLIENT._Menus

Function(s)

CLIENT:AddCargo(Cargo)

Add cargo.

Defined in:

Parameter:

Cargo.Cargo#CARGO Cargo

Return value:

CLIENT:CargoItemCount()

Get cargo item count.

Defined in:

Return value:

Cargo.Cargo#CARGO:

Cargo

CLIENT:ClearCargo()

Clear all cargo.

Defined in:

CLIENT:Destroy(GenerateEvent)

Destroys the POSITIONABLE.

Defined in:

Parameter:

#boolean GenerateEvent

(Optional) If true, generates a crash or dead event for the unit. If false, no event generated. If nil, a remove event is generated.

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.

CLIENT:Explode(power, delay)

Triggers an explosion at the coordinates of the positionable.

Defined in:

Parameters:

#number power

Power of the explosion in kg TNT. Default 100 kg TNT.

#number delay

(Optional) Delay of explosion in seconds.

Return value:

CLIENT:GetAirspeedIndicated(oatcorr)

Returns the indicated airspeed (IAS).

The IAS is calculated from the TAS under the approximation that TAS increases by ~2% with every 1000 feet altitude ASL.

Defined in:

Parameter:

#number oatcorr

(Optional) Outside air temperature (OAT) correction factor. Default 0.017 (=1.7%).

Return value:

#number:

IAS in m/s. Returns 0 if the POSITIONABLE does not exist.

CLIENT:GetAirspeedTrue()

#number:

Angle of attack in degrees.

Parameter:

#number MinDist

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

Return values:

DCS#Distance:

The bounding radius of the POSITIONABLE

#nil:

The POSITIONABLE is not existing or alive.

CLIENT:GetCargo()

Get all contained cargo.

Defined in:

#number:

Climb or descent angle in degrees. Or 0 if velocity vector norm is zero.

#nil:

The POSITIONABLE is not existing or alive.

CLIENT:GetCoord()

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

This function works similar to POSITIONABLE.GetCoordinate(), however, this function caches, updates and re-uses the same COORDINATE object stored within the POSITIONABLE. This has higher performance, but comes with all considerations associated with the possible referencing to the same COORDINATE object. This should only be used when performance is critical and there is sufficient awareness of the possible pitfalls. However, in most instances, GetCoordinate() is preferred as it will return a fresh new COORDINATE and thus avoid potentially unexpected issues.

Defined in:

Return value:

A reference to the COORDINATE object of the POSITIONABLE.

CLIENT:GetCoordinate()

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

Defined in:

Return value:

A new COORDINATE object of the POSITIONABLE.

CLIENT:GetDCSObject()

Returns the DCS object.

Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

Defined in:

Return value:

DCS#Object:

The DCS object.

CLIENT:GetGroundSpeed()

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

Return value:

Core.Message#MESSAGE:

CLIENT: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, Name is set to the type of the POSITIONABLE.

Return values:

#number z

Offset in the direction "the wing" of the unit is pointing in meters. z>0 starboard, z<0 port. Default 0 m.

Return value:

The COORDINATE of the offset with respect to the orientation of the POSITIONABLE.

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

CLIENT: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#Position3:

Table consisting of the point and orientation tables.

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

CLIENT:GetRadio()

Create a Sound.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:

Sound.Radio#RADIO:

Radio

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

CLIENT:GetRelativeCoordinate(x, y, z)

Returns a COORDINATE object, which is transformed to be relative to the POSITIONABLE.

Inverse of POSITIONABLE.GetOffsetCoordinate.

Defined in:

Parameters:

#number x

Offset along the world x-axis in meters. Default 0 m.

#number y

Offset along the world y-axis in meters. Default 0 m.

#number z

Offset along the world z-axis in meters. Default 0 m.

Return value:

The relative COORDINATE with respect to the orientation of the POSITIONABLE.

CLIENT:GetRelativeVelocity(Positionable)

Get relative velocity with respect to another POSITIONABLE.

Defined in:

Parameter:

#POSITIONABLE Positionable

Other POSITIONABLE.

Return value:

#number:

Relative velocity in m/s.

CLIENT:GetRoll()

Returns the roll angle of a unit.

Defined in:

Return values:

#number:

Pitch angle in degrees.

#nil:

The POSITIONABLE is not existing or alive.

CLIENT:GetSize()

Defined in:

CLIENT:GetSpot()

Get the Spot

Defined in:

Return value:

Core.Spot#SPOT:

The Spot

CLIENT:GetTroopCapacity()

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

CLIENT:GetVelocity()

The velocity Vec3 vector

#nil:

The POSITIONABLE is not existing or alive.

CLIENT:GetYaw()

Returns the yaw angle of a POSITIONABLE.

Defined in:

Return values:

#number:

Yaw angle in degrees.

#nil:

The POSITIONABLE is not existing or alive.

CLIENT:HasCargo(Cargo)

Returns if carrier has given cargo.

Defined in:

Parameter:

Cargo

Return value:

Cargo.Cargo#CARGO:

Cargo

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

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

CLIENT:IsAir()

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

CLIENT:IsShip()

The coordinate where the lase is pointing at.

#number LaserCode

Laser code or random number in [1000, 9999].

#number Duration

Duration of lasing in seconds.

Return value:

Core.Spot#SPOT:

CLIENT:LaseOff()

Stop Lasing a POSITIONABLE.

Defined in:

Return value:

CLIENT:LaseUnit(Target, LaserCode, Duration)

Start Lasing a POSITIONABLE.

Defined in:

Parameters:

#POSITIONABLE Target

The target to lase.

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.

CLIENT:New(PositionableName)

Create a new POSITIONABLE from a DCSPositionable

Defined in:

Parameter:

#string PositionableName

The POSITIONABLE name

Return value:

self

CLIENT:RemoveCargo(Cargo)

Remove cargo.

Defined in:

Parameter:

Cargo.Cargo#CARGO Cargo

Return value:

CLIENT:SetCargoBayWeightLimit(WeightLimit)

Set Cargo Bay Weight Limit in kg.

Defined in:

Parameter:

#number WeightLimit

(Optional) Weight limit in kg. If not given, the value is taken from the descriptors or hard coded.

CLIENT:Smoke(SmokeColor, Range, AddHeight)

Smoke the POSITIONABLE.

Defined in:

Parameters:

Utilities.Utils#SMOKECOLOR SmokeColor

The smoke color.

#number Range

CLIENT.AliveCheckScheduler

#string CLIENT.ClassName

Name of the class.

#boolean CLIENT.ClientAlive

Client alive.

#boolean CLIENT.ClientAlive2

Client alive 2.

#string CLIENT.ClientBriefing

Briefing.

#boolean CLIENT.ClientBriefingShown

#function CLIENT.ClientCallBack

Callback function.

#number CLIENT.ClientGroupID

Group ID of the client.

#string CLIENT.ClientGroupName

Group name.

#string CLIENT.ClientName

Name of the client.

#table CLIENT.ClientParameters

Parameters of the callback function.

#boolean CLIENT.ClientTransport

#boolean CLIENT.MessageSwitch

Message switch.

#table CLIENT.Players

Player table.

Core.Point#COORDINATE CLIENT.SpawnCoord

Spawn coordinate from the template.

#table CLIENT._Menus

Function(s)

CLIENT:GetCallsign()

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

Defined in:

Return value:

#string:

The CallSign of the IDENTIFIABLE.

CLIENT:GetCategory()

Returns object category of the DCS Identifiable.

One of

Object.Category.UNIT = 1
Object.Category.WEAPON = 2
Object.Category.STATIC = 3
Object.Category.BASE = 4
Object.Category.SCENERY = 5
Object.Category.Cargo = 6

#string:

The name of the coalition.

#nil:

The DCS Identifiable is not existing or alive.

CLIENT:GetCountry()

Returns country of the Identifiable.

Defined in:

Return value:

DCS#country.id:

The country identifier or #nil The DCS Identifiable is not existing or alive.

CLIENT:GetCountryName()

Returns country name of the Identifiable.

Defined in:

Return value:

#string:

Name of the country.

CLIENT:GetDesc()

Returns Identifiable descriptor.

Descriptor type depends on Identifiable category.

Defined in:

Return value:

DCS#Object.Desc:

The Identifiable descriptor or #nil The DCS Identifiable is not existing or alive.

CLIENT:GetName()

#string AttributeName

The attribute name.

Return value:

#boolean:

true if the attribute exists or #nil The DCS Identifiable is not existing or alive.

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

#boolean:

true if Identifiable is alive or #nil if the Identifiable is not existing or is not alive.

CLIENT:New(IdentifiableName)

Create a new IDENTIFIABLE from a DCSIdentifiable

Defined in:

Parameter:

#string IdentifiableName

The DCS Identifiable name

Return value:

#IDENTIFIABLE:

self

Field(s)

CLIENT.AliveCheckScheduler

#string CLIENT.ClassName

Name of the class.

#boolean CLIENT.ClientAlive

Client alive.

#boolean CLIENT.ClientAlive2

Client alive 2.

#string CLIENT.ClientBriefing

Briefing.

#boolean CLIENT.ClientBriefingShown

#function CLIENT.ClientCallBack

Callback function.

#number CLIENT.ClientGroupID

Group ID of the client.

#string CLIENT.ClientGroupName

Group name.

#string CLIENT.ClientName

Name of the client.

#table CLIENT.ClientParameters

Parameters of the callback function.

#boolean CLIENT.ClientTransport

#boolean CLIENT.MessageSwitch

Message switch.

#table CLIENT.Players

Player table.

Core.Point#COORDINATE CLIENT.SpawnCoord

Spawn coordinate from the template.

DCS#Object ObjectName

The Object name

Return value:

#OBJECT:

self

Field(s)

CLIENT.AliveCheckScheduler

#string CLIENT.ClassName

Name of the class.

#boolean CLIENT.ClientAlive

Client alive.

#boolean CLIENT.ClientAlive2

Client alive 2.

#string CLIENT.ClientBriefing

Briefing.

#boolean CLIENT.ClientBriefingShown

#function CLIENT.ClientCallBack

Callback function.

#number CLIENT.ClientGroupID

Group ID of the client.

#string CLIENT.ClientGroupName

Group name.

#string CLIENT.ClientName

Name of the client.

#table CLIENT.ClientParameters

Parameters of the callback function.

#boolean CLIENT.ClientTransport

#boolean CLIENT.MessageSwitch

Message switch.

#table CLIENT.Players

Player table.

Core.Point#COORDINATE CLIENT.SpawnCoord

Spawn coordinate from the template.

#table CLIENT._Menus

Function(s)

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

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

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

Defined in:

Parameter:

Arguments

A #table or any field.

CLIENT:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

CLIENT:EventRemoveAll()

Remove all subscribed events

Defined in:

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

CLIENT:GetEventPriority()

Get the Class Core.Event processing Priority.

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

Defined in:

Return value:

#number:

The Core.Event processing Priority.

CLIENT:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

CLIENT:GetState(Object, Key)

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

CLIENT:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

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

Return value:

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

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

CLIENT:IsInstanceOf(ClassName)

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

Examples:

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

CLIENT:OnEventDetailedFailure(EventData)

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

Will update this page when new information become available.

initiator: The unit that had the failure.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

CLIENT:OnEventLand(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

CLIENT:OnEventLandingAfterEjection(EventData)

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

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

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

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

Occurs when the game thinks an object is destroyed.

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

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

CLIENT:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

CLIENT:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

CLIENT:SetState(Object, Key, Value)

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

#number Level

CLIENT:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

CLIENT:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

CLIENT:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

CLIENT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

The main event handling function...

This function captures all events generated for the class.

Defined in: