Close ×

AI.AI_A2A_Cap

AI - Models the process of Combat Air Patrol (CAP) for airplanes.
AI.AI_A2A_Dispatcher

AI - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
AI.AI_A2A_Gci

AI - Models the process of Ground Controlled Interception (GCI) for airplanes.
AI.AI_A2A_Patrol

AI - Models the process of air patrol of airplanes.
AI.AI_A2G_BAI

AI - Models the process of air to ground BAI engagement for airplanes and helicopters.
AI.AI_A2G_CAS

AI - Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_A2G_Dispatcher

AI - Create an automated A2G defense system with reconnaissance units, coordinating SEAD, BAI and CAS operations.
AI.AI_A2G_SEAD

AI - Models the process of air to ground SEAD engagement for airplanes and helicopters.
AI.AI_Air

AI - Models the process of AI air operations.
AI.AI_Air_Dispatcher

AI - Create an automated AIR defense system with reconnaissance units, coordinating SEAD, BAI and CAP operations.
AI.AI_Air_Engage

AI - Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_Air_Patrol

AI - Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
AI.AI_Air_Squadron

AI - Models squadrons for airplanes and helicopters.
AI.AI_BAI

AI - Peform Battlefield Area Interdiction (BAI) within an engagement zone.
AI.AI_Balancer

AI - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players.
AI.AI_CAP

AI - Perform Combat Air Patrolling (CAP) for airplanes.
AI.AI_CAS

AI - Perform Close Air Support (CAS) near friendlies.
AI.AI_Cargo

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_APC

AI - Models the intelligent transportation of cargo using ground vehicles.
AI.AI_Cargo_Airplane

AI - Models the intelligent transportation of cargo using airplanes.
AI.AI_Cargo_Dispatcher

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Dispatcher_APC

AI - Models the intelligent transportation of infantry and other cargo using APCs.
AI.AI_Cargo_Dispatcher_Airplane

AI - Models the intelligent transportation of infantry and other cargo using Planes.
AI.AI_Cargo_Dispatcher_Helicopter

AI - Models the intelligent transportation of infantry and other cargo using Helicopters.
AI.AI_Cargo_Dispatcher_Ship

AI - Models the intelligent transportation of infantry and other cargo using Ships.
AI.AI_Cargo_Helicopter

AI - Models the intelligent transportation of cargo using helicopters.
AI.AI_Cargo_Ship

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Escort

AI - Taking the lead of AI escorting your flight or of other AI.
AI.AI_Escort_Dispatcher

AI - Models the automatic assignment of AI escorts to player flights.
AI.AI_Escort_Dispatcher_Request

AI - Models the assignment of AI escorts to player flights upon request using the radio menu.
AI.AI_Escort_Request

AI - Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
AI.AI_Formation

AI - Build large airborne formations of aircraft.
AI.AI_Patrol

AI - Perform Air Patrolling for airplanes.
Actions.Act_Account

Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occurring on UNITs.
Actions.Act_Assign

(SP) (MP) (FSM) Accept or reject process for player (task) assignments.
Actions.Act_Assist

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

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

Cargo - Management of CARGO logistics, that can be transported from and to transportation carriers.
Cargo.CargoCrate

Cargo - Management of single cargo crates, which are based on a STATIC object.
Cargo.CargoGroup

Cargo - Management of grouped cargo logistics, which are based on a GROUP object.
Cargo.CargoSlingload

Cargo - Management of single cargo crates, which are based on a STATIC object.
Cargo.CargoUnit

Cargo - Management of single cargo logistics, which are based on a UNIT object.
Core.Astar

Core - A* Pathfinding.
Core.Base

Core - The base class within the framework.
Core.Beacon

Core - TACAN and other beacons.
Core.Condition

Core - Define any or all conditions to be evaluated.
Core.Database

Core - Manages several databases containing templates, mission objects, and mission information.
Core.Event

Core - Models DCS event dispatching using a publish-subscribe model.
Core.Fsm

Core - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.
Core.Goal

Core - Models the process to achieve goal(s).
Core.MarkerOps_Base

Core - Tap into markers added to the F10 map by users.
Core.Menu

Core - Manage hierarchical menu structures and commands for players within a mission.
Core.Message

Core - Informs the players using messages during a simulation.
Core.Pathline

Core - Path from A to B.
Core.Point

Core - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
Core.Report

Core - Provides a handy means to create messages and reports.
Core.ScheduleDispatcher

Core - SCHEDULEDISPATCHER dispatches the different schedules.
Core.Scheduler

Core - Prepares and handles the execution of functions over scheduled time (intervals).
Core.Set

Core - Define collections of objects to perform bulk actions and logically group objects.
Core.Settings

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.
Core.Spawn

Core - Spawn dynamically new groups of units in running missions.
Core.SpawnStatic

Core - Spawn statics.
Core.Spot

Core - Management of spotting logistics, that can be activated and deactivated upon command.
Core.TextAndSound

Core - A Moose GetText system.
Core.Timer

Core - Timer scheduler.
Core.UserFlag

Core - Manage user flags to interact with the mission editor trigger system and server side scripts.
Core.Velocity

Core - Models a velocity or speed, which can be expressed in various formats according the settings.
Core.Zone

Core - Define zones within your mission of various forms, with various capabilities.
Core.Zone_Detection

Core - The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.
DCS

DCS API Prototypes.
Functional.ATC_Ground

Functional - Monitor airbase traffic and regulate speed while taxiing.
Functional.Artillery

Functional - Control artillery units.
Functional.CleanUp

Functional - Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
Functional.ClientWatch

Functional - Manage and track client slots easily to add your own client-based menus and modules to.
Functional.Designate

Functional - Management of target Designation.
Functional.Detection

Functional - Models the detection of enemy units by FACs or RECCEs and group them according various methods.
Functional.DetectionZones

Functional - Captures the class DETECTION_ZONES.
Functional.Escort

Functional - Taking the lead of AI escorting your flight.
Functional.Fox

Functional - Yet Another Missile Trainer.
Functional.Mantis

Functional - Modular, Automatic and Network capable Targeting and Interception System for Air Defenses.
Functional.MissileTrainer

Functional - Train missile defence and deflection.
Functional.Movement

Functional - Limit the movement of simulaneous moving ground vehicles.
Functional.PseudoATC

Functional - Basic ATC.
Functional.RAT

Functional - Create random airtraffic in your missions.
Functional.Range

Functional - Range Practice.
Functional.Scoring

Functional - Administer the scoring of player achievements, file and log the scoring events for use at websites.
Functional.Sead

Functional - Make SAM sites evasive and execute defensive behaviour when being fired upon.
Functional.Shorad

Functional - Short Range Air Defense System.
Functional.Suppression

Functional - Suppress fire of ground units when they get hit.
Functional.Warehouse

Functional - Simulation of logistic operations.
Functional.ZoneCaptureCoalition

Functional - Models the process to zone guarding and capturing.
Functional.ZoneGoal

Functional - Base class that models processes to achieve goals involving a Zone.
Functional.ZoneGoalCargo

Functional - Base class that models processes to achieve goals involving a Zone and Cargo.
Functional.ZoneGoalCoalition

Functional - Base class that models processes to achieve goals involving a Zone for a Coalition.
Ops.ATIS


Ops.Airboss

Ops - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).
Ops.CSAR

Ops - Combat Search and Rescue.
Ops.CTLD

Ops - Combat Troops & Logistics Department.
Ops.RecoveryTanker

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
Shapes.CUBE


Author: nielsvaes/coconutcockpit
Shapes.LINE


Author: nielsvaes/coconutcockpit
Shapes.OVAL


Author: nielsvaes/coconutcockpit
Shapes.POLYGON


Author: nielsvaes/coconutcockpit
Shapes.SHAPE_BASE

Shapes - Class that serves as the base shapes drawn in the Mission Editor
Author: nielsvaes/coconutcockpit
Shapes.TRIANGLE

TRIANGLE class with properties and methods for handling triangles.
Sound.Radio

Sound - Radio transmissions.
Sound.RadioQueue

Sound - Queues Radio Transmissions.
Sound.RadioSpeech

Core - Makes the radio talk.
Sound.SRS

Sound - Simple Radio Standalone (SRS) Integration and Text-to-Speech.
Sound.SoundOutput

Sound - Sound output classes.
Sound.UserSound

Sound - Manage user sound.
Tasking.CommandCenter

Tasking - A command center governs multiple missions, and takes care of the reporting and communications.
Tasking.DetectionManager

Tasking - This module contains the DETECTION_MANAGER class and derived classes.
Tasking.Mission

Tasking - A mission models a goal to be achieved through the execution and completion of tasks by human players.
Tasking.Task

Tasking - A task object governs the main engine to administer human taskings.
Tasking.TaskInfo

Tasking - Controls the information of a Task.
Tasking.Task_A2A

Tasking - The TASK_A2A models tasks for players in Air to Air engagements.
Tasking.Task_A2A_Dispatcher

Tasking - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.
Tasking.Task_A2G

Tasking - The TASK_A2G models tasks for players in Air to Ground engagements.
Tasking.Task_A2G_Dispatcher

Tasking - Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.
Tasking.Task_CARGO

Tasking - Base class to model tasks for players to transport cargo.
Tasking.Task_Capture_Dispatcher

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.
Tasking.Task_Capture_Zone

Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
Tasking.Task_Cargo_CSAR

Tasking - Orchestrates the task for players to execute CSAR for downed pilots.
Tasking.Task_Cargo_Dispatcher

Tasking - Creates and manages player TASK_CARGO tasks.
Tasking.Task_Cargo_Transport

Tasking - Models tasks for players to transport cargo.
Tasking.Task_Manager

Tasking - This module contains the TASK_MANAGER class and derived classes.
Utilities.Enums

Utilities Enumerators.
Utilities.FiFo

 UTILS - Classic FiFo Stack.
Utilities.Profiler

Utils - Lua Profiler.
Utilities.STTS

Utilities  - DCS Simple Text-To-Speech (STTS).
Utilities.Socket

Utilities - Socket.
Utilities.Templates

Utilities - Templates.
Utilities.Utils

Utilities - Derived utilities taken from the MIST framework, added helpers from the MOOSE community.
Wrapper.Airbase

Wrapper - AIRBASE is a wrapper class to handle the DCS Airbase objects.
Wrapper.Client

Wrapper - CLIENT wraps DCS Unit objects acting as a Client or Player within a mission.
Wrapper.Controllable

Wrapper - CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".
Wrapper.DynamicCargo

Wrapper - Dynamic Cargo create from the F8 menu.
Wrapper.Group

