Banner Image

Module AI.AI_Patrol

AI -- Perform Air Patrolling for airplanes.

Features:

  • Patrol AI airplanes within a given zone.
  • Trigger detected events when enemy airplanes are detected.
  • Manage a fuel treshold to RTB on time.

AI PATROL classes makes AI Controllables execute an Patrol.

There are the following types of PATROL classes defined:


Demo Missions


YouTube Playlist


Author: FlightControl

Contributions:

  • Dutch_Baron: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)
  • Pikey: Testing and API concept review.

Global(s)

Global AI_PATROL_ZONE

Implements the core functions to patrol a Zone by an AI Wrapper.Controllable or Wrapper.Group.

#AI_PATROL_ZONE AI_PATROL_ZONE

Implements the core functions to patrol a Zone by an AI Wrapper.Controllable or Wrapper.Group.

Process

The AI_PATROL_ZONE is assigned a Wrapper.Group and this must be done before the AI_PATROL_ZONE process can be started using the Start event.

Process

The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits. Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.

Process

This cycle will continue.

Process

During the patrol, the AI will detect enemy targets, which are reported through the Detected event.

Process

-- Note that the enemy is not engaged! To model enemy engagement, either tailor the Detected event, or use derived AI_ classes to model AI offensive or defensive behaviour.

Process

Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB. When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.

Process

1. AI_PATROL_ZONE constructor

2. AI_PATROL_ZONE is a FSM

Process

2.1. AI_PATROL_ZONE States

  • None ( Group ): The process is not started yet.
  • Patrolling ( Group ): The AI is patrolling the Patrol Zone.
  • Returning ( Group ): The AI is returning to Base.
  • Stopped ( Group ): The process is stopped.
  • Crashed ( Group ): The AI has crashed or is dead.

2.2. AI_PATROL_ZONE Events

  • Start ( Group ): Start the process.
  • Stop ( Group ): Stop the process.
  • Route ( Group ): Route the AI to a new random 3D point within the Patrol Zone.
  • RTB ( Group ): Route the AI to the home base.
  • Detect ( Group ): The AI is detecting targets.
  • Detected ( Group ): The AI has detected new targets.
  • Status ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.

3. Set or Get the AI controllable

4. Set the Speed and Altitude boundaries of the AI controllable

5. Manage the detection process of the AI controllable

The detection process of the AI controllable can be manipulated. Detection requires an amount of CPU power, which has an impact on your mission performance. Only put detection on when absolutely necessary, and the frequency of the detection can also be set.

The detection frequency can be set with AI_PATROL_ZONE.SetRefreshTimeInterval( seconds ), where the amount of seconds specify how much seconds will be waited before the next detection. Use the method AI_PATROL_ZONE.GetDetectedUnits() to obtain a list of the Wrapper.Units detected by the AI.

The detection can be filtered to potential targets in a specific zone. Use the method AI_PATROL_ZONE.SetDetectionZone() to set the zone where targets need to be detected. Note that when the zone is too far away, or the AI is not heading towards the zone, or the AI is too high, no targets may be detected according the weather conditions.

6. Manage the "out of fuel" in the AI_PATROL_ZONE

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 treshold is calculated. When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AI is targetted to the AI_PATROL_ZONE. Once the time is finished, the old AI will return to the base. Use the method AI_PATROL_ZONE.ManageFuel() to have this proces in place.

7. Manage "damage" behaviour of the AI in the AI_PATROL_ZONE

When the AI is damaged, it is required that a new AIControllable is started. However, damage cannon be foreseen early on. Therefore, when the damage treshold is reached, the AI will return immediately to the home base (RTB). Use the method AI_PATROL_ZONE.ManageDamage() to have this proces in place.


Type(s)

Fields and Methods inherited from AI_PATROL_ZONE Description

AI_PATROL_ZONE.AIControllable

The Wrapper.Controllable patrolling.

AI_PATROL_ZONE.CheckStatus

AI_PATROL_ZONE:ClearDetectedUnits()

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

AI_PATROL_ZONE.CoordTest

AI_PATROL_ZONE:Detect()

Synchronous Event Trigger for Event Detect.

AI_PATROL_ZONE.DetectActivated

AI_PATROL_ZONE.DetectInterval

AI_PATROL_ZONE.DetectOn

AI_PATROL_ZONE.DetectZone

AI_PATROL_ZONE:Detected()

Synchronous Event Trigger for Event Detected.

AI_PATROL_ZONE.DetectedUnits

AI_PATROL_ZONE:GetDetectedUnits()

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

AI_PATROL_ZONE:ManageDamage(PatrolDamageThreshold)

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

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.

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

Creates a new AI_PATROL_ZONE object

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

OnAfter Transition Handler for Event Detect.

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

OnAfter Transition Handler for Event Detected.

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

OnAfter Transition Handler for Event RTB.

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

OnAfter Transition Handler for Event Route.

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

OnAfter Transition Handler for Event Start.

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

OnAfter Transition Handler for Event Status.

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

OnAfter Transition Handler for Event Stop.

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

OnBefore Transition Handler for Event Detect.

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

OnBefore Transition Handler for Event Detected.

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

OnBefore Transition Handler for Event RTB.

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

OnBefore Transition Handler for Event Route.

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

OnBefore Transition Handler for Event Start.

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

OnBefore Transition Handler for Event Status.

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

OnBefore Transition Handler for Event Stop.

AI_PATROL_ZONE:OnCrash(EventData)

AI_PATROL_ZONE:OnEjection(EventData)

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

OnEnter Transition Handler for State Patrolling.

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

OnEnter Transition Handler for State Returning.

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

OnEnter Transition Handler for State Stopped.

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

OnLeave Transition Handler for State Patrolling.

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

OnLeave Transition Handler for State Returning.

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

OnLeave Transition Handler for State Stopped.

AI_PATROL_ZONE:OnPilotDead(EventData)

AI_PATROL_ZONE.PatrolAltType

AI_PATROL_ZONE.PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

AI_PATROL_ZONE.PatrolDamageThreshold

AI_PATROL_ZONE.PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

AI_PATROL_ZONE.PatrolFuelThresholdPercentage

AI_PATROL_ZONE.PatrolManageDamage

AI_PATROL_ZONE.PatrolMaxSpeed

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

AI_PATROL_ZONE.PatrolMinSpeed

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

AI_PATROL_ZONE.PatrolOutOfFuelOrbitTime

AI_PATROL_ZONE.PatrolZone

The Zone where the patrol needs to be executed.

AI_PATROL_ZONE:RTB()

Synchronous Event Trigger for Event RTB.

AI_PATROL_ZONE:Route()

Synchronous Event Trigger for Event Route.

AI_PATROL_ZONE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude)

Sets the floor and ceiling altitude of the patrol.

AI_PATROL_ZONE:SetDetectionActivated()

Activate the detection.

AI_PATROL_ZONE:SetDetectionDeactivated()

Deactivate the detection.

AI_PATROL_ZONE:SetDetectionOff()

Set the detection off.

AI_PATROL_ZONE:SetDetectionOn()

Set the detection on.

AI_PATROL_ZONE:SetDetectionZone(DetectionZone)

Set the detection zone where the AI is detecting targets.

AI_PATROL_ZONE:SetRefreshTimeInterval(Seconds)

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

AI_PATROL_ZONE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed)

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

AI_PATROL_ZONE:SetStatusOff()

Set the status checking off.

AI_PATROL_ZONE:Start()

Synchronous Event Trigger for Event Start.

AI_PATROL_ZONE:Status()

Synchronous Event Trigger for Event Status.

AI_PATROL_ZONE:Stop()

Synchronous Event Trigger for Event Stop.

AI_PATROL_ZONE._NewPatrolRoute(AIControllable, self)

AI_PATROL_ZONE:__Detect(Delay)

Asynchronous Event Trigger for Event Detect.

AI_PATROL_ZONE:__Detected(Delay)

Asynchronous Event Trigger for Event Detected.

AI_PATROL_ZONE:__RTB(Delay)

Asynchronous Event Trigger for Event RTB.

AI_PATROL_ZONE:__Route(Delay)

Asynchronous Event Trigger for Event Route.

AI_PATROL_ZONE:__Start(Delay)

Asynchronous Event Trigger for Event Start.

AI_PATROL_ZONE:__Status(Delay)

Asynchronous Event Trigger for Event Status.

AI_PATROL_ZONE:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

AI_PATROL_ZONE:onafterDead()

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

AI_PATROL_ZONE:onafterRTB()

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

Defines a new patrol route using the Process_PatrolZone parameters and settings.

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

Defines a new patrol route using the Process_PatrolZone parameters and settings.

AI_PATROL_ZONE:onafterStatus()

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

AI_PATROL_ZONE:onbeforeStatus()

Fields and Methods inherited from FSM_CONTROLLABLE Description

AI_PATROL_ZONE.Controllable

AI_PATROL_ZONE:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_PATROL_ZONE:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

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

OnAfter Transition Handler for Event Stop.

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

OnBefore Transition Handler for Event Stop.

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

OnEnter Transition Handler for State Stopped.

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

OnLeave Transition Handler for State Stopped.

AI_PATROL_ZONE:SetControllable(FSMControllable)

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

AI_PATROL_ZONE:Stop()

Synchronous Event Trigger for Event Stop.

AI_PATROL_ZONE:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

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

Fields and Methods inherited from FSM Description

AI_PATROL_ZONE:AddEndState(State)

Adds an End state.

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

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

AI_PATROL_ZONE:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

AI_PATROL_ZONE:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AI_PATROL_ZONE.CallScheduler

AI_PATROL_ZONE.Events

AI_PATROL_ZONE:GetCurrentState()

AI_PATROL_ZONE:GetEndStates()

Returns the End states.

AI_PATROL_ZONE:GetProcess(From, Event)

AI_PATROL_ZONE:GetProcesses()

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

AI_PATROL_ZONE:GetScores()

Returns a table with the scores defined.

AI_PATROL_ZONE:GetStartState()

Returns the start state of the FSM.

AI_PATROL_ZONE:GetState()

AI_PATROL_ZONE:GetSubs()

Returns a table with the Subs defined.

AI_PATROL_ZONE:GetTransitions()

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

AI_PATROL_ZONE:Is(State)

AI_PATROL_ZONE:LoadCallBacks(CallBackTable)

AI_PATROL_ZONE:New()

Creates a new FSM object.

AI_PATROL_ZONE.Scores

AI_PATROL_ZONE:SetProcess(From, Event, Fsm)

AI_PATROL_ZONE:SetStartState(State)

Sets the start state of the FSM.

AI_PATROL_ZONE._EndStates

AI_PATROL_ZONE._EventSchedules

AI_PATROL_ZONE._Processes

AI_PATROL_ZONE._Scores

AI_PATROL_ZONE._StartState

AI_PATROL_ZONE._Transitions

AI_PATROL_ZONE:_add_to_map(Map, Event)

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

AI_PATROL_ZONE:_create_transition(EventName)

AI_PATROL_ZONE:_delayed_transition(EventName)

AI_PATROL_ZONE:_eventmap(Events, EventStructure)

AI_PATROL_ZONE:_gosub(ParentFrom, ParentEvent)

AI_PATROL_ZONE:_handler(EventName, ...)

AI_PATROL_ZONE:_isendstate(Current)

AI_PATROL_ZONE:_submap(subs, sub, name)

AI_PATROL_ZONE:can(e)

AI_PATROL_ZONE:cannot(e)

AI_PATROL_ZONE.current

AI_PATROL_ZONE.endstates

AI_PATROL_ZONE:is(state)

AI_PATROL_ZONE.options

AI_PATROL_ZONE.subs

Fields and Methods inherited from BASE Description

AI_PATROL_ZONE.ClassID

The ID number of the class.

AI_PATROL_ZONE.ClassName

The name of the class.

AI_PATROL_ZONE.ClassNameAndID

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

AI_PATROL_ZONE:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

AI_PATROL_ZONE:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

AI_PATROL_ZONE:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

AI_PATROL_ZONE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

AI_PATROL_ZONE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

AI_PATROL_ZONE:E(Arguments)

Log an exception which will be traced always.

AI_PATROL_ZONE:EventDispatcher()

Returns the event dispatcher

AI_PATROL_ZONE:EventRemoveAll()

Remove all subscribed events

AI_PATROL_ZONE:F(Arguments)

Trace a function call.

AI_PATROL_ZONE:F2(Arguments)

Trace a function call level 2.

AI_PATROL_ZONE:F3(Arguments)

Trace a function call level 3.

AI_PATROL_ZONE:GetClassID()

Get the ClassID of the class instance.

AI_PATROL_ZONE:GetClassName()

Get the ClassName of the class instance.

AI_PATROL_ZONE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

AI_PATROL_ZONE:GetEventPriority()

Get the Class Event processing Priority.

AI_PATROL_ZONE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

AI_PATROL_ZONE:GetState(Object, Key)

Get a Value given a Key from the Object.

AI_PATROL_ZONE:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

AI_PATROL_ZONE:I(Arguments)

Log an information which will be traced always.

AI_PATROL_ZONE:Inherit(Child, Parent)

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

AI_PATROL_ZONE:IsInstanceOf(ClassName)

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

AI_PATROL_ZONE:IsTrace()

Enquires if tracing is on (for the class).

AI_PATROL_ZONE:New()

BASE constructor.

AI_PATROL_ZONE:OnEvent(EventData)

Occurs when an object is completely destroyed.

AI_PATROL_ZONE:OnEventBaseCaptured(EventData)

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

AI_PATROL_ZONE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

AI_PATROL_ZONE:OnEventCrash(EventData)

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

AI_PATROL_ZONE:OnEventDead(EventData)

Occurs when an object is dead.

AI_PATROL_ZONE:OnEventDetailedFailure(EventData)

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

AI_PATROL_ZONE:OnEventEjection(EventData)

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

AI_PATROL_ZONE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

AI_PATROL_ZONE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

AI_PATROL_ZONE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

AI_PATROL_ZONE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

AI_PATROL_ZONE:OnEventKill(EventData)

Occurs on the death of a unit.

AI_PATROL_ZONE:OnEventLand(EventData)

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

AI_PATROL_ZONE:OnEventLandingAfterEjection(EventData)

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

AI_PATROL_ZONE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

AI_PATROL_ZONE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

AI_PATROL_ZONE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

AI_PATROL_ZONE:OnEventMissionEnd(EventData)

Occurs when a mission ends

AI_PATROL_ZONE:OnEventMissionStart(EventData)

Occurs when a mission starts

AI_PATROL_ZONE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

AI_PATROL_ZONE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

AI_PATROL_ZONE:OnEventPlayerLeaveUnit(EventData)

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

AI_PATROL_ZONE:OnEventRefueling(EventData)

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

AI_PATROL_ZONE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

AI_PATROL_ZONE:OnEventScore(EventData)

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

AI_PATROL_ZONE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

AI_PATROL_ZONE:OnEventShootingStart(EventData)

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

AI_PATROL_ZONE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

AI_PATROL_ZONE:OnEventTakeoff(EventData)

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

AI_PATROL_ZONE:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

AI_PATROL_ZONE:ScheduleStop(SchedulerFunction)

Stops the Schedule.

AI_PATROL_ZONE.Scheduler

AI_PATROL_ZONE:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

AI_PATROL_ZONE:SetState(Object, Key, Value)

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

AI_PATROL_ZONE:T(Arguments)

Trace a function logic level 1.

AI_PATROL_ZONE:T2(Arguments)

Trace a function logic level 2.

AI_PATROL_ZONE:T3(Arguments)

Trace a function logic level 3.

AI_PATROL_ZONE:TraceAll(TraceAll)

Trace all methods in MOOSE

AI_PATROL_ZONE:TraceClass(Class)

Set tracing for a class

AI_PATROL_ZONE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

AI_PATROL_ZONE:TraceLevel(Level)

Set trace level

AI_PATROL_ZONE:TraceOff()

Set trace off.

AI_PATROL_ZONE:TraceOn()

Set trace on.

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.

AI_PATROL_ZONE:UnHandleEvent(Event)

UnSubscribe to a DCS event.

AI_PATROL_ZONE._

AI_PATROL_ZONE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

AI_PATROL_ZONE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

AI_PATROL_ZONE.__

AI_PATROL_ZONE:onEvent(event)

AI_PATROL_ZONE class

Field(s)

#table AI_PATROL_ZONE.DetectedUnits

This table contains the targets detected during patrol.

DCS#Altitude AI_PATROL_ZONE.PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

DCS#Altitude AI_PATROL_ZONE.PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

Core.Zone#ZONE_BASE AI_PATROL_ZONE.PatrolZone

The Zone where the patrol needs to be executed.

Function(s)

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

Defined in:

AI_PATROL_ZONE

Synchronous Event Trigger for Event Detect.

Defined in:

AI_PATROL_ZONE

Synchronous Event Trigger for Event Detected.

Defined in:

AI_PATROL_ZONE

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

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

However, damage cannot be foreseen early on. Therefore, when the damage treshold 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 treshold will be 0.25.

Defined in:

AI_PATROL_ZONE

Parameter:

#number PatrolDamageThreshold

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

Return value:

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 treshold is calculated. When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted 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 treshold 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:

Creates a new AI_PATROL_ZONE object

Defined in:

AI_PATROL_ZONE

Parameters:

Core.Zone#ZONE_BASE PatrolZone

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

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 )

OnAfter Transition Handler for Event Detect.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Detected.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event RTB.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Route.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Start.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Status.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnAfter Transition Handler for Event Stop.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnBefore Transition Handler for Event Detect.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

OnBefore Transition Handler for Event Detected.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

OnBefore Transition Handler for Event RTB.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

OnBefore Transition Handler for Event Route.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

OnBefore Transition Handler for Event Start.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

OnBefore Transition Handler for Event Status.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

OnBefore Transition Handler for Event Stop.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

Defined in:

AI_PATROL_ZONE

Parameter:

Defined in:

AI_PATROL_ZONE

Parameter:

OnEnter Transition Handler for State Patrolling.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnEnter Transition Handler for State Returning.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnEnter Transition Handler for State Stopped.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnLeave Transition Handler for State Patrolling.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

OnLeave Transition Handler for State Returning.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

OnLeave Transition Handler for State Stopped.

Defined in:

AI_PATROL_ZONE

Parameters:

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.

Defined in:

AI_PATROL_ZONE

Parameter:

Synchronous Event Trigger for Event RTB.

Defined in:

AI_PATROL_ZONE

Synchronous Event Trigger for Event Route.

Defined in:

AI_PATROL_ZONE

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:

Activate the detection.

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

Defined in:

AI_PATROL_ZONE

Return value:

Deactivate the detection.

The AI will NOT detect for targets.

Defined in:

AI_PATROL_ZONE

Return value:

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:

Set the detection on.

The AI will detect for targets.

Defined in:

AI_PATROL_ZONE

Return value:

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:

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:

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:

Set the status checking off.

Defined in:

AI_PATROL_ZONE

Return value:

Synchronous Event Trigger for Event Start.

Defined in:

AI_PATROL_ZONE

Synchronous Event Trigger for Event Status.

Defined in:

AI_PATROL_ZONE

Synchronous Event Trigger for Event Stop.

Defined in:

AI_PATROL_ZONE

Defined in:

AI_PATROL_ZONE

Parameters:

This statis method is called from the route path within the last task at the last waaypoint of the Controllable. Note that this method is required, as triggers the next route when patrolling for the Controllable.

self

Asynchronous Event Trigger for Event Detect.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Detected.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event RTB.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Route.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Start.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Status.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

Asynchronous Event Trigger for Event Stop.

Defined in:

AI_PATROL_ZONE

Parameter:

#number Delay

The delay in seconds.

Defined in:

AI_PATROL_ZONE

Defined in:

AI_PATROL_ZONE

Parameters:

Controllable

From

Event

To

Defined in:

AI_PATROL_ZONE

Defines a new patrol route using the Process_PatrolZone parameters and settings.

Defined in:

AI_PATROL_ZONE

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Defines a new patrol route using the Process_PatrolZone parameters and settings.

Defined in:

AI_PATROL_ZONE

Parameters:

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:

Defined in:

AI_PATROL_ZONE

Defined in:

AI_PATROL_ZONE

Parameters:

Controllable

From

Event

To

Defined in:

AI_PATROL_ZONE

Field(s)

#table AI_PATROL_ZONE.DetectedUnits

This table contains the targets detected during patrol.

DCS#Altitude AI_PATROL_ZONE.PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

DCS#Altitude AI_PATROL_ZONE.PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

Core.Zone#ZONE_BASE AI_PATROL_ZONE.PatrolZone

The Zone where the patrol needs to be executed.

Function(s)

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Creates a new FSM_CONTROLLABLE object.

Defined in:

Parameters:

#table FSMT

Finite State Machine Table

(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Return value:

OnAfter Transition Handler for Event Stop.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnBefore Transition Handler for Event Stop.

Defined in:

Parameters:

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.

OnEnter Transition Handler for State Stopped.

Defined in:

Parameters:

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

OnLeave Transition Handler for State Stopped.

Defined in:

Parameters:

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.

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Defined in:

Parameter:

Return value:

Synchronous Event Trigger for Event Stop.

Asynchronous Event Trigger for Event Stop.

Defined in:

Parameter:

#number Delay

The delay in seconds.

Field(s)

#table AI_PATROL_ZONE.DetectedUnits

This table contains the targets detected during patrol.

DCS#Altitude AI_PATROL_ZONE.PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

DCS#Altitude AI_PATROL_ZONE.PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

Core.Zone#ZONE_BASE AI_PATROL_ZONE.PatrolZone

The Zone where the patrol needs to be executed.

Function(s)

Adds an End state.

Defined in:

Parameter:

State

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

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:

The SubFSM.

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

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

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.

Returns the End states.

Defined in:

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Returns a table with the scores defined.

Defined in:

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Returns a table with the Subs defined.

Defined in:

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

Defined in:

Return value:

#table:

Defined in:

Parameter:

State

Defined in:

Parameter:

CallBackTable

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Defined in:

Parameters:

Map

Event

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameters:

Events

EventStructure

Defined in:

Parameters:

ParentFrom

ParentEvent

Defined in:

Parameters:

EventName

...

Defined in:

Parameter:

Current

Defined in:

Parameters:

subs

sub

name

Defined in:

Parameter:

e

Defined in:

Parameter:

e

Defined in:

Parameter:

state

Field(s)

#table AI_PATROL_ZONE.DetectedUnits

This table contains the targets detected during patrol.

DCS#Altitude AI_PATROL_ZONE.PatrolCeilingAltitude

The highest altitude in meters where to execute the patrol.

DCS#Altitude AI_PATROL_ZONE.PatrolFloorAltitude

The lowest altitude in meters where to execute the patrol.

Core.Zone#ZONE_BASE AI_PATROL_ZONE.PatrolZone

The Zone where the patrol needs to be executed.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

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

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

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

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

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

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

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

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

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

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

Defined in:

Parameter:

The EventData structure.

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

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

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

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

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

Defined in:

Parameter:

event