Module Ops.ArmyGroup

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:AddTaskBarrage(Clock, Heading, Alpha, Altitude, Radius, Nshots, WeaponType, Prio)

Add a scheduled task to fire at a given coordinate.

Defined in:

ARMYGROUP

Parameters:

#string Clock

Time when to start the attack.

#number Heading

Heading min in Degrees.

#number Alpha

Shooting angle in Degrees.

#number Altitude

Altitude in meters.

#number Radius

Radius in meters. Default 100 m.

#number Nshots

Number of shots to fire. Default nil.

#number WeaponType

Type of weapon. Default auto.

#number Prio

Priority of the task.

Return value:

The task table.

ARMYGROUP:AddTaskCargoGroup(GroupSet, PickupZone, DeployZone, Clock, Prio)

Add a scheduled task to transport group(s).

Defined in:

ARMYGROUP

Parameters:

Core.Set#SET_GROUP GroupSet

Set of cargo groups. Can also be a singe Wrapper.Group#GROUP object.

Core.Zone#ZONE PickupZone

Zone where the cargo is picked up.

Core.Zone#ZONE DeployZone

Zone where the cargo is delivered to.

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

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

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.

#string Formation

Formation the group will use.

#boolean Updateroute

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

Return value:

Waypoint table.

ARMYGROUP:Cruise(Speed, Formation)

Triggers the FSM event "Cruise".

Defined in:

ARMYGROUP

Parameters:

#number Speed

Speed in knots until next waypoint is reached.

#number Formation

Ops.Target#TARGET Target

The target to be engaged. Can also be a GROUP or UNIT object.

#number Speed

Speed in knots.

#string Formation

Formation used in the engagement.

ARMYGROUP:FindNearestAmmoSupply(Radius)

Return value:

self

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

On after "Cruise" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

ARMYGROUP

Parameters:

#string From

From state.

ARMYGROUP

Parameters:

#string From

From state.

Triggers the FSM event "Rearm".

Defined in:

ARMYGROUP

Parameters:

Core.Point#COORDINATE Coordinate

Coordinate where to rearm.

#number Formation

#number Formation

(Optional) Formation of the group.

Defined in:

ARMYGROUP

Defined in:

ARMYGROUP

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)

#number Tmax

(Optional) Maximum time a group will be suppressed. Default is 25 seconds.

Return value:

self

Defined in:

ARMYGROUP

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

Initialize group parameters.

Also initializes waypoints if self.waypoints is nil.

Defined in:

ARMYGROUP

Parameter:

#table Template

Template used to init the group. Default is self.template.

Return value:

self

ARMYGROUP:_Suppress()

Suppress fire of the group by setting its ROE to weapon hold.

Defined in:

ARMYGROUP

ARMYGROUP:_UpdateEngageTarget()

Update engage target.

Defined in:

ARMYGROUP

ARMYGROUP:__Cruise(delay, Speed, Formation)

Triggers the FSM event "Cruise" after a delay.

Defined in:

ARMYGROUP

Parameters:

#number delay

Delay in seconds.

ARMYGROUP

Parameters:

#number delay

Delay in seconds.

Wrapper.Group#GROUP Group

the group to be engaged.

ARMYGROUP

Parameters:

#number delay

Delay in seconds.

ARMYGROUP

Parameters:

Core.Zone#ZONE_BASE Zone

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

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.

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsGroup#OPSGROUP.Element Element

The group element.

ARMYGROUP:onafterEngageTarget(From, Event, To, Target, Speed, Formation)

On after "EngageTarget" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.Target#TARGET Target

The target to be engaged. Can also be a group or unit.

#number Speed

Attack speed in knots.

#string Formation

Formation used in the engagement. Default ENUMS.Formation.Vehicle.Vee.

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:onafterHit(From, Event, To, Enemy)

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:onafterUnsuppressed(From, Event, To)

After "Recovered" event.

Group has recovered and its ROE is set back to the "normal" unsuppressed state. Optionally the group is flared green.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

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

On after "UpdateRoute" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number n

Next waypoint index. Default is the one coming after that one that has been passed last.

#number N

Waypoint Max waypoint index to be included in the route. Default is the final waypoint.

#number Speed

Speed in knots. Default cruise speed.

#number Formation

Formation of the group.

ARMYGROUP:onbeforeEngageTarget(From, Event, To, Group, Speed, Formation, 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.

#number Speed

Speed in knots.

#string Formation

Formation used in the engagement. Default ENUMS.Formation.Vehicle.Vee.

Target

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

On before "RTZ" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Zone#ZONE Zone

The zone to return to.

#number Formation

Formation of the group.

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

On before "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: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:onbeforeUnsuppressed(From, Event, To)

Before "Recovered" event.

Check if suppression time is over.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Return value:

#boolean:

ARMYGROUP:onbeforeUpdateRoute(From, Event, To, n, N, Speed, Formation)

On before "UpdateRoute" event.

Defined in:

ARMYGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number n

Next waypoint index. Default is the one coming after that one that has been passed last.

#number N

Waypoint Max waypoint index to be included in the route. Default is the final waypoint.

#number Speed

Speed in knots. Default cruise speed.

#number Formation

Formation of the group.

Field(s)

#number ARMYGROUP.TsuppressAve

Bla

#number ARMYGROUP.TsuppressMax

Bla

#number ARMYGROUP.TsuppressMin

Bla

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

Not dead or destroyed yet.

#boolean ARMYGROUP.isDestroyed

ARMYGROUP.isLateActivated

Is (template) group late activated.

#boolean ARMYGROUP.isMobile

If true, group is mobile.

#boolean ARMYGROUP.isSuppressed

Bla

#boolean ARMYGROUP.isUncontrolled

Ground groups cannot be uncontrolled.

ARMYGROUP.lid

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

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.

#boolean ARMYGROUP.suppressOn

Bla

#boolean ARMYGROUP.suppressionOn

Activate suppression.

ARMYGROUP.suppressionROE

Backup ROE.

ARMYGROUP.tacan

ARMYGROUP.timerCheckZone

Start check zone timer.

ARMYGROUP.timerQueueUpdate

Start queue update timer.

ARMYGROUP.timerStatus

Start the status monitoring.

#string ARMYGROUP.version

Army Group version.

Function(s)

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

Defined in:

Parameter:

Ops.Auftrag#AUFTRAG Mission

Mission for this group.

Return value:

self

ARMYGROUP:AddOpsTransport(OpsTransport)

Create a cargo transport assignment.

Defined in:

Parameter:

Ops.OpsTransport#OPSTRANSPORT OpsTransport

The troop transport assignment.

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:

#OPSGROUP.Task:

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:

#OPSGROUP.Task:

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:AddWeightCargo(UnitName, Weight)

Add weight to the internal cargo of an element of the group.

Defined in:

Parameters:

#string UnitName

Name of the unit. Default is of the whole group.

#number Weight

Cargo weight to be added in kg.

ARMYGROUP:CanCargo(CargoGroup)

Check if the group can in principle be carrier of a cargo group.

This checks the max cargo capacity of the group but not how much cargo is already loaded (if any). Note that the cargo group cannot be split into units, i.e. the largest cargo bay of any element of the group must be able to load the whole cargo group in one piece.

Defined in:

Parameter:

#OPSGROUP CargoGroup

Cargo group, which needs a carrier.

Return value:

#boolean:

If true, there is an element of the group that can load the whole cargo group.

ARMYGROUP:CancelAllMissions()

Cancel all missions in mission queue that are not already done or cancelled.

Defined in:

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

Clear DCS tasks.

Defined in:

Return value:

self

ARMYGROUP:ClearWaypoints(IndexMin, IndexMax)

Clear waypoints.

Defined in:

Parameters:

#number IndexMin

Clear waypoints up to this min WP index. Default 1.

#number IndexMax

Clear waypoints up to this max WP index. Default #self.waypoints.

ARMYGROUP:CountElements(States)

Count elements of the group.

Defined in:

Parameter:

#table States

(Optional) Only count elements in specific states. Can also be a single state passed as #string.

Return value:

#number:

Number of elements.

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

Count remaining cargo transport assignments.

Defined in:

Return value:

#number:

Number of unfinished transports in the queue.

ARMYGROUP:CountTasksWaypoint(uid, id)

Count remaining waypoint tasks.

Defined in:

Parameters:

#number uid

Unique waypoint ID.

Return value:

#number:

Number of waypoint tasks.

ARMYGROUP:Deactivate(delay)

Deactivate the group.

Group will be respawned in late activated state.

Defined in:

Parameter:

#number delay

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

Return value:

self

ARMYGROUP:DelOpsTransport(CargoTransport)

Delete a cargo transport assignment from the cargo queue.

Defined in:

Parameter:

Ops.OpsTransport#OPSTRANSPORT CargoTransport

Cargo transport do be deleted.

Return value:

self

ARMYGROUP:Despawn(Delay, NoEventRemoveUnit)

Despawn the group.

The whole group is despawned and a "Remove Unit" event is generated for all current units of the group. If no Remove Unit event should be generated, the second optional parameter needs to be set to true. If this group belongs to an AIRWING, BRIGADE or FLEET, it will be added to the warehouse stock if the NoEventRemoveUnit parameter is false or nil.

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:DespawnUnit(UnitName, Delay, NoEventRemoveUnit)

Despawn a unit of the group.

A "Remove Unit" event is generated by default.

Defined in:

Parameters:

#string UnitName

Name of the unit

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

#table:

Cargo ops groups.

ARMYGROUP:GetCargoOpsGroups()

Get OPSGROUPs in the cargo bay.

Defined in:

Coordinate of the target.

#number WeaponBitType

#number indx

Waypoint index. Default is the next waypoint.

Return value:

#number:

Distance in meters.

ARMYGROUP:GetEPLRS()

Get current EPLRS state.

Defined in:

Return value:

#boolean:

If true, EPLRS is on.

ARMYGROUP:GetElementAlive()

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

#boolean:

If true, emission is on.

ARMYGROUP:GetExpectedSpeed()

Returns the currently expected speed.

Defined in:

Return value:

#number:

Expected speed in m/s.

ARMYGROUP:GetFreeCargobay(UnitName, IncludeReserved)

Get free cargo bay weight.

Defined in:

Parameters:

#string UnitName

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

Returns the absolute total life points of the group.

Defined in:

Parameter:

#OPSGROUP.Element Element

(Optional) Only get life points of this element.

Return values:

#number:

Life points, i.e. the sum of life points over all units in the group (unless a specific element was passed).

#number:

Initial life points.

ARMYGROUP:GetMissionByID(id)

Get mission by its id (auftragsnummer).

Defined in:

Parameter:

#number id

Mission id (auftragsnummer).

Return value:

Ops.Auftrag#AUFTRAG:

The mission.

ARMYGROUP:GetMissionByTaskID(taskid)

Get mission by its task id.

Defined in:

Parameter:

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:

Core.Point#COORDINATE:

Coordinate of the next waypoint.

ARMYGROUP:GetOpsTransportByUID(uid)

Get cargo transport assignment from the cargo queue by its unique ID.

Defined in:

Parameter:

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

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

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:

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

its current position in the waypoints table.

Defined in:

Parameter:

Weapon range data.

ARMYGROUP:GetWeightCargo(UnitName, IncludeReserved)

Get weight of the internal cargo the group is carriing right now.

Defined in:

Parameters:

#string UnitName

Name of the unit. Default is of the whole group.

#boolean IncludeReserved

If false, cargo weight that is only reserved is not counted. By default (true or nil), the reserved cargo is included.

Return value:

#number:

Cargo weight in kg.

ARMYGROUP:GetWeightCargoMax(UnitName)

Get max weight of the internal cargo the group can carry.

Optionally, the max cargo weight of a specific unit can be requested.

Defined in:

Parameter:

#string UnitName

Name of the unit. Default is of the whole group.

Return value:

#number:

Max cargo weight in kg. This does not include any cargo loaded or reserved currently.

ARMYGROUP:GetWeightTotal(UnitName, IncludeReserved)

Get total weight of the group including cargo.

Optionally, the total weight of a specific unit can be requested.

Defined in:

Parameters:

#string UnitName

Name of the unit. Default is of the whole group.

#boolean IncludeReserved

If false, cargo weight that is only reserved is not counted. By default (true or nil), the reserved cargo is included.

Return value:

#number:

Total weight in kg.

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. Can also be a DCS#Vec3.

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

#boolean:

If true, group is awaiting transport lift..

ARMYGROUP:IsBoarding(CarrierGroupName)

Check if the group is currently boarding a carrier.

Defined in:

Parameter:

#string CarrierGroupName

(Optional) Additionally check if group is boarding this particular carrier group.

Return value:

#boolean:

If true, group is boarding.

ARMYGROUP:IsBusy()

Check if the group is currently busy doing something.

Boarding
Rearming
Returning
Pickingup, Loading, Transporting, Unloading
Engageing

Defined in:

Return value:

#boolean:

If true, group is busy.

ARMYGROUP:IsCargo(CheckTransport)

Check if the group is assigned as cargo.

Defined in:

Parameter:

#boolean CheckTransport

If true or nil, also check if cargo is associated with a transport assignment. If not, we consider it not cargo.

Return value:

#boolean:

If true, group is cargo.

ARMYGROUP:IsCarrier()

Check if the group is a carrier.

Defined in:

Return value:

#boolean:

If true, group is a carrier.

ARMYGROUP:IsDead()

ARMYGROUP:IsInUtero()

Check if group is in state in utero.

Note that dead groups are also in utero but will return false here.

Defined in:

Return value:

#boolean:

If true, group is not spawned yet.

ARMYGROUP:IsInZone(Zone)

Check if group is currently inside a zone.

Defined in:

Parameter:

If true, group is loaded.

ARMYGROUP:IsLoading()

Check if the group is loading cargo.

Defined in:

Return value:

#boolean:

If true, group is loading.

ARMYGROUP:IsMissionInQueue(Mission)

Check if a given mission is already in the queue.

Defined in:

Parameter:

Ops.Auftrag#AUFTRAG Mission

the mission to check

Return value:

#boolean:

If true, the mission is in the queue.

ARMYGROUP:IsMissionTypeInQueue(MissionType)

Check if a given mission type is already in the queue.

Defined in:

Parameter:

If true, group is not cargo.

ARMYGROUP:IsNotCarrier()

Check if the group is not a carrier yet.

Defined in:

Return value:

#boolean:

If true, group is not a carrier.

ARMYGROUP:IsOnMission(MissionUID)

Check if group is currently on a mission.

Defined in:

Parameter:

If true, group is currently waiting.

ARMYGROUP:KnowTarget(TargetObject, KnowType, KnowDist, Delay)

Set detection on or off.

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

Defined in:

Parameters:

Wrapper.Positionable#POSITIONABLE TargetObject

The target object.

#boolean KnowType

Make type known.

#boolean KnowDist

Make distance known.

#number Delay

Delay in seconds before the target is known.

Return value:

self

ARMYGROUP:MarkWaypoints(Duration)

Mark waypoints on F10 map.

Defined in:

Parameter:

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

#string From

From state.

#string Event

Event.

#string To

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

ARMYGROUP:RadioTransmission(Text, Delay, SayCallsign, Frequency)

Send a radio transmission via SRS Text-To-Speech.

Defined in:

Parameters:

#string Text

Text of transmission.

#number Delay

Delay in seconds before the transmission is started.

#boolean SayCallsign

If true, the callsign is prepended to the given text. Default false.

#number Frequency

Override sender frequency, helpful when you need multiple radios from the same sender. Default is the frequency set for the OpsGroup.

Return value:

self

ARMYGROUP:RedWeightCargo(UnitName, Weight)

Reduce weight to the internal cargo of an element of the group.

Defined in:

Parameters:

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

Return value:

self

ARMYGROUP:ReturnToLegion(Delay)

Return group back to the legion it belongs to.

#number Delay

Delay in seconds. Default now.

#number ExplosionPower

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

Return value:

self

ARMYGROUP:SetAltitude(Altitude, Keep, RadarAlt)

Set current altitude.

Defined in:

Parameters:

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:SetDefaultAltitude(Altitude)

Set default cruise altitude.

Defined in:

Parameter:

#number Altitude

Altitude in feet. Default is 10,000 ft for airplanes and 1,500 feet for helicopters.

Return value:

self

ARMYGROUP:SetDefaultCallsign(CallsignName, CallsignNumber)

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:SetDefaultImmortal(OnOffSwitch)

Set the default immortal for the group.

Defined in:

Parameter:

#boolean OnOffSwitch

If true, group is immortal by default.

Return value:

self

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

Disable to automatically engage detected targets.

Defined in:

Return value:

self

ARMYGROUP:SetEngageDetectedOn(RangeMax, TargetTypes, EngageZoneSet, NoEngageZoneSet)

Enable to automatically engage detected targets.

Defined in:

Parameters:

#number RangeMax

Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.

#table TargetTypes

Types of target attributes that will be engaged. See DCS enum attributes. Default "All".

Core.Set#SET_ZONE EngageZoneSet

Set of zones in which targets are engaged. Default is anywhere.

Core.Set#SET_ZONE NoEngageZoneSet

Set of zones in which targets are not engaged. Default is nowhere.

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

Use SRS Simple-Text-To-Speech for transmissions.

Defined in:

Parameters:

#string PathToSRS

Path to SRS directory.

#string Gender

Gender: "male" or "female" (default).

#string Culture

Culture, e.g. "en-GB" (default).

#string Voice

Specific voice. Overrides Gender and Culture.

#number Port

SRS port. Default 5002.

#string PathToGoogleKey

Full path to the google credentials JSON file, e.g. "C:\Users\myUsername\Downloads\key.json".

#string Label

Label of the SRS comms for the SRS Radio overlay. Defaults to "ROBOT". No spaces allowed!

#number Volume

Volume to be set, 0.0 = silent, 1.0 = loudest. Defaults to 1.0

Return value:

self

ARMYGROUP:SetSpeed(Speed, Keep, AltCorrected)

Set current speed.

Defined in:

Parameters:

#number Speed

Speed in knots. Default is 70% of max speed.

#boolean Keep

If true the group will maintain that speed on passing waypoints. If nil or false the group will return to the speed as defined by their route.

#boolean AltCorrected

If true, use altitude corrected indicated air speed.

Return value:

self

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

Triggers the FSM event "Stop".

Stops the OPSGROUP and all its event handlers.

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)

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.

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:Teleport(Coordinate, Delay, NoPauseMission)

