Banner Image

Module Actions.Route

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.


#ACT_ROUTE FSM class, extends Core.Fsm#FSM_PROCESS

ACT_ROUTE state machine:

This class is a state machine: it manages a process that is triggered by events causing state transitions to occur. All derived classes from this class will start with the class name, followed by a _. See the relevant derived class descriptions below. Each derived class follows exactly the same process, using the same events and following the same state transitions, but will have different implementation behaviour upon each event or state transition.

ACT_ROUTE Events:

These are the events defined in this class:

  • Start: The process is started. The process will go into the Report state.
  • Report: The process is reporting to the player the route to be followed.
  • Route: The process is routing the controllable.
  • Pause: The process is pausing the route of the controllable.
  • Arrive: The controllable has arrived at a route point.
  • More: There are more route points that need to be followed. The process will go back into the Report state.
  • NoMore: There are no more route points that need to be followed. The process will go into the Success state.

ACT_ROUTE Event methods:

Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions occurring in the process. There are two types of event methods, which you can use to influence the normal mechanisms in the state machine:

  • Immediate: The event method has exactly the name of the event.
  • Delayed: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed.

ACT_ROUTE States:

  • None: The controllable did not receive route commands.
  • Arrived (*): The controllable has arrived at a route point.
  • Aborted (*): The controllable has aborted the route path.
  • Routing: The controllable is understay to the route point.
  • Pausing: The process is pausing the routing. AI air will go into hover, AI ground will stop moving. Players can fly around.
  • Success (*): All route points were reached.
  • Failed (*): The process has failed.

(*) End states of the process.

ACT_ROUTE state transition methods:

State transition functions can be set by the mission designer customizing or improving the behaviour of the state. There are 2 moments when state transition methods will be called by the state machine:

  • Before the state transition. The state transition method needs to start with the name OnBefore + the name of the state. If the state transition method returns false, then the processing of the state transition will not be done! If you want to change the behaviour of the AIControllable at this event, return false, but then you'll need to specify your own logic using the AIControllable!

  • After the state transition. The state transition method needs to start with the name OnAfter + the name of the state. These state transition methods need to provide a return value, which is specified at the function description.


1) #ACT_ROUTE_ZONE class, extends Core.Fsm.Route#ACT_ROUTE

The ACT_ROUTE_ZONE class implements the core functions to route an AIR Wrapper.Controllable player Wrapper.Unit to a Zone. The player receives on perioding times messages with the coordinates of the route to follow. Upon arrival at the zone, a confirmation of arrival is sent, and the process will be ended.

1.1) ACT_ROUTE_ZONE constructor:


Global(s)

Global ACT_ROUTE

Global ACT_ROUTE_POINT

Global ACT_ROUTE_ZONE

Type(s)

Fields and Methods inherited from FSM_PROCESS Description

ACT_ROUTE:Assign(Task, ProcessUnit)

Assign the process to a Wrapper.Unit and activate the process.

ACT_ROUTE:Copy(Controllable, Task)

Creates a new FSM_PROCESS object based on this FSM_PROCESS.

ACT_ROUTE:GetCommandCenter()

Gets the mission of the process.

ACT_ROUTE:GetMission()

Gets the mission of the process.

ACT_ROUTE:GetTask()

Gets the task of the process.

ACT_ROUTE:Init(FsmProcess)

ACT_ROUTE:Message(Message)

Send a message of the Task to the Group of the Unit.

ACT_ROUTE:New(Controllable, Task)

Creates a new FSM_PROCESS object.

ACT_ROUTE:Remove()

Removes an FSM_PROCESS object.

ACT_ROUTE:SetTask(Task)

Sets the task of the process.

ACT_ROUTE.Task

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

ACT_ROUTE:onenterFailed(ProcessUnit, Task, From, Event, To)

ACT_ROUTE:onstatechange(ProcessUnit, Event, From, To, Task)

StateMachine callback function for a FSM_PROCESS

