+ 
+Module Core.MarkerOps_Base
+Core - MarkerOps_Base.
+ + + +Main Features:
+ +-
+
- Create an easy way to tap into markers added to the F10 map by users. +
- Recognize own tag and list of keywords. +
- Matched keywords are handed down to functions. +
+ +
Author: Applevangelist
+ +Date: 5 May 2021
+ ++
-
+ +Global(s)
Global MARKEROPS_BASE |
+
+ Fiat lux. -- Latin proverb. + |
+
Fiat lux. -- Latin proverb.
+ + + ++ +
The MARKEROPS_BASE Concept
+ +This class enable scripting text-based actions from markers.
+ + +Type(s)
| Fields and Methods inherited from MARKEROPS_BASE | +Description | +
|---|---|
| + |
+ Name of the class. + |
+
| + |
+ Table of keywords to recognize. + |
+
| + |
+ Function to instantiate a new #MARKEROPS_BASE object. + |
+
MARKEROPS_BASE:OnAfterMarkAdded(From, Event, To, Text, Keywords, Coord) |
+
+ On after "MarkAdded" event. + |
+
MARKEROPS_BASE:OnAfterMarkChanged(From, Event, To, Text, Keywords, Coord) |
+
+ On after "MarkChanged" event. + |
+
| + |
+ On after "MarkDeleted" event. + |
+
| + |
+ (internal) Handle events. + |
+
| + |
+ "Stop" trigger. + |
+
| + |
+ Tag to identify commands. + |
+
| + |
+ (internal) Match keywords table. + |
+
| + |
+ (internal) Match tag. + |
+
| + | + + | +
| + | + + | +
MARKEROPS_BASE:onbeforeMarkAdded(From, Event, To, Text, Keywords, Coord) |
+
+ On before "MarkAdded" event. + |
+
MARKEROPS_BASE:onbeforeMarkChanged(From, Event, To, Text, Keywords, Coord) |
+
+ On before "MarkChanged" event. + |
+
| + |
+ On before "MarkDeleted" event. + |
+
| + |
+ On enter "Stopped" event. + |
+
| + |
+ Version of #MARKEROPS_BASE. + |
+
| Fields and Methods inherited from FSM | +Description | +
|---|---|
| + |
+ Adds an End state. + |
+
MARKEROPS_BASE: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. + |
+
| + |
+ Adds a score for the FSM to be achieved. + |
+
MARKEROPS_BASE:AddScoreProcess(From, Event, State, ScoreText, Score) |
+
+ Adds a score for the FSM_PROCESS to be achieved. + |
+
| + |
+ Add a new transition rule to the FSM. + |
+
| + |
+ Call scheduler. + |
+
| + |
+ Name of the class. + |
+
| + | + + | +
| + |
+ Get current state. + |
+
| + |
+ Returns the End states. + |
+
| + | + + | +
| + |
+ Returns a table of the SubFSM rules defined within the FSM. + |
+
| + |
+ Returns a table with the scores defined. + |
+
| + |
+ Returns the start state of the FSM. + |
+
| + |
+ Get current state. + |
+
| + |
+ Returns a table with the Subs defined. + |
+
| + |
+ Returns a table of the transition rules defined within the FSM. + |
+
| + |
+ Check if FSM is in state. + |
+
| + |
+ Load call backs. + |
+
| + |
+ Creates a new FSM object. + |
+
| + |
+ Scores. + |
+
| + | + + | +
| + |
+ Sets the start state of the FSM. + |
+
| + | + + | +
| + | + + | +
| + | + + | +
| + | + + | +
| + | + + | +
| + | + + | +
| + |
+ Add to map. + |
+
MARKEROPS_BASE:_call_handler(step, trigger, params, EventName) |
+
+ Call handler. + |
+
| + |
+ Create transition. + |
+
| + |
+ Delayed transition. + |
+
| + |
+ Event map. + |
+
| + |
+ Go sub. + |
+
| + |
+ Handler. + |
+
| + |
+ Is end state. + |
+
| + |
+ Sub maps. + |
+
| + |
+ Check if can do an event. + |
+
| + |
+ Check if cannot do an event. + |
+
| + |
+ Current state name. + |
+
| + | + + | +
| + |
+ Check if FSM is in state. + |
+
| + |
+ Options. + |
+
| + |
+ Subs. + |
+
| Fields and Methods inherited from BASE | +Description | +
|---|---|
| + |
+ The ID number of the class. + |
+
| + |
+ The name of the class. + |
+
| + |
+ The name of the class concatenated with the ID number of the class. + |
+
| + |
+ Clear the state of an object. + |
+
MARKEROPS_BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
+
+ Creation of a Birth Event. + |
+
MARKEROPS_BASE:CreateEventCrash(EventTime, Initiator, IniObjectCategory) |
+
+ Creation of a Crash Event. + |
+
| + |
+ Creation of a Dead Event. + |
+
| + |
+ Creation of a |
+
| + |
+ Creation of a Remove Unit Event. + |
+
| + |
+ Creation of a Takeoff Event. + |
+
| + |
+ Log an exception which will be traced always. + |
+
| + |
+ Returns the event dispatcher + |
+
| + |
+ Remove all subscribed events + |
+
| + |
+ Trace a function call. + |
+
| + |
+ Trace a function call level 2. + |
+
| + |
+ Trace a function call level 3. + |
+
| + |
+ Get the ClassID of the class instance. + |
+
| + |
+ Get the ClassName of the class instance. + |
+
| + |
+ Get the ClassName + ClassID of the class instance. + |
+
| + |
+ Get the Class Event processing Priority. + |
+
| + |
+ This is the worker method to retrieve the Parent class. + |
+
| + |
+ Get a Value given a Key from the Object. + |
+
| + |
+ Subscribe to a DCS Event. + |
+
| + |
+ Log an information which will be traced always. + |
+
| + |
+ This is the worker method to inherit from a parent class. + |
+
| + |
+ This is the worker method to check if an object is an (sub)instance of a class. + |
+
| + |
+ Enquires if tracing is on (for the class). + |
+
| + |
+ BASE constructor. + |
+
| + |
+ Occurs when an object is completely destroyed. + |
+
| + |
+ BDA. + |
+
| + |
+ Occurs when a ground unit captures either an airbase or a farp. + |
+
| + |
+ Occurs when any object is spawned into the mission. + |
+
| + |
+ Occurs when any aircraft crashes into the ground and is completely destroyed. + |
+
| + |
+ Occurs when an object is dead. + |
+
| + |
+ Unknown precisely what creates this event, likely tied into newer damage model. + |
+
| + |
+ Discard chair after ejection. + |
+
| + |
+ Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected + |
+
| + |
+ Occurs when any aircraft shuts down its engines. + |
+
| + |
+ Occurs when any aircraft starts its engines. + |
+
| + |
+ Occurs whenever an object is hit by a weapon. + |
+
| + |
+ Occurs when any system fails on a human controlled aircraft. + |
+
| + |
+ Occurs on the death of a unit. + |
+
| + |
+ Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed. + |
+
| + |
+ Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. + |
+
| + |
+ Landing quality mark. + |
+
| + |
+ Occurs when a new mark was added. + |
+
| + |
+ Occurs when a mark text was changed. + |
+
| + |
+ Occurs when a mark was removed. + |
+
| + |
+ Occurs when a mission ends. + |
+
| + |
+ Occurs when a mission starts. + |
+
| + |
+ Weapon add. + |
+
| + |
+ Occurs when the pilot of an aircraft is killed. + |
+
| + |
+ Occurs when a player enters a slot and takes control of an aircraft. + |
+
| + |
+ Occurs when any player assumes direct control of a unit. + |
+
| + |
+ Occurs when any player relieves control of a unit to the AI. + |
+
| + |
+ Occurs when an aircraft connects with a tanker and begins taking on fuel. + |
+
| + |
+ Occurs when an aircraft is finished taking fuel. + |
+
| + |
+ Occurs when any modification to the "Score" as seen on the debrief menu would occur. + |
+
| + |
+ Occurs when any unit stops firing its weapon. + |
+
| + |
+ Occurs when any unit begins firing a weapon that has a high rate of fire. + |
+
| + |
+ Occurs whenever any unit in a mission fires a weapon. + |
+
| + |
+ Occurs when an aircraft takes off from an airbase, farp, or ship. + |
+
| + |
+ Trigger zone. + |
+
| + |
+ Occurs when the game thinks an object is destroyed. + |
+
| + |
+ Schedule a new time event. + |
+
MARKEROPS_BASE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
+
+ Schedule a new time event. + |
+
| + |
+ Stops the Schedule. + |
+
| + | + + | +
| + |
+ Set the Class Event processing Priority. + |
+
| + |
+ Set a state or property of the Object given a Key and a Value. + |
+
| + |
+ Trace a function logic level 1. + |
+
| + |
+ Trace a function logic level 2. + |
+
| + |
+ Trace a function logic level 3. + |
+
| + |
+ Trace all methods in MOOSE + |
+
| + |
+ Set tracing for a class + |
+
| + |
+ Set tracing for a specific method of class + |
+
| + |
+ Set trace level + |
+
| + |
+ Set trace off. + |
+
| + |
+ Set trace on. + |
+
| + |
+ 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. + |
+
| + |
+ UnSubscribe to a DCS event. + |
+
| + | + + | +
MARKEROPS_BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
+
+ Trace a function call. + |
+
MARKEROPS_BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
+
+ Trace a function logic. + |
+
| + | + + | +
| + | + + | +
MARKEROPS_BASE class.
+ +Field(s)
+Name of the class.
+ +Table of keywords to recognize.
+ +Tag to identify commands.
+ +Set some string id for output to DCS.log file.
+ +Version of #MARKEROPS_BASE.
+ +Function(s)
+Function to instantiate a new #MARKEROPS_BASE object.
+ +Defined in:
+MARKEROPS_BASE
+Parameters:
++ #string + Tagname +
+Name to identify us from the event text.
+ ++ #table + Keywords +
+Table of keywords recognized from the event text.
+ +Return value:
+self
+ +On after "MarkAdded" event.
+ + +Triggered when a Marker is added to the F10 map.
+ +Defined in:
+MARKEROPS_BASE
+Parameters:
++ #string + From +
+The From state
+ ++ #string + Event +
+The Event called
+ ++ #string + To +
+The To state
+ ++ #string + Text +
+The text on the marker
+ ++ #table + Keywords +
+Table of matching keywords found in the Event text
+ ++ Core.Point#COORDINATE + Coord +
+Coordinate of the marker.
+ +On after "MarkChanged" event.
+ + +Triggered when a Marker is changed on the F10 map.
+ +Defined in:
+MARKEROPS_BASE
+Parameters:
++ #string + From +
+The From state
+ ++ #string + Event +
+The Event called
+ ++ #string + To +
+The To state
+ ++ #string + Text +
+The text on the marker
+ ++ #table + Keywords +
+Table of matching keywords found in the Event text
+ ++ Core.Point#COORDINATE + Coord +
+Coordinate of the marker.
+ +On after "MarkDeleted" event.
+ + +Triggered when a Marker is deleted from the F10 map.
+ +Defined in:
+MARKEROPS_BASE
+Parameters:
++ #string + From +
+The From state
+ ++ #string + Event +
+The Event called
+ ++ #string + To +
+The To state
+ +(internal) Handle events.
+ +"Stop" trigger.
+ + +Used to stop the function an unhandle events
+ +Defined in:
+MARKEROPS_BASE
+(internal) Match keywords table.
+ +Defined in:
+MARKEROPS_BASE
+Parameter:
++ #string + Eventtext +
+Text added to the marker.
+ +Return value:
+#table:
+(internal) Match tag.
+ +Defined in:
+MARKEROPS_BASE
+Parameter:
++ #string + Eventtext +
+Text added to the marker.
+ +Return value:
+#boolean:
+On before "MarkAdded" event.
+ + +Triggered when a Marker is added to the F10 map.
+ +Defined in:
+MARKEROPS_BASE
+Parameters:
++ #string + From +
+The From state
+ ++ #string + Event +
+The Event called
+ ++ #string + To +
+The To state
+ ++ #string + Text +
+The text on the marker
+ ++ #table + Keywords +
+Table of matching keywords found in the Event text
+ ++ Core.Point#COORDINATE + Coord +
+Coordinate of the marker.
+ +On before "MarkChanged" event.
+ + +Triggered when a Marker is changed on the F10 map.
+ +Defined in:
+MARKEROPS_BASE
+Parameters:
++ #string + From +
+The From state
+ ++ #string + Event +
+The Event called
+ ++ #string + To +
+The To state
+ ++ #string + Text +
+The text on the marker
+ ++ #table + Keywords +
+Table of matching keywords found in the Event text
+ ++ Core.Point#COORDINATE + Coord +
+Coordinate of the marker.
+ +On before "MarkDeleted" event.
+ + +Triggered when a Marker is removed from the F10 map.
+ +Defined in:
+MARKEROPS_BASE
+Parameters:
++ #string + From +
+The From state
+ ++ #string + Event +
+The Event called
+ ++ #string + To +
+The To state
+ +On enter "Stopped" event.
+ + +Unsubscribe events.
+ +Defined in:
+MARKEROPS_BASE
+Parameters:
++ #string + From +
+The From state
+ ++ #string + Event +
+The Event called
+ ++ #string + To +
+The To state
+ +Field(s)
+Name of the class.
+ +Table of keywords to recognize.
+ +Tag to identify commands.
+ +Set some string id for output to DCS.log file.
+ +Version of #MARKEROPS_BASE.
+ +Function(s)
+Adds an End state.
+ +Defined in:
+Parameter:
++ #string + State +
+The FSM 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.
+ ++ 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:
+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.
+ +Get current state.
+ +Returns the End states.
+ +Returns a table of the SubFSM rules defined within the FSM.
+ +Returns a table with the scores defined.
+ +Returns the start state of the FSM.
+ +Defined in:
+Return value:
+#string:
+A string containing the start state.
+ +Get current state.
+ +Returns a table with the Subs defined.
+ +Returns a table of the transition rules defined within the FSM.
+ +Check if FSM is in state.
+ +Defined in:
+Parameters:
++ #string + State +
+State name.
+ ++ #boolean + If +
+true, FSM is in this state.
+ +Load call backs.
+ +Defined in:
+Parameter:
++ #table + CallBackTable +
+Table of call backs.
+ +Creates a new FSM object.
+ +Defined in:
+Parameters:
++ From +
++ Event +
++ Fsm +
+Sets the start state of the FSM.
+ +Defined in:
+Parameter:
++ #string + State +
+A string defining the start state.
+ +Add to map.
+ +Defined in:
+Parameters:
++ #table + Map +
+Map.
+ ++ #table + Event +
+Event table.
+ +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.
+ +Create transition.
+ +Defined in:
+Parameter:
++ #string + EventName +
+Event name.
+ +Return value:
+#function:
+Function.
+ +Delayed transition.
+ +Defined in:
+Parameter:
++ #string + EventName +
+Event name.
+ +Return value:
+#function:
+Function.
+ +Event map.
+ +Defined in:
+Parameters:
++ #table + Events +
+Events.
+ ++ #table + EventStructure +
+Event structure.
+ +Go sub.
+ +Defined in:
+Parameters:
++ #string + ParentFrom +
+Parent from state.
+ ++ #string + ParentEvent +
+Parent event name.
+ +Return value:
+#table:
+Subs.
+ +Handler.
+ +Defined in:
+Parameters:
++ #string + EventName +
+Event name.
+ ++ ... +
+Arguments.
+ +Is end state.
+ +Defined in:
+Parameter:
++ #string + Current +
+Current state name.
+ +Return values:
+#table:
+FSM parent.
+ +#string:
+Event name.
+ +Sub maps.
+ +Defined in:
+Parameters:
++ #table + subs +
+Subs.
+ ++ #table + sub +
+Sub.
+ ++ #string + name +
+Name.
+ +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.
+ +Check if cannot do an event.
+ +Defined in:
+Parameter:
++ #string + e +
+Event name.
+ +Return value:
+#boolean:
+If true, FSM cannot do the event.
+ +Check if FSM is in state.
+ +Defined in:
+Parameters:
++ #string + State +
+State name.
+ ++ #boolean + If +
+true, FSM is in this state.
+ ++ state +
+Field(s)
+Name of the class.
+ +Table of keywords to recognize.
+ +Tag to identify commands.
+ +Set some string id for output to DCS.log file.
+ +Version of #MARKEROPS_BASE.
+ +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.
+ ++ 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.
+ +Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
Defined in:
+ +Parameter:
++ Wrapper.Unit#UNIT + PlayerUnit +
+The aircraft unit the player entered.
+ +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
+ +Remove all subscribed events
+ +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.
+ +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()
+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.
+ +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:
+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).
+ +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
+Occurs when an object is completely destroyed.
+ + +initiator : The unit that is was destroyed.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +BDA.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when any object is spawned into the mission.
+ + +initiator : The unit that was spawned.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when any aircraft crashes into the ground and is completely destroyed.
+ + +initiator : The unit that has crashed.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when an object is dead.
+ + +initiator : The unit that is dead.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Discard chair after ejection.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when any aircraft shuts down its engines.
+ + +initiator : The unit that is stopping its engines..
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when any aircraft starts its engines.
+ + +initiator : The unit that is starting its engines..
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when any system fails on a human controlled aircraft.
+ + +initiator : The unit that had the failure.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Landing quality mark.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when a new mark was added.
+ + +MarkID: ID of the mark.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when a mark text was changed.
+ + +MarkID: ID of the mark.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when a mark was removed.
+ + +MarkID: ID of the mark.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when a mission ends.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when a mission starts.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Weapon add.
+ + +Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when a player enters a slot and takes control of an aircraft.
+ + +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.
+ +Occurs when any player assumes direct control of a unit.
+ + +initiator : The unit that is being taken control of.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when an aircraft is finished taking fuel.
+ + +initiator : The unit that was receiving fuel.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+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:
++ Core.Event#EVENTDATA + EventData +
+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), auto cannons, and machine guns. +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.
+ +Occurs whenever any unit in a mission fires a weapon.
+ + +But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when an aircraft takes off from an airbase, farp, or ship.
+ + +initiator : The unit that took off. +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.
+ +Trigger zone.
+ +Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+The EventData structure.
+ +Occurs when the game thinks an object is destroyed.
+ + + +-
+
- initiator: The unit that is was destroyed. +
Defined in:
+ +Parameter:
++ Core.Event#EVENTDATA + EventData +
+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, 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.
+ +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
+ +Set tracing for a specific method of class
+ +Defined in:
+ +Parameters:
++ #string + Class +
++ #string + Method +
+Set trace level
+ +Set trace off.
+ +Set trace on.
+ +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:
++ Core.Event#EVENTS + EventID +
+Event ID.
+ +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
+ +