Teleport the group to a different location.

Defined in:

Parameters:

Core.Point#COORDINATE Coordinate

Coordinate where the group is teleported to.

#number Delay

Add OPSGROUP to cargo bay of a carrier.

Defined in:

Parameters:

#OPSGROUP CargoGroup

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

Ops.OpsTransport#OPSTRANSPORT CargoTransport

The next due cargo transport or nil.

Return value:

#boolean:

If true, all cargo was delivered.

ARMYGROUP:_CheckDetectedUnits()

Check detected units.

Defined in:

ARMYGROUP:_CheckGoPickup(CargoTransport)

Check if all cargo of this transport assignment was delivered.

Defined in:

Parameter:

Ops.OpsTransport#OPSTRANSPORT CargoTransport

The next due cargo transport or nil.

Return value:

#boolean:

If true, all cargo was delivered.

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:

Core.Point#COORDINATE:

The coordinate of the object.

ARMYGROUP:_CountPausedMissions()

Count paused mission.

Defined in:

Return value:

#number:

Number of paused missions.

ARMYGROUP:_CreateWaypoint(Waypoint, waypoint)

Enhance waypoint table.

Defined in:

Parameters:

Parameter:

#OPSGROUP CargoGroup

Cargo group.

Return values:

#OPSGROUP.MyCargo:

Cargo bay item or nil if the group is not in the carrier.

#number:

CargoBayIndex Index of item in the cargo bay table.

#OPSGROUP.Element:

Carrier element.

ARMYGROUP:_GetDetectedTarget()

Get target group.

Defined in:

Return values:

Wrapper.Group#GROUP:

Detected target group.

#number:

Distance to target.

ARMYGROUP:_GetElementZoneLoader(Element, Zone, Loader)

Get/update the (un-)loading zone of the element.

Defined in:

Parameters:

#OPSGROUP.Element Element

Element.

Core.Zone#ZONE_POLYGON Zone

The zone.

#OPSGROUP.CarrierLoader Loader

Loader parameters.

Return value:

Core.Zone#ZONE_POLYGON:

Bounding box polygon zone.

ARMYGROUP:_GetMyCarrier()

Get my carrier.

Defined in:

Return values:

Carrier group.

Ops.Auftrag#AUFTRAG:

Paused mission or nil.

ARMYGROUP:_GetROEName(roe)

Get name of ROE corresponding to the numerical value.

Defined in:

#boolean:

If true, space for me was reserved.

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:_NewCargoStatus(Status)

Set (new) cargo status.

Defined in:

Parameter:

#string Status

ARMYGROUP:_RemovePausedMission(AuftragsNummer)

Remove paused mission from the table.

Defined in:

Parameter:

#number AuftragsNummer

Mission ID of the paused mission to remove.

Return value:

self

ARMYGROUP:_Respawn(Delay, Template, Reset)

Respawn the group.

Defined in:

Parameters:

#number Delay

Delay in seconds before respawn happens. Default 0.

DCS#Template Template

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

#boolean Reset

Reset waypoints and reinit group if true.

Return value:

self

ARMYGROUP:_SandwitchDCSTask(DCSTask, Task, SetTask, Delay)

Sandwitch DCS task in stop condition and push the task to the group.

Defined in:

Parameters:

DCS#Task DCSTask

The DCS task.

Ops.OpsGroup#OPSGROUP.Task Task

#boolean SetTask

Set task instead of pushing it.

#number Delay

Delay in seconds. Default nil.

ARMYGROUP:_SetElementStatusAll(status)

Set status for all elements (except dead ones).

Defined in:

Parameter:

#string status

Element status.

ARMYGROUP:_SetLegion(Legion)

Set legion this ops group belongs to.

Defined in:

Parameter:

Ops.Legion#LEGION Legion

The Legion.

Return value:

self

ARMYGROUP:_SetMissionOptions(mission)

Set mission specific options for ROE, Alarm state, etc.

Defined in:

Parameter:

Ops.Auftrag#AUFTRAG mission

The mission table.

ARMYGROUP:_SetMyCarrier(CarrierGroup, CarrierElement, Reserved)

Set my carrier.

Defined in:

Parameters:

#OPSGROUP CarrierGroup

Carrier group.

#OPSGROUP.Element CarrierElement

Carrier element.

#boolean Reserved

If true, reserve space for me.

ARMYGROUP:_SetTemplate(Template)

Set the template of the group.

Defined in:

Parameter:

#table Template

Template to set. Default is from the GROUP.

Return value:

self

ARMYGROUP:_SetWaypointTasks(Waypoint)

Set tasks at this waypoint

Defined in:

Parameter:

#OPSGROUP.Waypoint Waypoint

The waypoint.

Return value:

#number:

Number of tasks.

ARMYGROUP:_SimpleTaskFunction(Function, uid)

Simple task function.

Can be used to call a function which has the warehouse and the executing group as parameters.

Defined in:

Parameters:

#string Function

The name of the function to call passed as string.

#number uid

Waypoint UID.

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:

The mission.

ARMYGROUP:__Status(delay)

Triggers the FSM event "Status" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

ARMYGROUP:__Stop(delay)

#string From

From state.

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsTransport#OPSTRANSPORT CargoTransport

The cargo transport assignment.

ARMYGROUP:onafterDestroyed(From, Event, To)

On after "Destroyed" 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)

#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, Speed)

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

#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:onafterLoad(From, Event, To, CargoGroup, Carrier)

On after "Load" event.

Carrier loads a cargo group into ints cargo bay.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP CargoGroup

The OPSGROUP loaded as cargo.

#OPSGROUP.Element Carrier

The carrier element/unit.

ARMYGROUP:onafterLoading(From, Event, To)

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

The mission that is done.

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)

Event.

#string To

To state.

#table Template

The template used to respawn the group. Default is the inital template of the group.

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: