Banner Image

Module Wrapper.Client

Wrapper -- CLIENT wraps DCS Unit objects acting as a Client or Player within a mission.


Author: FlightControl

Contributions:


Global(s)

Global CLIENT

Wrapper class of those Units defined within the Mission Editor that have the skillset defined as Client or Player.

#CLIENT CLIENT

Wrapper class of those Units defined within the Mission Editor that have the skillset defined as Client or Player.

Note that clients are NOT the same as Units, they are NOT necessarily alive. The CLIENT class is a wrapper class to handle the DCS Unit objects that have the skillset defined as Client or Player:

  • Wraps the DCS Unit objects with skill level set to Player or Client.
  • Support all DCS Unit APIs.
  • Enhance with Unit specific APIs not in the DCS Group API set.
  • When player joins Unit, execute alive init logic.
  • Handles messages to players.
  • Manage the "state" of the DCS Unit.

Clients are being used by the MISSION class to follow players and register their successes.

CLIENT reference methods

For each DCS Unit having skill level Player or Client, a CLIENT wrapper object (instance) will be created within the _DATABASE object. This is done at the beginning of the mission (when the mission starts).

The CLIENT class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference using the DCS Unit or the DCS UnitName.

Another thing to know is that CLIENT objects do not "contain" the DCS Unit object. The CLIENT methods will reference the DCS Unit object by name when it is needed during API execution. If the DCS Unit object does not exist or is nil, the CLIENT methods will return nil and log an exception in the DCS.log file.

The CLIENT class provides the following functions to retrieve quickly the relevant CLIENT instance:

  • CLIENT.Find(): Find a CLIENT instance from the _DATABASE object using a DCS Unit object.
  • CLIENT.FindByName(): Find a CLIENT instance from the _DATABASE object using a DCS Unit name.

IMPORTANT: ONE SHOULD NEVER SANATIZE these CLIENT OBJECT REFERENCES! (make the CLIENT object references nil).

Type(s)

Fields and Methods inherited from CLIENT Description

CLIENT:AddBriefing(ClientBriefing)

AddBriefing adds a briefing to a CLIENT when a player joins a mission.

CLIENT:Alive(CallBackFunction, ...)

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

CLIENT.AliveCheckScheduler

CLIENT.ClientAlive2

CLIENT.ClientBriefing

CLIENT.ClientBriefingShown

CLIENT.ClientCallBack

CLIENT.ClientGroupID

CLIENT.ClientGroupName

CLIENT.ClientGroupUnit

CLIENT.ClientName

CLIENT.ClientParameters

CLIENT.ClientTransport

CLIENT:Find(ClientName, ClientBriefing, DCSUnit, Error)

Finds a CLIENT from the _DATABASE using the relevant DCS Unit.

CLIENT:FindByName(ClientName, ClientBriefing, Error)

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

CLIENT:GetClientGroupDCSUnit()

Returns the DCSUnit of the CLIENT.

CLIENT:GetClientGroupID()

CLIENT:GetClientGroupName()

Get the name of the group of the client.

CLIENT:GetClientGroupUnit()

Returns the UNIT of the CLIENT.

CLIENT:GetDCSGroup()

Return the DCSGroup of a Client.

CLIENT:IsMultiSeated()

Checks if the CLIENT is a multi-seated UNIT.

CLIENT:IsTransport()

Evaluates if the CLIENT is a transport.

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

The main message driver for the CLIENT.

CLIENT.MessageSwitch

CLIENT:Register(ClientName)

CLIENT:Reset(ClientName)

Resets a CLIENT.

CLIENT:ShowBriefing()

Show the briefing of a CLIENT.

CLIENT:ShowCargo()

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

CLIENT:ShowMissionBriefing(MissionBriefing)

Show the mission briefing of a MISSION to the CLIENT.

CLIENT:Transport()

Transport defines that the Client is a Transport.

CLIENT:_AliveCheckScheduler(SchedulerName)

CLIENT._Menus

Fields and Methods inherited from UNIT Description

CLIENT:Explode(power, delay)

Triggers an explosion at the coordinates of the unit.

CLIENT:Find(DCSUnit)

Finds a UNIT from the _DATABASE using a DCSUnit object.

CLIENT:FindByName(UnitName)

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

CLIENT:GetAmmo()

Returns the Unit's ammunition.

CLIENT:GetAmmunition()

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

CLIENT:GetCallsign()

Returns the Unit's callsign - the localized string.

CLIENT:GetCategoryName()

Returns the category name of the #UNIT.

CLIENT:GetDCSObject()

CLIENT:GetDamageRelative()

Returns the unit's relative damage, i.e.

CLIENT:GetFuel()

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

CLIENT:GetGroup()

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

CLIENT:GetLife()

Returns the unit's health.

CLIENT:GetLife0()

Returns the Unit's initial health.

CLIENT:GetLifeRelative()

Returns the unit's relative health.

CLIENT:GetNumber()

Returns the unit's number in the group.

CLIENT:GetPlayerName()

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

CLIENT:GetPrefix()

Returns the prefix name of the DCS Unit.

CLIENT:GetRadar()

Returns two values:

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

CLIENT:GetRange()

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

CLIENT:GetSensors()

Returns the unit sensors.

CLIENT:GetSpeedMax()

Returns the unit's max speed in km/h derived from the DCS descriptors.

CLIENT:GetTemplate()

Get the unit table from a unit's template.

CLIENT:GetTemplateFuel()

Get the fuel of the unit from its template.

CLIENT:GetTemplatePayload()

Get the payload table from a unit's template.

CLIENT:GetTemplatePylons()

Get the pylons table from a unit's template.

CLIENT:GetThreatLevel()

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

CLIENT:GetUnits()

Returns a list of one Wrapper.Unit.

CLIENT:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

CLIENT:HasSEAD()

Returns if the unit is SEADable.

CLIENT:HasSensors(...)

Returns if the unit has sensors of a certain type.

CLIENT:InAir()

Returns true if the UNIT is in the air.

CLIENT:IsActive()

Returns if the unit is activated.

CLIENT:IsAlive()

Returns if the Unit is alive.

CLIENT:IsDetected(TargetUnit)

Returns if a unit is detecting the TargetUnit.

CLIENT:IsFriendly(FriendlyCoalition)

Returns if the unit is a friendly unit.

CLIENT:IsLOS(TargetUnit)

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

CLIENT:IsPlayer()

Check if an (air) unit is a client or player slot.

CLIENT:IsShip()

Returns if the unit is of a ship category.

CLIENT:KnowUnit(TargetUnit, TypeKnown, DistanceKnown)

Forces the unit to become aware of the specified target, without the unit manually detecting the other unit itself.

CLIENT:Name()

Return the name of the UNIT.

CLIENT:OtherUnitInRadius(AwaitUnit, Radius)

Returns true if there is an other DCS Unit within a radius of the current 2D point of the DCS Unit.

CLIENT:ReSpawnAt(Coordinate, Heading)

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

CLIENT:Register(UnitName)

Create a new UNIT from DCSUnit.

CLIENT:ResetEvents()

Reset the subscriptions.

CLIENT:UnHandleEvent(Event)

UnSubscribe to a DCS event.

Fields and Methods inherited from CONTROLLABLE Description

CLIENT:ClearTasks()

Clear all tasks from the controllable.

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

Give the CONTROLLABLE the command to activate a beacon.

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

Activate ICLS system of the CONTROLLABLE.

CLIENT:CommandDeactivateBeacon(Delay)

Deactivate the active beacon of the CONTROLLABLE.

