Module Ops.ArmyGroup

Ops.OpsGroup#OPSGROUP.Task:

self

ARMYGROUP:AddTaskAttackGroup(TargetGroup, WeaponExpend, WeaponType, Clock, Prio)

Add a scheduled task.

Defined in:

ARMYGROUP

Parameters:

Wrapper.Group#GROUP TargetGroup

Target group.

#number WeaponExpend

How much weapons does are used.

#number WeaponType

Type of weapon. Default auto.

#string Clock

Time when to start the attack.

#number Prio

Priority of the task.

Return value:

The task table.

ARMYGROUP:AddTaskFireAtPoint(Coordinate, Clock, Radius, Nshots, WeaponType, Prio)

Add a scheduled task to fire at a given coordinate.

Defined in:

ARMYGROUP

Parameters:

Core.Point#COORDINATE Coordinate

Coordinate of the target.

#string Clock

Time when to start the attack.

#number Radius

Radius in meters. Default 100 m.

#number Nshots

Number of shots to fire. Default 3.

#number WeaponType

Type of weapon. Default auto.

#number Prio

Priority of the task.

Return value:

Ops.OpsGroup#OPSGROUP.Task:

The task table.

ARMYGROUP:AddTaskWaypointFireAtPoint(Coordinate, Waypoint, Radius, Nshots, WeaponType, Prio)

Add a waypoint task to fire at a given coordinate.

Defined in:

ARMYGROUP

Parameters:

Core.Point#COORDINATE Coordinate

Coordinate of the target.

Ops.OpsGroup#OPSGROUP.Waypoint Waypoint

Where the task is executed. Default is next waypoint.

#number Radius

Radius in meters. Default 100 m.

#number Nshots

Number of shots to fire. Default 3.

#number WeaponType

Type of weapon. Default auto.

#number Prio

Priority of the task.

Return value:

Ops.OpsGroup#OPSGROUP.Task:

The task table.

ARMYGROUP:AddWaypoint(Coordinate, Speed, AfterWaypointWithID, Formation, Updateroute)

Add an a waypoint to the route.

Defined in:

ARMYGROUP

Parameters:

Core.Point#COORDINATE Coordinate

The coordinate of the waypoint.

#number Speed

Speed in knots. Default is default cruise speed or 70% of max speed.

#number AfterWaypointWithID

Insert waypoint after waypoint given ID. Default is to insert as last waypoint.

#number Formation

Formation the group will use.

#boolean Updateroute

If true or nil, call UpdateRoute. If false, no call.

Return value:

Ops.OpsGroup#OPSGROUP.Waypoint:

Waypoint table.

ARMYGROUP:GetClosestRoad()

Get coordinate of the closest road.

Defined in:

ARMYGROUP

Return value:

Coordinate of a road closest to the group.

ARMYGROUP:GetClosestRoadDist()

Get 2D distance to the closest road.

Defined in:

ARMYGROUP

Return value:

#number:

Distance in meters to the closest road.

ARMYGROUP:IsCombatReady()

Check if the group is ready for combat.

I.e. not reaming, retreating, retreated, out of ammo or engaging.

Defined in:

ARMYGROUP

Return value:

#boolean:

If true, group is on a combat ready.

ARMYGROUP:IsCruising()

Check if the group is currently cruising.

Defined in:

ARMYGROUP

Return value:

#boolean:

If true, group cruising.

ARMYGROUP:IsHolding()

Check if the group is currently holding its positon.

Defined in:

ARMYGROUP

Return value:

#boolean:

If true, group was ordered to hold.

ARMYGROUP:IsOnDetour()

Check if the group is currently on a detour.

Defined in:

ARMYGROUP

Return value:

#boolean:

If true, group is on a detour.

ARMYGROUP:New(Group)

Create a new ARMYGROUP class object.

Defined in:

ARMYGROUP

Parameter:

Wrapper.Group#GROUP Group

The group object. Can also be given by its group name as #string.

Return value:

self

ARMYGROUP:OnEventBirth(EventData)

Event function handling the birth of a unit.

Defined in:

ARMYGROUP

Parameter:

Core.Event#EVENTDATA EventData

Event data.

ARMYGROUP:OnEventDead(EventData)

Event function handling the crash of a unit.

Defined in:

ARMYGROUP

Parameter:

Core.Event#EVENTDATA EventData

Event data.

ARMYGROUP:OnEventHit(EventData)

Event function handling when a unit is hit.

Defined in:

ARMYGROUP

Parameter:

Core.Event#EVENTDATA EventData

Event data.

ARMYGROUP:OnEventRemoveUnit(EventData)

Event function handling when a unit is removed from the game.

Defined in:

ARMYGROUP

Parameter:

Core.Event#EVENTDATA EventData

Event data.

ARMYGROUP:SetPatrolAdInfinitum(switch)

Group patrols ad inifintum.

If the last waypoint is reached, it will go to waypoint one and repeat its route.

Defined in:

ARMYGROUP

Parameter:

#boolean switch

If true or nil, patrol until the end of time. If false, go along the waypoints once and stop.

Return value:

self

ARMYGROUP:SetRetreatZones(RetreatZoneSet)

Define a set of possible retreat zones.

Defined in:

ARMYGROUP

Parameter:

Core.Set#SET_ZONE RetreatZoneSet

The retreat zone set. Default is an empty set.

Return value:

self

ARMYGROUP:SwitchFormation(Formation, Permanently, NoRouteUpdate)

Switch to a specific formation.

Defined in:

ARMYGROUP

Parameters:

#number Formation

New formation the group will fly in. Default is the setting of SetDefaultFormation().

#boolean Permanently

If true, formation always used from now on.

#boolean NoRouteUpdate

If true, route is not updated.

Return value:

self

ARMYGROUP:_InitGroup()

Initialize group parameters.

Also initializes waypoints if self.waypoints is nil.

Defined in:

ARMYGROUP

Return value:

self

ARMYGROUP:_UpdateEngageTarget()

Update engage target.

Defined in:

ARMYGROUP

ARMYGROUP:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

Stops the ARMYGROUP and all its event handlers.

Defined in:

ARMYGROUP

Parameter:

#number delay

Delay in seconds.

ARMYGROUP:onafterCruise(From, Event, To, Speed, Formation)

On after "Cruise" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Speed

Speed in knots.

#number Formation

Formation.

ARMYGROUP:onafterDetour(From, Event, To, Coordinate, Speed, Formation, ResumeRoute)

On after "Detour" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Point#COORDINATE Coordinate

Coordinate where to go.

#number Speed

Speed in knots. Default cruise speed.

#number Formation

Formation of the group.

#number ResumeRoute

If true, resume route after detour point was reached. If false, the group will stop at the detour point and wait for futher commands.

ARMYGROUP:onafterDetourReached(From, Event, To)

On after "DetourReached" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterDisengage(From, Event, To)

On after "Disengage" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterElementSpawned(From, Event, To, Element)

On after "ElementSpawned" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#ARMYGROUP.Element Element

The group element.

ARMYGROUP:onafterEngageTarget(From, Event, To, Group, Target)

On after "EngageTarget" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Group#GROUP Group

the group to be engaged.

Target

ARMYGROUP:onafterFullStop(From, Event, To)

On after "FullStop" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterGotoWaypoint(From, Event, To, UID, Speed, Formation)

On after "GotoWaypoint" event.

Group will got to the given waypoint and execute its route from there.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number UID

The goto waypoint unique ID.

#number Speed

(Optional) Speed to waypoint in knots.

#number Formation

(Optional) Formation to waypoint.

ARMYGROUP:onafterRearm(From, Event, To, Coordinate, Formation)

On after "Rearm" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Point#COORDINATE Coordinate

Coordinate where to rearm.

#number Formation

Formation of the group.

ARMYGROUP:onafterRearmed(From, Event, To)

On after "Rearmed" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterRearming(From, Event, To)

On after "Rearming" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterRetreat(From, Event, To, Zone, Formation)

On after "Retreat" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Zone#ZONE_BASE Zone

(Optional) Zone where to retreat. Default is the closest retreat zone.

#number Formation

(Optional) Formation of the group.

ARMYGROUP:onafterRetreated(From, Event, To)

On after "Retreated" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterSpawned(From, Event, To)

On after "Spawned" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterStatus(From, Event, To)

Update status.

Defined in:

ARMYGROUP

Parameters:

From

Event

ARMYGROUP:onafterStop(From, Event, To)

On after "Stop" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterUpdateRoute(From, Event, To, n, Speed, Formation)

On after "UpdateRoute" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number n

Waypoint number. Default is next waypoint.

#number Speed

Speed in knots. Default cruise speed.

#number Formation

Formation of the group.

ARMYGROUP:onbeforeEngageTarget(From, Event, To, Group, Target)

On after "EngageTarget" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Group#GROUP Group

the group to be engaged.

Target

ARMYGROUP:onbeforeRetreat(From, Event, To, Zone, Formation)

On before "Retreat" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Zone#ZONE_BASE Zone

(Optional) Zone where to retreat. Default is the closest retreat zone.

#number Formation

(Optional) Formation of the group.

ARMYGROUP:onbeforeStatus(From, Event, To)

Update status.

Defined in:

ARMYGROUP

Parameters:

From

Event

Field(s)

#boolean ARMYGROUP.adinfinitum

Resume route at first waypoint when final waypoint is reached.

ARMYGROUP.ammo

Group ammo.

#ARMYGROUP.Target ARMYGROUP.engage

Engage target.

#boolean ARMYGROUP.formationPerma

Formation that is used permanently and overrules waypoint formations.

#boolean ARMYGROUP.groupinitialized

Init done.

#boolean ARMYGROUP.isAI

Ground are always AI.

#boolean ARMYGROUP.isAircraft

Define category.

#boolean ARMYGROUP.isArmygroup

Defaults

#boolean ARMYGROUP.isGround

ARMYGROUP.isLateActivated

Is (template) group late activated.

#boolean ARMYGROUP.isMobile

If true, group is mobile.

#boolean ARMYGROUP.isNaval

#boolean ARMYGROUP.isUncontrolled

Ground groups cannot be uncontrolled.

ARMYGROUP.lid

Set some string id for output to DCS.log file.

#boolean ARMYGROUP.passedfinalwp

#boolean ARMYGROUP.retreatOnOutOfAmmo

If true, the group will automatically retreat when out of ammo. Needs a retreat zone!

Core.Set#SET_ZONE ARMYGROUP.retreatZones

Set of retreat zones.

ARMYGROUP.speedMax

Max speed in km/h.

ARMYGROUP.speedWp

Current set speed in m/s.

ARMYGROUP.tacan

ARMYGROUP.template

Get template of group.

ARMYGROUP.timerCheckZone

Start check zone timer.

ARMYGROUP.timerQueueUpdate

Start queue update timer.

#string ARMYGROUP.version

Army Group version.

Function(s)

ARMYGROUP:Activate(delay)

Activate a late activated group.

Defined in:

Parameter:

#number delay

(Optional) Delay in seconds before the group is activated. Default is immediately.

Return value:

self

ARMYGROUP:AddCheckZone(CheckZone)

Add a zone that triggers and event if the group enters or leaves any of the zones.

Defined in:

Parameter:

Core.Zone#ZONE CheckZone

Zone to check.

Return value:

self

ARMYGROUP:AddMission(Mission)

Add mission to queue.

Defined in:

Parameter:

Ops.Auftrag#AUFTRAG Mission

Mission for this group.

Return value:

self

ARMYGROUP:AddTask(task, clock, description, prio, duration)

Add a scheduled task.

Defined in:

Parameters:

#table task

DCS task table structure.

#string clock

Mission time when task is executed. Default in 5 seconds. If argument passed as #number, it defines a relative delay in seconds.

#string description

Brief text describing the task, e.g. "Attack SAM".

#number prio

Priority of the task.

#number duration

Duration before task is cancelled in seconds counted after task started. Default never.

Return value:

The task structure.

ARMYGROUP:AddTaskEnroute(task)

Add an enroute task.

Defined in:

Parameter:

#table task

DCS task table structure.

ARMYGROUP:AddTaskWaypoint(task, Waypoint, description, prio, duration)

Add a waypoint task.

Defined in:

Parameters:

#table task

DCS task table structure.

#OPSGROUP.Waypoint Waypoint

where the task is executed. Default is the at next waypoint.

#string description

Brief text describing the task, e.g. "Attack SAM".

#number prio

Priority of the task. Number between 1 and 100. Default is 50.

#number duration

Duration before task is cancelled in seconds counted after task started. Default never.

Return value:

The task structure.

ARMYGROUP:AddWeaponRange(RangeMin, RangeMax, BitType)

Add a weapon range for ARTY auftrag.

Defined in:

Parameters:

#number RangeMin

Minimum range in nautical miles. Default 0 NM.

#number RangeMax

Maximum range in nautical miles. Default 10 NM.

#number BitType

Bit mask of weapon type for which the given min/max ranges apply. Default is ENUMS.WeaponFlag.Auto, i.e. for all weapon types.

Return value:

self

ARMYGROUP:CheckTaskDescriptionUnique(description)

Check if task description is unique.

Defined in:

Parameter:

#string description

Task destription

Return value:

#boolean:

If true, no other task has the same description.

ARMYGROUP:ClearTasks(DCSTask)

Clear DCS tasks.

Defined in:

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

ARMYGROUP:CountRemainingMissison()

Count remaining missons.

Defined in:

Return value:

#number:

Number of missions to be done.

ARMYGROUP:CountRemainingTasks()

Count the number of tasks that still pending in the queue.

Defined in:

Return values:

#number:

Total number of tasks remaining.

#number:

Number of SCHEDULED tasks remaining.

#number:

Number of WAYPOINT tasks remaining.

ARMYGROUP:CountTasksWaypoint(uid, id)

Count remaining waypoint tasks.

Defined in:

Parameters:

#number uid

Unique waypoint ID.

Return value:

#number:

Number of waypoint tasks.

ARMYGROUP:Despawn(Delay, NoEventRemoveUnit)

Despawn the group.

The whole group is despawned and (optionally) a "Remove Unit" event is generated for all current units of the group.

Defined in:

Parameters:

#number Delay

Delay in seconds before the group will be despawned. Default immediately.

#boolean NoEventRemoveUnit

If true, no event "Remove Unit" is generated.

Return value:

self

ARMYGROUP:DespawnElement(Element, Delay, NoEventRemoveUnit)