Wrapper - GROUP wraps the DCS Class Group objects.
Wrapper.Identifiable

Wrapper - IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.
Wrapper.Marker

Wrapper - Markers On the F10 map.
Wrapper.Net

Wrapper - DCS net functions.
Wrapper.Object

Wrapper - OBJECT wraps the DCS Object derived objects.
Wrapper.Positionable

Wrapper - POSITIONABLE wraps DCS classes that are "positionable".
Wrapper.Scenery

Wrapper - SCENERY models scenery within the DCS simulator.
Wrapper.Static

Wrapper - STATIC wraps the DCS StaticObject class.
Wrapper.Storage

Wrapper - Warehouse storage of DCS airbases.
Wrapper.Unit

Wrapper - UNIT is a wrapper class for the DCS Class Unit.
Wrapper.Weapon

Wrapper - Weapon functions.

Module Wrapper.Marker

Wrapper - Markers On the F10 map.

Main Features:

Convenient handling of markers via multiple user API functions.
Update text and position of marker easily via scripting.
Delay creation and removal of markers via (optional) parameters.
Retrieve data such as text and coordinate.
Marker specific FSM events when a marker is added, removed or changed.
Additional FSM events when marker text or position is changed.

Author: funkyfranky

Global(s)

Global MARKER

Just because...

#MARKER MARKER

Just because...

The MARKER Class Idea

The MARKER class simplifies creating, updating and removing of markers on the F10 map.

Create a Marker

-- Create a MARKER object at Batumi with a trivial text.
local Coordinate = AIRBASE:FindByName( "Batumi" ):GetCoordinate()
mymarker = MARKER:New( Coordinate, "I am Batumi Airfield" )

Now this does not show the marker yet. We still need to specify to whom it is shown. There are several options, i.e. show the marker to everyone, to a specific coalition only, or only to a specific group.

For Everyone

If the marker should be visible to everyone, you can use the :ToAll() function.

mymarker = MARKER:New( Coordinate, "I am Batumi Airfield" ):ToAll()

For a Coalition

If the maker should be visible to a specific coalition, you can use the :ToCoalition() function.

mymarker = MARKER:New( Coordinate , "I am Batumi Airfield" ):ToCoalition( coalition.side.BLUE )

This would show the marker only to the Blue coalition.

For a Group

mymarker = MARKER:New( Coordinate , "Target Location" ):ToGroup( tankGroup )

Removing a Marker

mymarker:Remove(60)

This removes the marker after 60 seconds

Updating a Marker

The marker text and coordinate can be updated easily as shown below.

However, note that updating involves to remove and recreate the marker if either text or its coordinate is changed. This is a DCS scripting engine limitation.

Update Text

If you created a marker "mymarker" as shown above, you can update the displayed test by

mymarker:UpdateText( "I am the new text at Batumi" )

The update can also be delayed by, e.g. 90 seconds, using

mymarker:UpdateText( "I am the new text at Batumi", 90 )

Update Coordinate

If you created a marker "mymarker" as shown above, you can update its coordinate on the F10 map by

mymarker:UpdateCoordinate( NewCoordinate )

The update can also be delayed by, e.g. 60 seconds, using

mymarker:UpdateCoordinate( NewCoordinate , 60 )

Retrieve Data

The important data as the displayed text and the coordinate of the marker can be retrieved easily.

Text

local text  =mymarker:GetText()
env.info( "Marker Text = " .. text )

Coordinate

local Coordinate = mymarker:GetCoordinate()
env.info( "Marker Coordinate LL DSM = " .. Coordinate:ToStringLLDMS() )

FSM Events

Moose creates additional events, so called FSM event, when markers are added, changed, removed, and text or the coordinate is updated.

These events can be captured and used for processing via OnAfter functions as shown below.

Added

Changed

Removed

TextUpdate

CoordUpdate

Examples

Global _MARKERID

Marker ID.

#number _MARKERID

Marker ID.

Running number.

Type(s)

Type MARKER

MARKER , extends Core.Fsm#FSM , extends Core.Base#BASE

Fields and Methods inherited from MARKER	Description
MARKER:Added(EventData)	Triggers the FSM event "Added".
MARKER:Changed(EventData)	Triggers the FSM event "Changed".
MARKER.ClassName	Name of the class.
MARKER:CoordUpdate(Coordinate)	Triggers the FSM event "CoordUpdate".
MARKER.Debug	Debug mode. Messages to all about status.
MARKER:GetCoordinate()	Get position of the marker.
MARKER:GetText()	Get text that is displayed in the marker panel.
MARKER:IsInvisible()	Check if marker is currently invisible on the F10 map.
MARKER:IsVisible()	Check if marker is currently visible on the F10 map.
MARKER:Message(Text)	Set message that is displayed on screen if the marker is added.
MARKER:New(Coordinate, Text)	Create a new MARKER class object.
MARKER:OnAfterAdded(From, Event, To, EventData)	On after "Added" event user function.
MARKER:OnAfterChanged(From, Event, To, EventData)	On after "Changed" event user function.
MARKER:OnAfterCoordUpdate(From, Event, To, Coordinate)	On after "CoordUpdate" event user function.
MARKER:OnAfterRemoved(From, Event, To, EventData)	On after "Removed" event user function.
MARKER:OnAfterTextUpdate(From, Event, To, Text)	On after "TextUpdate" event user function.
MARKER:OnEventMarkAdded(EventData)	Event function when a MARKER is added.
MARKER:OnEventMarkChange(EventData)	Event function when a MARKER changed.
MARKER:OnEventMarkRemoved(EventData)	Event function when a MARKER is removed.
MARKER:ReadOnly()	Marker is readonly.
MARKER:ReadWrite()	Marker is read and write.
MARKER:Refresh(Delay)	Refresh the marker.
MARKER:Remove(Delay)	Remove a marker.
MARKER:Removed(EventData)	Triggers the FSM event "Removed".
MARKER:SetText(Text)	Set text that is displayed in the marker panel.
MARKER:TextUpdate(Text)	Triggers the FSM event "TextUpdate".
MARKER:ToAll(Delay)	Place marker visible for everyone.
MARKER:ToBlue(Delay)	Place marker visible for the blue coalition only.
MARKER:ToCoalition(Coalition, Delay)	Place marker visible for a specific coalition only.
MARKER:ToGroup(Group, Delay)	Place marker visible for a specific group only.
MARKER:ToNeutral(Delay)	Place marker visible for the neutral coalition only.
MARKER:ToRed(Delay)	Place marker visible for the blue coalition only.
MARKER:UpdateCoordinate(Coordinate, Delay)	Update the coordinate where the marker is displayed.
MARKER:UpdateText(Text, Delay)	Update the text displayed on the mark panel.
MARKER:__Added(EventData)	Triggers the delayed FSM event "Added".
MARKER:__Changed(EventData)	Triggers the delayed FSM event "Changed".
MARKER:__CoordUpdate(Coordinate)	Triggers the delayed FSM event "CoordUpdate".
MARKER:__Removed(EventData)	Triggers the delayed FSM event "Removed".
MARKER:__TextUpdate(Text)	Triggers the delayed FSM event "TextUpdate".
MARKER.coalition	Coalition to which the marker is displayed.
MARKER.coordinate	Coordinate of the mark.
MARKER.groupid
MARKER.groupname
MARKER.lid	Class id string for output to DCS log file.
MARKER.message	Message displayed when the mark is added.
MARKER.mid	Marker ID.
MARKER.myid
MARKER:onafterAdded(From, Event, To, EventData)	On after "Added" event.
MARKER:onafterChanged(From, Event, To, EventData)	On after "Changed" event.
MARKER:onafterCoordUpdate(From, Event, To, Coordinate)	On after "CoordUpdate" event.
MARKER:onafterRemoved(From, Event, To, EventData)	On after "Removed" event.
MARKER:onafterTextUpdate(From, Event, To, Text)	On after "TextUpdate" event.
MARKER.readonly	Marker is read-only.
MARKER.shown
MARKER.text	Text displayed in the mark panel.
MARKER.toall
MARKER.tocoalition
MARKER.togroup
MARKER.version	Marker class version.

Fields and Methods inherited from FSM	Description
MARKER:AddEndState(State)	Adds an End state.
MARKER:AddProcess(From, Event, Process, ReturnEvents)	Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.
MARKER:AddScore(State, ScoreText, Score)	Adds a score for the FSM to be achieved.
MARKER:AddScoreProcess(From, Event, State, ScoreText, Score)	Adds a score for the FSM_PROCESS to be achieved.
MARKER:AddTransition(From, Event, To)	Add a new transition rule to the FSM.
MARKER.CallScheduler	Call scheduler.
MARKER.ClassName	Name of the class.
MARKER.Events
MARKER:GetCurrentState()	Get current state.
MARKER:GetEndStates()	Returns the End states.
MARKER:GetProcess(From, Event)
MARKER:GetProcesses()	Returns a table of the SubFSM rules defined within the FSM.
MARKER:GetScores()	Returns a table with the scores defined.
MARKER:GetStartState()	Returns the start state of the FSM.
MARKER:GetState()	Get current state.
MARKER:GetSubs()	Returns a table with the Subs defined.
MARKER:GetTransitions()	Returns a table of the transition rules defined within the FSM.
MARKER:Is(State)	Check if FSM is in state.
MARKER:LoadCallBacks(CallBackTable)	Load call backs.
MARKER:New()	Creates a new FSM object.
MARKER.Scores	Scores.
MARKER:SetProcess(From, Event, Fsm)
MARKER:SetStartState(State)	Sets the start state of the FSM.
MARKER._EndStates
MARKER._EventSchedules
MARKER._Processes
MARKER._Scores
MARKER._StartState
MARKER._Transitions
MARKER:_add_to_map(Map, Event)	Add to map.
MARKER:_call_handler(step, trigger, params, EventName)	Call handler.
MARKER:_create_transition(EventName)	Create transition.
MARKER:_delayed_transition(EventName)	Delayed transition.
MARKER:_eventmap(Events, EventStructure)	Event map.
MARKER:_gosub(ParentFrom, ParentEvent)	Go sub.
MARKER:_handler(EventName, ...)	Handler.
MARKER:_isendstate(Current)	Is end state.
MARKER:_submap(subs, sub, name)	Sub maps.
MARKER:can(e)	Check if can do an event.
MARKER:cannot(e)	Check if cannot do an event.
MARKER.current	Current state name.
MARKER.endstates
MARKER:is(State, state)	Check if FSM is in state.
MARKER.options	Options.
MARKER.subs	Subs.

Fields and Methods inherited from BASE	Description
MARKER.ClassID	The ID number of the class.
MARKER.ClassName	The name of the class.
MARKER.ClassNameAndID	The name of the class concatenated with the ID number of the class.
MARKER:ClearState(Object, StateName)	Clear the state of an object.
MARKER:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)	Creation of a Birth Event.
MARKER:CreateEventCrash(EventTime, Initiator, IniObjectCategory)	Creation of a Crash Event.
MARKER:CreateEventDead(EventTime, Initiator, IniObjectCategory)	Creation of a Dead Event.
MARKER:CreateEventDynamicCargoLoaded(DynamicCargo)	Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.
MARKER:CreateEventDynamicCargoRemoved(DynamicCargo)	Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.
MARKER:CreateEventDynamicCargoUnloaded(DynamicCargo)	Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.
MARKER:CreateEventNewDynamicCargo(DynamicCargo)	Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.
MARKER:CreateEventPlayerEnterAircraft(PlayerUnit)	Creation of a `S_EVENT_PLAYER_ENTER_AIRCRAFT` event.
MARKER:CreateEventRemoveUnit(EventTime, Initiator)	Creation of a Remove Unit Event.
MARKER:CreateEventTakeoff(EventTime, Initiator)	Creation of a Takeoff Event.
MARKER:CreateEventUnitLost(EventTime, Initiator)	Creation of a Crash Event.
MARKER:E(Arguments)	Log an exception which will be traced always.
MARKER:EventDispatcher()	Returns the event dispatcher
MARKER:EventRemoveAll()	Remove all subscribed events
MARKER:F(Arguments)	Trace a function call.
MARKER:F2(Arguments)	Trace a function call level 2.
MARKER:F3(Arguments)	Trace a function call level 3.
MARKER:GetClassID()	Get the ClassID of the class instance.
MARKER:GetClassName()	Get the ClassName of the class instance.
MARKER:GetClassNameAndID()	Get the ClassName + ClassID of the class instance.
MARKER:GetEventPriority()	Get the Class Core.Event processing Priority.
MARKER:GetParent(Child, FromClass)	This is the worker method to retrieve the Parent class.
MARKER:GetState(Object, Key)	Get a Value given a Key from the Object.
MARKER:HandleEvent(EventID, EventFunction)	Subscribe to a DCS Event.
MARKER:I(Arguments)	Log an information which will be traced always.
MARKER:Inherit(Child, Parent)	This is the worker method to inherit from a parent class.
MARKER:IsInstanceOf(ClassName)	This is the worker method to check if an object is an (sub)instance of a class.
MARKER:IsTrace()	Enquires if tracing is on (for the class).
MARKER:New()	BASE constructor.
MARKER:OnEvent(EventData)	Occurs when an Event for an object is triggered.
MARKER:OnEventBDA(EventData)	BDA.
MARKER:OnEventBaseCaptured(EventData)	Occurs when a ground unit captures either an airbase or a farp.
MARKER:OnEventBirth(EventData)	Occurs when any object is spawned into the mission.
MARKER:OnEventCrash(EventData)	Occurs when any aircraft crashes into the ground and is completely destroyed.
MARKER:OnEventDead(EventData)	Occurs when an object is dead.
MARKER:OnEventDetailedFailure(EventData)	Unknown precisely what creates this event, likely tied into newer damage model.
MARKER:OnEventDiscardChairAfterEjection(EventData)	Discard chair after ejection.
MARKER:OnEventDynamicCargoLoaded(EventData)	Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.
MARKER:OnEventDynamicCargoRemoved(EventData)	Occurs when a dynamic cargo crate is removed.
MARKER:OnEventDynamicCargoUnloaded(EventData)	Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.
MARKER:OnEventEjection(EventData)	Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.
MARKER:OnEventEngineShutdown(EventData)	Occurs when any aircraft shuts down its engines.
MARKER:OnEventEngineStartup(EventData)	Occurs when any aircraft starts its engines.
MARKER:OnEventHit(EventData)	Occurs whenever an object is hit by a weapon.
MARKER:OnEventHumanFailure(EventData)	Occurs when any system fails on a human controlled aircraft.
MARKER:OnEventKill(EventData)	Occurs on the death of a unit.
MARKER:OnEventLand(EventData)	Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.
MARKER:OnEventLandingAfterEjection(EventData)	Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
MARKER:OnEventLandingQualityMark(EventData)	Landing quality mark.
MARKER:OnEventMarkAdded(EventData)	Occurs when a new mark was added.
MARKER:OnEventMarkChange(EventData)	Occurs when a mark text was changed.
MARKER:OnEventMarkRemoved(EventData)	Occurs when a mark was removed.
MARKER:OnEventMissionEnd(EventData)	Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.
MARKER:OnEventMissionStart(EventData)	Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.
MARKER:OnEventNewDynamicCargo(EventData)	Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.
MARKER:OnEventParatrooperLanding(EventData)	Weapon add.
MARKER:OnEventPilotDead(EventData)	Occurs when the pilot of an aircraft is killed.
MARKER:OnEventPlayerEnterAircraft(EventData)	Occurs when a player enters a slot and takes control of an aircraft.
MARKER:OnEventPlayerEnterUnit(EventData)	Occurs when any player assumes direct control of a unit.
MARKER:OnEventPlayerLeaveUnit(EventData)	Occurs when any player relieves control of a unit to the AI.
MARKER:OnEventRefueling(EventData)	Occurs when an aircraft connects with a tanker and begins taking on fuel.
MARKER:OnEventRefuelingStop(EventData)	Occurs when an aircraft is finished taking fuel.
MARKER:OnEventScore(EventData)	Occurs when any modification to the "Score" as seen on the debrief menu would occur.
MARKER:OnEventShootingEnd(EventData)	Occurs when any unit stops firing its weapon.
MARKER:OnEventShootingStart(EventData)	Occurs when any unit begins firing a weapon that has a high rate of fire.
MARKER:OnEventShot(EventData)	Occurs whenever any unit in a mission fires a weapon.
MARKER:OnEventTakeoff(EventData)	Occurs when an aircraft takes off from an airbase, farp, or ship.
MARKER:OnEventTriggerZone(EventData)	Trigger zone.
MARKER:OnEventUnitLost(EventData)	Occurs when the game thinks an object is destroyed.
MARKER:ScheduleOnce(Start, SchedulerFunction, ...)	Schedule a new time event.
MARKER:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)	Schedule a new time event.
MARKER:ScheduleStop(SchedulerID)	Stops the Schedule.
MARKER.Scheduler
MARKER:SetEventPriority(EventPriority)	Set the Class Core.Event processing Priority.
MARKER:SetState(Object, Key, Value)	Set a state or property of the Object given a Key and a Value.
MARKER:T(Arguments)	Trace a function logic level 1.
MARKER:T2(Arguments)	Trace a function logic level 2.
MARKER:T3(Arguments)	Trace a function logic level 3.
MARKER:TraceAll(TraceAll)	Trace all methods in MOOSE
MARKER:TraceClass(Class)	Set tracing for a class
MARKER:TraceClassMethod(Class, Method)	Set tracing for a specific method of class
MARKER:TraceLevel(Level)	Set trace level
MARKER:TraceOff()	Set trace off.
MARKER:TraceOn()	Set trace on.
MARKER: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.
MARKER:UnHandleEvent(EventID)	UnSubscribe to a DCS event.
MARKER._
MARKER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function call.
MARKER:_Serialize(Arguments)	(Internal) Serialize arguments
MARKER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function logic.
MARKER.__
MARKER:onEvent(event)	The main event handling function...

Type Wrapper.Marker

Type MARKER

Marker class.

Field(s)

#string MARKER.ClassName

Name of the class.

#boolean MARKER.Debug

Debug mode. Messages to all about status.

#number MARKER.coalition

Coalition to which the marker is displayed.

Core.Point#COORDINATE MARKER.coordinate

Coordinate of the mark.

#string MARKER.lid

Class id string for output to DCS log file.

#string MARKER.message

Message displayed when the mark is added.

#number MARKER.mid

Marker ID.

MARKER.myid

#boolean MARKER.readonly

Marker is read-only.

#boolean MARKER.shown

#string MARKER.text

Text displayed in the mark panel.

#boolean MARKER.toall

#string MARKER.version

Marker class version.

Function(s)

MARKER:Added(EventData)

Triggers the FSM event "Added".

Defined in:

MARKER

Parameter:

Core.Event#EVENTDATA EventData

Event data table.

MARKER:Changed(EventData)

Triggers the FSM event "Changed".

Defined in:

MARKER

Parameter:

Core.Event#EVENTDATA EventData

Event data table.

MARKER:CoordUpdate(Coordinate)

Triggers the FSM event "CoordUpdate".

Defined in:

MARKER

Parameter:

Core.Point#COORDINATE Coordinate

The new Coordinate.

MARKER:GetCoordinate()

Get position of the marker.

Defined in:

MARKER

Return value:

Core.Point#COORDINATE:

The coordinate of the marker.

MARKER:GetText()

Get text that is displayed in the marker panel.

Defined in:

MARKER

Return value:

#string:

Marker text.

MARKER:IsInvisible()

Check if marker is currently invisible on the F10 map.

Defined in:

MARKER

Return value:

MARKER:IsVisible()

Check if marker is currently visible on the F10 map.

Defined in:

MARKER

Return value:

#boolean:

True if the marker is currently visible.

MARKER:Message(Text)

Set message that is displayed on screen if the marker is added.

Defined in:

MARKER

Parameter:

#string Text

Message displayed when the marker is added.

Return value:

#MARKER:

self

MARKER:New(Coordinate, Text)

Create a new MARKER class object.

Defined in:

MARKER

Parameters:

Core.Point#COORDINATE Coordinate

Coordinate where to place the marker.

#string Text

Text displayed on the mark panel.

Return value:

#MARKER:

self

MARKER:OnAfterAdded(From, Event, To, EventData)

On after "Added" event user function.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Event#EVENTDATA EventData

Event data table.

MARKER:OnAfterChanged(From, Event, To, EventData)

On after "Changed" event user function.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Event#EVENTDATA EventData

Event data table.

MARKER:OnAfterCoordUpdate(From, Event, To, Coordinate)

On after "CoordUpdate" event user function.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Point#COORDINATE Coordinate

The updated Coordinate.

MARKER:OnAfterRemoved(From, Event, To, EventData)

On after "Removed" event user function.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Event#EVENTDATA EventData

Event data table.

MARKER:OnAfterTextUpdate(From, Event, To, Text)

On after "TextUpdate" event user function.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#string Text

The new text.

MARKER:OnEventMarkAdded(EventData)

Event function when a MARKER is added.

Defined in:

MARKER

Parameter:

Core.Event#EVENTDATA EventData

MARKER:OnEventMarkChange(EventData)

Event function when a MARKER changed.

Defined in:

MARKER

Parameter:

Core.Event#EVENTDATA EventData

MARKER:OnEventMarkRemoved(EventData)

Event function when a MARKER is removed.

Defined in:

MARKER

Parameter:

Core.Event#EVENTDATA EventData

MARKER:ReadOnly()

Marker is readonly.

Text cannot be changed and marker cannot be removed. The will not update the marker in the game, Call MARKER:Refresh to update state.

Defined in:

MARKER

Return value:

#MARKER:

self

MARKER:ReadWrite()

Marker is read and write.

Text cannot be changed and marker cannot be removed. The will not update the marker in the game, Call MARKER:Refresh to update state.

Defined in:

MARKER

Return value:

#MARKER:

self

MARKER:Refresh(Delay)

Refresh the marker.

Defined in:

MARKER

Parameter:

#number Delay

(Optional) Delay in seconds, before the marker is created.

Return value:

#MARKER:

self

MARKER:Remove(Delay)

Remove a marker.

Defined in:

MARKER

Parameter:

#number Delay

(Optional) Delay in seconds, before the marker is removed.

Return value:

#MARKER:

self

MARKER:Removed(EventData)

Triggers the FSM event "Removed".

Defined in:

MARKER

Parameter:

Core.Event#EVENTDATA EventData

Event data table.

MARKER:SetText(Text)

Set text that is displayed in the marker panel.

Note this does not show the marker.

Defined in:

MARKER

Parameter:

#string Text

Marker text. Default is an empty string "".

Return value:

#MARKER:

self

MARKER:TextUpdate(Text)

Triggers the FSM event "TextUpdate".

Defined in:

MARKER

Parameter:

#string Text

The new text.

MARKER:ToAll(Delay)

Place marker visible for everyone.

Defined in:

MARKER

Parameter:

#number Delay

(Optional) Delay in seconds, before the marker is created.

Return value:

#MARKER:

self

MARKER:ToBlue(Delay)

Place marker visible for the blue coalition only.

Defined in:

MARKER

Parameter:

#number Delay

(Optional) Delay in seconds, before the marker is created.

Return value:

#MARKER:

self

MARKER:ToCoalition(Coalition, Delay)

Place marker visible for a specific coalition only.

Defined in:

MARKER

Parameters:

#number Coalition

Coalition 1=Red, 2=Blue, 0=Neutral. See coalition.side.RED.

#number Delay

(Optional) Delay in seconds, before the marker is created.

Return value:

#MARKER:

self

MARKER:ToGroup(Group, Delay)

Place marker visible for a specific group only.

Defined in:

MARKER

Parameters:

Wrapper.Group#GROUP Group

The group to which the marker is displayed.

#number Delay

(Optional) Delay in seconds, before the marker is created.

Return value:

#MARKER:

self

MARKER:ToNeutral(Delay)

Place marker visible for the neutral coalition only.

Defined in:

MARKER

Parameter:

#number Delay

(Optional) Delay in seconds, before the marker is created.

Return value:

#MARKER:

self

MARKER:ToRed(Delay)

Place marker visible for the blue coalition only.

Defined in:

MARKER

Parameter:

#number Delay

(Optional) Delay in seconds, before the marker is created.

Return value:

#MARKER:

self

MARKER:UpdateCoordinate(Coordinate, Delay)

Update the coordinate where the marker is displayed.

Defined in:

MARKER

Parameters:

Core.Point#COORDINATE Coordinate

The new coordinate.

#number Delay

(Optional) Delay in seconds, before the marker is created.

Return value:

#MARKER:

self

MARKER:UpdateText(Text, Delay)

Update the text displayed on the mark panel.

Defined in:

MARKER

Parameters:

#string Text

Updated text.

#number Delay

(Optional) Delay in seconds, before the marker is created.

Return value:

#MARKER:

self

MARKER:__Added(EventData)

Triggers the delayed FSM event "Added".

Defined in:

MARKER

Parameter:

Core.Event#EVENTDATA EventData

Event data table.

MARKER:__Changed(EventData)

Triggers the delayed FSM event "Changed".

Defined in:

MARKER

Parameter:

Core.Event#EVENTDATA EventData

Event data table.

MARKER:__CoordUpdate(Coordinate)

Triggers the delayed FSM event "CoordUpdate".

Defined in:

MARKER

Parameter:

Core.Point#COORDINATE Coordinate

The updated Coordinate.

MARKER:__Removed(EventData)

Triggers the delayed FSM event "Removed".

Defined in:

MARKER

Parameter:

Core.Event#EVENTDATA EventData

Event data table.

MARKER:__TextUpdate(Text)

Triggers the delayed FSM event "TextUpdate".

Defined in:

MARKER

Parameter:

#string Text

The new text.

MARKER:onafterAdded(From, Event, To, EventData)

On after "Added" event.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Event#EVENTDATA EventData

Event data table.

MARKER:onafterChanged(From, Event, To, EventData)

On after "Changed" event.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Event#EVENTDATA EventData

Event data table.

MARKER:onafterCoordUpdate(From, Event, To, Coordinate)

On after "CoordUpdate" event.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Point#COORDINATE Coordinate

The updated coordinates.

MARKER:onafterRemoved(From, Event, To, EventData)

On after "Removed" event.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Event#EVENTDATA EventData

Event data table.

MARKER:onafterTextUpdate(From, Event, To, Text)

On after "TextUpdate" event.

Defined in:

MARKER

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#string Text

The updated text, displayed in the mark panel.

Field(s)

#string MARKER.ClassName

Name of the class.

#boolean MARKER.Debug

Debug mode. Messages to all about status.

#number MARKER.coalition

Coalition to which the marker is displayed.

Core.Point#COORDINATE MARKER.coordinate

Coordinate of the mark.

#string MARKER.lid

Class id string for output to DCS log file.

#string MARKER.message

Message displayed when the mark is added.

#number MARKER.mid

Marker ID.

MARKER.myid

#boolean MARKER.readonly

Marker is read-only.

#boolean MARKER.shown

#string MARKER.text

Text displayed in the mark panel.

#boolean MARKER.toall

#string MARKER.version

Marker class version.

Function(s)

MARKER:AddEndState(State)

Adds an End state.

Defined in:

Core.Fsm#FSM

Parameter:

#string State

The FSM state.

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

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

Defined in:

Core.Fsm#FSM

Parameters:

#table From

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

#string Event

The Event name.

Core.Fsm#FSM_PROCESS Process

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

Core.Fsm#FSM_PROCESS:

The SubFSM.

MARKER:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

Defined in:

Core.Fsm#FSM

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

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

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Core.Fsm#FSM

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

MARKER:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Core.Fsm#FSM

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.

MARKER:GetCurrentState()

Get current state.

Defined in:

Core.Fsm#FSM

Return value:

#string:

Current FSM state.

MARKER:GetEndStates()

Returns the End states.

Defined in:

Core.Fsm#FSM

Return value:

#table:

End states.

MARKER:GetProcess(From, Event)

Defined in:

Core.Fsm#FSM

Parameters:

From

Event

MARKER:GetProcesses()

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

Defined in:

Core.Fsm#FSM

Return value:

#table:

Sub processes.

MARKER:GetScores()

Returns a table with the scores defined.

Defined in:

Core.Fsm#FSM

Return value:

#table:

Scores.

MARKER:GetStartState()

Returns the start state of the FSM.

Defined in:

Core.Fsm#FSM

Return value:

#string:

A string containing the start state.

MARKER:GetState()

Get current state.

Defined in:

Core.Fsm#FSM

Return value:

#string:

Current FSM state.

MARKER:GetSubs()

Returns a table with the Subs defined.

Defined in:

Core.Fsm#FSM

Return value:

#table:

Sub processes.

MARKER:GetTransitions()

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

Defined in:

Core.Fsm#FSM

Return value:

#table:

Transitions.

MARKER:Is(State)

Check if FSM is in state.

Defined in:

Core.Fsm#FSM

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

MARKER:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Core.Fsm#FSM

Parameter:

#table CallBackTable

Table of call backs.

MARKER:New()

Creates a new FSM object.

Defined in:

Core.Fsm#FSM

Return value:

#FSM:

MARKER:SetProcess(From, Event, Fsm)

Defined in:

Core.Fsm#FSM

Parameters:

From

Event

Fsm

MARKER:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Core.Fsm#FSM

Parameter:

#string State

A string defining the start state.

MARKER:_add_to_map(Map, Event)

Add to map.

Defined in:

Core.Fsm#FSM

Parameters:

#table Map

Map.

#table Event

Event table.

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

Call handler.

Defined in:

Core.Fsm#FSM

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

MARKER:_create_transition(EventName)

Create transition.

Defined in:

Core.Fsm#FSM

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

MARKER:_delayed_transition(EventName)

Delayed transition.

Defined in:

Core.Fsm#FSM

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

MARKER:_eventmap(Events, EventStructure)

Event map.

Defined in:

Core.Fsm#FSM

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

MARKER:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Core.Fsm#FSM

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

MARKER:_handler(EventName, ...)

Handler.

Defined in:

Core.Fsm#FSM

Parameters:

#string EventName

Event name.

...

Arguments.

MARKER:_isendstate(Current)

Is end state.

Defined in:

Core.Fsm#FSM

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

MARKER:_submap(subs, sub, name)

Sub maps.

Defined in:

Core.Fsm#FSM

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

MARKER:can(e)

Check if can do an event.

Defined in:

Core.Fsm#FSM

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

MARKER:cannot(e)

Check if cannot do an event.

Defined in:

Core.Fsm#FSM

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

MARKER:is(State, state)

Check if FSM is in state.

Defined in:

Core.Fsm#FSM

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#string MARKER.ClassName

Name of the class.

#boolean MARKER.Debug

Debug mode. Messages to all about status.

#number MARKER.coalition

Coalition to which the marker is displayed.

Core.Point#COORDINATE MARKER.coordinate

Coordinate of the mark.

#string MARKER.lid

Class id string for output to DCS log file.

#string MARKER.message

Message displayed when the mark is added.

#number MARKER.mid

Marker ID.

MARKER.myid

#boolean MARKER.readonly

Marker is read-only.

#boolean MARKER.shown

#string MARKER.text

Text displayed in the mark panel.

#boolean MARKER.toall

#string MARKER.version

Marker class version.

Function(s)

MARKER:ClearState(Object, StateName)

Clear the state of an object.