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

Wrapper - DCS net functions.

Encapsules multiplayer server environment scripting functions from net

Author: Applevangelist

Last Update Oct 2023

Global(s)

Global NET

Encapsules multiplayer environment scripting functions from net with some added FSM functions and options to block/unblock players in MP environments.

#NET NET

Encapsules multiplayer environment scripting functions from net with some added FSM functions and options to block/unblock players in MP environments.

Type(s)

Type NET

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

Fields and Methods inherited from NET	Description
NET.BlockMessage
NET:BlockPlayer(Client, PlayerName, Seconds, Message)	Block a player.
NET:BlockPlayerSet(PlayerSet, Seconds, Message)	Block a SET_CLIENT of players
NET:BlockSide(Side, Seconds)	Block a specific coalition side, does NOT automatically kick all players of that side or kick out joined players
NET:BlockSlot(slot, Seconds, Slot)	Block a specific player slot, does NOT automatically kick a player in that slot or kick out joined players
NET.BlockTime
NET:BlockUCID(ucid, Seconds)	Block a specific UCID of a player, does NOT automatically kick the player with the UCID if already joined.
NET.BlockedPilots
NET.BlockedSides
NET.BlockedSlots
NET.BlockedUCIDs
NET.ClassName
NET:DoStringIn(State, DoString)	Executes a lua string in a given lua environment in the game.
NET:ForceSlot(Client, SideID, SlotID)	Force the slot for a specific client.
NET:GetKnownPilotData(Client, Name)	Get some data of pilots who have currently joined
NET:GetMyPlayerID()	Returns the playerID of the local player.
NET:GetName(Client)	Return the name of a given client.
NET:GetPlayerIDByName(Name)	Find the PlayerID by name
NET:GetPlayerIDFromClient(Client)	Find the PlayerID from a CLIENT object.
NET:GetPlayerInfo(Client, Attribute)	Return a table of attributes for a given client.
NET:GetPlayerList()	Return a table of players currently connected to the server.
NET:GetPlayerStatistic(Client, StatisticID)	Return a statistic for a given client.
NET:GetPlayerUCID(Client, Name)	Get player UCID from player CLIENT object or player name.
NET:GetServerID()	Returns the playerID of the server.
NET:GetSlot(Client)	Returns the SideId and SlotId of a given client.
NET:IsAnyBlocked(UCID, Name, PlayerID, PlayerSide, PlayerSlot)	[Internal] Check any blockers
NET.Json2Lua(Json)	Converts a JSON string to a lua value.
NET:Kick(Client, Message)	Kicks a player from the server.
NET.KnownPilots
NET:Log(Message)	Write an "INFO" entry to the DCS log file, with the message Message.
NET.Lua2Json(Lua)	Converts a lua value to a JSON string.
NET:New()	Instantiate a new NET object.
NET:OnAfterPlayerBlocked(From, Event, To, Client, Name, Seconds)	FSM Function OnAfterPlayerBlocked.
NET:OnAfterPlayerDied(From, Event, To, Client, Name)	FSM Function OnAfterPlayerDied.
NET:OnAfterPlayerEjected(From, Event, To, Client, Name)	FSM Function OnAfterPlayerEjected.
NET:OnAfterPlayerJoined(From, Event, To, Client, Name)	FSM Function OnAfterPlayerJoined.
NET:OnAfterPlayerLeft(From, Event, To, Client, Name)	FSM Function OnAfterPlayerLeft.
NET:OnAfterPlayerUnblocked(From, Event, To, Client, Name)	FSM Function OnAfterPlayerUnblocked.
NET:ReturnToSpectators(Client)	Force a client back to spectators.
NET:SendChat(Message, ToAll)	Send chat message.
NET:SendChatToClient(Message, ToClient, FromClient)	Send chat message to a specific player using the CLIENT object.
NET:SendChatToPlayer(Message, ToPlayer, FromPlayer)	Send chat message to a specific player using the player name
NET:SetBlockMessage(Text)	Set block chat message.
NET:SetBlockTime(Seconds)	Set block time in seconds.
NET:SetUnblockMessage(Text)	Set unblock chat message.
NET.UnblockMessage
NET:UnblockPlayer(Client, PlayerName, Message)	Unblock a player.
NET:UnblockPlayerSet(PlayerSet, Message)	Unblock a SET_CLIENT of players
NET.UnblockSide(side, Seconds, self, Side)	Unblock a specific coalition side.
NET.UnblockSlot(slot, self, Slot)	Unblock a specific slot.
NET:UnblockUCID(ucid)	Unblock a specific UCID of a player
NET.Version
NET:_EventHandler(EventData)	[Internal] Event Handler
NET.lid
NET:onafterRun(From, Event, To)	Stop the event functions
NET:onafterStatus(From, Event, To)	Status - housekeeping
NET:onafterStop(From, Event, To)	Stop the event functions

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

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

Type NET.PlayerData

NET.PlayerData

Fields and Methods inherited from NET.PlayerData	Description
NET.PlayerData.id
NET.PlayerData.name
NET.PlayerData.side
NET.PlayerData.slot
NET.PlayerData.timestamp
NET.PlayerData.ucid

Field(s)

#string NET.BlockMessage

#number NET.BlockTime

#table NET.BlockedPilots

#table NET.BlockedSides

#table NET.BlockedSlots

#table NET.BlockedUCIDs

#string NET.ClassName

#table NET.KnownPilots

#string NET.UnblockMessage

#string NET.Version

#string NET.lid

Function(s)

NET:BlockPlayer(Client, PlayerName, Seconds, Message)

Block a player.

Defined in:

NET

Parameters:

Wrapper.Client#CLIENT Client

CLIENT object.

#string PlayerName

(optional) Name of the player.

#number Seconds

(optional) Number of seconds the player has to wait before rejoining.

#string Message

(optional) Message to be sent via chat.

Return value:

#NET:

self

NET:BlockPlayerSet(PlayerSet, Seconds, Message)

Block a SET_CLIENT of players

Defined in:

NET

Parameters:

Core.Set#SET_CLIENT PlayerSet

The SET to block.

#number Seconds

Seconds (optional) Number of seconds the player has to wait before rejoining.

#string Message

(optional) Message to be sent via chat.

Return value:

#NET:

self

NET:BlockSide(Side, Seconds)

Block a specific coalition side, does NOT automatically kick all players of that side or kick out joined players

Defined in:

NET

Parameters:

#number Side

The side to block - 1 : Red, 2 : Blue

#number Seconds

Seconds (optional) Number of seconds the player has to wait before rejoining.

Return value:

#NET:

self

NET:BlockSlot(slot, Seconds, Slot)

Block a specific player slot, does NOT automatically kick a player in that slot or kick out joined players

Defined in:

NET

Parameters:

#string slot

The slot to block

#number Seconds

Seconds (optional) Number of seconds the player has to wait before rejoining.

Slot

Return value:

#NET:

self

NET:BlockUCID(ucid, Seconds)

Block a specific UCID of a player, does NOT automatically kick the player with the UCID if already joined.

Defined in:

NET

Parameters:

#string ucid

#number Seconds

Seconds (optional) Number of seconds the player has to wait before rejoining.

Return value:

#NET:

self

NET:DoStringIn(State, DoString)

Executes a lua string in a given lua environment in the game.

Defined in:

NET

Parameters:

#string State

The state in which to execute - see below.

#string DoString

The lua string to be executed.

Return value:

#string:

Output

Usage:

States are:
'config': the state in which $INSTALL_DIR/Config/main.cfg is executed, as well as $WRITE_DIR/Config/autoexec.cfg  - used for configuration settings
'mission': holds current mission
'export': runs $WRITE_DIR/Scripts/Export.lua and the relevant export API

NET:ForceSlot(Client, SideID, SlotID)

Force the slot for a specific client.

If this returns false, it didn't work via net (which is ALWAYS the case as of Nov 2024)!

Defined in:

NET

Parameters:

Wrapper.Client#CLIENT Client

The client

#number SideID

i.e. 0 : spectators, 1 : Red, 2 : Blue

#number SlotID

Slot number

Return value:

#boolean:

Success

NET:GetKnownPilotData(Client, Name)

Get some data of pilots who have currently joined

Defined in:

NET

Parameters:

Wrapper.Client#CLIENT Client

Provide either the client object whose data to find or

#string Name

The player name whose data to find

Return value:

#table:

Table of #NET.PlayerData or nil if not found

NET:GetMyPlayerID()

Returns the playerID of the local player.

Always returns 1 for server.

Defined in:

NET

Return value:

#number:

NET:GetName(Client)

Return the name of a given client.

Effectively the same as CLIENT:GetPlayerName().

Defined in:

NET

Parameter:

Wrapper.Client#CLIENT Client

The client

Return value:

#string:

Name or nil if not obtainable

Defined in:

NET

Parameter:

#string Name

The player name whose ID to find

Return value:

#number:

PlayerID or nil

NET:GetPlayerIDFromClient(Client)

Find the PlayerID from a CLIENT object.

Defined in:

NET

Parameter:

Wrapper.Client#CLIENT Client

The client

Return value:

#number:

PlayerID or nil

NET:GetPlayerInfo(Client, Attribute)

Return a table of attributes for a given client.

If optional attribute is present, only that value is returned.

Defined in:

NET

Parameters:

Wrapper.Client#CLIENT Client

The client.

#string Attribute

(Optional) The attribute to obtain. List see below.

Return value:

#table:

PlayerInfo or nil if it cannot be found

Usage:

Table holds these attributes:

         'id'    : playerID
         'name'  : player name
         'side'  : 0 - spectators, 1 - red, 2 - blue
         'slot'  : slotID of the player or 
         'ping'  : ping of the player in ms
         'ipaddr': IP address of the player, SERVER ONLY
         'ucid'  : Unique Client Identifier, SERVER ONLY

NET:GetPlayerList()

Return a table of players currently connected to the server.

Defined in:

NET

Return value:

#table:

PlayerList

NET:GetPlayerStatistic(Client, StatisticID)

Return a statistic for a given client.

Defined in:

NET

Parameters:

Wrapper.Client#CLIENT Client

The client

#number StatisticID

The statistic to obtain

Return value:

#number:

Statistic or nil

Usage:

StatisticIDs are:

net.PS_PING  (0) - ping (in ms)
net.PS_CRASH (1) - number of crashes
net.PS_CAR   (2) - number of destroyed vehicles
net.PS_PLANE (3) - ... planes/helicopters
net.PS_SHIP  (4) - ... ships
net.PS_SCORE (5) - total score
net.PS_LAND  (6) - number of landings
net.PS_EJECT (7) - of ejects

         mynet:GetPlayerStatistic(Client,7) -- return number of ejects

NET:GetPlayerUCID(Client, Name)

Get player UCID from player CLIENT object or player name.

Provide either one.

Defined in:

NET

Parameters:

Wrapper.Client#CLIENT Client

The client object to be used.

#string Name

Player name to be used.

Return value:

#boolean:

success

NET:GetServerID()

Returns the playerID of the server.

Currently always returns 1.

Defined in:

NET

Return value:

#number:

NET:GetSlot(Client)

Returns the SideId and SlotId of a given client.

Defined in:

NET

Parameter:

Wrapper.Client#CLIENT Client

The client

Return values:

#number:

SideID i.e. 0 : spectators, 1 : Red, 2 : Blue

#number:

SlotID

NET:IsAnyBlocked(UCID, Name, PlayerID, PlayerSide, PlayerSlot)

[Internal] Check any blockers

Defined in:

NET

Parameters:

#string UCID

#string Name

#number PlayerID

#number PlayerSide

#string PlayerSlot

Return value:

#boolean:

IsBlocked

Defined in:

NET

Parameter:

#string Json

Anything JSON

Return value:

#table:

Lua

NET:Kick(Client, Message)

Kicks a player from the server.

Can display a message to the user.

Defined in:

NET

Parameters:

Wrapper.Client#CLIENT Client

The client

#string Message

(Optional) The message to send.

Return value:

#boolean:

success

NET:Log(Message)

Write an "INFO" entry to the DCS log file, with the message Message.

Defined in:

NET

Parameter:

#string Message

The message to be logged.

Return value:

#NET:

self

Defined in:

NET

Parameter:

#string Lua

Anything lua

Return value:

#table:

Json

Defined in:

NET

Return value:

#NET:

self

NET:OnAfterPlayerBlocked(From, Event, To, Client, Name, Seconds)

FSM Function OnAfterPlayerBlocked.

Defined in:

NET

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

Client Object, might be nil.

#string Name

Name of blocked Pilot.

#number Seconds

Blocked for this number of seconds

Return value:

#NET:

self

NET:OnAfterPlayerDied(From, Event, To, Client, Name)

FSM Function OnAfterPlayerDied.

Defined in:

NET

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Unit#UNIT Client

Unit Object, might be nil.

#string Name

Name of dead Pilot.

Return value:

#NET:

self

NET:OnAfterPlayerEjected(From, Event, To, Client, Name)

FSM Function OnAfterPlayerEjected.

Defined in:

NET

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Unit#UNIT Client

Unit Object, might be nil.

#string Name

Name of leaving Pilot.

Return value:

#NET:

self

NET:OnAfterPlayerJoined(From, Event, To, Client, Name)

FSM Function OnAfterPlayerJoined.

Defined in:

NET

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

Object.

#string Name

Name of joining Pilot.

Return value:

#NET:

self

NET:OnAfterPlayerLeft(From, Event, To, Client, Name)

FSM Function OnAfterPlayerLeft.

Defined in:

NET

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Unit#UNIT Client

Unit Object, might be nil.

#string Name

Name of leaving Pilot.

Return value:

#NET:

self

NET:OnAfterPlayerUnblocked(From, Event, To, Client, Name)

FSM Function OnAfterPlayerUnblocked.

Defined in:

NET

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

Client Object, might be nil.

#string Name

Name of unblocked Pilot.

Return value:

#NET:

self

NET:ReturnToSpectators(Client)

Force a client back to spectators.

If this returns false, it didn't work via net (which is ALWAYS the case as of Nov 2024)!

Defined in:

NET

Parameter:

Wrapper.Client#CLIENT Client

The client

Return value:

#boolean:

Succes

Defined in:

NET

Parameters:

#string Message

Message to send

#boolean ToAll

(Optional)

Return value:

#NET:

self

NET:SendChatToClient(Message, ToClient, FromClient)

Send chat message to a specific player using the CLIENT object.

Defined in:

NET

Parameters:

#string Message

The text message

Wrapper.Client#CLIENT ToClient

Client receiving the message

Wrapper.Client#CLIENT FromClient

(Optional) Client sending the message

Return value:

#NET:

self

NET:SendChatToPlayer(Message, ToPlayer, FromPlayer)

Send chat message to a specific player using the player name

Defined in:

NET

Parameters:

#string Message

The text message

#string ToPlayer

Player receiving the message

#string FromPlayer

Optional) Player sending the message

Return value:

#NET:

self

Defined in:

NET

Parameter:

#string Text

The message

Return value:

#NET:

self

Defined in:

NET

Parameter:

#number Seconds

Numnber of seconds this block will last. Defaults to 600.

Return value:

#NET:

self

Defined in:

NET

Parameter:

#string Text

The message

Return value:

#NET:

self

NET:UnblockPlayer(Client, PlayerName, Message)

Unblock a player.

Defined in:

NET

Parameters:

Wrapper.Client#CLIENT Client

CLIENT object

#string PlayerName

(optional) Name of the player.

#string Message

(optional) Message to be sent via chat.

Return value:

#NET:

self

NET:UnblockPlayerSet(PlayerSet, Message)

Unblock a SET_CLIENT of players

Defined in:

NET

Parameters:

Core.Set#SET_CLIENT PlayerSet

The SET to unblock.

#string Message

(optional) Message to be sent via chat.

Return value:

#NET:

self

NET.UnblockSide(side, Seconds, self, Side)

Unblock a specific coalition side.

Does NOT unblock specifically blocked playernames or UCIDs.

Defined in:

NET

Parameters:

#number side

The side to block - 1 : Red, 2 : Blue

#number Seconds

Seconds (optional) Number of seconds the player has to wait before rejoining.

self

Side

Return value:

#NET:

self

NET.UnblockSlot(slot, self, Slot)

Unblock a specific slot.

Defined in:

NET

Parameters:

#string slot

The slot to block

self

Slot

Return value:

#NET:

self

Defined in:

NET

Parameter:

#string ucid

Return value:

#NET:

self

Defined in:

NET

Parameter:

Core.Event#EVENTDATA EventData

Return value:

#NET:

self

NET:onafterRun(From, Event, To)

Stop the event functions

Defined in:

NET

Parameters:

#string From

#string Event

#string To

Return value:

#NET:

self

NET:onafterStatus(From, Event, To)

Status - housekeeping

Defined in:

NET

Parameters:

#string From

#string Event

#string To

Return value:

#NET:

self

NET:onafterStop(From, Event, To)

Stop the event functions

Defined in:

NET

Parameters:

#string From

#string Event

#string To

Return value:

#NET:

self

Field(s)

#string NET.BlockMessage

#number NET.BlockTime

#table NET.BlockedPilots

#table NET.BlockedSides

#table NET.BlockedSlots

#table NET.BlockedUCIDs

#string NET.ClassName

#table NET.KnownPilots

#string NET.UnblockMessage

#string NET.Version

#string NET.lid

Function(s)

Defined in:

Core.Fsm#FSM

Parameter:

#string State

The FSM state.

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

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

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

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

Defined in:

Core.Fsm#FSM

Return value:

#string:

Current FSM state.

Defined in:

Core.Fsm#FSM

Return value:

#table:

End states.

Defined in:

Core.Fsm#FSM

Parameters:

From

Event

NET:GetProcesses()

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

Defined in:

Core.Fsm#FSM

Return value:

#table:

Sub processes.

NET:GetScores()

Returns a table with the scores defined.

Defined in:

Core.Fsm#FSM

Return value:

#table:

Scores.

Defined in:

Core.Fsm#FSM

Return value:

#string:

A string containing the start state.

Defined in:

Core.Fsm#FSM

Return value:

#string:

Current FSM state.

Defined in:

Core.Fsm#FSM

Return value:

#table:

Sub processes.

NET:GetTransitions()

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

Defined in:

Core.Fsm#FSM

Return value:

#table:

Transitions.

Defined in:

Core.Fsm#FSM

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

NET:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Core.Fsm#FSM

Parameter:

#table CallBackTable

Table of call backs.

Defined in:

Core.Fsm#FSM

Return value:

#FSM:

NET:SetProcess(From, Event, Fsm)

Defined in:

Core.Fsm#FSM

Parameters:

From

Event

Fsm

Defined in:

Core.Fsm#FSM

Parameter:

#string State

A string defining the start state.

Defined in:

Core.Fsm#FSM

Parameters:

#table Map

Map.

#table Event

Event table.

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

NET:_create_transition(EventName)

Create transition.

Defined in:

Core.Fsm#FSM

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

NET:_delayed_transition(EventName)

Delayed transition.

Defined in:

Core.Fsm#FSM

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

NET:_eventmap(Events, EventStructure)

Event map.

Defined in:

Core.Fsm#FSM

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

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

Defined in:

Core.Fsm#FSM

Parameters:

#string EventName

Event name.

...

Arguments.

Defined in:

Core.Fsm#FSM

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Defined in:

Core.Fsm#FSM

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Defined in:

Core.Fsm#FSM

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Defined in:

Core.Fsm#FSM

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Defined in:

Core.Fsm#FSM

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#string NET.BlockMessage

#number NET.BlockTime

#table NET.BlockedPilots

#table NET.BlockedSides

#table NET.BlockedSlots

#table NET.BlockedUCIDs

#string NET.ClassName

#table NET.KnownPilots

#string NET.UnblockMessage

#string NET.Version

#string NET.lid

Function(s)

NET:ClearState(Object, StateName)

Clear the state of an object.