Fields and Methods inherited from FSM_CONTROLLABLE Description

ACT_ROUTE.Controllable

ACT_ROUTE:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

ACT_ROUTE:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

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

OnAfter Transition Handler for Event Stop.

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

OnBefore Transition Handler for Event Stop.

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

OnEnter Transition Handler for State Stopped.

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

OnLeave Transition Handler for State Stopped.

ACT_ROUTE:SetControllable(FSMControllable)

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

ACT_ROUTE:Stop()

Synchronous Event Trigger for Event Stop.

ACT_ROUTE:__Stop(Delay)

Asynchronous Event Trigger for Event Stop.

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

Fields and Methods inherited from FSM Description

ACT_ROUTE:AddEndState(State)

Adds an End state.

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

ACT_ROUTE:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

ACT_ROUTE:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

ACT_ROUTE.CallScheduler

ACT_ROUTE.Events

ACT_ROUTE:GetCurrentState()

ACT_ROUTE:GetEndStates()

Returns the End states.

ACT_ROUTE:GetProcess(From, Event)

ACT_ROUTE:GetProcesses()

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

ACT_ROUTE:GetScores()

Returns a table with the scores defined.

ACT_ROUTE:GetStartState()

Returns the start state of the FSM.

ACT_ROUTE:GetState()

ACT_ROUTE:GetSubs()

Returns a table with the Subs defined.

ACT_ROUTE:GetTransitions()

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

ACT_ROUTE:Is(State)

ACT_ROUTE:LoadCallBacks(CallBackTable)

ACT_ROUTE:New()

Creates a new FSM object.

ACT_ROUTE.Scores

ACT_ROUTE:SetProcess(From, Event, Fsm)

ACT_ROUTE:SetStartState(State)

Sets the start state of the FSM.

ACT_ROUTE._EndStates

ACT_ROUTE._EventSchedules

ACT_ROUTE._Processes

ACT_ROUTE._Scores

ACT_ROUTE._StartState

ACT_ROUTE._Transitions

ACT_ROUTE:_add_to_map(Map, Event)

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

ACT_ROUTE:_create_transition(EventName)

ACT_ROUTE:_delayed_transition(EventName)

ACT_ROUTE:_eventmap(Events, EventStructure)

ACT_ROUTE:_gosub(ParentFrom, ParentEvent)

ACT_ROUTE:_handler(EventName, ...)

ACT_ROUTE:_isendstate(Current)

ACT_ROUTE:_submap(subs, sub, name)

ACT_ROUTE:can(e)

ACT_ROUTE:cannot(e)

ACT_ROUTE.current

ACT_ROUTE.endstates

ACT_ROUTE:is(state)

ACT_ROUTE.options

ACT_ROUTE.subs

Fields and Methods inherited from BASE Description

ACT_ROUTE.ClassID

The ID number of the class.

ACT_ROUTE.ClassName

The name of the class.

ACT_ROUTE.ClassNameAndID

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

ACT_ROUTE:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

ACT_ROUTE:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

ACT_ROUTE:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

ACT_ROUTE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

ACT_ROUTE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

ACT_ROUTE:E(Arguments)

Log an exception which will be traced always.

ACT_ROUTE:EventDispatcher()

Returns the event dispatcher

ACT_ROUTE:EventRemoveAll()

Remove all subscribed events

ACT_ROUTE:F(Arguments)

Trace a function call.

ACT_ROUTE:F2(Arguments)

Trace a function call level 2.

ACT_ROUTE:F3(Arguments)

Trace a function call level 3.

ACT_ROUTE:GetClassID()

Get the ClassID of the class instance.

ACT_ROUTE:GetClassName()

Get the ClassName of the class instance.

ACT_ROUTE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

ACT_ROUTE:GetEventPriority()

Get the Class Event processing Priority.

ACT_ROUTE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

ACT_ROUTE:GetState(Object, Key)

Get a Value given a Key from the Object.

ACT_ROUTE:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

ACT_ROUTE:I(Arguments)

Log an information which will be traced always.

ACT_ROUTE:Inherit(Child, Parent)

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

ACT_ROUTE:IsInstanceOf(ClassName)

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

ACT_ROUTE:IsTrace()

Enquires if tracing is on (for the class).

ACT_ROUTE:New()

BASE constructor.

ACT_ROUTE:OnEvent(EventData)

Occurs when an object is completely destroyed.

ACT_ROUTE:OnEventBaseCaptured(EventData)

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

ACT_ROUTE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

ACT_ROUTE:OnEventCrash(EventData)

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

ACT_ROUTE:OnEventDead(EventData)

Occurs when an object is dead.

ACT_ROUTE:OnEventEjection(EventData)

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

ACT_ROUTE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

ACT_ROUTE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

ACT_ROUTE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

ACT_ROUTE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

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

ACT_ROUTE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

ACT_ROUTE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

ACT_ROUTE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

ACT_ROUTE:OnEventMissionEnd(EventData)

Occurs when a mission ends

ACT_ROUTE:OnEventMissionStart(EventData)

Occurs when a mission starts

ACT_ROUTE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

ACT_ROUTE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

ACT_ROUTE:OnEventPlayerLeaveUnit(EventData)

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

ACT_ROUTE:OnEventRefueling(EventData)

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

ACT_ROUTE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

ACT_ROUTE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

ACT_ROUTE:OnEventShootingStart(EventData)

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

ACT_ROUTE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

ACT_ROUTE:OnEventTakeoff(EventData)

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

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

Schedule a new time event.

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

Schedule a new time event.

ACT_ROUTE:ScheduleStop(SchedulerFunction)

Stops the Schedule.

ACT_ROUTE.Scheduler

ACT_ROUTE:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

ACT_ROUTE:SetState(Object, Key, Value)

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

ACT_ROUTE:T(Arguments)

Trace a function logic level 1.

ACT_ROUTE:T2(Arguments)

Trace a function logic level 2.

ACT_ROUTE:T3(Arguments)

Trace a function logic level 3.

ACT_ROUTE:TraceAll(TraceAll)

Trace all methods in MOOSE

ACT_ROUTE:TraceClass(Class)

Set tracing for a class

ACT_ROUTE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

ACT_ROUTE:TraceLevel(Level)

Set trace level

ACT_ROUTE:TraceOff()

Set trace off.

ACT_ROUTE:TraceOn()

Set trace on.

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

ACT_ROUTE:UnHandleEvent(Event)

UnSubscribe to a DCS event.

ACT_ROUTE._

ACT_ROUTE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

ACT_ROUTE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

ACT_ROUTE.__

ACT_ROUTE:onEvent(event)

ACT_ROUTE class

Field(s)

Function(s)

Get the routing text to be displayed.

The route mode determines the text displayed.

Defined in:

ACT_ROUTE

Parameter:

Wrapper.Unit#UNIT Controllable

Return value:

#string:

Defined in:

ACT_ROUTE

Creates a new routing state machine.

The process will route a CLIENT to a ZONE until the CLIENT is within that ZONE.

Defined in:

ACT_ROUTE

Return value:

self

Set a Cancel Menu item.

Defined in:

ACT_ROUTE

Parameters:

MenuGroup

MenuText

ParentMenu

MenuTime

MenuTag

Return value:

Set the route mode.

There are 2 route modes supported:

  • SetRouteMode( "B" ): Route mode is Bearing and Range.
  • SetRouteMode( "C" ): Route mode is LL or MGRS according coordinate system setup.

Defined in:

ACT_ROUTE

Parameter:

RouteMode

Return value:

StateMachine callback function

Defined in:

ACT_ROUTE

Parameters:

Wrapper.Unit#UNIT ProcessUnit

#string Event

#string From

#string To

StateMachine callback function

Defined in:

ACT_ROUTE

Parameters:

Wrapper.Unit#UNIT ProcessUnit