Despawn an element/unit of the group.

Defined in:

Parameters:

#OPSGROUP.Element Element

The element that will be despawned.

#number Delay

Delay in seconds before the element will be despawned. Default immediately.

#boolean NoEventRemoveUnit

If true, no event "Remove Unit" is generated.

Return value:

self

ARMYGROUP:Destroy(Delay)

Destroy group.

The whole group is despawned and a Unit Lost for aircraft or Dead event for ground/naval units is generated for all current units.

Defined in:

Parameter:

#number Delay

Delay in seconds before the group will be destroyed. Default immediately.

Return value:

self

ARMYGROUP:GetAlarmstate()

Get current Alarm State of the group.

Defined in:

Return value:

#number:

Current Alarm State.

ARMYGROUP:GetAmmo0()

Get inital amount of ammunition.

Defined in:

Return value:

Initial ammo table.

ARMYGROUP:GetAmmoElement(element)

Get the number of shells a unit or group currently has.

For a group the ammo count of all units is summed up.

Defined in:

Parameter:

#OPSGROUP.Element element

The element.

Return value:

Ammo data.

ARMYGROUP:GetAmmoTot()

Get total amount of ammunition of the whole group.

Defined in:

Return value:

Ammo data.

ARMYGROUP:GetAmmoUnit(unit, display)

Get the number of shells a unit or group currently has.

For a group the ammo count of all units is summed up.

Defined in:

Parameters:

Wrapper.Unit#UNIT unit

The unit object.

#boolean display

Display ammo table as message to all. Default false.

Return value:

Ammo data.

ARMYGROUP:GetCoalition()

Get coalition.

Defined in:

Return value:

#number:

Coalition side of carrier.

ARMYGROUP:GetCoordinate(NewObject)

Get current coordinate of the group.

Defined in:

Parameter:

#boolean NewObject

Create a new coordiante object.

Return value:

The coordinate (of the first unit) of the group.

ARMYGROUP:GetDCSGroup()

Get DCS GROUP object.

Defined in:

Return value:

DCS#Group:

DCS group object.

ARMYGROUP:GetDCSUnit(UnitNumber)

Get DCS GROUP object.

Defined in:

Parameter:

#number UnitNumber

Number of the unit in the group. Default first unit.

Return value:

DCS#Unit:

DCS group object.

ARMYGROUP:GetDCSUnits()

Get DCS units.

Defined in:

Return value:

#list<DCS#Unit>:

DCS units.

ARMYGROUP:GetDetectedGroups()

Get set of detected groups.

Defined in:

Return value:

Core.Set#SET_GROUP:

Set of detected groups.

ARMYGROUP:GetDetectedUnits()

Get set of detected units.

Defined in:

Return value:

Core.Set#SET_UNIT:

Set of detected units.

ARMYGROUP:GetDistanceToWaypoint(indx)

Get distance to waypoint.

Defined in:

Parameter:

#number indx

Waypoint index. Default is the next waypoint.

Return value:

#number:

Distance in meters.

ARMYGROUP:GetElementAlive()

Get the first element of a group, which is alive.

Defined in:

Return value:

#OPSGROUP.Element:

The element or #nil if no element is alive any more.

ARMYGROUP:GetElementByName(unitname)

Get the element of a group.

Defined in:

Parameter:

#string unitname

Name of unit.

Return value:

#OPSGROUP.Element:

The element.

ARMYGROUP:GetExpectedSpeed()

Returns the currently expected speed.

Defined in:

Return value:

#number:

Expected speed in m/s.

ARMYGROUP:GetGroup()

Get MOOSE GROUP object.

Defined in:

Return value:

Wrapper.Group#GROUP:

Moose group object.

ARMYGROUP:GetHeading()

Get current heading of the group.

Defined in:

Return value:

#number:

Current heading of the group in degrees.

ARMYGROUP:GetHighestThreat()

Get highest threat.

Defined in:

Return values:

Wrapper.Unit#UNIT:

The highest threat unit.

#number:

Threat level of the unit.

ARMYGROUP:GetLaserCode()

Get LASER code.

Defined in:

Return value:

#number:

Current Laser code.

ARMYGROUP:GetLaserCoordinate()

Get current LASER coordinate, i.e.

where the beam is pointing at if the LASER is on.

Defined in:

Return value:

Current position where the LASER is pointing at.

ARMYGROUP:GetLaserTarget()

Get current target of the LASER.

This can be a STATIC or UNIT object.

Defined in:

Wrapper.Positionable#POSITIONABLE:

Return value:

Current target object.

ARMYGROUP:GetLifePoints()

Returns the absolute (average) life points of the group.

Defined in:

Return values:

#number:

Life points. If group contains more than one element, the average is given.

#number:

Initial life points.

ARMYGROUP:GetMissionByID(id)

Get mission by its id (auftragsnummer).

Defined in:

Parameter:

#number id

Mission id (auftragsnummer).

Return value:

The mission.

ARMYGROUP:GetMissionByTaskID(taskid)

Get mission by its task id.

Defined in:

Parameter:

#number taskid

The id of the (waypoint) task of the mission.

Return value:

The mission.

ARMYGROUP:GetMissionCurrent()

Get current mission.

Defined in:

Return value:

The current mission or nil.

ARMYGROUP:GetName()

Get the group name.

Defined in:

Return value:

#string:

Group name.

ARMYGROUP:GetNelements(status)

Get number of elements alive.

Defined in:

Parameter:

#string status

(Optional) Only count number, which are in a special status.

Return value:

#number:

Number of elements.

ARMYGROUP:GetNextWaypointCoordinate(cyclic)

Get coordinate of next waypoint of the group.

Defined in:

Parameter:

#boolean cyclic

If true, return first waypoint if last waypoint was reached.

Return value:

Coordinate of the next waypoint.

ARMYGROUP:GetOrientation()

Get current orientation of the first unit in the group.

Defined in:

Return values:

Orientation X parallel to where the "nose" is pointing.

Orientation Y pointing "upwards".

Orientation Z perpendicular to the "nose".

ARMYGROUP:GetOrientationX()

Get current orientation of the first unit in the group.

Defined in:

Return value:

Orientation X parallel to where the "nose" is pointing.

ARMYGROUP:GetROE()

Get current ROE of the group.

Defined in:

Return value:

#number:

Current ROE.

ARMYGROUP:GetROT()

Get current ROT of the group.

Defined in:

Return value:

#number:

Current ROT.

ARMYGROUP:GetRadio()

Get current Radio frequency and modulation.

Defined in:

Return values:

#number:

Radio frequency in MHz or nil.

#number:

Radio modulation or nil.

#boolean:

If true, the radio is on. Otherwise, radio is turned off.

ARMYGROUP:GetSpeedCruise()

Get default cruise speed.

Defined in:

Return value:

#number:

Cruise speed (>0) in knots.

ARMYGROUP:GetSpeedToWaypoint(indx)

Returns a non-zero speed to the next waypoint (even if the waypoint speed is zero).

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Speed to next waypoint (>0) in knots.

ARMYGROUP:GetTACAN()

Get current TACAN parameters.

Defined in:

Return values:

#number:

TACAN channel.

#string:

TACAN Morse code.

#string:

TACAN band ("X" or "Y").

