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

Utils - Lua Profiler.

Find out how many times functions are called and how much real time it costs.

Author: TAW CougarNL, funkyfranky

Global(s)

Global PROFILER

The emperor counsels simplicity. *First principles.

#PROFILER PROFILER

The emperor counsels simplicity. *First principles.

Of each particular thing, ask: What is it in itself, in its own constitution? What is its causal nature?*

Banner Image

The PROFILER Concept

Profile your lua code. This tells you, which functions are called very often and which consume most real time. With this information you can optimize the performance of your code.

Prerequisites

The modules os, io and lfs need to be de-sanitized. Comment out the lines

--sanitizeModule('os')
--sanitizeModule('io')
--sanitizeModule('lfs')

in your "DCS World OpenBeta/Scripts/MissionScripting.lua" file.

But be aware that these changes can make you system vulnerable to attacks.

Disclaimer

Profiling itself is CPU expensive! Don't use this when you want to fly or host a mission.

Start

The profiler can simply be started with the PROFILER.Start(Delay, Duration) function

PROFILER.Start()

The optional parameter Delay can be used to delay the start by a certain amount of seconds and the optional parameter Duration can be used to stop the profiler after a certain amount of seconds.

Stop

The profiler automatically stops when the mission ends. But it can be stopped any time with the PROFILER.Stop(Delay) function

PROFILER.Stop()

The optional parameter Delay can be used to specify a delay after which the profiler is stopped.

When the profiler is stopped, the output is written to a file.

Output

The profiler output is written to a file in your DCS home folder

X:\User\<Your User Name>\Saved Games\DCS OpenBeta\Logs

The default file name is "MooseProfiler.txt". If that file exists, the file name is "MooseProfiler-001.txt" etc.

Data

The data in the output file provides information on the functions that were called in the mission.

It will tell you how many times a function was called in total, how many times per second, how much time in total and the percentage of time.

If you only want output for functions that are called more than X times per second, you can set

PROFILER.ThreshCPS=1.5

With this setting, only functions which are called more than 1.5 times per second are displayed. The default setting is PROFILER.ThreshCPS=0.0 (no threshold).

Furthermore, you can limit the output for functions that consumed a certain amount of CPU time in total by

PROFILER.ThreshTtot=0.005

With this setting, which is also the default, only functions which in total used more than 5 milliseconds CPU time.

Type(s)

Type PROFILER

PROFILER

Fields and Methods inherited from PROFILER	Description
PROFILER.ClassName	Name of the class.
PROFILER.Counters	Function counters.
PROFILER.Start(Delay, Duration)	Start profiler.
PROFILER.Stop(Delay)	Stop profiler.
PROFILER.ThreshCPS	Low calls per second threshold. Only write output if function has more calls per second than this value.
PROFILER.ThreshTtot	Total time threshold. Only write output if total function CPU time is more than this value.
PROFILER.TstartGame	Game start time timer.getTime().
PROFILER.TstartOS	OS real start time os.clock.
PROFILER._flog(f, txt)	Write text to log file.
PROFILER.dInfo	Info.
PROFILER.eventhandler	Event handler to get mission end event.
PROFILER.fTime	Function time.
PROFILER.fTimeTotal	Total function time.
PROFILER.fileNamePrefix	Output file name prefix, e.g. "MooseProfiler".
PROFILER.fileNameSuffix	Output file name prefix, e.g. "txt"
PROFILER.getData(func)	Get data.
PROFILER.getfilename(ext)	Write info to output file.
PROFILER.hook(event)	Debug hook.
PROFILER.logUnknown	Log unknown functions. Default is off.
PROFILER.printCSV(data, runTimeGame)	Print csv file.
PROFILER.showInfo(runTimeGame, runTimeOS)	Write info to output file.
PROFILER.showTable(data, f, runTimeGame)	Show table.

Type PROFILER.Data

PROFILER.Data

Fields and Methods inherited from PROFILER.Data	Description
PROFILER.Data.count	Number of function calls.
PROFILER.Data.func	The function name.
PROFILER.Data.line	The line number
PROFILER.Data.src	The source file.
PROFILER.Data.tm	Total time in seconds.

Type Utilities.Profiler

Type PROFILER

PROFILER class.

Field(s)

#string PROFILER.ClassName

Name of the class.

#table PROFILER.Counters

Function counters.

#number PROFILER.ThreshCPS

Low calls per second threshold. Only write output if function has more calls per second than this value.

#number PROFILER.ThreshTtot

Total time threshold. Only write output if total function CPU time is more than this value.

#number PROFILER.TstartGame

Game start time timer.getTime().

#number PROFILER.TstartOS

OS real start time os.clock.

#table PROFILER.dInfo

Info.

#table PROFILER.eventhandler

Event handler to get mission end event.

#table PROFILER.fTime

Function time.

#table PROFILER.fTimeTotal

Total function time.

#string PROFILER.fileNamePrefix

Output file name prefix, e.g. "MooseProfiler".

#string PROFILER.fileNameSuffix

Output file name prefix, e.g. "txt"

#boolean PROFILER.logUnknown

Log unknown functions. Default is off.

Function(s)

PROFILER.Start(Delay, Duration)

Start profiler.

Defined in:

PROFILER

Parameters:

#number Delay

Delay in seconds before profiler is stated. Default is immediately.

#number Duration

Duration in (game) seconds before the profiler is stopped. Default is when mission ends.

PROFILER.Stop(Delay)

Stop profiler.

Defined in:

PROFILER

Parameter:

#number Delay

Delay before stop in seconds.

PROFILER._flog(f, txt)

Write text to log file.

Defined in:

PROFILER

Parameters:

#function f

The file.

#string txt

The text.

PROFILER.getData(func)

Get data.

Defined in:

PROFILER

Parameter:

#function func

Function.

Return values:

#string:

Function name.

#string:

Source file name.

#string:

Line number.

#number:

Function time in seconds.

PROFILER.getfilename(ext)

Write info to output file.

Defined in:

PROFILER

Parameter:

#string ext

Extension.

Return value:

#string:

File name.

PROFILER.hook(event)

Debug hook.

Defined in:

PROFILER

Parameter:

#table event

Event.

PROFILER.printCSV(data, runTimeGame)

Print csv file.

Defined in:

PROFILER

Parameters:

#table data

Data table.

#number runTimeGame

Game run time in seconds.

PROFILER.showInfo(runTimeGame, runTimeOS)

Write info to output file.

Defined in:

PROFILER

Parameters:

#number runTimeGame

Game time in seconds.

#number runTimeOS

OS time in seconds.

PROFILER.showTable(data, f, runTimeGame)

Show table.

Defined in:

PROFILER

Parameters:

#table data

Data table.

#function f

The file.

#number runTimeGame

Game run time in seconds.

Type PROFILER.Data

Waypoint data.

Field(s)

#number PROFILER.Data.count

Number of function calls.

#string PROFILER.Data.func

The function name.

#number PROFILER.Data.line

The line number

#string PROFILER.Data.src

The source file.

#number PROFILER.Data.tm

Total time in seconds.