CLIENT:CommandDeactivateICLS(Delay)

Deactivate the ICLS of the CONTROLLABLE.

CLIENT:CommandDoScript(DoScript)

Do Script command

CLIENT:CommandEPLRS(SwitchOnOff, Delay)

Set EPLRS of the CONTROLLABLE on/off.

CLIENT:CommandSetCallsign(CallName, CallNumber, Delay)

Set callsign of the CONTROLLABLE.

CLIENT:CommandStopRoute(StopRoute)

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

CLIENT:CommandSwitchWayPoint(FromWayPoint, ToWayPoint)

Perform a switch waypoint command

CLIENT.ControllableName

The name of the controllable.

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

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

CLIENT.DCSControllable

The DCS controllable class.

CLIENT:EnRouteTaskAWACS()

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

CLIENT:EnRouteTaskEWR()

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

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

(AIR) Engaging a controllable.

CLIENT:EnRouteTaskEngageTargets(Distance, TargetTypes, Priority)

(AIR) Engaging targets of defined types.

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

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

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

(AIR) Search and attack the Unit.

CLIENT:EnRouteTaskFAC(Radius, Priority)

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

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

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

CLIENT:EnRouteTaskTanker()

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

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

Return the detected target groups of the controllable as a SET_GROUP.

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

Return the detected targets of the controllable.

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

Return the detected targets of the controllable.

CLIENT:GetFuel()

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

CLIENT:GetFuelAve()

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

CLIENT:GetFuelMin()

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

CLIENT:GetLife()

Returns the health.

CLIENT:GetLife0()

Returns the initial health.

CLIENT:GetTaskMission()

Return the mission template of the controllable.

CLIENT:GetTaskRoute()

Return the mission route of the controllable.

CLIENT:GetWayPoints()

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

CLIENT:HasTask()

Checking the Task Queue of the controllable.

CLIENT:IsAirPlane()

Returns if the Controllable contains AirPlanes.

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

Check if a certain GROUP is detected by the controllable.

CLIENT:IsHelicopter()

Returns if the Controllable contains Helicopters.

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

Check if a target is detected.

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

Check if a certain UNIT is detected by the controllable.

CLIENT:New(ControllableName)

Create a new CONTROLLABLE from a DCSControllable

CLIENT:OptionAlarmStateAuto()

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

CLIENT:OptionAlarmStateGreen()

Alarm state to Green: Group is not combat ready.

CLIENT:OptionAlarmStateRed()

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

CLIENT:OptionAllowJettisonWeaponsOnThreat()

Allow to Jettison of weapons upon threat.

CLIENT:OptionKeepWeaponsOnThreat()

Keep weapons upon threat.

CLIENT:OptionROEHoldFire()

Weapons Hold: AI will hold fire under all circumstances.

CLIENT:OptionROEHoldFirePossible()

Can the CONTROLLABLE hold their weapons?

CLIENT:OptionROEOpenFire()

Open Fire (Only Designated): AI will engage only targets specified in its taskings.

CLIENT:OptionROEOpenFirePossible()

Can the CONTROLLABLE attack designated targets?

CLIENT:OptionROEOpenFireWeaponFree()

Open Fire, Weapons Free (Priority Designated): AI will engage any enemy group it detects, but will prioritize targets specified in the groups tasking.

CLIENT:OptionROEOpenFireWeaponFreePossible()

Can the CONTROLLABLE attack priority designated targets?

CLIENT:OptionROEReturnFire()

Return Fire: AI will only engage threats that shoot first.

CLIENT:OptionROEReturnFirePossible()

Can the CONTROLLABLE attack returning on enemy fire?

CLIENT:OptionROEWeaponFree()

Weapon free.

CLIENT:OptionROEWeaponFreePossible()

Can the CONTROLLABLE attack targets of opportunity?

CLIENT:OptionROTEvadeFire()

Evade on fire.

CLIENT:OptionROTEvadeFirePossible()

Can the CONTROLLABLE evade on enemy fire?

CLIENT:OptionROTNoReaction()

No evasion on enemy threats.

CLIENT:OptionROTNoReactionPossible()

Can the CONTROLLABLE ignore enemy fire?

CLIENT:OptionROTPassiveDefense()

Evasion passive defense.

CLIENT:OptionROTPassiveDefensePossible()

Can the CONTROLLABLE evade using passive defenses?

CLIENT:OptionROTVertical()

Evade on fire using vertical manoeuvres.

CLIENT:OptionROTVerticalPossible()

Can the CONTROLLABLE evade on fire using vertical manoeuvres?

CLIENT:OptionRTBAmmo(WeaponsFlag)

Set RTB on ammo.

CLIENT:OptionRTBBingoFuel(RTB)

Set RTB on bingo fuel.

CLIENT:OptionRestrictBurner(RestrictBurner)

Sets Controllable Option for Restriction of Afterburner.

CLIENT:PatrolRoute()

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

CLIENT:PatrolRouteRandom(Speed, Formation, ToWaypoint)

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

CLIENT:PatrolZones(ZoneList, Speed, Formation, DelayMin, DelayMax)

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

CLIENT:PopCurrentTask()

Popping current Task from the controllable.

CLIENT:PushTask(DCSTask, WaitTime)

Pushing Task on the queue from the controllable.

CLIENT:Route(Route, DelaySeconds)

Make the controllable to follow a given route.

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

Make the AIR Controllable fly towards a specific point.

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

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

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

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

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

Make the GROUND Controllable to drive towards a specific point.

CLIENT:RoutePush(Route, DelaySeconds)

Make the controllable to push follow a given route.

CLIENT:RouteResume()

Resumes the movement of the vehicle on the route.

CLIENT:RouteStop()

Stops the movement of the vehicle on the route.

CLIENT:RouteToVec2(Point, Speed)

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

CLIENT:RouteToVec3(Point, Speed)

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

CLIENT:SetCommand(DCSCommand)

Executes a command action for the CONTROLLABLE.

CLIENT:SetTask(DCSTask, WaitTime)

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

CLIENT:SetTaskWaypoint(Waypoint, Task)

Set a Task at a Waypoint using a Route list.

CLIENT:StartUncontrolled(delay)

Give an uncontrolled air controllable the start command.

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

(AIR) Attack a Controllable.

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

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

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

(AIR) Attack the Unit.

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

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

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

(AIR) Delivering weapon on the runway.

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.

CLIENT:TaskCombo(DCSTasks)

Return a Combo Task taking an array of Tasks.

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

Return a condition section for a controlled task.

CLIENT:TaskControlled(DCSTask, DCSStopCondition)

Return a Controlled Task taking a Task and a TaskCondition.

CLIENT:TaskEPLRS(SwitchOnOff, idx)

Set EPLRS data link on/off.

CLIENT:TaskEmbarkToTransport(Point, Radius)

(GROUND) Embark to a Transport landed at a location.

CLIENT:TaskEmbarking(Vec2, GroupSetForEmparking, Duration, (, GroupSetForEmbarking, DistributionGroupSet)

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

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

(AIR) Escort another airborne controllable.

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

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

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

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

CLIENT:TaskFollow(FollowControllable, Vec3, LastWaypointIndex)

(AIR) Following another airborne controllable.

CLIENT:TaskFollowBigFormation(FollowControllable, Vec3, LastWaypointIndex)

(AIR) Following another airborne controllable.

CLIENT:TaskFunction(FunctionString, ...)

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

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

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

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.

CLIENT:TaskHold()

(GROUND) Hold ground controllable from moving.

CLIENT:TaskHoldPosition(Duration)

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

CLIENT:TaskLandAtVec2(Point, Duration, Vec2)

(AIR HELICOPTER) Landing at the ground.

CLIENT:TaskLandAtZone(Zone, Duration, RandomPoint)

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

CLIENT:TaskMission(TaskMission)

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

CLIENT:TaskOrbit(Coord, Altitude, Speed, CoordRaceTrack)

(AIR) Orbit at a position with at a given altitude and speed.

CLIENT:TaskOrbitCircle(Altitude, Speed, Coordinate)

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

CLIENT:TaskOrbitCircleAtVec2(Point, Altitude, Speed)

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

CLIENT:TaskRefueling()

(AIR) Refueling from the nearest tanker.

CLIENT:TaskRoute(Points)

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

CLIENT:TaskRouteToVec2(Vec2, Speed, Formation)

(GROUND) Route the controllable to a given Vec2.

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

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

CLIENT.TaskScheduler

CLIENT:TaskWrappedAction(DCSCommand, Index)

Return a WrappedAction Task taking a Command.

CLIENT:WayPointExecute(WayPoint, WaitTime)

Executes the WayPoint plan.

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

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

CLIENT:WayPointInitialize(WayPoints)

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

CLIENT.WayPoints

CLIENT:_GetController()

Get the controller for the CONTROLLABLE.

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

Task function when controllable passes a waypoint.

Fields and Methods inherited from POSITIONABLE Description

CLIENT:AddCargo(Cargo)

Add cargo.

CLIENT:CargoItemCount()

Get cargo item count.

CLIENT:ClearCargo()

Clear all cargo.

CLIENT:Destroy(GenerateEvent)

Destroys the POSITIONABLE.

CLIENT:Flare(FlareColor)

Signal a flare at the position of the POSITIONABLE.

CLIENT:FlareGreen()

Signal a green flare at the position of the POSITIONABLE.

CLIENT:FlareRed()

Signal a red flare at the position of the POSITIONABLE.

CLIENT:FlareWhite()

Signal a white flare at the position of the POSITIONABLE.

CLIENT:FlareYellow()

Signal a yellow flare at the position of the POSITIONABLE.

CLIENT:GetAltitude()

Returns the altitude of the POSITIONABLE.

CLIENT:GetAoA()

Returns the Angle of Attack of a positionable.

CLIENT:GetBeacon()

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

CLIENT:GetBoundingBox()

Get the bounding box of the underlying POSITIONABLE DCS Object.

CLIENT:GetBoundingRadius(mindist)

Get the bounding radius of the underlying POSITIONABLE DCS Object.

CLIENT:GetCargo()

Get all contained cargo.

CLIENT:GetCargoBayFreeWeight()

Get Cargo Bay Free Weight in kg.

CLIENT:GetClimbAngle()

Returns the unit's climb or descent angle.

CLIENT:GetCoordinate()

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

CLIENT:GetHeading()

Returns the POSITIONABLE heading in degrees.

CLIENT:GetHeight()

Returns the POSITIONABLE height in meters.

CLIENT:GetLaserCode()

Get the last assigned laser code

CLIENT:GetMessage(Message, Duration, Name)

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

CLIENT:GetMessageText(Message, Name)

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

CLIENT:GetMessageType(Message, MessageType, Name)

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

CLIENT:GetObjectSize()

Get the object size.

CLIENT:GetOffsetCoordinate(x, y, z)

Returns a COORDINATE object, which is offset with respect to the orientation of the POSITIONABLE.

CLIENT:GetOrientation()

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

CLIENT:GetOrientationX()

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

CLIENT:GetOrientationY()

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

CLIENT:GetOrientationZ()

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

CLIENT:GetPitch()

Returns the pitch angle of a unit.

CLIENT:GetPointVec2()

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

CLIENT:GetPointVec3()

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

CLIENT:GetPosition()

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

CLIENT:GetPositionVec3()

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

CLIENT:GetRadio()

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

CLIENT:GetRandomVec3(Radius)

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

CLIENT:GetRelativeVelocity(positionable)

Get relative velocity with respect to another POSITIONABLE.

CLIENT:GetRoll()

Returns the roll angle of a unit.

CLIENT:GetSize()

CLIENT:GetSpot()

Get the Spot

CLIENT:GetVec2()

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

CLIENT:GetVec3()

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

CLIENT:GetVelocity()

Returns the a Velocity object from the positionable.

CLIENT:GetVelocityKMH()

Returns the POSITIONABLE velocity in km/h.

CLIENT:GetVelocityKNOTS()

Returns the POSITIONABLE velocity in knots.

CLIENT:GetVelocityMPS()

Returns the POSITIONABLE velocity in meters per second.

CLIENT:GetVelocityVec3()

Returns the POSITIONABLE velocity Vec3 vector.

CLIENT:GetYaw()

Returns the yaw angle of a unit.

CLIENT:HasCargo(Cargo)

Returns if carrier has given cargo.

CLIENT:InAir()

Returns true if the POSITIONABLE is in the air.

CLIENT:IsAboveRunway()

Returns if the Positionable is located above a runway.

CLIENT:IsAir()

Returns if the unit is of an air category.

CLIENT:IsCargoEmpty()

Is cargo bay empty.

CLIENT:IsGround()

Returns if the unit is of an ground category.

CLIENT:IsInZone(Zone)

Returns true if the unit is within a Zone.

CLIENT:IsLasing()

Check if the POSITIONABLE is lasing a target

CLIENT:IsNotInZone(Zone)

Returns true if the unit is not within a Zone.

CLIENT:LaseCoordinate(Coordinate, LaserCode, Duration)

Start Lasing a COORDINATE.

CLIENT:LaseOff()

Stop Lasing a POSITIONABLE

CLIENT:LaseUnit(Target, LaserCode, Duration)

Start Lasing a POSITIONABLE

CLIENT.LaserCode

CLIENT:Message(Message, Duration, Name)

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

CLIENT:MessageToAll(Message, Duration, Name)

Send a message to all coalitions.

CLIENT:MessageToBlue(Message, Duration, Name)

Send a message to the blue coalition.

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

Send a message to a client.

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

Send a message to a coalition.

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

Send a message to a Wrapper.Group.

CLIENT:MessageToRed(Message, Duration, Name)

Send a message to the red coalition.

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

Send a message to a Core.Set#SET_GROUP.

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

Send a message to a coalition.

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

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

CLIENT:New(PositionableName)

Create a new POSITIONABLE from a DCSPositionable

CLIENT.PositionableName

CLIENT:RemoveCargo(Cargo)

Remove cargo.

CLIENT:SetCargoBayWeightLimit(WeightLimit)

Set Cargo Bay Weight Limit in kg.

CLIENT:Smoke(SmokeColor, Range, AddHeight)

Smoke the POSITIONABLE.

CLIENT:SmokeBlue()

Smoke the POSITIONABLE Blue.

CLIENT:SmokeGreen()

Smoke the POSITIONABLE Green.

CLIENT:SmokeOrange()

Smoke the POSITIONABLE Orange.

CLIENT:SmokeRed()

Smoke the POSITIONABLE Red.

CLIENT:SmokeWhite()

Smoke the POSITIONABLE White.

CLIENT.Spot

CLIENT.__

Fields and Methods inherited from IDENTIFIABLE Description

CLIENT:GetCallsign()

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

CLIENT:GetCategory()

Returns category of the DCS Identifiable.

CLIENT:GetCategoryName()

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

CLIENT:GetCoalition()

Returns coalition of the Identifiable.

CLIENT:GetCoalitionName()

Returns the name of the coalition of the Identifiable.

CLIENT:GetCountry()

Returns country of the Identifiable.

CLIENT:GetCountryName()

Returns country name of the Identifiable.

CLIENT:GetDesc()

Returns Identifiable descriptor.

CLIENT:GetName()

Returns DCS Identifiable object name.

CLIENT:GetThreatLevel()

CLIENT:GetTypeName()

Returns the type name of the DCS Identifiable.

CLIENT:HasAttribute(AttributeName)

Check if the Object has the attribute.

CLIENT.IdentifiableName

The name of the identifiable.

CLIENT:IsAlive()

Returns if the Identifiable is alive.

CLIENT:New(IdentifiableName)

Create a new IDENTIFIABLE from a DCSIdentifiable

Fields and Methods inherited from OBJECT Description

CLIENT:Destroy()

Destroys the OBJECT.

CLIENT:GetID()

Returns the unit's unique identifier.

CLIENT:New(ObjectName, Test)

Create a new OBJECT from a DCSObject

CLIENT.ObjectName

The name of the Object.

Fields and Methods inherited from BASE Description

CLIENT.ClassID

The ID number of the class.

CLIENT.ClassName

The name of the class.

CLIENT.ClassNameAndID

The name of the class concatenated with the ID number of the class.

CLIENT:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

CLIENT:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

CLIENT:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

CLIENT:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

CLIENT:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

CLIENT:E(Arguments)

Log an exception which will be traced always.

CLIENT:EventDispatcher()

Returns the event dispatcher

CLIENT:EventRemoveAll()

Remove all subscribed events

CLIENT:F(Arguments)

Trace a function call.

CLIENT:F2(Arguments)

Trace a function call level 2.

CLIENT:F3(Arguments)

Trace a function call level 3.

CLIENT:GetClassID()

Get the ClassID of the class instance.

CLIENT:GetClassName()

Get the ClassName of the class instance.

CLIENT:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

CLIENT:GetEventPriority()

Get the Class Event processing Priority.

CLIENT:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

CLIENT:GetState(Object, Key)

Get a Value given a Key from the Object.

CLIENT:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

CLIENT:I(Arguments)

Log an information which will be traced always.

CLIENT:Inherit(Child, Parent)

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

CLIENT:IsInstanceOf(ClassName)

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

CLIENT:IsTrace()

Enquires if tracing is on (for the class).

CLIENT:New()

BASE constructor.

CLIENT:OnEvent(EventData)

Occurs when an object is completely destroyed.

CLIENT:OnEventBaseCaptured(EventData)

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

CLIENT:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

CLIENT:OnEventCrash(EventData)

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

CLIENT:OnEventDead(EventData)

Occurs when an object is dead.

CLIENT:OnEventDetailedFailure(EventData)

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

CLIENT:OnEventEjection(EventData)

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

CLIENT:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

CLIENT:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

CLIENT:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

CLIENT:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

CLIENT:OnEventKill(EventData)

Occurs on the death of a unit.

CLIENT:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

CLIENT:OnEventLandingAfterEjection(EventData)

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

CLIENT:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

CLIENT:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

CLIENT:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

CLIENT:OnEventMissionEnd(EventData)

Occurs when a mission ends

CLIENT:OnEventMissionStart(EventData)

Occurs when a mission starts

CLIENT:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

CLIENT:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

CLIENT:OnEventPlayerLeaveUnit(EventData)

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

CLIENT:OnEventRefueling(EventData)

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

CLIENT:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

CLIENT:OnEventScore(EventData)

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

CLIENT:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

CLIENT:OnEventShootingStart(EventData)

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

CLIENT:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

CLIENT:OnEventTakeoff(EventData)

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

CLIENT:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

CLIENT:ScheduleStop(SchedulerFunction)

Stops the Schedule.

CLIENT.Scheduler

CLIENT:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

CLIENT:SetState(Object, Key, Value)

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

CLIENT:T(Arguments)

Trace a function logic level 1.

CLIENT:T2(Arguments)

Trace a function logic level 2.

CLIENT:T3(Arguments)

Trace a function logic level 3.

CLIENT:TraceAll(TraceAll)

Trace all methods in MOOSE

CLIENT:TraceClass(Class)

Set tracing for a class

CLIENT:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

CLIENT:TraceLevel(Level)

Set trace level

CLIENT:TraceOff()

Set trace off.

CLIENT:TraceOn()

Set trace on.

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.

CLIENT:UnHandleEvent(Event)

UnSubscribe to a DCS event.

CLIENT._

CLIENT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

CLIENT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

CLIENT.__

CLIENT:onEvent(event)

The CLIENT class

Field(s)

CLIENT.AliveCheckScheduler

self.AliveCheckScheduler = routines.scheduleFunction( self._AliveCheckScheduler, { self }, timer.getTime() + 1, 5 )

#table CLIENT._Menus

Function(s)

AddBriefing adds a briefing to a CLIENT when a player joins a mission.

Defined in:

CLIENT

Parameter:

#string ClientBriefing

is the text defining the Mission briefing.

Return value:

self

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

Defined in:

CLIENT

Parameters:

#function CallBackFunction

Create a function that will be called when a player joins the slot.

...

Return value:

Finds a CLIENT from the _DATABASE using the relevant DCS Unit.

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.

DCSUnit

Error

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

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

Returns the DCSUnit of the CLIENT.

Defined in:

CLIENT

Return value:

TODO: Check DCS#Group.ID - Get the group ID of the client. @param #CLIENT self @return DCS#Group.ID

Defined in:

CLIENT

Get the name of the group of the client.

Defined in:

CLIENT

Return value:

#string:

Returns the UNIT of the CLIENT.

Defined in:

CLIENT

Return value:

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:

The group of the Client.

Checks if the CLIENT is a multi-seated UNIT.

Defined in:

CLIENT

Return value:

#boolean:

true if multi-seated.

Evaluates if the CLIENT is a transport.

Defined in:

CLIENT

Return value:

#boolean:

true is a transport.

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.

Defined in:

CLIENT

Parameter:

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.

Show the briefing of a CLIENT.

Defined in:

CLIENT

Return value:

self

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

Show the mission briefing of a MISSION to the CLIENT.

Defined in:

CLIENT

Parameter:

#string MissionBriefing

Return value:

self

Transport defines that the Client is a Transport.

Transports show cargo.

Defined in:

CLIENT

Return value:

Defined in:

CLIENT

Parameter:

SchedulerName

Field(s)

CLIENT.AliveCheckScheduler

self.AliveCheckScheduler = routines.scheduleFunction( self._AliveCheckScheduler, { self }, timer.getTime() + 1, 5 )

#table CLIENT._Menus

Function(s)

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

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

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

Defined in:

Parameter:

#string UnitName

The Unit Name.

Return value:

self

Returns the Unit's ammunition.

Defined in:

Return value:

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

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.

#number:

Number of rockets left.

#number:

Number of bombs left.

#number:

Number of missiles left.

Returns the Unit's callsign - the localized string.

Defined in:

Return values:

#string:

The Callsign of the Unit.

#nil:

The DCS Unit is not existing or alive.

Returns the category name of the #UNIT.

Defined in:

Return value:

#string:

Category name = Helicopter, Airplane, Ground Unit, Ship

Defined in:

Return value:

Returns the unit's relative damage, i.e.

1-life.

Defined in:

Return value:

#number:

The Unit's relative health value, i.e. a number in [0,1] or 1 if unit does not exist any more.

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.

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

Defined in:

Return values:

The Group of the Unit.

#nil:

The DCS Unit is not existing or alive.

Returns the unit's health.

Dead units has health <= 1.0.

Defined in:

Return value:

#number:

The Unit's health value or -1 if unit does not exist any more.

Returns the Unit's initial health.

Defined in:

Return value:

#number:

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

Returns the unit's relative health.

Defined in:

Return value:

#number:

The Unit's relative health value, i.e. a number in [0,1] or -1 if unit does not exist any more.

Returns the unit's number in the group.

The number is the same number the unit has in ME. It may not be changed during the mission. If any unit in the group is destroyed, the numbers of another units will not be changed.

Defined in:

Return values:

#number:

The Unit number.

#nil:

The DCS Unit is not existing or alive.

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.

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

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.

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

#nil:

The DCS Unit is not existing or alive.

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.

Returns the unit sensors.

Defined in:

Return values:

#nil:

The DCS Unit is not existing or alive.

Returns the unit's max speed in km/h derived from the DCS descriptors.

Defined in:

Return value:

#number:

Speed in km/h.

Get the unit table from a unit's template.

Defined in:

Return value:

#table:

Table of the unit template (deep copy) or #nil.

Get the fuel of the unit from its template.

Defined in:

Return value:

#number:

Fuel of unit in kg.

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.

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.

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:

Returns a list of one Wrapper.Unit.

Defined in:

Return value:

#list<Wrapper.Unit#UNIT>:

A list of one Wrapper.Unit.

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

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

Return value:

Returns if the unit is SEADable.

Defined in:

Return values:

#boolean:

returns true if the unit is SEADable.

#nil:

The DCS Unit is not existing or alive.

Returns if the unit has sensors of a certain type.

Defined in:

Parameter:

...

Return values:

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

#nil:

The DCS Unit is not existing or alive.

Returns true if the UNIT is in the air.

Defined in:

Return value:

#boolean:

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

Returns if the unit is activated.

Defined in:

Return values:

#boolean:

true if Unit is activated.

#nil:

The DCS Unit is not existing or alive.

Returns if the Unit is alive.

If the Unit is not alive, 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 values:

#boolean:

true if Unit is alive and active.

#boolean:

false if Unit is alive but not active.

#nil:

if the Unit is not existing or is not alive.

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.

Returns if the unit is a friendly unit.

Defined in:

Parameter:

FriendlyCoalition

Return value:

#boolean:

IsFriendly evaluation result.

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

Defined in:

Parameter:

#UNIT TargetUnit

Return value:

#boolean:

true If the TargetUnit has LOS with the unit, otherwise false.

Check if an (air) unit is a client or player slot.

Information is retrieved from the group template.

Defined in:

Return value:

#boolean:

If true, unit is associated with a client or player slot.

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.

Forces the unit to become aware of the specified target, without the unit manually detecting the other unit itself.

Applies only to a Unit Controller. Cannot be used at the group level.

Defined in:

Parameters:

#UNIT TargetUnit

The unit to be known.

#boolean TypeKnown

The target type is known. If false, the type is not known.

#boolean DistanceKnown

The distance to the target is known. If false, distance is unknown.

Return the name of the UNIT.

Defined in:

Return value:

#string:

The UNIT name.

Returns true if there is an other DCS Unit within a radius of the current 2D point of the DCS Unit.

Defined in:

Parameters:

#UNIT AwaitUnit

The other UNIT wrapper object.

Radius

The radius in meters with the DCS Unit in the centre.

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.

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:

The position where to Spawn the new Unit at.

#number Heading

The heading of the unit respawn.

Create a new UNIT from DCSUnit.

Defined in:

Parameter:

#string UnitName

The name of the DCS unit.

Return value:

Reset the subscriptions.

Defined in:

Return value:

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Field(s)

CLIENT.AliveCheckScheduler

self.AliveCheckScheduler = routines.scheduleFunction( self._AliveCheckScheduler, { self }, timer.getTime() + 1, 5 )

#table CLIENT._Menus

Function(s)

Clear all tasks from the controllable.

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:

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

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

Activate ICLS system of the CONTROLLABLE.

The controllable should be an aircraft carrier!

Defined in:

Parameters:

#number Channel

ICLS channel.

#number UnitID

The 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 deactivated.

Return value:

Deactivate the active beacon of the CONTROLLABLE.

Defined in:

Parameter:

#number Delay

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

Return value:

Deactivate the ICLS of the CONTROLLABLE.

Defined in:

Parameter:

#number Delay

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

Return value:

Do Script command

Defined in:

Parameter:

#string DoScript

Return value:

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:

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:

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:

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
)

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.

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

No parameters.

Defined in:

Return value:

The DCS task structure.

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

No parameters.

Defined in:

Return value:

The DCS task structure.

(AIR) Engaging a controllable.

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

Defined in:

Parameters:

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.

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

#number AttackQty

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

DCS#Azimuth Direction

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

DCS#Distance Altitude

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

#boolean AttackQtyLimit

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

Return value:

The DCS task structure.

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

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.

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

ptional) 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.

TargetTypes

Return value:

The DCS task structure.

(AIR) Search and attack the Unit.

Defined in:

Parameters:

Wrapper.Unit#UNIT EngageUnit

The UNIT.

#number Priority

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

#boolean GroupAttack

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

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

#number AttackQty

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

DCS#Azimuth Direction

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

DCS#Distance Altitude

(optional) Desired 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.

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

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

Defined in:

Parameters:

DCS#Distance Radius

The maximal distance from the FAC to a target.

#number Priority

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

Return value:

The DCS task structure.

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

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

Defined in:

Parameters:

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

(Optional) Designation type.

#boolean Datalink

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

Return value:

The DCS task structure.

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

No parameters.

Defined in:

Return value:

The DCS task structure.

Return the detected target groups of the controllable as a SET_GROUP.

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

Defined in:

Parameters:

#boolean DetectVisual

(Optional) 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 value:

Set of detected groups.

Return the detected targets of the controllable.

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

Defined in:

Parameters:

#boolean DetectVisual

(optional)

#boolean DetectOptical

(optional)

#boolean DetectRadar

(optional)

#boolean DetectIRST

(optional)

#boolean DetectRWR

(optional)

#boolean DetectDLINK

(optional)

Return value:

#table:

DetectedTargets

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

Set of detected units.

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

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

Defined in:

Return value:

#nil:

The CONTROLLABLE is not existing or alive.

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

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

Defined in:

Return value:

#nil:

The CONTROLLABLE is not existing or alive.

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

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

Defined in:

Return value:

#nil:

The CONTROLLABLE is not existing or alive.

Returns the health.

Dead controllables have health <= 1.0.

Defined in:

Return values:

#number:

The controllable health value (unit or group average).

#nil:

The controllable is not existing or alive.

Returns the initial health.

Defined in:

Return values:

#number:

The controllable health value (unit or group average).

#nil:

The controllable is not existing or alive.

Return the mission template of the controllable.

Defined in:

Return value:

#table:

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

Return the mission route of the controllable.

Defined in:

Return value:

#table:

The mission route defined by points.

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

Defined in:

Return value:

#table:

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

Checking the Task Queue of the controllable.

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

Returns if the Controllable contains AirPlanes.

Defined in:

Return value:

#boolean:

true if Controllable contains AirPlanes.

Check if a certain GROUP 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:

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

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

#boolean:

True if any unit of the group is detected.

Returns if the Controllable contains Helicopters.

Defined in:

Return value:

#boolean:

true if Controllable contains Helicopters.

Check if a target is detected.

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 visible by line of sight.

#number:

Mission time when target was detected.

#boolean:

True if target type is known.

#boolean:

True if distance to target is known.

Last known position vector of the target.

Last known velocity vector of the target.

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:

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 visible by line of sight.

#number:

Mission time when target was detected.

#boolean:

True if target type is known.

#boolean:

True if distance to target is known.

Last known position vector of the target.

Last known velocity vector of the target.

Create a new CONTROLLABLE from a DCSControllable

Defined in:

Parameter:

#string ControllableName

The DCS Controllable name

Return value:

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:

Alarm state to Green: Group is not combat ready.

Sensors are stowed if possible.

Defined in:

Return value:

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

Defined in:

Return value:

Allow to Jettison of weapons upon threat.

Defined in:

Return value:

Keep weapons upon threat.

Defined in:

Return value:

Weapons Hold: AI will hold fire under all circumstances.

Can the CONTROLLABLE hold their weapons?

Defined in:

Return value:

#boolean:

Open Fire (Only Designated): AI will engage only targets specified in its taskings.

Defined in:

Return value:

Can the CONTROLLABLE attack designated targets?

Defined in:

Return value:

#boolean:

Open Fire, Weapons Free (Priority Designated): AI will engage any enemy group it detects, but will prioritize targets specified in the groups tasking.

Only for AIR units!

Defined in:

Return value:

Can the CONTROLLABLE attack priority designated targets?

Only for AIR!

Defined in:

Return value:

#boolean:

Return Fire: AI will only engage threats that shoot first.

Defined in:

Return value:

Can the CONTROLLABLE attack returning on enemy fire?

Defined in:

Return value:

#boolean:

Can the CONTROLLABLE attack targets of opportunity?

Defined in:

Return value:

#boolean:

Evade on fire.

Defined in:

Return value:

Can the CONTROLLABLE evade on enemy fire?

Defined in:

Return value:

#boolean:

No evasion on enemy threats.

Defined in:

Return value:

Can the CONTROLLABLE ignore enemy fire?

Defined in:

Return value:

#boolean:

Evasion passive defense.

Defined in:

Return value:

Can the CONTROLLABLE evade using passive defenses?

Defined in:

Return value:

#boolean:

Evade on fire using vertical manoeuvres.

Defined in:

Return value:

Can the CONTROLLABLE evade on fire using vertical manoeuvres?

Defined in:

Return value:

#boolean:

Set RTB on ammo.

Defined in:

Parameter:

#boolean WeaponsFlag

Weapons.flag enumerator.

Return value:

Set RTB on bingo fuel.

Defined in:

Parameter:

#boolean RTB

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

Return value:

Sets Controllable Option for Restriction of Afterburner.

Defined in:

Parameter:

#boolean RestrictBurner

If true, restrict burner. If false or nil, allow (unrestrict) burner.

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

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

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

Defined in:

Parameters:

#number Speed

Speed in km/h.

#string Formation

The formation the group uses.

The waypoint where the group should move to.

Return value:

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

Popping current Task from the controllable.

Pushing Task on the queue from the controllable.

Defined in:

Parameters:

DCSTask

WaitTime

Return value:

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.

Make the AIR Controllable fly towards a specific point.

Defined in:

Parameters:

Core.Point#COORDINATE ToCoordinate

A Coordinate to drive to.

The altitude type.

The route point type.

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.

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.

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.

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.

Make the controllable to push follow a given route.

Defined in:

Parameters:

#table Route

A table of Route Points.

#number DelaySeconds

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

Return value:

The CONTROLLABLE.

Resumes the movement of the vehicle on the route.

Stops the movement of the vehicle on the route.

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

Defined in:

Parameters:

DCS#Vec3 Point

The destination point in Vec3 format.

#number Speed

The speed [m/s] to travel.

Return value:

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

Executes a command action for the CONTROLLABLE.

Defined in:

Parameter:

DCS#Command DCSCommand

The command to be executed.

Return value:

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:

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:

Give an uncontrolled air controllable the start command.

Defined in:

Parameter:

#number delay

(Optional) Delay before start command in seconds.

Return value:

(AIR) Attack a Controllable.

Defined in:

Parameters:

The Controllable to be attacked.

#number WeaponType

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

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

#number AttackQty

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

DCS#Azimuth Direction

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

DCS#Distance Altitude

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

#boolean AttackQtyLimit

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

Return value:

The DCS task structure.

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

(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 aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.

DCS#Azimuth Direction

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

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

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

(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 aicraft/controllable will not make more attacks than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.

DCS#Azimuth Direction

(Optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction.

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

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

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

#number AttackQty

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

DCS#Azimuth Direction

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

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

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

Airbase to attack.

#number WeaponType

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

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

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

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

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

(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 aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.

DCS#Azimuth Direction

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

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

Return a Combo Task taking an array of Tasks.

Defined in:

Parameter:

Return value:

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

Return a Controlled Task taking a Task and a TaskCondition.

Defined in:

Parameters:

DCS#Task DCSTask

DCS#DCSStopCondition DCSStopCondition

Return value:

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.

(GROUND) Embark to a Transport landed at a location.

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

Defined in:

Parameters:

DCS#Vec2 Point

The point where to wait.

#number Radius

The radius of the embarking zone around the Point.

Return value:

The DCS task structure.

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

Defined in:

Parameters:

DCS#Vec2 Vec2

The point where to wait. Needs to have x and y components.

Core.Set#SET_GROUP GroupSetForEmparking

Set of groups to embark.

#number Duration

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

ptional) DistributionGroupSet Set of groups identifying the groups needing to board specific helicopters.

GroupSetForEmbarking

DistributionGroupSet

Return value:

The DCS task structure.

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

The controllable to be escorted.

DCS#Vec3 Vec3

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

#number LastWaypointIndex

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

#number EngagementDistance

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

Array of AttributeName that is contains threat categories allowed to engage. Default {"Air"}.

Return value:

The DCS task structure.

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

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

Defined in:

Parameters:

Target CONTROLLABLE.

#number WeaponType

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

(optional) Designation type.

#boolean Datalink

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

Return value:

The DCS task structure.

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

Defined in:

Parameters:

DCS#Vec2 Vec2

The point to fire at.

DCS#Distance Radius

The radius of the zone to deploy the fire at.

#number AmmoCount

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

#number WeaponType

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

Return value:

The DCS task structure.

(AIR) Following another airborne controllable.

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

Defined in:

Parameters:

The controllable to be followed.

DCS#Vec3 Vec3

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

#number LastWaypointIndex

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

Return value:

The DCS task structure.

(AIR) Following another airborne controllable.

The unit / controllable will follow lead unit of another controllable, wingmens of both controllables will continue following their leaders. Used to support CarpetBombing Task

Defined in:

Parameters:

#CONTROLLABLE FollowControllable

The controllable to be followed.

DCS#Vec3 Vec3

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

#number LastWaypointIndex

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

Return value:

The DCS task structure.

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

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

Defined in:

Parameters:

#string FunctionString

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

...

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

Return value:

Usage:


 local ZoneList = {
   ZONE:New( "ZONE1" ),
   ZONE:New( "ZONE2" ),
   ZONE:New( "ZONE3" ),
   ZONE:New( "ZONE4" ),
   ZONE:New( "ZONE5" )
 }

 GroundGroup = GROUP:FindByName( "Vehicle" )

 --- @param Wrapper.Group#GROUP GroundGroup
 function RouteToZone( Vehicle, ZoneRoute )

   local Route = {}

   Vehicle:E( { ZoneRoute = ZoneRoute } )

   Vehicle:MessageToAll( "Moving to zone " .. ZoneRoute:GetName(), 10 )

   -- Get the current coordinate of the Vehicle
   local FromCoord = Vehicle:GetCoordinate()

   -- Select a random Zone and get the Coordinate of the new Zone.
   local RandomZone = ZoneList[ math.random( 1, #ZoneList ) ] -- Core.Zone#ZONE
   local ToCoord = RandomZone:GetCoordinate()

   -- Create a "ground route point", which is a "point" structure that can be given as a parameter to a Task
   Route[#Route+1] = FromCoord:WaypointGround( 72 )
   Route[#Route+1] = ToCoord:WaypointGround( 60, "Vee" )

   local TaskRouteToZone = Vehicle:TaskFunction( "RouteToZone", RandomZone )

   Vehicle:SetTaskWaypoint( Route[#Route], TaskRouteToZone ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.

   Vehicle:Route( Route, math.random( 10, 20 ) ) -- Move after a random seconds to the Route. See the Route method for details.

 end

   RouteToZone( GroundGroup, ZoneList[1] )

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

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.

(GROUND) Hold ground controllable from moving.

Defined in:

Return value:

The DCS task structure.

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

(AIR HELICOPTER) Landing at the ground.

For helicopters only.

Defined in:

Parameters:

DCS#Vec2 Point

The point where to land.

#number Duration

The duration in seconds to stay on the ground.

Vec2

Return value:

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

Defined in:

Parameters:

The zone where to land.

#number Duration

The duration in seconds to stay on the ground.

RandomPoint

Return value:

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

Defined in:

Parameter:

#table TaskMission

A table containing the mission task.

Return value:

(AIR) Orbit at a position with at a given altitude and speed.

Optionally, a race track pattern can be specified.

Defined in:

Parameters:

Coordinate at which the CONTROLLABLE orbits.

#number Altitude

Altitude in meters of the orbit pattern. Default y component of Coord.

#number Speed

Speed [m/s] flying the orbit pattern. Default 128 m/s = 250 knots.

Core.Point#COORDINATE CoordRaceTrack

(Optional) If this coordinate is specified, the CONTROLLABLE will fly a race-track pattern using this and the initial coordinate.

Return value:

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

Defined in:

Parameters:

#number Altitude

The altitude [m] to hold the position.

#number Speed

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

(Optional) The coordinate where to orbit. If the coordinate is not given, then the current position of the controllable is used.

Return value:

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

Defined in:

Parameters:

DCS#Vec2 Point

The point to hold the position.

#number Altitude

The altitude AGL in meters to hold the position.

#number Speed

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

Return value:

(AIR) Refueling from the nearest tanker.

No parameters.

Defined in:

Return value:

The DCS task structure.

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

Defined in:

Parameter:

#table Points

A table of route points.

Return value:

(GROUND) Route the controllable to a given Vec2.

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

Defined in:

Parameters:

DCS#Vec2 Vec2

The Vec2 where to route to.

#number Speed

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

Base#FORMATION Formation

The formation string.

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

The zone where to route to.

#boolean Randomize

Defines whether to target point gets randomized within the Zone.

#number Speed

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

Base#FORMATION Formation

The formation string.

Return a WrappedAction Task taking a Command.

Defined in:

Parameters:

DCS#Command DCSCommand

Index

Return value:

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:

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:

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

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

Defined in:

Parameter:

#table WayPoints

If WayPoints is given, then use the route.

Return value:

Get the controller for the CONTROLLABLE.

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

self.AliveCheckScheduler = routines.scheduleFunction( self._AliveCheckScheduler, { self }, timer.getTime() + 1, 5 )

#table CLIENT._Menus

Function(s)

Add cargo.

Defined in:

Parameter:

Return value:

Get cargo item count.

Defined in:

Return value:

Destroys the POSITIONABLE.

Defined in:

Parameter:

#boolean GenerateEvent

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

Return value:

#nil:

The DCS Unit is not existing or alive.

Usages:

  • -- Air unit example: destroy the Helicopter and generate a S_EVENT_CRASH for each unit in the Helicopter group.
    Helicopter = UNIT:FindByName( "Helicopter" )
    Helicopter:Destroy( true )
  • -- Ground unit example: destroy the Tanks and generate a S_EVENT_DEAD for each unit in the Tanks group.
    Tanks = UNIT:FindByName( "Tanks" )
    Tanks:Destroy( true )
  • -- Ship unit example: destroy the Ship silently.
    Ship = STATIC:FindByName( "Ship" )
    Ship:Destroy()
    
  • -- Destroy without event generation example.
    Ship = STATIC:FindByName( "Boat" )
    Ship:Destroy( false ) -- Don't generate an event upon destruction.
    

Signal a flare at the position of the POSITIONABLE.

Signal a green flare at the position of the POSITIONABLE.

Signal a red flare at the position of the POSITIONABLE.

Signal a white flare at the position of the POSITIONABLE.

Signal a yellow flare at the position of the POSITIONABLE.

Returns the altitude of the POSITIONABLE.

Defined in:

Return values:

The altitude of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

Returns the Angle of Attack of a positionable.

Defined in:

Return value:

#number:

Angle of attack in degrees.

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

Defined in:

Return value:

Get the bounding box of the underlying POSITIONABLE DCS Object.

Defined in:

Return values:

The bounding box of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

Get the bounding radius of the underlying POSITIONABLE DCS Object.

Defined in:

Parameter:

#number mindist

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

Return value:

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

Get all contained cargo.

Get Cargo Bay Free Weight in kg.

Defined in:

Return value:

#number:

CargoBayFreeWeight

Returns the unit's climb or descent angle.

Defined in:

Return value:

#number:

Climb or descent angle in degrees. Or 0 if velocity vector norm is zero (or nil). Or nil, if the position of the POSITIONABLE returns nil.

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

Defined in:

Return value:

The COORDINATE of the POSITIONABLE.

Returns the POSITIONABLE heading in degrees.

Defined in:

Return values:

#number:

The POSITIONABLE heading

#nil:

The POSITIONABLE is not existing or alive.

Returns the POSITIONABLE height in meters.

Defined in:

Return values:

The height of the positionable.

#nil:

The POSITIONABLE is not existing or alive.

Get the last assigned laser code

Defined in:

Return value:

#number:

The laser code

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

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

Return value:

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

Defined in:

Parameters:

#string Message

The message text

#string Name

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

Return value:

#string:

The message text

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

Defined in:

Parameters:

#string Message

The message text

Core.Message#MESSAGE MessageType

MessageType The message type.

#string Name

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

Return value:

Get the object size.

Defined in:

Return values:

Max size of object in x, z or 0 if bounding box could not be obtained.

Length x or 0 if bounding box could not be obtained.

Height y or 0 if bounding box could not be obtained.

Width z or 0 if bounding box could not be obtained.

Returns a COORDINATE object, which is offset with respect to the orientation of the POSITIONABLE.

Defined in:

Parameters:

#number x

Offset in the direction "the nose" of the unit is pointing in meters. Default 0 m.

#number y

Offset "above" the unit in meters. Default 0 m.

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

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

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

Defined in:

Return values:

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

Y orientation, i.e. vertical.

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

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

along the direction of movement.

Defined in:

Return value:

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

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

vertical orientation.

Defined in:

Return value:

Y orientation, i.e. vertical.

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

perpendicular to direction of movement.

Defined in:

Return value:

Z orientation, i.e. perpendicular to movement.

Returns the pitch angle of a unit.

Defined in:

Return value:

#number:

Pitch ange in degrees.

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

Defined in:

Return values:

The 2D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

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

Defined in:

Return values:

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

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:

Table consisting of the point and orientation tables.

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

Defined in:

Return values:

The 3D position vectors of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

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

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

Defined in:

Return value:

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

Get relative velocity with respect to another POSITIONABLE.

Defined in:

Parameter:

#POSITIONABLE positionable

Other positionable.

Return value:

#number:

Relative velocity in m/s.

Returns the roll angle of a unit.

Defined in:

Return value:

#number:

Pitch ange in degrees.

Get the Spot

Defined in:

Return value:

The Spot

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

Defined in:

Return values:

The 2D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

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

Defined in:

Return values:

The 3D point vector of the POSITIONABLE.

#nil:

The POSITIONABLE is not existing or alive.

Returns the a Velocity object from the positionable.

Defined in:

Return values:

Velocity The Velocity object.

#nil:

The POSITIONABLE is not existing or alive.

Returns the POSITIONABLE velocity in km/h.

Defined in:

Return value:

#number:

The velocity in km/h

Returns the POSITIONABLE velocity in knots.

Defined in:

Return value:

#number:

The velocity in knots.

Returns the POSITIONABLE velocity in meters per second.

Defined in:

Return value:

#number:

The velocity in meters per second.

Returns the POSITIONABLE velocity Vec3 vector.

Defined in:

Return values:

The velocity Vec3 vector

#nil:

The POSITIONABLE is not existing or alive.

Returns the yaw angle of a unit.

Defined in:

Return value:

#number:

Yaw ange in degrees.

Returns if carrier has given cargo.

Defined in:

Parameter:

Cargo

Return value:

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.

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.

Returns if the unit is of an air category.

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

Defined in:

Return value:

#boolean:

Air category evaluation result.

Returns if the unit is of an ground category.

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

Defined in:

Return value:

#boolean:

Ground category evaluation result.

Returns true if the unit is within a Zone.

Defined in:

Parameter:

The zone to test.

Return value:

#boolean:

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

Check if the POSITIONABLE is lasing a target

Defined in:

Return value:

#boolean:

true if it is lasing a target

Returns true if the unit is not within a Zone.

Defined in:

Parameter:

The zone to test.

Return value:

#boolean:

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

Start Lasing a COORDINATE.

Defined in:

Parameters:

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:

Stop Lasing a POSITIONABLE

Start Lasing a POSITIONABLE

Defined in:

Parameters:

#POSITIONABLE Target

The target to lase.

#number LaserCode

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

#number Duration

Duration of lasing in seconds.

Return value:

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

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

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

Send a message to all coalitions.

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

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

Send a message to the blue coalition.

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

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

Send a message to a client.

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

The client object receiving the message.

#string Name

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

Send a message to a coalition.

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

DCS#coalition MessageCoalition

The Coalition receiving the message.

#string Name

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

Send a message to a Wrapper.Group.

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

Wrapper.Group#GROUP MessageGroup

The GROUP object receiving the message.

#string Name

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

Send a message to the red coalition.

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

#string Name

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

Send a message to a Core.Set#SET_GROUP.

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

Defined in:

Parameters:

#string Message

The message text

DCS#Duration Duration

The duration of the message.

Core.Set#SET_GROUP MessageSetGroup

The SET_GROUP collection receiving the message.

#string Name

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

Send a message to a coalition.

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

Defined in:

Parameters:

#string Message

The message text

The message type that determines the duration.

DCS#coalition MessageCoalition

The Coalition receiving the message.

#string Name

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

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

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

Defined in:

Parameters:

#string Message

The message text

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.

Create a new POSITIONABLE from a DCSPositionable

Defined in:

Parameter:

#string PositionableName

The POSITIONABLE name

Return value:

Remove cargo.

Defined in:

Parameter:

Return value:

Set Cargo Bay Weight Limit in kg.

Defined in:

Parameter:

#number WeightLimit

Smoke the POSITIONABLE.

Defined in:

Parameters:

The color to smoke to positionable.

#number Range

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

#number AddHeight

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

Smoke the POSITIONABLE Blue.

Smoke the POSITIONABLE Green.

Smoke the POSITIONABLE Orange.

Smoke the POSITIONABLE Red.

Smoke the POSITIONABLE White.

Field(s)

CLIENT.AliveCheckScheduler

self.AliveCheckScheduler = routines.scheduleFunction( self._AliveCheckScheduler, { self }, timer.getTime() + 1, 5 )

#table CLIENT._Menus

Function(s)

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

Defined in:

Return value:

#string:

The CallSign of the IDENTIFIABLE.

Returns category of the DCS Identifiable.

Defined in:

Return value:

The category ID

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

Defined in:

Return value:

#string:

The DCS Identifiable Category Name

Returns coalition of the Identifiable.

Defined in:

Return values:

The side of the coalition.

#nil:

The DCS Identifiable is not existing or alive.

Returns the name of the coalition of the Identifiable.

Defined in:

Return values:

#string:

The name of the coalition.

#nil:

The DCS Identifiable is not existing or alive.

Returns country of the Identifiable.

Defined in:

Return values:

The country identifier.

#nil:

The DCS Identifiable is not existing or alive.

Returns country name of the Identifiable.

Defined in:

Return value:

#string:

Name of the country.

Returns Identifiable descriptor.

Descriptor type depends on Identifiable category.

Defined in:

Return values:

The Identifiable descriptor.

#nil:

The DCS Identifiable is not existing or alive.

Returns DCS Identifiable object name.

The function provides access to non-activated objects too.

Defined in:

Return values:

#string:

The name of the DCS Identifiable.

#nil:

The DCS Identifiable is not existing or alive.

Returns the type name of the DCS Identifiable.

Defined in:

Return values:

#string:

The type name of the DCS Identifiable.

#nil:

The DCS Identifiable is not existing or alive.

Check if the Object has the attribute.

Defined in:

Parameter:

#string AttributeName

The attribute name.

Return values:

#boolean:

true if the attribute exists.

#nil:

The DCS Identifiable is not existing or alive.

Returns if the Identifiable is alive.

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

Defined in:

Return values:

#boolean:

true if Identifiable is alive.

#nil:

if the Identifiable is not existing or is not alive.

Create a new IDENTIFIABLE from a DCSIdentifiable

Defined in:

Parameter:

#string IdentifiableName

The DCS Identifiable name

Return value:

Field(s)

CLIENT.AliveCheckScheduler

self.AliveCheckScheduler = routines.scheduleFunction( self._AliveCheckScheduler, { self }, timer.getTime() + 1, 5 )

#table CLIENT._Menus

Function(s)

Destroys the OBJECT.

Defined in:

Return values:

#boolean:

true if the object is destroyed.

#nil:

The DCS Unit is not existing or alive.

Returns the unit's unique identifier.

Defined in:

Return value:

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

Create a new OBJECT from a DCSObject

Defined in:

Parameters:

DCS#Object ObjectName

The Object name

Test

Return value:

self

Field(s)

CLIENT.AliveCheckScheduler

self.AliveCheckScheduler = routines.scheduleFunction( self._AliveCheckScheduler, { self }, timer.getTime() + 1, 5 )

#table CLIENT._Menus

Function(s)

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.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

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.

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

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:

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

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

Examples:

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

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

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

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

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

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.

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

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

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.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

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

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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 )

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

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

Defined in:

Parameter:

event