#boolean:

TACAN is On (true) or Off (false).

#string:

UnitName Name of the unit acting as beacon.

ARMYGROUP:GetTaskByID(id, status)

Get task by its id.

Defined in:

Parameters:

#number id

Task id.

#string status

(Optional) Only return tasks with this status, e.g. OPSGROUP.TaskStatus.SCHEDULED.

Return value:

The task or nil.

ARMYGROUP:GetTaskCurrent()

Get the currently executed task if there is any.

Defined in:

Return value:

Current task or nil.

ARMYGROUP:GetTasksWaypoint(id)

Get the unfinished waypoint tasks

Defined in:

Parameter:

#number id

Unique waypoint ID.

Return value:

#table:

Table of tasks. Table could also be empty {}.

ARMYGROUP:GetThreat(ThreatLevelMin, ThreatLevelMax)

Get highest detected threat.

Detection must be turned on. The threat level is a number between 0 and 10, where 0 is the lowest, e.g. unarmed units.

Defined in:

Parameters:

#number ThreatLevelMin

Only consider threats with level greater or equal to this number. Default 1 (so unarmed units wont be considered).

#number ThreatLevelMax

Only consider threats with level smaller or queal to this number. Default 10.

Return values:

Wrapper.Unit#UNIT:

Highest threat unit detected by the group or nil if no threat is currently detected.

#number:

Threat level.

ARMYGROUP:GetTimeToWaypoint(indx)

Get time to waypoint based on current velocity.

Defined in:

Parameter:

#number indx

Waypoint index. Default is the next waypoint.

Return value:

#number:

Time in seconds. If velocity is 0

ARMYGROUP:GetUnit(UnitNumber)

Get MOOSE UNIT object.

Defined in:

Parameter:

#number UnitNumber

Number of the unit in the group. Default first unit.

Return value:

Wrapper.Unit#UNIT:

The MOOSE UNIT object.

ARMYGROUP:GetVec2()

Get current 2D position vector of the group.

Defined in:

Return value:

DCS#Vec2:

Vector with x,y components.

ARMYGROUP:GetVec3()

Get current 3D position vector of the group.

Defined in:

Return value:

Vector with x,y,z components.

ARMYGROUP:GetVelocity()

Get current velocity of the group.

Defined in:

Return value:

#number:

Velocity in m/s.

ARMYGROUP:GetWaypoint(indx)

Get waypoint.

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

Waypoint table.

ARMYGROUP:GetWaypointByID(uid)

Get the waypoint from its unique ID.

Defined in:

Parameter:

#number uid

Waypoint unique ID.

Return value:

Waypoint data.

ARMYGROUP:GetWaypointByIndex(index)

Get the waypoint from its index.

Defined in:

Parameter:

#number index

Waypoint index.

Return value:

Waypoint data.

ARMYGROUP:GetWaypointCoordinate(index)

Get waypoint coordinates.

Defined in:

Parameter:

#number index

Waypoint index.

Return value:

Coordinate of the next waypoint.

ARMYGROUP:GetWaypointCurrent()

Get current waypoint.

Defined in:

Return value:

Current waypoint table.

ARMYGROUP:GetWaypointFinal()

Get final waypoint.

Defined in:

Return value:

Final waypoint table.

ARMYGROUP:GetWaypointID(indx)

Get unique ID of waypoint given its index.

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Unique ID.

ARMYGROUP:GetWaypointIndex(uid)

Get the waypoint index (its position in the current waypoints table).

Defined in:

Parameter:

#number uid

Waypoint unique ID.

Return value:

Waypoint data.

ARMYGROUP:GetWaypointIndexAfterID(uid)

Get waypoint index after waypoint with given ID.

So if the waypoint has index 3 it will return 4.

Defined in:

Parameter:

#number uid

Unique ID of the waypoint. Default is new waypoint index after the last current one.

Return value:

#number:

Index after waypoint with given ID.

ARMYGROUP:GetWaypointIndexCurrent()

Get current waypoint index.

This is the index of the last passed waypoint.

Defined in:

Return value:

#number:

Current waypoint index.

ARMYGROUP:GetWaypointIndexNext(cyclic, i)

Get next waypoint index.

Defined in:

Parameters:

#boolean cyclic

If true, return first waypoint if last waypoint was reached. Default is patrol ad infinitum value set.

#number i

Waypoint index from which the next index is returned. Default is the last waypoint passed.

Return value:

#number:

Next waypoint index.

ARMYGROUP:GetWaypointNext(cyclic)

Get next waypoint.

Defined in:

Parameter:

#boolean cyclic

If true, return first waypoint if last waypoint was reached.

Return value:

Next waypoint table.

ARMYGROUP:GetWaypointSpeed(indx)

Get waypoint speed.

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Speed set at waypoint in knots.

ARMYGROUP:GetWaypointUID(waypoint)

Get unique ID of waypoint.

Defined in:

Parameter:

#OPSGROUP.Waypoint waypoint

The waypoint data table.

Return value:

#number:

Unique ID.

ARMYGROUP:GetWaypointUIDFromIndex(index)

Get the waypoint UID from its index, i.e.

its current position in the waypoints table.

Defined in:

Parameter:

#number index

Waypoint index.

Return value:

#number:

Unique waypoint ID.

ARMYGROUP:GetWaypoints()

Get the waypoints.

Defined in:

Return value:

#table:

Table of all waypoints.

ARMYGROUP:GetWeaponData(BitType)

Get weapon data.

Defined in:

Parameter:

#number BitType

Type of weapon.

Return value:

#OPSGROUP.WeaponData:

Weapon range data.

ARMYGROUP:HasLoS(Coordinate, Element, OffsetElement, OffsetCoordinate)

Check if an element of the group has line of sight to a coordinate.

Defined in:

Parameters:

Core.Point#COORDINATE Coordinate

The position to which we check the LoS.

#OPSGROUP.Element Element

The (optinal) element. If not given, all elements are checked.

DCS#Vec3 OffsetElement

Offset vector of the element.

DCS#Vec3 OffsetCoordinate

Offset vector of the coordinate.

Return value:

#boolean:

If true, there is line of sight to the specified coordinate.

ARMYGROUP:HasPassedFinalWaypoint()

Check if this group has passed its final waypoint.

Defined in:

Return value:

#boolean:

If true, this group has passed the final waypoint.

ARMYGROUP:InitWaypoints()

Initialize Mission Editor waypoints.

Defined in:

Return value:

self

ARMYGROUP:IsActive()

Check if group is activated.

Defined in:

Return value:

#boolean:

If true, the group exists or false if the group does not exist. If nil, the DCS group could not be found.

ARMYGROUP:IsAlive()

Check if group is alive.

Defined in:

Return value:

#boolean:

true if group is exists and is activated, false if group is exist but is NOT activated. nil otherwise, e.g. the GROUP object is nil or the group is not spawned yet.

ARMYGROUP:IsDead()

Check if group is dead.

Defined in:

Return value:

#boolean:

If true, all units/elements of the group are dead.

ARMYGROUP:IsEngaging()

Check if the group is engaging another unit or group.

Defined in:

Return value:

#boolean:

If true, group is engaging.

ARMYGROUP:IsExist()

Check if group is exists.

Defined in:

Return value:

#boolean:

If true, the group exists or false if the group does not exist. If nil, the DCS group could not be found.

ARMYGROUP:IsInUtero()

Check if group is in state in utero.

Defined in:

Return value:

#boolean:

If true, group is not spawned yet.

ARMYGROUP:IsLasing()

Check if the group has currently switched a LASER on.

Defined in:

Return value:

#boolean:

If true, LASER of the group is on.

ARMYGROUP:IsLateActivated()

Check if this group is currently "late activated" and needs to be "activated" to appear in the mission.

Defined in:

Return value:

#boolean:

Is this the group late activated?

ARMYGROUP:IsRearming()

Check if the group is currently rearming.

Defined in:

Return value:

#boolean:

If true, group is rearming.

ARMYGROUP:IsRetreating()

Check if the group is currently retreating.

Defined in:

Return value:

#boolean:

If true, group is retreating.

ARMYGROUP:IsSpawned()

Check if group is in state spawned.

Defined in:

Return value:

#boolean:

If true, group is spawned.

ARMYGROUP:IsStopped()

Check if FSM is stopped.

Defined in:

Return value:

#boolean:

If true, FSM state is stopped.

ARMYGROUP:IsUncontrolled()

Check if this group is currently "uncontrolled" and needs to be "started" to begin its route.

Defined in:

Return value:

#boolean:

If true, this group uncontrolled.

ARMYGROUP:MarkWaypoints(Duration)

Mark waypoints on F10 map.

Defined in:

Parameter:

#number Duration

Duration in seconds how long the waypoints are displayed before they are automatically removed. Default is that they are never removed.

Return value:

self

ARMYGROUP:New(Group)

Create a new OPSGROUP class object.

Defined in:

Parameter:

Wrapper.Group#GROUP Group

The group object. Can also be given by its group name as #string.

Return value:

self

ARMYGROUP:NewTaskScheduled(task, clock, description, prio, duration)

Create a scheduled task.

Defined in:

Parameters:

#table task

DCS task table structure.

#string clock

Mission time when task is executed. Default in 5 seconds. If argument passed as #number, it defines a relative delay in seconds.

#string description

Brief text describing the task, e.g. "Attack SAM".

#number prio

Priority of the task.

#number duration

Duration before task is cancelled in seconds counted after task started. Default never.

Return value:

The task structure.

ARMYGROUP:PushTask(DCSTask)

Push DCS task.

Defined in:

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

ARMYGROUP:RemoveMission(Mission)

Remove mission from queue.

Defined in:

Parameter:

Ops.Auftrag#AUFTRAG Mission

Mission to be removed.

Return value:

self

ARMYGROUP:RemoveTask(Task)

Remove task from task queue.

Defined in:

Parameter:

#OPSGROUP.Task Task

The task to be removed from the queue.

Return value:

#boolean:

True if task could be removed.

ARMYGROUP:RemoveWaypoint(wpindex)

Remove a waypoint.

Defined in:

Parameter:

#number wpindex

Waypoint number.

Return value:

self

ARMYGROUP:RemoveWaypointByID(uid)

Remove a waypoint with a ceratin UID.

Defined in:

Parameter:

#number uid

Waypoint UID.

Return value:

self

ARMYGROUP:RemoveWaypointMarkers(Delay)

Remove waypoints markers on the F10 map.

Defined in:

Parameter:

#number Delay

Delay in seconds before the markers are removed. Default is immediately.

Return value:

self

ARMYGROUP:Route(waypoints, delay)

Route group along waypoints.

Defined in:

Parameters:

#table waypoints

Table of waypoints.

#number delay

Delay in seconds.

Return value:

self

ARMYGROUP:RouteToMission(mission, delay)

Route group to mission.

Defined in:

Parameters:

Ops.Auftrag#AUFTRAG mission

The mission table.

#number delay

Delay in seconds.

ARMYGROUP:SelfDestruction(Delay, ExplosionPower)

Self destruction of group.

An explosion is created at the position of each element.

Defined in:

Parameters:

#number Delay

Delay in seconds. Default now.

#number ExplosionPower

(Optional) Explosion power in kg TNT. Default 500 kg.

Return value:

#number:

Relative fuel in percent.

ARMYGROUP:SetCheckZones(CheckZonesSet)

Define a SET of zones that trigger and event if the group enters or leaves any of the zones.

Defined in:

Parameter:

Core.Set#SET_ZONE CheckZonesSet

Set of zones.

Return value:

self

ARMYGROUP:SetDefaultAlarmstate(alarmstate)

Set the default Alarm State for the group.

This is the state gets when the group is spawned or to which it defaults back after a mission.

Defined in:

Parameter:

#number alarmstate

Alarm state of group. Default is AI.Option.Ground.val.ALARM_STATE.AUTO (0).

Return value:

self

ARMYGROUP:SetDefaultCallsign(CallsignName, CallsignNumber)

Set default callsign.

Defined in:

Parameters:

#number CallsignName

Callsign name.

#number CallsignNumber

Callsign number.

Return value:

self

ARMYGROUP:SetDefaultFormation(Formation)

Set default formation.

Defined in:

Parameter:

#number Formation

The formation the groups flies in.

Return value:

self

ARMYGROUP:SetDefaultICLS(Channel, Morse, UnitName, OffSwitch)

Set default ICLS parameters.

Defined in:

Parameters:

#number Channel

ICLS channel. Default is 1.

#string Morse

Morse code. Default "XXX".

#string UnitName

Name of the unit acting as beacon.

#boolean OffSwitch

If true, TACAN is off by default.

Return value:

self

ARMYGROUP:SetDefaultROE(roe)

Set the default ROE for the group.

This is the ROE state gets when the group is spawned or to which it defaults back after a mission.

Defined in:

Parameter:

#number roe

ROE of group. Default is ENUMS.ROE.ReturnFire.

Return value:

self

ARMYGROUP:SetDefaultROT(rot)

Set the default ROT for the group.

This is the ROT state gets when the group is spawned or to which it defaults back after a mission.

Defined in:

Parameter:

#number rot

ROT of group. Default is ENUMS.ROT.PassiveDefense.

Return value:

self

ARMYGROUP:SetDefaultRadio(Frequency, Modulation, OffSwitch)

Set default Radio frequency and modulation.

Defined in:

Parameters:

#number Frequency

Radio frequency in MHz. Default 251 MHz.

#number Modulation

Radio modulation. Default radio.Modulation.AM.

#boolean OffSwitch

If true, radio is OFF by default.

Return value:

self

ARMYGROUP:SetDefaultSpeed(Speed)

Set default cruise speed.

Defined in:

Parameter:

#number Speed

Speed in knots.

Return value:

self

ARMYGROUP:SetDefaultTACAN(Channel, Morse, UnitName, Band, OffSwitch)

Set default TACAN parameters.

Defined in:

Parameters:

#number Channel

TACAN channel. Default is 74.

#string Morse

Morse code. Default "XXX".

#string UnitName

Name of the unit acting as beacon.

#string Band

TACAN mode. Default is "X" for ground and "Y" for airborne units.

#boolean OffSwitch

If true, TACAN is off by default.

Return value:

self

ARMYGROUP:SetDetection(Switch)

Set detection on or off.

If detection is on, detected targets of the group will be evaluated and FSM events triggered.

Defined in:

Parameter:

#boolean Switch

If true, detection is on. If false or nil, detection is off. Default is off.

Return value:

self

ARMYGROUP:SetLaser(Code, CheckLOS, IROff, UpdateTime)

Set LASER parameters.

Defined in:

Parameters:

#number Code

Laser code. Default 1688.

#boolean CheckLOS

Check if lasing unit has line of sight to target coordinate. Default is true.

#boolean IROff

If true, then dont switch on the additional IR pointer.

#number UpdateTime

Time interval in seconds the beam gets up for moving targets. Default every 0.5 sec.

Return value:

self

ARMYGROUP:SetLaserTarget(Target)

Set LASER target.

Defined in:

Parameter:

Wrapper.Positionable#POSITIONABLE Target

The target to lase. Can also be a COORDINATE object.

ARMYGROUP:SetTask(DCSTask)

Set DCS task.

Enroute tasks are injected automatically.

Defined in:

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

ARMYGROUP:SetVerbosity(VerbosityLevel)

Set verbosity level.

Defined in:

Parameter:

#number VerbosityLevel

Level of output (higher=more). Default 0.

Return value:

self

ARMYGROUP:Status()

Triggers the FSM event "Status".

Defined in:

ARMYGROUP:SwitchAlarmstate(alarmstate)

Set current Alarm State of the group.

0 = "Auto"
1 = "Green"
2 = "Red"

Defined in:

Parameter:

#number alarmstate

Alarm state of group. Default is 0="Auto".

Return value:

self

ARMYGROUP:SwitchCallsign(CallsignName, CallsignNumber)

Switch to a specific callsign.

Defined in:

Parameters:

#number CallsignName

Callsign name.

#number CallsignNumber

Callsign number.

Return value:

self

ARMYGROUP:SwitchFormation(Formation)

Switch to a specific formation.

Defined in:

Parameter:

#number Formation

New formation the group will fly in. Default is the setting of SetDefaultFormation().

Return value:

self

ARMYGROUP:SwitchICLS(Channel, Morse, UnitName)

Activate/switch ICLS beacon settings.

Defined in:

Parameters:

#number Channel

ICLS Channel. Default is what is set in SetDefaultICLS() so usually channel 1.

#string Morse

ICLS morse code. Default is what is set in SetDefaultICLS() so usually "XXX".

#string UnitName

Name of the unit in the group which should activate the ICLS beacon. Can also be given as #number to specify the unit number. Default is the first unit of the group.

Return value:

self

ARMYGROUP:SwitchROE(roe)

Set current ROE for the group.

Defined in:

Parameter:

#string roe

ROE of group. Default is value set in SetDefaultROE (usually ENUMS.ROE.ReturnFire).

Return value:

self

ARMYGROUP:SwitchROT(rot)

Set ROT for the group.

Defined in:

Parameter:

#string rot

ROT of group. Default is value set in :SetDefaultROT (usually ENUMS.ROT.PassiveDefense).

Return value:

self

ARMYGROUP:SwitchRadio(Frequency, Modulation)

Turn radio on or switch frequency/modulation.

Defined in:

Parameters:

#number Frequency

Radio frequency in MHz. Default is value set in SetDefaultRadio (usually 251 MHz).

#number Modulation

Radio modulation. Default is value set in SetDefaultRadio (usually radio.Modulation.AM).

Return value:

self

ARMYGROUP:SwitchTACAN(Channel, Morse, UnitName, Band)

Activate/switch TACAN beacon settings.

Defined in:

Parameters:

#number Channel

TACAN Channel.

#string Morse

TACAN morse code. Default is the value set in OPSGROUP.SetDefaultTACAN or if not set "XXX".

#string UnitName

Name of the unit in the group which should activate the TACAN beacon. Can also be given as #number to specify the unit number. Default is the first unit of the group.

#string Band

TACAN channel mode "X" or "Y". Default is "Y" for aircraft and "X" for ground and naval groups.

Return value:

self

ARMYGROUP:TurnOffICLS()

Deactivate ICLS beacon.

Defined in:

Return value:

self

ARMYGROUP:TurnOffRadio()

Turn radio off.

Defined in:

Return value:

self

ARMYGROUP:TurnOffTACAN()

Deactivate TACAN beacon.

Defined in:

Return value:

self

ARMYGROUP:_AddWaypoint(waypoint, wpnumber)

Initialize Mission Editor waypoints.

Defined in:

Parameters:

#OPSGROUP.Waypoint waypoint

Waypoint data.

#number wpnumber

Waypoint index/number. Default is as last waypoint.

ARMYGROUP:_AllSameStatus(unitname, status)

Check if all elements of the group have the same status (or are dead).

Defined in:

Parameters:

#string unitname

Name of unit.

status

ARMYGROUP:_AllSimilarStatus(status)

Check if all elements of the group have the same status (or are dead).

Defined in:

Parameter:

#string status

Status to check.

Return value:

#boolean:

If true, all elements have a similar status.

ARMYGROUP:_CheckAmmoFull()

Check ammo is full.

Defined in:

Return value:

#boolean:

If true, ammo is full.

ARMYGROUP:_CheckAmmoStatus()

Check ammo status.

Defined in:

ARMYGROUP:_CheckDamage()

Check damage.

Defined in:

Return value:

self

ARMYGROUP:_CheckDetectedUnits()

Check detected units.

Defined in:

ARMYGROUP:_CheckGroupDone(delay)

Check if passed the final waypoint and, if necessary, update route.

Defined in:

Parameter:

#number delay

Delay in seconds.

ARMYGROUP:_CheckInZones()

Check if group is in zones.

Defined in:

ARMYGROUP:_CheckStuck()

Check if group got stuck.

Defined in:

ARMYGROUP:_CoordinateFromObject(Object)

Get coordinate from an object.

Defined in:

Parameter:

Wrapper.Object#OBJECT Object

The object.

Return value:

The coordinate of the object.

ARMYGROUP:_CreateWaypoint(Waypoint, waypoint)

Enhance waypoint table.

Defined in:

Parameters:

#OPSGROUP.Waypoint Waypoint

data.

waypoint

Return value:

Modified waypoint data.

ARMYGROUP:_GetNextMission()

Get next mission.

Defined in:

Return value:

Next mission or nil.

ARMYGROUP:_GetNextTask()

Get next task in queue.

Task needs to be in state SCHEDULED and time must have passed.

Defined in:

Return value:

The next task in line or nil.

ARMYGROUP:_GetROEName(roe)

Get name of ROE corresponding to the numerical value.

Defined in:

Parameter:

roe

Return value:

#string:

Name of ROE.

ARMYGROUP:_MissileCategoryName(categorynumber)

Returns a name of a missile category.

Defined in:

Parameter:

#number categorynumber

Number of missile category from weapon missile category enumerator. See https://wiki.hoggitworld.com/view/DCS_Class_Weapon

Return value:

#string:

Missile category name.

ARMYGROUP._PassingWaypoint(group, opsgroup, uid)

Function called when a group is passing a waypoint.

Defined in:

Parameters:

Wrapper.Group#GROUP group

Group that passed the waypoint.

#OPSGROUP opsgroup

Ops group object.

#number uid

Waypoint UID.

ARMYGROUP:_PrintTaskAndMissionStatus()

Print info on mission and task status to DCS log file.

Defined in:

ARMYGROUP:_QueueUpdate()

On after "QueueUpdate" event.

Defined in:

ARMYGROUP:_SetElementStatusAll(status)

Set status for all elements (except dead ones).

Defined in:

Parameter:

#string status

Element status.

ARMYGROUP:_SetWaypointTasks(Waypoint)

Set tasks at this waypoint

Defined in:

Parameter:

#OPSGROUP.Waypoint Waypoint

The waypoint.

Return value:

#number:

Number of tasks.

ARMYGROUP:_SortTaskQueue()

Sort task queue.

Defined in:

ARMYGROUP:_SwitchICLS(Icls)

Activate/switch ICLS beacon settings.

Defined in:

Parameter:

#OPSGROUP.Beacon Icls

ICLS data table.

Return value:

self

ARMYGROUP:_SwitchTACAN(Tacan)

Activate/switch TACAN beacon settings.

Defined in:

Parameter:

#OPSGROUP.Beacon Tacan

TACAN data table. Default is the default TACAN settings.

Return value:

self

ARMYGROUP._TaskDone(group, opsgroup, task)

Function called when a task is done.

Defined in:

Parameters:

Wrapper.Group#GROUP group

Group for which the task is done.

#OPSGROUP opsgroup

Ops group.

#OPSGROUP.Task task

Task.

ARMYGROUP._TaskExecute(group, opsgroup, task)

Function called when a task is executed.

Defined in:

Parameters:

Wrapper.Group#GROUP group

Group which should execute the task.

#OPSGROUP opsgroup

Ops group.

#OPSGROUP.Task task

Task.

ARMYGROUP:_UpdateLaser()

Update laser point.

Defined in:

ARMYGROUP:_UpdatePosition()

Check if all elements of the group have the same status (or are dead).

Defined in:

Return value:

self

ARMYGROUP:_UpdateStatus(element, newstatus, airbase)

Check if all elements of the group have the same status or are dead.

Defined in:

Parameters:

#OPSGROUP.Element element

Element.

#string newstatus

New status of element

Wrapper.Airbase#AIRBASE airbase

Airbase if applicable.

ARMYGROUP:_UpdateWaypointTasks(n)

Initialize Mission Editor waypoints.

Defined in:

Parameter:

#number n

Waypoint

ARMYGROUP:__Status(delay)

Triggers the FSM event "Status" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

ARMYGROUP:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

Stops the OPSGROUP and all its event handlers.

Defined in:

Parameter:

#number delay

Delay in seconds.

ARMYGROUP:onafterDead(From, Event, To)

On after "Dead" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterDetectedGroup(From, Event, To, Group)

On after "DetectedGroup" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Group#GROUP Group

The detected Group.

ARMYGROUP:onafterDetectedGroupNew(From, Event, To, Group)

On after "DetectedGroupNew" event.

Add newly detected group to detected group set.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Group#GROUP Group

The detected group.

ARMYGROUP:onafterDetectedUnit(From, Event, To, Unit)

On after "DetectedUnit" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Unit#UNIT Unit

The detected unit.

ARMYGROUP:onafterDetectedUnitNew(From, Event, To, Unit)

On after "DetectedUnitNew" event.

Add newly detected unit to detected unit set.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Unit#UNIT Unit

The detected unit.

ARMYGROUP:onafterElementDead(From, Event, To, Element)

On after "ElementDead" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP.Element Element

The flight group element.

ARMYGROUP:onafterElementDestroyed(From, Event, To, Element)

On after "ElementDestroyed" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP.Element Element

The flight group element.

ARMYGROUP:onafterEnterZone(From, Event, To, Zone)

On after "EnterZone" event.

Sets self.inzones[zonename]=true.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Zone#ZONE Zone

The zone that the group entered.

ARMYGROUP:onafterGotoWaypoint(From, Event, To, UID)

On after "GotoWaypoint" event.

Group will got to the given waypoint and execute its route from there.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number UID

The goto waypoint unique ID.

ARMYGROUP:onafterLaserCode(From, Event, To, Code)

On after "LaserCode" event.

Changes the LASER code.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Code

Laser code. Default is 1688.

ARMYGROUP:onafterLaserGotLOS(From, Event, To)

On after "LaserGotLOS" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterLaserLostLOS(From, Event, To)

On after "LaserLostLOS" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterLaserOff(From, Event, To)

On after "LaserOff" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterLaserOn(From, Event, To, Target)

On after "LaserOn" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Point#COORDINATE Target

Target Coordinate. Target can also be any POSITIONABLE from which we can obtain its coordinates.

ARMYGROUP:onafterLaserPause(From, Event, To)

On after "LaserPause" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterLaserResume(From, Event, To)

On after "LaserResume" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterLeaveZone(From, Event, To, Zone)

On after "LeaveZone" event.

Sets self.inzones[zonename]=false.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Zone#ZONE Zone

The zone that the group entered.

ARMYGROUP:onafterMissionCancel(From, Event, To, Mission)

On after "MissionCancel" event.

Cancels the mission.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Auftrag#AUFTRAG Mission

The mission to be cancelled.

ARMYGROUP:onafterMissionDone(From, Event, To, Mission)

On after "MissionDone" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Auftrag#AUFTRAG Mission

ARMYGROUP:onafterMissionExecute(From, Event, To, Mission)

On after "MissionExecute" event.

Mission execution began.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Auftrag#AUFTRAG Mission

The mission table.

ARMYGROUP:onafterMissionStart(From, Event, To, Mission)

On after "MissionStart" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Auftrag#AUFTRAG Mission

The mission table.

ARMYGROUP:onafterPassingWaypoint(From, Event, To, Waypoint)

On after "PassingWaypoint" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP.Waypoint Waypoint

Waypoint data passed.

ARMYGROUP:onafterPauseMission(From, Event, To)

On after "PauseMission" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterStop(From, Event, To)

On after "Stop" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onafterTaskCancel(From, Event, To, Task)

On after "TaskCancel" event.

Cancels the current task or simply sets the status to DONE if the task is not the current one.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP.Task Task

The task to cancel. Default is the current task (if any).

ARMYGROUP:onafterTaskDone(From, Event, To, Task)

On after "TaskDone" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP.Task Task

ARMYGROUP:onafterTaskExecute(From, Event, To, Task)

On after "TaskExecute" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsGroup#OPSGROUP.Task Task

The task.

ARMYGROUP:onafterUnpauseMission(From, Event, To)

On after "UnpauseMission" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onbeforeDead(From, Event, To)

On before "Dead" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onbeforeLaserOff(From, Event, To)

On before "LaserOff" event.

Check if LASER is on.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onbeforeLaserOn(From, Event, To, Target)

On before "LaserOn" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Point#COORDINATE Target

Target Coordinate. Target can also be any POSITIONABLE from which we can obtain its coordinates.

ARMYGROUP:onbeforeLaserResume(From, Event, To)

On before "LaserResume" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

ARMYGROUP:onbeforeMissionStart(From, Event, To, Mission)

On before "MissionStart" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Auftrag#AUFTRAG Mission

The mission table.

ARMYGROUP:onbeforeTaskDone(From, Event, To, Task)

On before "TaskDone" event.

Deny transition if task status is PAUSED.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP.Task Task

Field(s)

#boolean ARMYGROUP.adinfinitum

Resume route at first waypoint when final waypoint is reached.

ARMYGROUP.ammo

Group ammo.

#ARMYGROUP.Target ARMYGROUP.engage

Engage target.

#boolean ARMYGROUP.formationPerma

Formation that is used permanently and overrules waypoint formations.

#boolean ARMYGROUP.groupinitialized

Init done.

#boolean ARMYGROUP.isAI

Ground are always AI.

#boolean ARMYGROUP.isAircraft

Define category.

#boolean ARMYGROUP.isArmygroup

Defaults

#boolean ARMYGROUP.isGround

ARMYGROUP.isLateActivated

Is (template) group late activated.

#boolean ARMYGROUP.isMobile

If true, group is mobile.

#boolean ARMYGROUP.isNaval

#boolean ARMYGROUP.isUncontrolled

Ground groups cannot be uncontrolled.

ARMYGROUP.lid

Set some string id for output to DCS.log file.

#boolean ARMYGROUP.passedfinalwp

#boolean ARMYGROUP.retreatOnOutOfAmmo

If true, the group will automatically retreat when out of ammo. Needs a retreat zone!

Core.Set#SET_ZONE ARMYGROUP.retreatZones

Set of retreat zones.

ARMYGROUP.speedMax

Max speed in km/h.

ARMYGROUP.speedWp

Current set speed in m/s.

ARMYGROUP.tacan

ARMYGROUP.template

Get template of group.

ARMYGROUP.timerCheckZone

Start check zone timer.

ARMYGROUP.timerQueueUpdate

Start queue update timer.

#string ARMYGROUP.version

Army Group version.

Function(s)

ARMYGROUP:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

ARMYGROUP:AddProcess(From, Event, Process, ReturnEvents)

Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

Core.Fsm#FSM_PROCESS Process

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

Core.Fsm#FSM_PROCESS:

The SubFSM.

ARMYGROUP:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

ARMYGROUP:AddScoreProcess(From, Event, State, ScoreText, Score)

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

ARMYGROUP:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

ARMYGROUP:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

ARMYGROUP:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

ARMYGROUP:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

ARMYGROUP:GetProcesses()

Returns a table of the SubFSM rules defined within the FSM.

Defined in:

Return value:

#table:

Sub processes.

ARMYGROUP:GetScores(Scores)

Returns a table with the scores defined.

Defined in:

Parameter:

#table Scores

ARMYGROUP:GetStartState()

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

ARMYGROUP:GetState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

ARMYGROUP:GetSubs()

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

ARMYGROUP:GetTransitions()

Returns a table of the transition rules defined within the FSM.

Defined in:

Return value:

#table:

Transitions.

ARMYGROUP:Is(State)

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

ARMYGROUP:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

ARMYGROUP:New()

Creates a new FSM object.

Defined in:

Return value:

#FSM:

ARMYGROUP:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

ARMYGROUP:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

ARMYGROUP:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

ARMYGROUP:_call_handler(step, trigger, params, EventName)

Call handler.

Defined in:

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

ARMYGROUP:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

ARMYGROUP:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

ARMYGROUP:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

ARMYGROUP:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

ARMYGROUP:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

ARMYGROUP:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

ARMYGROUP:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

ARMYGROUP:can(e)

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

ARMYGROUP:cannot(e)

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

ARMYGROUP:is(State, state)

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#boolean ARMYGROUP.adinfinitum

Resume route at first waypoint when final waypoint is reached.

ARMYGROUP.ammo

Group ammo.

#ARMYGROUP.Target ARMYGROUP.engage

Engage target.

#boolean ARMYGROUP.formationPerma

Formation that is used permanently and overrules waypoint formations.

#boolean ARMYGROUP.groupinitialized

Init done.

#boolean ARMYGROUP.isAI

Ground are always AI.

#boolean ARMYGROUP.isAircraft

Define category.

#boolean ARMYGROUP.isArmygroup

Defaults

#boolean ARMYGROUP.isGround

ARMYGROUP.isLateActivated

Is (template) group late activated.

#boolean ARMYGROUP.isMobile

If true, group is mobile.

#boolean ARMYGROUP.isNaval

#boolean ARMYGROUP.isUncontrolled

Ground groups cannot be uncontrolled.

ARMYGROUP.lid

Set some string id for output to DCS.log file.

#boolean ARMYGROUP.passedfinalwp

#boolean ARMYGROUP.retreatOnOutOfAmmo

If true, the group will automatically retreat when out of ammo. Needs a retreat zone!

Core.Set#SET_ZONE ARMYGROUP.retreatZones

Set of retreat zones.

ARMYGROUP.speedMax

Max speed in km/h.

ARMYGROUP.speedWp

Current set speed in m/s.

ARMYGROUP.tacan

ARMYGROUP.template

Get template of group.

ARMYGROUP.timerCheckZone

Start check zone timer.

ARMYGROUP.timerQueueUpdate

Start queue update timer.

#string ARMYGROUP.version

Army Group version.

Function(s)

ARMYGROUP:ClearState(Object, StateName)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

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

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

ARMYGROUP:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

ARMYGROUP:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

ARMYGROUP:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

ARMYGROUP:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

ARMYGROUP:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

ARMYGROUP:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

ARMYGROUP:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ARMYGROUP:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

ARMYGROUP:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

ARMYGROUP:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ARMYGROUP:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ARMYGROUP:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ARMYGROUP:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

ARMYGROUP:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

ARMYGROUP:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

ARMYGROUP:GetEventPriority()

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

ARMYGROUP:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

ARMYGROUP:GetState(Object, Key)

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

ARMYGROUP:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

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

Return value:

ARMYGROUP:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ARMYGROUP:Inherit(Child, Parent)

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

ARMYGROUP:IsInstanceOf(ClassName)

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

Examples:

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

ARMYGROUP:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

ARMYGROUP:New()

BASE constructor.

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

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

Defined in:

Return value:

ARMYGROUP:OnEvent(EventData)

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventBaseCaptured(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventCrash(EventData)

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

initiator : The unit that has crashed

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventDead(EventData)

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventDetailedFailure(EventData)

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

Will update this page when new information become available.

initiator: The unit that had the failure.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventEjection(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventKill(EventData)

Occurs on the death of a unit.

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventLand(EventData)

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

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventLandingAfterEjection(EventData)

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

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventMissionEnd(EventData)

Occurs when a mission ends

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventMissionStart(EventData)

Occurs when a mission starts

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventPlayerEnterAircraft(EventData)

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

NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventPlayerLeaveUnit(EventData)

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

initiator : The unit that the player left.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventRefueling(EventData)

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventScore(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventShootingStart(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventTakeoff(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ARMYGROUP:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

ARMYGROUP:ScheduleStop(SchedulerFunction)

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

ARMYGROUP:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

ARMYGROUP:SetState(Object, Key, Value)

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

ARMYGROUP:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ARMYGROUP:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ARMYGROUP:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ARMYGROUP:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

ARMYGROUP:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

ARMYGROUP:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

ARMYGROUP:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

ARMYGROUP:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

ARMYGROUP:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

ARMYGROUP:TraceOnOff(TraceOnOff)

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

ARMYGROUP:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

ARMYGROUP:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

ARMYGROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in: