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

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

The #CLIENTWATCH class adds a simplified way to create scripts and menus for individual clients. Instead of creating large algorithms and juggling multiple event handlers, you can simply provide one or more prefixes to the class and use the callback functions on spawn, despawn, and any aircraft related events to script to your hearts content.

Features:

Find clients by prefixes or by providing a Wrapper.CLIENT object
Trigger functions when the client spawns and despawns
Create multiple client instances without overwriting event handlers between instances
More reliable aircraft lost events for when DCS thinks the aircraft id dead but a dead event fails to trigger
Easily manage clients spawned in dynamic slots

Author: Statua

Contributions: FlightControl: Wrapper.CLIENT

Global(s)

Global CLIENTWATCH

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

#CLIENTWATCH CLIENTWATCH

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

Creating a new instance

To start, you must first create a new instance of the client manager and provide it with either a Wrapper.Client#CLIENT object, a string prefix of the unit name, or a table of string prefixes for unit names. These are used to capture the client unit when it spawns and apply your scripted functions to it. Only fixed wing and rotary wing aircraft controlled by players can be used by this class. This will not work if the client aircraft is alive!

Examples

     -- Create an instance with a Wrapper.Client#CLIENT object
     local heliClient = CLIENT:FindByName('Rotary1-1')
     local clientInstance = CLIENTWATCH:New(heliClient)

     -- Create an instance with part of the unit name in the Mission Editor
     local clientInstance = CLIENTWATCH:New("Rotary")

     -- Create an instance using prefixes for a few units as well as a FARP name for any dynamic spawns coming out of it
     local clientInstance = CLIENTWATCH:New({"Rescue","UH-1H","FARP ALPHA"})

Applying functions and methods to client aircraft when they spawn

Once the instance is created, it will watch for birth events. If the unit name of the client aircraft matches the one provided in the instance, the callback method #CLIENTWATCH() can be used to apply functions and methods to the client object.

In the OnAfterSpawn() callback method are four values. From, Event, To, and ClientObject. From,Event,To are standard FSM strings for the state changes. ClientObject is where the magic happens. This is a special object which you can use to access all the data of the client aircraft. The following entries in ClientObject are available for you to use:

ClientObject.Unit: The Moose Wrapper.Unit#UNIT of the client aircraft
ClientObject.Group: The Moose Wrapper.Group#GRUP of the client aircraft
ClientObject.Client: The Moose Wrapper.Client#CLIENT of the client aircraft
ClientObject.PlayerName: A #string of the player controlling the aircraft
ClientObject.UnitName: A #string of the client aircraft unit.
ClientObject.GroupName: A #string of the client aircraft group.

Examples

     -- Create an instance with a client unit prefix and send them a message when they spawn
     local clientInstance = CLIENTWATCH:New("Rotary")
     function clientInstance:OnAfterSpawn(From,Event,To,ClientObject,EventData)
         MESSAGE:New("Welcome to your aircraft!",10):ToUnit(ClientObject.Unit)
     end

Using event callbacks

In a normal setting, you can only use a callback function for a specific option in one location. If you have multiple scripts that rely on the same callback from the same object, this can get quite messy. With the ClientWatch module, these callbacks are isolated t the instances and therefore open the possibility to use many instances with the same callback doing different things. ClientWatch instances subscribe to all events that are applicable to player controlled aircraft and provides callbacks for each, forwarding the EventData in the callback function.

The following event callbacks can be used inside the OnAfterSpawn() callback:

:OnAfterDespawn(From,Event,To): Triggers whenever DCS no longer sees the aircraft as 'alive'. No event data is given in this callback as it is derived from other events
:OnAfterHit(From,Event,To,EventData): Triggers every time the aircraft takes damage or is struck by a weapon/explosion
:OnAfterKill(From,Event,To,EventData): Triggers after the aircraft kills something with its weapons
:OnAfterScore(From,Event,To,EventData): Triggers after accumulating score
:OnAfterShot(From,Event,To,EventData): Triggers after a single-shot weapon is released
:OnAfterShootingStart(From,Event,To,EventData): Triggers when an automatic weapon begins firing
:OnAfterShootingEnd(From,Event,To,EventData): Triggers when an automatic weapon stops firing
:OnAfterLand(From,Event,To,EventData): Triggers when an aircraft transitions from being airborne to on the ground
:OnAfterTakeoff(From,Event,To,EventData): Triggers when an aircraft transitions from being on the ground to airborne
:OnAfterRunwayTakeoff(From,Event,To,EventData): Triggers after lifting off from a runway
:OnAfterRunwayTouch(From,Event,To,EventData): Triggers when an aircraft's gear makes contact with a runway
:OnAfterRefueling(From,Event,To,EventData): Triggers when an aircraft begins taking on fuel
:OnAfterRefuelingStop(From,Event,To,EventData): Triggers when an aircraft stops taking on fuel
:OnAfterPlayerLeaveUnit(From,Event,To,EventData): Triggers when a player leaves an operational aircraft
:OnAfterCrash(From,Event,To,EventData): Triggers when an aircraft is destroyed (may fail to trigger if the aircraft is only partially destroyed)
:OnAfterDead(From,Event,To,EventData): Triggers when an aircraft is considered dead (may fail to trigger if the aircraft was partially destroyed first)
:OnAfterPilotDead(From,Event,To,EventData): Triggers when the pilot is killed (may fail to trigger if the aircraft was partially destroyed first)
:OnAfterUnitLost(From,Event,To,EventData): Triggers when an aircraft is lost for any reason (may fail to trigger if the aircraft was partially destroyed first)
:OnAfterEjection(From,Event,To,EventData): Triggers when a pilot ejects from an aircraft
:OnAfterHumanFailure(From,Event,To,EventData): Triggers when an aircraft or system is damaged from any source or action by the player
:OnAfterHumanAircraftRepairStart(From,Event,To,EventData): Triggers when an aircraft repair is started
:OnAfterHumanAircraftRepairFinish(From,Event,To,EventData): Triggers when an aircraft repair is completed
:OnAfterEngineStartup(From,Event,To,EventData): Triggers when the engine enters what DCS considers to be a started state. Parameters vary by aircraft
:OnAfterEngineShutdown(From,Event,To,EventData): Triggers when the engine enters what DCS considers to be a stopped state. Parameters vary by aircraft
:OnAfterWeaponAdd(From,Event,To,EventData): Triggers when an item is added to an aircraft's payload
:OnAfterWeaponDrop(From,Event,To,EventData): Triggers when an item is jettisoned or dropped from an aircraft (unconfirmed)
:OnAfterWeaponRearm(From,Event,To,EventData): Triggers when an item with internal supply is restored (unconfirmed)

Examples

     -- Show a message to player when they take damage from a weapon
     local clientInstance = CLIENTWATCH:New("Rotary")
         function clientInstance:OnAfterSpawn(From,Event,To,ClientObject,EventData)
         function ClientObject:OnAfterHit(From,Event,To,EventData)
            local typeShooter = EventData.IniTypeName
            local nameWeapon = EventData.weapon_name
            MESSAGE:New("A "..typeShooter.." hit you with a "..nameWeapon,20):ToUnit(ClientObject.Unit)
         end
     end

Global CLIENTWATCHTools

#table CLIENTWATCHTools

@type CLIENTWATCHTools @field #table Unit Wrapper.UNIT of the cient object @field #table Group Wrapper.GROUP of the cient object @field #table Client Wrapper.CLIENT of the cient object @field #string PlayerName Name of the player controlling the client object @field #string UnitName Name of the unit that is the client object @field #string GroupName Name of the group the client object belongs to

Type(s)

Type CLIENTWATCH

CLIENTWATCH , extends Core.Fsm#FSM_CONTROLLABLE , extends Core.Fsm#FSM , extends Core.Base#BASE

Fields and Methods inherited from CLIENTWATCH	Description
CLIENTWATCH.ClassName	Name of the class.
CLIENTWATCH.Debug	Write Debug messages to DCS log file and send Debug messages to all players.
CLIENTWATCH.DebugEventData
CLIENTWATCH:FilterByCategory(Category, Category, value)	Filter out all clients that are not of the given category
CLIENTWATCH:FilterByCoalition(Coalition, Coalition, value)	Filter out all clients not belonging to the provided coalition
CLIENTWATCH.FilterCategory	If not nil, will only activate for aircraft of the given category value.
CLIENTWATCH.FilterCoalition	If not nil, will only activate for aircraft of the given coalition value.
CLIENTWATCH:New(Will, Put, Provide, Leave, client)	Creates a new instance of CLIENTWATCH to add scripts to.
CLIENTWATCH:OnAfterSpawn(Controllable, From, Event, To, clientObject, eventdata)	User function for OnAfter "Spawn" event.
CLIENTWATCH.lid	String for DCS log file.
CLIENTWATCH.version	CLIENTWATCH version

Fields and Methods inherited from FSM_CONTROLLABLE	Description
CLIENTWATCH.Controllable
CLIENTWATCH:GetControllable()	Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.
CLIENTWATCH:New(FSMT, Controllable)	Creates a new FSM_CONTROLLABLE object.
CLIENTWATCH:OnAfterStop(Controllable, From, Event, To)	OnAfter Transition Handler for Event Stop.
CLIENTWATCH:OnBeforeStop(Controllable, From, Event, To)	OnBefore Transition Handler for Event Stop.
CLIENTWATCH:OnEnterStopped(Controllable, From, Event, To)	OnEnter Transition Handler for State Stopped.
CLIENTWATCH:OnLeaveStopped(Controllable, From, Event, To)	OnLeave Transition Handler for State Stopped.
CLIENTWATCH:SetControllable(FSMControllable)	Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.
CLIENTWATCH:Stop()	Synchronous Event Trigger for Event Stop.
CLIENTWATCH:__Stop(Delay)	Asynchronous Event Trigger for Event Stop.
CLIENTWATCH:_call_handler(step, trigger, params, EventName)

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

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

Type Functional.ClientWatch

Type CLIENTWATCH

CLIENTWATCH class

Field(s)

#string CLIENTWATCH.ClassName

Name of the class.

#boolean CLIENTWATCH.Debug

Write Debug messages to DCS log file and send Debug messages to all players.

#boolean CLIENTWATCH.DebugEventData

#number CLIENTWATCH.FilterCategory

If not nil, will only activate for aircraft of the given category value.

#number CLIENTWATCH.FilterCoalition

If not nil, will only activate for aircraft of the given coalition value.

#string CLIENTWATCH.lid

String for DCS log file.

#string CLIENTWATCH.version

CLIENTWATCH version

Function(s)

CLIENTWATCH:FilterByCategory(Category, Category, value)

Filter out all clients that are not of the given category

Defined in:

CLIENTWATCH

Parameters:

#number Category

number (0 = airplane, 1 = helicopter)

#string Category

string ('airplane' or 'helicopter')

value

CLIENTWATCH:FilterByCoalition(Coalition, Coalition, value)

Filter out all clients not belonging to the provided coalition

Defined in:

CLIENTWATCH

Parameters:

#number Coalition

number (1 = red, 2 = blue)

#string Coalition

string ('red' or 'blue')

value

CLIENTWATCH:New(Will, Put, Provide, Leave, client)

Creates a new instance of CLIENTWATCH to add scripts to.

Can be used multiple times with the same client/prefixes if you need it for multiple scripts.

Defined in:

CLIENTWATCH

Parameters:

#string Will

watch for clients whos UNIT NAME or GROUP NAME matches part of the #string as a prefix.

#table Put

strings in a table to use multiple prefixes for the above method.

Wrapper.Client#CLIENT Provide

a Moose CLIENT object to apply to that specific aircraft slot (static slots only!)

#nil Leave

blank to activate for ALL CLIENTS

client

Return value:

#CLIENTWATCH:

self

CLIENTWATCH:OnAfterSpawn(Controllable, From, Event, To, clientObject, eventdata)

User function for OnAfter "Spawn" event.

Defined in:

CLIENTWATCH

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

Controllable of the group.

#string From

From state.

#string Event

Event.

#string To

To state.

#table clientObject

Custom object that handles events and stores Moose object data. See top documentation for more details.

#table eventdata

Data from EVENTS.Birth.

Field(s)

#string CLIENTWATCH.ClassName

Name of the class.

#boolean CLIENTWATCH.Debug

Write Debug messages to DCS log file and send Debug messages to all players.

#boolean CLIENTWATCH.DebugEventData

#number CLIENTWATCH.FilterCategory

If not nil, will only activate for aircraft of the given category value.

#number CLIENTWATCH.FilterCoalition

If not nil, will only activate for aircraft of the given coalition value.

#string CLIENTWATCH.lid

String for DCS log file.

#string CLIENTWATCH.version

CLIENTWATCH version

Function(s)

CLIENTWATCH:GetControllable()

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Defined in:

Core.Fsm#FSM_CONTROLLABLE

Return value:

Wrapper.Controllable#CONTROLLABLE:

CLIENTWATCH:New(FSMT, Controllable)

Creates a new FSM_CONTROLLABLE object.

Defined in:

Core.Fsm#FSM_CONTROLLABLE

Parameters:

#table FSMT

Finite State Machine Table

Wrapper.Controllable#CONTROLLABLE Controllable

(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.

Return value:

#FSM_CONTROLLABLE:

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

OnAfter Transition Handler for Event Stop.

Defined in:

Core.Fsm#FSM_CONTROLLABLE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

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

OnBefore Transition Handler for Event Stop.

Defined in:

Core.Fsm#FSM_CONTROLLABLE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

#boolean:

Return false to cancel Transition.

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

OnEnter Transition Handler for State Stopped.

Defined in:

Core.Fsm#FSM_CONTROLLABLE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

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

OnLeave Transition Handler for State Stopped.

Defined in:

Core.Fsm#FSM_CONTROLLABLE

Parameters:

Wrapper.Controllable#CONTROLLABLE Controllable

The Controllable Object managed by the FSM.

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

Return value:

Parameter:

#number Delay

The delay in seconds.

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

Defined in:

Core.Fsm#FSM_CONTROLLABLE

Parameters:

step

trigger

params

EventName

Field(s)

#string CLIENTWATCH.ClassName

Name of the class.

#boolean CLIENTWATCH.Debug

Write Debug messages to DCS log file and send Debug messages to all players.

#boolean CLIENTWATCH.DebugEventData

#number CLIENTWATCH.FilterCategory

If not nil, will only activate for aircraft of the given category value.

#number CLIENTWATCH.FilterCoalition

If not nil, will only activate for aircraft of the given coalition value.

#string CLIENTWATCH.lid

String for DCS log file.

#string CLIENTWATCH.version

CLIENTWATCH version

Function(s)

CLIENTWATCH:AddEndState(State)

Adds an End state.

Defined in:

Core.Fsm#FSM

Parameter:

#string State

The FSM state.

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

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

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

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

CLIENTWATCH:GetCurrentState()

Get current state.

Defined in:

Core.Fsm#FSM

Return value:

#string:

Current FSM state.

CLIENTWATCH:GetEndStates()

Returns the End states.

Defined in:

Core.Fsm#FSM

Return value:

#table:

End states.

#boolean:

If true, FSM is in this state.

CLIENTWATCH:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Core.Fsm#FSM

Parameter:

#table CallBackTable

Table of call backs.

CLIENTWATCH:New()

Creates a new FSM object.

Defined in:

Core.Fsm#FSM

Return value:

#FSM:

CLIENTWATCH:SetProcess(From, Event, Fsm)

Defined in:

Core.Fsm#FSM

Parameters:

From

Core.Fsm#FSM

Parameters:

#string step

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

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

CLIENTWATCH:_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.

CLIENTWATCH:_handler(EventName, ...)

Handler.

Defined in:

Core.Fsm#FSM

Parameters:

#string EventName

Event name.

...

Arguments.

CLIENTWATCH:_isendstate(Current)

Is end state.

Defined in:

Core.Fsm#FSM

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

CLIENTWATCH:_submap(subs, sub, name)

Sub maps.

Defined in:

Core.Fsm#FSM

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

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

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

CLIENTWATCH: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 CLIENTWATCH.ClassName

Name of the class.

#boolean CLIENTWATCH.Debug

Write Debug messages to DCS log file and send Debug messages to all players.

#boolean CLIENTWATCH.DebugEventData

#number CLIENTWATCH.FilterCategory

If not nil, will only activate for aircraft of the given category value.

#number CLIENTWATCH.FilterCoalition

If not nil, will only activate for aircraft of the given coalition value.

#string CLIENTWATCH.lid

String for DCS log file.

#string CLIENTWATCH.version

CLIENTWATCH version

Function(s)

CLIENTWATCH:ClearState(Object, StateName)

Clear the state of an object.