#string Event

#string From

#string To

Check if the controllable has arrived.

Defined in:

ACT_ROUTE

Parameter:

Wrapper.Unit#UNIT ProcessUnit

Return value:

#boolean:

Field(s)

Function(s)

Assign the process to a Wrapper.Unit and activate the process.

Defined in:

Parameters:

Wrapper.Unit#UNIT ProcessUnit

Return value:

self

Creates a new FSM_PROCESS object based on this FSM_PROCESS.

Defined in:

Parameters:

Controllable

Task

Return value:

Gets the mission of the process.

Gets the mission of the process.

Defined in:

Return value:

Gets the task of the process.

Defined in:

Return value:

Defined in:

Parameter:

FsmProcess

Send a message of the Task to the Group of the Unit.

Defined in:

Parameter:

Message

Creates a new FSM_PROCESS object.

Defined in:

Parameters:

Controllable

Task

Return value:

Removes an FSM_PROCESS object.

Defined in:

Return value:

Sets the task of the process.

Defined in:

Parameter:

Return value:

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameters:

ProcessUnit

Task

From

Event

To

StateMachine callback function for a FSM_PROCESS

Defined in:

Parameters:

#string Event

#string From

#string To

Task

Field(s)

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.

Defined in:

Parameters:

step

trigger

params

EventName

Field(s)

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:

Parameter:

EventName

Defined in:

Parameter:

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)

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.

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

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

ACT_ROUTE_POINT class

Field(s)

#number ACT_ROUTE_POINT.DisplayTime

10 seconds is the default

Function(s)

Get Coordinate

Defined in:

ACT_ROUTE_POINT

Return value:

Coordinate The Coordinate to route to.

Get Range around Coordinate

Defined in:

ACT_ROUTE_POINT

Return value:

#number:

The Range to consider the arrival. Default is 10000 meters.

Creates a new routing state machine.

The task will route a controllable to a Coordinate until the controllable is within the Range.

Defined in:

ACT_ROUTE_POINT

Parameter:

FsmRoute

Creates a new routing state machine.

The task will route a controllable to a Coordinate until the controllable is within the Range.

Defined in:

ACT_ROUTE_POINT

Parameters:

Coordinate to Target.

#number Range

The Distance to Target.

Coordinate

Set Coordinate

Defined in:

ACT_ROUTE_POINT

Parameter:

The Coordinate to route to.

Set Range around Coordinate

Defined in:

ACT_ROUTE_POINT

Parameter:

#number Range

The Range to consider the arrival. Default is 10000 meters.

StateMachine callback function

Defined in:

ACT_ROUTE_POINT

Parameters:

Wrapper.Unit#UNIT ProcessUnit

#string Event

#string From

#string To

Method override to check if the controllable has arrived.

Defined in:

ACT_ROUTE_POINT

Parameter:

Wrapper.Unit#UNIT ProcessUnit

Return value:

#boolean:

ACT_ROUTE_ZONE class

Field(s)

#number ACT_ROUTE_ZONE.DisplayTime

10 seconds is the default

Function(s)

Get Zone

Defined in:

ACT_ROUTE_ZONE

Return value:

Zone The Zone object where to route to.

Defined in:

ACT_ROUTE_ZONE

Parameter:

FsmRoute

Creates a new routing state machine.

The task will route a controllable to a ZONE until the controllable is within that ZONE.

Defined in:

ACT_ROUTE_ZONE

Parameter:

Set Zone

Defined in:

ACT_ROUTE_ZONE

Parameters:

The Zone object where to route to.

#number Altitude

#number Heading

StateMachine callback function

Defined in:

ACT_ROUTE_ZONE

Parameters:

Wrapper.Unit#UNIT ProcessUnit

#string Event

#string From

#string To

Method override to check if the controllable has arrived.

Defined in:

ACT_ROUTE_ZONE

Parameter:

Wrapper.Unit#UNIT ProcessUnit

Return value:

#boolean: