Module AI.AI_Patrol

The Core.Zone where the patrol needs to be executed.

Function(s)

AI_PATROL_ZONE:ClearDetectedUnits()

Clears the list of Wrapper.Unit#UNITs that were detected by the AI.

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:Detect()

Synchronous Event Trigger for Event Detect.

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:Detected()

Synchronous Event Trigger for Event Detected.

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:GetDetectedUnits()

Gets a list of Wrapper.Unit#UNITs that were detected by the AI.

No filtering is applied, so, ANY detected UNIT can be in this list. It is up to the mission designer to use the Wrapper.Unit class and methods to filter the targets.

Defined in:

AI_PATROL_ZONE

Return value:

#table:

The list of Wrapper.Unit#UNITs

AI_PATROL_ZONE:ManageDamage(PatrolDamageThreshold)

When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.

However, damage cannot be foreseen early on. Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB). Note that for groups, the average damage of the complete group will be calculated. So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshold will be 0.25.

Defined in:

AI_PATROL_ZONE

Parameter:

#number PatrolDamageThreshold

The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.

Return value:

self

AI_PATROL_ZONE:ManageFuel(PatrolFuelThresholdPercentage, PatrolOutOfFuelOrbitTime)

When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.

Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated. When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targeted to the AI_PATROL_ZONE. Once the time is finished, the old AI will return to the base.

Defined in:

AI_PATROL_ZONE

Parameters:

#number PatrolFuelThresholdPercentage

The threshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.

#number PatrolOutOfFuelOrbitTime

The amount of seconds the out of fuel AIControllable will orbit before returning to the base.

Return value:

self

AI_PATROL_ZONE:New(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType)

Creates a new AI_PATROL_ZONE object

Defined in:

AI_PATROL_ZONE

Parameters:

Core.Zone#ZONE_BASE PatrolZone

The Core.Zone where the patrol needs to be executed.

DCS#Altitude PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

DCS#Altitude PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

DCS#Speed PatrolMinSpeed

The minimum speed of the Wrapper.Controllable in km/h.

DCS#Speed PatrolMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

DCS#AltitudeType PatrolAltType

The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO

Return value:

self

Usage:

-- Define a new AI_PATROL_ZONE Object. This PatrolArea will patrol an AIControllable within PatrolZone between 3000 and 6000 meters, with a variying speed between 600 and 900 km/h.
PatrolZone = ZONE:New( 'PatrolZone' )
PatrolSpawn = SPAWN:New( 'Patrol Group' )
PatrolArea = AI_PATROL_ZONE:New( PatrolZone, 3000, 6000, 600, 900 )

AI_PATROL_ZONE:OnAfterDetect(Controllable, From, Event, To)

OnAfter Transition Handler for Event Detect.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnAfterDetected(Controllable, From, Event, To)

OnAfter Transition Handler for Event Detected.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnAfterRTB(Controllable, From, Event, To)

OnAfter Transition Handler for Event RTB.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnAfterRoute(Controllable, From, Event, To)

OnAfter Transition Handler for Event Route.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnAfterStart(Controllable, From, Event, To)

OnAfter Transition Handler for Event Start.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnAfterStatus(Controllable, From, Event, To)

OnAfter Transition Handler for Event Status.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnAfterStop(Controllable, From, Event, To)

OnAfter Transition Handler for Event Stop.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnBeforeDetect(Controllable, From, Event, To)

OnBefore Transition Handler for Event Detect.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnBeforeDetected(Controllable, From, Event, To)

OnBefore Transition Handler for Event Detected.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnBeforeRTB(Controllable, From, Event, To)

OnBefore Transition Handler for Event RTB.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnBeforeRoute(Controllable, From, Event, To)

OnBefore Transition Handler for Event Route.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnBeforeStart(Controllable, From, Event, To)

OnBefore Transition Handler for Event Start.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnBeforeStatus(Controllable, From, Event, To)

OnBefore Transition Handler for Event Status.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnBeforeStop(Controllable, From, Event, To)

OnBefore Transition Handler for Event Stop.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnCrash(EventData)

@param #AI_PATROL_ZONE self @param Core.Event#EVENTDATA EventData

Defined in:

AI_PATROL_ZONE

Parameter:

EventData

AI_PATROL_ZONE:OnEjection(EventData)

@param #AI_PATROL_ZONE self @param Core.Event#EVENTDATA EventData

Defined in:

AI_PATROL_ZONE

Parameter:

EventData

AI_PATROL_ZONE:OnEnterPatrolling(Controllable, From, Event, To)

OnEnter Transition Handler for State Patrolling.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnEnterReturning(Controllable, From, Event, To)

OnEnter Transition Handler for State Returning.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnEnterStopped(Controllable, From, Event, To)

OnEnter Transition Handler for State Stopped.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnLeavePatrolling(Controllable, From, Event, To)

OnLeave Transition Handler for State Patrolling.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnLeaveReturning(Controllable, From, Event, To)

OnLeave Transition Handler for State Returning.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnLeaveStopped(Controllable, From, Event, To)

OnLeave Transition Handler for State Stopped.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnPilotDead(EventData)

@param #AI_PATROL_ZONE self @param Core.Event#EVENTDATA EventData

Defined in:

AI_PATROL_ZONE

Parameter:

EventData

AI_PATROL_ZONE:RTB()

Synchronous Event Trigger for Event RTB.

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:Route()

Synchronous Event Trigger for Event Route.

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude)

Sets the floor and ceiling altitude of the patrol.

Defined in:

AI_PATROL_ZONE

Parameters:

DCS#Altitude PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

DCS#Altitude PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

Return value:

self

AI_PATROL_ZONE:SetDetectionActivated()

Activate the detection.

The AI will detect for targets if the Detection is switched On.

Defined in:

AI_PATROL_ZONE

Return value:

self

AI_PATROL_ZONE:SetDetectionDeactivated()

Deactivate the detection.

The AI will NOT detect for targets.

Defined in:

AI_PATROL_ZONE

Return value:

self

AI_PATROL_ZONE:SetDetectionOff()

Set the detection off.

The AI will NOT detect for targets. However, the list of already detected targets will be kept and can be enquired!

Defined in:

AI_PATROL_ZONE

Return value:

self

AI_PATROL_ZONE:SetDetectionOn()

Set the detection on.

The AI will detect for targets.

Defined in:

AI_PATROL_ZONE

Return value:

self

AI_PATROL_ZONE:SetDetectionZone(DetectionZone)

Set the detection zone where the AI is detecting targets.

Defined in:

AI_PATROL_ZONE

Parameter:

Core.Zone#ZONE DetectionZone

The zone where to detect targets.

Return value:

self

AI_PATROL_ZONE:SetRefreshTimeInterval(Seconds)

Set the interval in seconds between each detection executed by the AI.

The list of already detected targets will be kept and updated. Newly detected targets will be added, but already detected targets that were not detected in this cycle, will NOT be removed! The default interval is 30 seconds.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Seconds

The interval in seconds.

Return value:

self

AI_PATROL_ZONE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed)

Sets (modifies) the minimum and maximum speed of the patrol.

Defined in:

AI_PATROL_ZONE

Parameters:

DCS#Speed PatrolMinSpeed

The minimum speed of the Wrapper.Controllable in km/h.

DCS#Speed PatrolMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

Return value:

self

AI_PATROL_ZONE:SetStatusOff()

Set the status checking off.

Defined in:

AI_PATROL_ZONE

Return value:

self

AI_PATROL_ZONE:Start()

Synchronous Event Trigger for Event Start.

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:Status()

Synchronous Event Trigger for Event Status.

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:Stop()

Synchronous Event Trigger for Event Stop.

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:_NewPatrolRoute(AIControllable)

@param Wrapper.Controllable#CONTROLLABLE AIControllable This static method is called from the route path within the last task at the last waypoint of the Controllable. Note that this method is required, as triggers the next route when patrolling for the Controllable.

Defined in:

AI_PATROL_ZONE

Parameter:

AIControllable

AI_PATROL_ZONE:__Detect(Delay)

Asynchronous Event Trigger for Event Detect.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

AI_PATROL_ZONE:__Detected(Delay)

Asynchronous Event Trigger for Event Detected.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

AI_PATROL_ZONE:__RTB(Delay)

Asynchronous Event Trigger for Event RTB.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

AI_PATROL_ZONE:__Route(Delay)

Asynchronous Event Trigger for Event Route.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

AI_PATROL_ZONE:__Start(Delay)

Asynchronous Event Trigger for Event Start.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

AI_PATROL_ZONE:__Status(Delay)

Asynchronous Event Trigger for Event Status.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

AI_PATROL_ZONE:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

AI_PATROL_ZONE:onafterDead()

@param #AI_PATROL_ZONE self

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:onafterDetect(Controllable, From, Event, To)

@param #AI_PATROL_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable

Defined in:

AI_PATROL_ZONE

Parameters:

Controllable

From

Event

AI_PATROL_ZONE:onafterRTB()

@param #AI_PATROL_ZONE self

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:onafterRoute(Controllable, From, Event, To)

Defines a new patrol route using the #AI_PATROL_ZONE parameters and settings.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:onafterStart(Controllable, From, Event, To)

Defines a new patrol route using the #AI_PATROL_ZONE parameters and settings.

Defined in:

AI_PATROL_ZONE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

self

AI_PATROL_ZONE:onafterStatus()

@param #AI_PATROL_ZONE self

Defined in:

AI_PATROL_ZONE

AI_PATROL_ZONE:onbeforeDetect(Controllable, From, Event, To)

@param #AI_PATROL_ZONE self @param Wrapper.Controllable#CONTROLLABLE Controllable+

Defined in:

AI_PATROL_ZONE

Parameters:

Controllable

From

Event

AI_PATROL_ZONE:onbeforeStatus()

@param #AI_PATROL_ZONE self

Defined in:

AI_PATROL_ZONE

Field(s)

Wrapper.Controllable#CONTROLLABLE AI_PATROL_ZONE.AIControllable

The Wrapper.Controllable patrolling.

#boolean AI_PATROL_ZONE.CheckStatus

Core.Spawn#SPAWN AI_PATROL_ZONE.CoordTest

#boolean AI_PATROL_ZONE.DetectActivated

AI_PATROL_ZONE.DetectInterval

#boolean AI_PATROL_ZONE.DetectOn

AI_PATROL_ZONE.DetectZone

#table AI_PATROL_ZONE.DetectedUnits

DCS#Altitude AI_PATROL_ZONE.PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

AI_PATROL_ZONE.PatrolDamageThreshold

DCS#Altitude AI_PATROL_ZONE.PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

AI_PATROL_ZONE.PatrolFuelThresholdPercentage

#boolean AI_PATROL_ZONE.PatrolManageDamage

DCS#Speed AI_PATROL_ZONE.PatrolMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

DCS#Speed AI_PATROL_ZONE.PatrolMinSpeed

The minimum speed of the Wrapper.Controllable in km/h.

AI_PATROL_ZONE.PatrolOutOfFuelOrbitTime

The Core.Zone where the patrol needs to be executed.

Function(s)

AI_PATROL_ZONE:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Defined in:

Wrapper.Controllable#CONTROLLABLE:

Return value:

AI_PATROL_ZONE:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

Defined in:

Parameters:

#table FSMT

Finite State Machine Table

Wrapper.Controllable#CONTROLLABLE Controllable

(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Return value:

#FSM_CONTROLLABLE:

AI_PATROL_ZONE:OnAfterStop(Controllable, From, Event, To)

OnAfter Transition Handler for Event Stop.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnBeforeStop(Controllable, From, Event, To)

OnBefore Transition Handler for Event Stop.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:OnEnterStopped(Controllable, From, Event, To)

OnEnter Transition Handler for State Stopped.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

AI_PATROL_ZONE:OnLeaveStopped(Controllable, From, Event, To)

OnLeave Transition Handler for State Stopped.

Defined in:

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

AI_PATROL_ZONE:SetControllable(FSMControllable)

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Defined in:

Parameter:

Wrapper.Controllable#CONTROLLABLE FSMControllable

Return value:

#FSM_CONTROLLABLE:

AI_PATROL_ZONE:Stop()

Synchronous Event Trigger for Event Stop.

Defined in:

AI_PATROL_ZONE:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

Defined in:

Parameter:

#number Delay

The delay in seconds.

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

Defined in:

Parameters:

step

trigger

params

EventName

Field(s)

Wrapper.Controllable#CONTROLLABLE AI_PATROL_ZONE.AIControllable

The Wrapper.Controllable patrolling.

#boolean AI_PATROL_ZONE.CheckStatus

Core.Spawn#SPAWN AI_PATROL_ZONE.CoordTest

#boolean AI_PATROL_ZONE.DetectActivated

AI_PATROL_ZONE.DetectInterval

#boolean AI_PATROL_ZONE.DetectOn

AI_PATROL_ZONE.DetectZone

#table AI_PATROL_ZONE.DetectedUnits

DCS#Altitude AI_PATROL_ZONE.PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

AI_PATROL_ZONE.PatrolDamageThreshold

DCS#Altitude AI_PATROL_ZONE.PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

AI_PATROL_ZONE.PatrolFuelThresholdPercentage

#boolean AI_PATROL_ZONE.PatrolManageDamage

DCS#Speed AI_PATROL_ZONE.PatrolMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

DCS#Speed AI_PATROL_ZONE.PatrolMinSpeed

The minimum speed of the Wrapper.Controllable in km/h.

AI_PATROL_ZONE.PatrolOutOfFuelOrbitTime

The Core.Zone where the patrol needs to be executed.

Function(s)

AI_PATROL_ZONE:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

AI_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

AI_PATROL_ZONE:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

AI_PATROL_ZONE:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

AI_PATROL_ZONE:GetProcesses()

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

Defined in:

Return value:

#table:

Sub processes.

AI_PATROL_ZONE:GetScores()

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

AI_PATROL_ZONE:GetStartState()

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

AI_PATROL_ZONE:GetState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

AI_PATROL_ZONE:GetSubs()

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

AI_PATROL_ZONE:GetTransitions()

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

Defined in:

Return value:

#table:

Transitions.

AI_PATROL_ZONE: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_PATROL_ZONE:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

AI_PATROL_ZONE:New()

Creates a new FSM object.

Defined in:

Return value:

#FSM:

AI_PATROL_ZONE:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

AI_PATROL_ZONE:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

AI_PATROL_ZONE:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

AI_PATROL_ZONE:_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_PATROL_ZONE:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

AI_PATROL_ZONE:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

AI_PATROL_ZONE:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

AI_PATROL_ZONE:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

AI_PATROL_ZONE:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

AI_PATROL_ZONE:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

AI_PATROL_ZONE:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

AI_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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)

Wrapper.Controllable#CONTROLLABLE AI_PATROL_ZONE.AIControllable

The Wrapper.Controllable patrolling.

#boolean AI_PATROL_ZONE.CheckStatus

Core.Spawn#SPAWN AI_PATROL_ZONE.CoordTest

#boolean AI_PATROL_ZONE.DetectActivated

AI_PATROL_ZONE.DetectInterval

#boolean AI_PATROL_ZONE.DetectOn

AI_PATROL_ZONE.DetectZone

#table AI_PATROL_ZONE.DetectedUnits

DCS#Altitude AI_PATROL_ZONE.PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

AI_PATROL_ZONE.PatrolDamageThreshold

DCS#Altitude AI_PATROL_ZONE.PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

AI_PATROL_ZONE.PatrolFuelThresholdPercentage

#boolean AI_PATROL_ZONE.PatrolManageDamage

DCS#Speed AI_PATROL_ZONE.PatrolMaxSpeed

The maximum speed of the Wrapper.Controllable in km/h.

DCS#Speed AI_PATROL_ZONE.PatrolMinSpeed

The minimum speed of the Wrapper.Controllable in km/h.

AI_PATROL_ZONE.PatrolOutOfFuelOrbitTime

The Core.Zone where the patrol needs to be executed.

Function(s)

AI_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

AI_PATROL_ZONE:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

AI_PATROL_ZONE:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

AI_PATROL_ZONE:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

Defined in:

Parameter:

Wrapper.DynamicCargo#DYNAMICCARGO DynamicCargo

the dynamic cargo object

AI_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

AI_PATROL_ZONE:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

AI_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

AI_PATROL_ZONE:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

AI_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

AI_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

AI_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE: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_PATROL_ZONE:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

AI_PATROL_ZONE:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

AI_PATROL_ZONE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

AI_PATROL_ZONE:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

AI_PATROL_ZONE:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

AI_PATROL_ZONE:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

AI_PATROL_ZONE: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_PATROL_ZONE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

AI_PATROL_ZONE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

AI_PATROL_ZONE:_Serialize(Arguments)

(Internal) Serialize arguments

Defined in:

Parameter:

#table Arguments

Return value:

#string:

Text

AI_PATROL_ZONE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

AI_PATROL_ZONE:onEvent(event)

The main event handling function...

This function captures all events generated for the class.

Defined in: