Module AI.AI_Formation

The mode the escort is in.

#string AI_FORMATION.FollowName

Core.Scheduler#SCHEDULER AI_FORMATION.FollowScheduler

The instance of the SCHEDULER class.

Wrapper.Unit#UNIT AI_FORMATION.FollowUnit

DCS#AI.Option.Air.val.ROE AI_FORMATION.OptionROE

Which ROE is set to the FollowGroup.

DCS#AI.Option.Air.val.REACTION_ON_THREAT AI_FORMATION.OptionReactionOnThreat

Which REACTION_ON_THREAT is set to the FollowGroup.

#boolean AI_FORMATION.ReportTargets

If true, nearby targets are reported.

#table AI_FORMATION.__Enum

#number AI_FORMATION.dtFollow

Time step between position updates.

Function(s)

AI_FORMATION:FollowMe(FollowGroup, ClientUnit, CT1, CV1, CT2, CV2)

Follow me.

Defined in:

AI_FORMATION

Parameters:

Wrapper.Group#GROUP FollowGroup

Follow group.

Wrapper.Unit#UNIT ClientUnit

Client Unit.

DCS#Time CT1

Time

DCS#Vec3 CV1

Vec3

DCS#Time CT2

Time

DCS#Vec3 CV2

Vec3

AI_FORMATION:FormationBox(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

FormationBox Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

AI_FORMATION:FormationCenterWing(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:FormationLeftLine(XStart, YStart, ZStart, ZSpace)

FormationLeftLine Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:FormationLeftWing(XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:FormationLine(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationLine Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:FormationRightLine(XStart, YStart, ZStart, ZSpace)

FormationRightLine Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:FormationRightWing(XStart, XSpace, YStart, ZStart, ZSpace)

FormationRightWing Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:FormationStack(XStart, XSpace, YStart, YSpace)

FormationStack Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

AI_FORMATION:FormationTrail(XStart, XSpace, YStart)

FormationTrail Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

AI_FORMATION:FormationVic(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationVic Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:GetFlightMode(FollowGroup)

Gets your escorts to flight mode.

Defined in:

AI_FORMATION

Parameter:

Wrapper.Group#GROUP FollowGroup

FollowGroup.

Return value:

AI_FORMATION:New(FollowUnit, FollowGroupSet, FollowName, FollowBriefing)

AI_FORMATION class constructor for an AI group

Defined in:

AI_FORMATION

Parameters:

Wrapper.Unit#UNIT FollowUnit

The UNIT leading the FolllowGroupSet.

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string FollowName

Name of the escort.

#string FollowBriefing

Briefing.

Return value:

self

AI_FORMATION:OnAfterFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

FormationBox Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

AI_FORMATION:OnAfterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:OnAfterFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationLeftLine Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:OnAfterFormationLeftWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:OnAfterFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationLine Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:OnAfterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationRightLine Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:OnAfterFormationRightWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationRightWing Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:OnAfterFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace)

FormationStack Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

AI_FORMATION:OnAfterFormationTrail(From, Event, To, XStart, XSpace, YStart)

FormationTrail Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

AI_FORMATION:OnAfterFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationVic Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:OnBeforeFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

FormationBox Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

Return value:

#boolean:

AI_FORMATION:OnBeforeFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

AI_FORMATION:OnBeforeFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationLeftLine Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

AI_FORMATION:OnBeforeFormationLeftWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

AI_FORMATION:OnBeforeFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationLine Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

AI_FORMATION:OnBeforeFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationRightLine Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

AI_FORMATION:OnBeforeFormationRightWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationRightWing Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

AI_FORMATION:OnBeforeFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace)

FormationStack Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

Return value:

#boolean:

AI_FORMATION:OnBeforeFormationTrail(From, Event, To, XStart, XSpace, YStart)

FormationTrail Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

Return value:

#boolean:

AI_FORMATION:OnBeforeFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationVic Handler OnBefore for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

AI_FORMATION:SetFlightModeAttack(FollowGroup)

This sets your escorts to execute an attack.

Defined in:

AI_FORMATION

Parameter:

Wrapper.Group#GROUP FollowGroup

FollowGroup.

Return value:

AI_FORMATION:SetFlightModeFormation(FollowGroup)

This sets your escorts to fly in a formation.

Defined in:

AI_FORMATION

Parameter:

Wrapper.Group#GROUP FollowGroup

FollowGroup.

Return value:

AI_FORMATION:SetFlightModeMission(FollowGroup)

This sets your escorts to fly a mission.

Defined in:

AI_FORMATION

Parameter:

Wrapper.Group#GROUP FollowGroup

FollowGroup.

Return value:

AI_FORMATION:SetFlightRandomization(FlightRandomization)

Use the method AI.AI_Formation#AI_FORMATION.SetFlightRandomization() to make the air units in your formation randomize their flight a bit while in formation.

Defined in:

AI_FORMATION

Parameter:

#number FlightRandomization

The formation flying errors that pilots can make while in formation. Is a range set in meters.

Return value:

AI_FORMATION:SetFollowTimeInterval(dt)

Set time interval between updates of the formation.

Defined in:

AI_FORMATION

Parameter:

#number dt

Time step in seconds between formation updates. Default is every 0.5 seconds.

Return value:

AI_FORMATION:TestSmokeDirectionVector(SmokeDirection)

This function is for test, it will put on the frequency of the FollowScheduler a red smoke at the direction vector calculated for the escort to fly to.

This allows to visualize where the escort is flying to.

Defined in:

AI_FORMATION

Parameter:

#boolean SmokeDirection

If true, then the direction vector will be smoked.

Return value:

AI_FORMATION:__FormationBox(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

FormationBox Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

AI_FORMATION:__FormationCenterWing(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:__FormationLeftLine(Delay, XStart, YStart, ZStart, ZSpace)

FormationLeftLine Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:__FormationLeftWing(Delay, XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:__FormationLine(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationLine Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:__FormationRightLine(Delay, XStart, YStart, ZStart, ZSpace)

FormationRightLine Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:__FormationRightWing(Delay, XStart, XSpace, YStart, ZStart, ZSpace)

FormationRightWing Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:__FormationStack(Delay, XStart, XSpace, YStart, YSpace)

FormationStack Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

AI_FORMATION:__FormationTrail(Delay, XStart, XSpace, YStart)

FormationTrail Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

AI_FORMATION:__FormationVic(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationVic Asynchronous Trigger for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:onafterFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels, FollowGroupSet)

FormationBox Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

FollowGroupSet

Return value:

AI_FORMATION:onafterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:onafterFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationLeftLine Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

AI_FORMATION:onafterFormationLeftWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

AI_FORMATION:onafterFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, Formation)

FormationLine Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Formation

Return value:

AI_FORMATION:onafterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationRightLine Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

AI_FORMATION:onafterFormationRightWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

Defined in:

AI_FORMATION

Parameters:

FollowGroupSet

From

Event

XStart

XSpace

YStart

ZStart

ZSpace

AI_FORMATION:onafterFormationStack(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace)

FormationStack Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

Return value:

AI_FORMATION:onafterFormationTrail(FollowGroupSet, From, Event, To, XStart, XSpace, YStart)

FormationTrail Handler OnAfter for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

Return value:

AI_FORMATION:onafterFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, FollowGroupSet)

FormationVic Handle for AI_FORMATION

Defined in:

AI_FORMATION

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FollowGroupSet

Return value:

AI_FORMATION:onafterStop(FollowGroupSet, From, Event, To)

Stop function.

Formation will not be updated any more.

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The following set of groups.

#string From

From state.

#string Event

Event.

#string To

The to state.

AI_FORMATION:onbeforeFollow(FollowGroupSet, From, Event, To)

Follow event fuction.

Check if coming from state "stopped". If so the transition is rejected.

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The following set of groups.

#string From

From state.

#string Event

Event.

#string To

The to state.

AI_FORMATION:onenterFollowing(FollowGroupSet, From, Event, To)

Enter following state.

Defined in:

AI_FORMATION

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The following set of groups.

#string From

From state.

#string Event

Event.

#string To

The to state.

Field(s)

AI_FORMATION.FlightRandomization

#number AI_FORMATION.FollowDistance

The current follow distance.

The mode the escort is in.

#string AI_FORMATION.FollowName

Core.Scheduler#SCHEDULER AI_FORMATION.FollowScheduler

The instance of the SCHEDULER class.

Wrapper.Unit#UNIT AI_FORMATION.FollowUnit

DCS#AI.Option.Air.val.ROE AI_FORMATION.OptionROE

Which ROE is set to the FollowGroup.

DCS#AI.Option.Air.val.REACTION_ON_THREAT AI_FORMATION.OptionReactionOnThreat

Which REACTION_ON_THREAT is set to the FollowGroup.

#boolean AI_FORMATION.ReportTargets

If true, nearby targets are reported.

#table AI_FORMATION.__Enum

#number AI_FORMATION.dtFollow

Time step between position updates.

Function(s)

AI_FORMATION:Get()

Gets the SET_BASE object that the FSM_SET governs.

Defined in:

Core.Fsm#FSM_SET

Return value:

Core.Set#SET_BASE:

AI_FORMATION:New(FSMT, Set_SET_BASE, FSMSet)

Creates a new FSM_SET object.

Defined in:

Core.Fsm#FSM_SET

Parameters:

#table FSMT

Finite State Machine Table

Set_SET_BASE

FSMSet (optional) The Set object that the FSM_SET governs.

FSMSet

Return value:

#FSM_SET:

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

Defined in:

Core.Fsm#FSM_SET

Parameters:

step

trigger

params

EventName

Field(s)

AI_FORMATION.FlightRandomization

#number AI_FORMATION.FollowDistance

The current follow distance.

The mode the escort is in.

#string AI_FORMATION.FollowName

Core.Scheduler#SCHEDULER AI_FORMATION.FollowScheduler

The instance of the SCHEDULER class.

Wrapper.Unit#UNIT AI_FORMATION.FollowUnit

DCS#AI.Option.Air.val.ROE AI_FORMATION.OptionROE

Which ROE is set to the FollowGroup.

DCS#AI.Option.Air.val.REACTION_ON_THREAT AI_FORMATION.OptionReactionOnThreat

Which REACTION_ON_THREAT is set to the FollowGroup.

#boolean AI_FORMATION.ReportTargets

If true, nearby targets are reported.

#table AI_FORMATION.__Enum

#number AI_FORMATION.dtFollow

Time step between position updates.

Function(s)

AI_FORMATION:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

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

Set the default #FSM_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.

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

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

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

AI_FORMATION:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

AI_FORMATION:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

AI_FORMATION:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

AI_FORMATION:GetProcesses()

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

Defined in:

Return value:

#table:

Sub processes.

AI_FORMATION:GetScores()

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

AI_FORMATION:GetStartState()

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

AI_FORMATION:GetState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

AI_FORMATION:GetSubs()

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

AI_FORMATION:GetTransitions()

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

Defined in:

Return value:

#table:

Transitions.

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

AI_FORMATION:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

AI_FORMATION:New()

Creates a new FSM object.

Defined in:

Return value:

#FSM:

AI_FORMATION:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

AI_FORMATION:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

AI_FORMATION:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

AI_FORMATION:_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.

AI_FORMATION:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

AI_FORMATION:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

AI_FORMATION:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

AI_FORMATION:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

AI_FORMATION:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

AI_FORMATION:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

AI_FORMATION:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

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

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

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

AI_FORMATION.FlightRandomization

#number AI_FORMATION.FollowDistance

The current follow distance.

The mode the escort is in.

#string AI_FORMATION.FollowName

Core.Scheduler#SCHEDULER AI_FORMATION.FollowScheduler

The instance of the SCHEDULER class.

Wrapper.Unit#UNIT AI_FORMATION.FollowUnit

DCS#AI.Option.Air.val.ROE AI_FORMATION.OptionROE

Which ROE is set to the FollowGroup.

DCS#AI.Option.Air.val.REACTION_ON_THREAT AI_FORMATION.OptionReactionOnThreat

Which REACTION_ON_THREAT is set to the FollowGroup.

#boolean AI_FORMATION.ReportTargets

If true, nearby targets are reported.

#table AI_FORMATION.__Enum

#number AI_FORMATION.dtFollow

Time step between position updates.

Function(s)

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

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

AI_FORMATION:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

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.

IniObjectCategory

AI_FORMATION:CreateEventDead(EventTime, Initiator, IniObjectCategory)

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.

IniObjectCategory

AI_FORMATION:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

AI_FORMATION:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

AI_FORMATION:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

AI_FORMATION:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

AI_FORMATION:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

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

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

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

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

AI_FORMATION:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

AI_FORMATION:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

AI_FORMATION:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

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

AI_FORMATION:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

AI_FORMATION:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

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

AI_FORMATION:GetEventPriority()

Get the Class Core.Event processing Priority.

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

Defined in:

Return value:

#number:

The Core.Event processing Priority.

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

AI_FORMATION:GetState(Object, Key)

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

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

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

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

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

AI_FORMATION:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

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

AI_FORMATION:OnEvent(EventData)

Occurs when an Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventBDA(EventData)

BDA.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventBaseCaptured(EventData)

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

AI_FORMATION:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventCrash(EventData)

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventDead(EventData)

Occurs when an object is dead.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

AI_FORMATION:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventDynamicCargoLoaded(EventData)

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventDynamicCargoUnloaded(EventData)

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

AI_FORMATION:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION: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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventLand(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventLandingAfterEjection(EventData)

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

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventLandingQualityMark(EventData)

Landing quality mark.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventMissionEnd(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventMissionStart(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventNewDynamicCargo(EventData)

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventParatrooperLanding(EventData)

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION: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. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventPlayerEnterAircraft(EventData)

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

AI_FORMATION:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventPlayerLeaveUnit(EventData)

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventRefueling(EventData)

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION: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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION: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. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

AI_FORMATION: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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventTakeoff(EventData)

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

AI_FORMATION:OnEventTriggerZone(EventData)

Trigger zone.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AI_FORMATION:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

AI_FORMATION:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

AI_FORMATION:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

AI_FORMATION:SetState(Object, Key, Value)

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

AI_FORMATION:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AI_FORMATION:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AI_FORMATION:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AI_FORMATION:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

AI_FORMATION:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

AI_FORMATION:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

AI_FORMATION:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

AI_FORMATION:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

AI_FORMATION:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

AI_FORMATION:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

AI_FORMATION:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

AI_FORMATION:_Serialize(Arguments)

(Internal) Serialize arguments

Defined in:

Parameter:

#table Arguments

Return value:

#string:

Text

AI_FORMATION:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

AI_FORMATION:onEvent(event)

The main event handling function...

This function captures all events generated for the class.

Defined in: