From 7e1ed445d3ec782325e336cab4ad11a8d6f7f889 Mon Sep 17 00:00:00 2001 From: MooseBotter Date: Tue, 12 Dec 2023 09:56:34 +0000 Subject: [PATCH] Auto commit by GitHub Actions Workflow --- Documentation/AI.AI_Air.html | 132 - Documentation/AI.AI_Air_Dispatcher.html | 44 - Documentation/AI.AI_Air_Squadron.html | 22 - Documentation/AI.AI_Cargo.html | 12 + Documentation/AI.AI_Cargo_Airplane.html | 56 - Documentation/AI.AI_Patrol.html | 12 - Documentation/Cargo.CargoGroup.html | 28 - Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 17974 +--------------- Documentation/Core.Settings.html | 8 +- Documentation/Core.Spawn.html | 284 +- Documentation/Core.SpawnStatic.html | 84 + Documentation/Core.Spot.html | 99 + Documentation/Functional.ATC_Ground.html | 4 +- Documentation/Functional.Mantis.html | 78 +- Documentation/Functional.RAT.html | 30 + Documentation/Functional.Scoring.html | 14 +- Documentation/Ops.Airboss.html | 90 +- Documentation/Ops.CSAR.html | 87 +- Documentation/Ops.CTLD.html | 88 +- Documentation/Sound.SRS.html | 28 - Documentation/Tasking.Task.html | 22 - .../Tasking.Task_A2A_Dispatcher.html | 8 +- Documentation/Tasking.Task_CARGO.html | 2 +- .../Tasking.Task_Cargo_Dispatcher.html | 228 +- Documentation/Utilities.FiFo.html | 22 + Documentation/Wrapper.Marker.html | 72 +- 27 files changed, 918 insertions(+), 18614 deletions(-) diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 20850b47e..860570187 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -3078,17 +3078,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -3188,28 +3177,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -5917,17 +5884,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -6027,28 +5983,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -6675,17 +6609,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -6785,28 +6708,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -8321,17 +8222,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -8431,28 +8321,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
diff --git a/Documentation/AI.AI_Air_Dispatcher.html b/Documentation/AI.AI_Air_Dispatcher.html index 16ab626f0..e5f79260b 100644 --- a/Documentation/AI.AI_Air_Dispatcher.html +++ b/Documentation/AI.AI_Air_Dispatcher.html @@ -4516,17 +4516,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -9824,17 +9813,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -11152,17 +11130,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -12782,17 +12749,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index ca3a03ff5..7f173ddbf 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2563,17 +2563,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
@@ -3645,17 +3634,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index ad13105cf..b29a37a21 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2797,6 +2797,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

No loading happened, so we need to pickup something else.

+ @@ -4827,6 +4830,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

No loading happened, so we need to pickup something else.

+ @@ -5439,6 +5445,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

No loading happened, so we need to pickup something else.

+ @@ -6939,6 +6948,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

No loading happened, so we need to pickup something else.

+ diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 94244e6ab..43dc65147 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2746,20 +2746,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

- -
- -
@@ -4536,20 +4522,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

- -
- -
@@ -5168,20 +5140,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

- -
- -
@@ -6688,20 +6646,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

- -
- -
diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index f0eaea63a..028a12ef2 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -3262,9 +3262,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

This table contains the targets detected during patrol.

-
@@ -6512,9 +6509,6 @@ Note that this method is required, as triggers the next route when patrolling fo - -

This table contains the targets detected during patrol.

-
@@ -7259,9 +7253,6 @@ Note that this method is required, as triggers the next route when patrolling fo - -

This table contains the targets detected during patrol.

-
@@ -8894,9 +8885,6 @@ Note that this method is required, as triggers the next route when patrolling fo - -

This table contains the targets detected during patrol.

-
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index fcca723c9..5f4414a47 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1938,20 +1938,6 @@ Therefore, this class is considered to be deprecated

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- - -
-
- - CARGO_GROUP.CargoGroup @@ -3273,20 +3259,6 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 383eaa450..e2b6bc060 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5796,7 +5796,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -7395,7 +7395,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 4ae17e3e9..ab83319fa 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -1975,7 +1975,6 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these

Type COORDINATE

COORDINATE -, extends Core.Base#BASE
@@ -2047,12 +2046,6 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these - - - - @@ -2424,7 +2417,7 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these @@ -2575,6 +2568,18 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these + + + + + + + + @@ -2844,7 +2849,7 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these @@ -2934,555 +2939,19 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these - -

COORDINATE:CircleToAll(Radius, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

Circle to all.

-

COORDINATE.ClassName

 -

Name of the class

COORDINATE.Heading

 -

Heading in degrees. Needs to be set first.

+

COORDINATE:NewFromLLDD(latitude, longitude, altitude)

Returns the coordinate from the latitude and longitude given in decimal degrees.

+

COORDINATE:NewFromMGRS(UTMZone, MGRSDigraph, Easting, Northing)

 +

Provides a COORDINATE from an MGRS Coordinate

+

COORDINATE:NewFromMGRSString(MGRSString)

 +

Provides a COORDINATE from an MGRS String

COORDINATE.Velocity

 -

Velocity in meters per second. Needs to be set first.

+

COORDINATE.x

 -

Component of the 3D vector.

+

COORDINATE.y

 -

Component of the 3D vector.

+

COORDINATE.z

 -

Component of the 3D vector.

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from BASEDescription

COORDINATE.ClassID

 -

The ID number of the class.

-

COORDINATE.ClassName

 -

The name of the class.

-

COORDINATE.ClassNameAndID

 -

The name of the class concatenated with the ID number of the class.

-

COORDINATE:ClearState(Object, StateName)

 -

Clear the state of an object.

-

COORDINATE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

 -

Creation of a Birth Event.

-

COORDINATE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Crash Event.

-

COORDINATE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Dead Event.

-

COORDINATE:CreateEventPlayerEnterAircraft(PlayerUnit)

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

-

COORDINATE:CreateEventRemoveUnit(EventTime, Initiator)

 -

Creation of a Remove Unit Event.

-

COORDINATE:CreateEventTakeoff(EventTime, Initiator)

 -

Creation of a Takeoff Event.

-

COORDINATE:CreateEventUnitLost(EventTime, Initiator)

 -

Creation of a Crash Event.

-

COORDINATE:E(Arguments)

 -

Log an exception which will be traced always.

-

COORDINATE:EventDispatcher()

 -

Returns the event dispatcher

-

COORDINATE:EventRemoveAll()

 -

Remove all subscribed events

-

COORDINATE:F(Arguments)

 -

Trace a function call.

-

COORDINATE:F2(Arguments)

 -

Trace a function call level 2.

-

COORDINATE:F3(Arguments)

 -

Trace a function call level 3.

-

COORDINATE:GetClassID()

 -

Get the ClassID of the class instance.

-

COORDINATE:GetClassName()

 -

Get the ClassName of the class instance.

-

COORDINATE:GetClassNameAndID()

 -

Get the ClassName + ClassID of the class instance.

-

COORDINATE:GetEventPriority()

 -

Get the Class Core.Event processing Priority.

-

COORDINATE:GetParent(Child, FromClass)

 -

This is the worker method to retrieve the Parent class.

-

COORDINATE:GetState(Object, Key)

 -

Get a Value given a Key from the Object.

-

COORDINATE:HandleEvent(EventID, EventFunction)

 -

Subscribe to a DCS Event.

-

COORDINATE:I(Arguments)

 -

Log an information which will be traced always.

-

COORDINATE:Inherit(Child, Parent)

 -

This is the worker method to inherit from a parent class.

-

COORDINATE:IsInstanceOf(ClassName)

 -

This is the worker method to check if an object is an (sub)instance of a class.

-

COORDINATE:IsTrace()

 -

Enquires if tracing is on (for the class).

-

COORDINATE:New()

 -

BASE constructor.

-

COORDINATE:OnEvent(EventData)

 -

Occurs when an Event for an object is triggered.

-

COORDINATE:OnEventBDA(EventData)

 -

BDA.

-

COORDINATE:OnEventBaseCaptured(EventData)

 -

Occurs when a ground unit captures either an airbase or a farp.

-

COORDINATE:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

COORDINATE:OnEventCrash(EventData)

 -

Occurs when any aircraft crashes into the ground and is completely destroyed.

-

COORDINATE:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

COORDINATE:OnEventDetailedFailure(EventData)

 -

Unknown precisely what creates this event, likely tied into newer damage model.

-

COORDINATE:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

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

-

COORDINATE:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

COORDINATE:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

COORDINATE:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

COORDINATE:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

COORDINATE:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

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

-

COORDINATE:OnEventLandingAfterEjection(EventData)

 -

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

-

COORDINATE:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

COORDINATE:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

COORDINATE:OnEventMarkChange(EventData)

 -

Occurs when a mark text was changed.

-

COORDINATE:OnEventMarkRemoved(EventData)

 -

Occurs when a mark was removed.

-

COORDINATE:OnEventMissionEnd(EventData)

 -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

COORDINATE:OnEventMissionStart(EventData)

 -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

COORDINATE:OnEventParatrooperLanding(EventData)

 -

Weapon add.

-

COORDINATE:OnEventPilotDead(EventData)

 -

Occurs when the pilot of an aircraft is killed.

-

COORDINATE:OnEventPlayerEnterAircraft(EventData)

 -

Occurs when a player enters a slot and takes control of an aircraft.

-

COORDINATE:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-

COORDINATE:OnEventPlayerLeaveUnit(EventData)

 -

Occurs when any player relieves control of a unit to the AI.

-

COORDINATE:OnEventRefueling(EventData)

 -

Occurs when an aircraft connects with a tanker and begins taking on fuel.

-

COORDINATE:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-

COORDINATE:OnEventScore(EventData)

 -

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

-

COORDINATE:OnEventShootingEnd(EventData)

 -

Occurs when any unit stops firing its weapon.

-

COORDINATE:OnEventShootingStart(EventData)

 -

Occurs when any unit begins firing a weapon that has a high rate of fire.

-

COORDINATE:OnEventShot(EventData)

 -

Occurs whenever any unit in a mission fires a weapon.

-

COORDINATE:OnEventTakeoff(EventData)

 -

Occurs when an aircraft takes off from an airbase, farp, or ship.

-

COORDINATE:OnEventTriggerZone(EventData)

 -

Trigger zone.

-

COORDINATE:OnEventUnitLost(EventData)

 -

Occurs when the game thinks an object is destroyed.

-

COORDINATE:ScheduleOnce(Start, SchedulerFunction, ...)

 -

Schedule a new time event.

-

COORDINATE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

 -

Schedule a new time event.

-

COORDINATE:ScheduleStop(SchedulerID)

 -

Stops the Schedule.

-

COORDINATE.Scheduler

 -

COORDINATE:SetEventPriority(EventPriority)

 -

Set the Class Core.Event processing Priority.

-

COORDINATE:SetState(Object, Key, Value)

 -

Set a state or property of the Object given a Key and a Value.

-

COORDINATE:T(Arguments)

 -

Trace a function logic level 1.

-

COORDINATE:T2(Arguments)

 -

Trace a function logic level 2.

-

COORDINATE:T3(Arguments)

 -

Trace a function logic level 3.

-

COORDINATE:TraceAll(TraceAll)

 -

Trace all methods in MOOSE

-

COORDINATE:TraceClass(Class)

 -

Set tracing for a class

-

COORDINATE:TraceClassMethod(Class, Method)

 -

Set tracing for a specific method of class

-

COORDINATE:TraceLevel(Level)

 -

Set trace level

-

COORDINATE:TraceOff()

 -

Set trace off.

-

COORDINATE:TraceOn()

 -

Set trace on.

-

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

-

COORDINATE:UnHandleEvent(EventID)

 -

UnSubscribe to a DCS event.

-

COORDINATE._

 - -

COORDINATE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function call.

-

COORDINATE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function logic.

-

COORDINATE.__

 - -

COORDINATE:onEvent(event)

 -

The main event handling function...
@@ -3644,8 +3113,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Type POINT_VEC2

POINT_VEC2 -, extends Core.Point#COORDINATE -, extends Core.Base#BASE
@@ -3764,1529 +3231,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

POINT_VEC2.x

 -

The x coordinate in meters.

+

POINT_VEC2.y

 -

the y coordinate in meters.

+

POINT_VEC2.z

 -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from COORDINATEDescription

POINT_VEC2:ArrowToAll(Endpoint, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

 -

Arrow to all.

-

POINT_VEC2:BigSmokeAndFire(preset, density, name)

 -

Big smoke and fire at the coordinate.

-

POINT_VEC2:BigSmokeAndFireHuge(density, name)

 -

Huge smoke and fire at the coordinate.

-

POINT_VEC2:BigSmokeAndFireLarge(density, name)

 -

Large smoke and fire at the coordinate.

-

POINT_VEC2:BigSmokeAndFireMedium(density, name)

 -

Medium smoke and fire at the coordinate.

-

POINT_VEC2:BigSmokeAndFireSmall(density, name)

 -

Small smoke and fire at the coordinate.

-

POINT_VEC2:BigSmokeHuge(density, name)

 -

Huge smoke at the coordinate.

-

POINT_VEC2:BigSmokeLarge(density, name)

 -

Large smoke at the coordinate.

-

POINT_VEC2:BigSmokeMedium(number, name, density)

 -

Medium smoke at the coordinate.

-

POINT_VEC2:BigSmokeSmall(density, name)

 -

Small smoke at the coordinate.

-

POINT_VEC2:CircleToAll(Radius, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

 -

Circle to all.

-

POINT_VEC2.ClassName

 -

Name of the class

-

POINT_VEC2:DistanceFromPointVec2(PointVec2Reference)

 -

Calculate the distance from a reference #COORDINATE.

-

POINT_VEC2:Explosion(ExplosionIntensity, Delay)

 -

Creates an explosion at the point of a certain intensity.

-

POINT_VEC2:FindClosestScenery(radius)

 -

Find the closest scenery to the COORDINATE within a certain radius.

-

POINT_VEC2:FindClosestStatic(radius)

 -

Find the closest static to the COORDINATE within a certain radius.

-

POINT_VEC2:FindClosestUnit(radius)

 -

Find the closest unit to the COORDINATE within a certain radius.

-

POINT_VEC2:Flare(FlareColor, Azimuth)

 -

Flares the point in a color.

-

POINT_VEC2:FlareGreen(Azimuth)

 -

Flare the COORDINATE Green.

-

POINT_VEC2:FlareRed(Azimuth)

 -

Flare the COORDINATE Red.

-

POINT_VEC2:FlareWhite(Azimuth)

 -

Flare the COORDINATE White.

-

POINT_VEC2:FlareYellow(Azimuth)

 -

Flare the COORDINATE Yellow.

-

POINT_VEC2:Get2DDistance(TargetCoordinate)

 -

Return the 2D distance in meters between the target COORDINATE and the COORDINATE.

-

POINT_VEC2:Get3DDistance(TargetCoordinate)

 -

Return the 3D distance in meters between the target COORDINATE and the COORDINATE.

-

POINT_VEC2:GetAltitudeText(Settings, Language)

 -

Return the altitude text of the COORDINATE.

-

POINT_VEC2:GetAngleDegrees(DirectionVec3)

 -

Return an angle in degrees from the COORDINATE using a direction vector in Vec3 format.

-

POINT_VEC2:GetAngleRadians(DirectionVec3)

 -

Return an angle in radians from the COORDINATE using a direction vector in Vec3 format.

-

POINT_VEC2:GetBRAText(AngleRadians, Distance, Settings, Language, MagVar)

 -

Provides a Bearing / Range / Altitude string

-

POINT_VEC2:GetBRText(AngleRadians, Distance, Settings, Language, MagVar)

 -

Provides a Bearing / Range string

-

POINT_VEC2:GetBearingText(AngleRadians, Precision, Settings, MagVar)

 -

Provides a bearing text in degrees.

-

POINT_VEC2.GetBullseyeCoordinate(Coalition)

 -

Return the BULLSEYE as COORDINATE Object

-

POINT_VEC2:GetClosestAirbase(Category, Coalition)

 -

Gets the nearest airbase with respect to the current coordinates.

-

POINT_VEC2:GetClosestAirbase2(Category, Coalition)

 -

[kept for downwards compatibility only] Gets the nearest airbase with respect to the current coordinates.

-

POINT_VEC2:GetClosestFreeParkingSpot(airbase, terminaltype)

 -

Gets the nearest free parking spot.

-

POINT_VEC2:GetClosestOccupiedParkingSpot(airbase, terminaltype)

 -

Gets the nearest occupied parking spot.

-

POINT_VEC2:GetClosestParkingSpot(airbase, terminaltype, free)

 -

Gets the nearest parking spot.

-

POINT_VEC2:GetClosestPointToRoad(Railroad)

 -

Gets the nearest coordinate to a road (or railroad).

-

POINT_VEC2:GetCoordinate()

 -

Return the coordinates itself.

-

POINT_VEC2:GetDirectionVec3(TargetCoordinate)

 -

Return a direction vector Vec3 from COORDINATE to the COORDINATE.

-

POINT_VEC2:GetDistanceText(Distance, Settings, Language, Precision)

 -

Provides a distance text expressed in the units of measurement.

-

POINT_VEC2:GetHeading()

 -

Get the heading of the coordinate, if applicable.

-

POINT_VEC2:GetHeadingText(Settings)

 -

Return the heading text of the COORDINATE.

-

POINT_VEC2:GetIntermediateCoordinate(ToCoordinate, Fraction)

 -

Return an intermediate COORDINATE between this an another coordinate.

-

POINT_VEC2:GetLLDDM()

 -

Get Latitude and Longitude in Degrees Decimal Minutes (DDM).

-

POINT_VEC2:GetLandHeight()

 -

Return the height of the land at the coordinate.

-

POINT_VEC2:GetMagneticDeclination(Month, Year)

 -

Returns the magnetic declination at the given coordinate.

-

POINT_VEC2:GetMinutesToSunrise(OnlyToday)

 -

Get minutes until the next sun rise at this coordinate.

-

POINT_VEC2:GetMinutesToSunset(OnlyToday)

 -

Get minutes until the next sun set at this coordinate.

-

POINT_VEC2:GetMovingText(Settings)

 -

Return velocity text of the COORDINATE.

-

POINT_VEC2:GetName()

 -

Return the "name" of the COORDINATE.

-

POINT_VEC2:GetNorthCorrectionRadians()

 -

Get a correction in radians of the real magnetic north of the COORDINATE.

-

POINT_VEC2:GetPathOnRoad(ToCoord, IncludeEndpoints, Railroad, MarkPath, SmokePath)

 -

Returns a table of coordinates to a destination using only roads or railroads.

-

POINT_VEC2:GetPressure(height)

 -

Returns the pressure in hPa.

-

POINT_VEC2:GetPressureText(height, Settings)

 -

Returns a text of the pressure according the measurement system Core.Settings.

-

POINT_VEC2:GetRandomCoordinateInRadius(OuterRadius, InnerRadius)

 -

Return a random Coordinate within an Outer Radius and optionally NOT within an Inner Radius of the COORDINATE.

-

POINT_VEC2:GetRandomVec2InRadius(OuterRadius, InnerRadius)

 -

Return a random Vec2 within an Outer Radius and optionally NOT within an Inner Radius of the COORDINATE.

-

POINT_VEC2:GetRandomVec3InRadius(OuterRadius, InnerRadius)

 -

Return a random Vec3 within an Outer Radius and optionally NOT within an Inner Radius of the COORDINATE.

-

POINT_VEC2:GetSunrise(InSeconds)

 -

Get todays sun rise time.

-

POINT_VEC2:GetSunriseAtDate(Day, Month, Year, InSeconds)

 -

Get sun rise time for a specific date at the coordinate.

-

POINT_VEC2:GetSunriseAtDayOfYear(DayOfYear, InSeconds)

 -

Get sun rise time for a specific day of the year at the coordinate.

-

POINT_VEC2:GetSunset(InSeconds)

 -

Get todays sun set time.

-

POINT_VEC2:GetSunsetAtDate(Day, Month, Year, InSeconds)

 -

Get sun set time for a specific date at the coordinate.

-

POINT_VEC2:GetSurfaceType()

 -

Gets the surface type at the coordinate.

-

POINT_VEC2:GetTemperature(height)

 -

Returns the temperature in Degrees Celsius.

-

POINT_VEC2:GetTemperatureText(height, Settings)

 -

Returns a text of the temperature according the measurement system Core.Settings.

-

POINT_VEC2:GetVec2()

 -

Return the coordinates of the COORDINATE in Vec2 format.

-

POINT_VEC2:GetVec3()

 -

Return the coordinates of the COORDINATE in Vec3 format.

-

POINT_VEC2:GetVelocity()

 -

Return the velocity of the COORDINATE.

-

POINT_VEC2:GetVelocityText(Settings)

 -

Return the velocity text of the COORDINATE.

-

POINT_VEC2:GetWind(height, turbulence)

 -

Returns the wind direction (from) and strength.

-

POINT_VEC2:GetWindText(height, Settings)

 -

Returns a text documenting the wind direction (from) and strength according the measurement system Core.Settings.

-

POINT_VEC2:GetWindVec3(height, turbulence)

 -

Returns the 3D wind direction vector.

-

POINT_VEC2:GetWindWithTurbulenceVec3(height)

 -

Returns the wind direction (from) and strength.

-

POINT_VEC2.Heading

 -

Heading in degrees. Needs to be set first.

-

POINT_VEC2:HeadingTo(ToCoordinate)

 -

Returns the heading from this to another coordinate.

-

POINT_VEC2:IlluminationBomb(Power, Delay)

 -

Creates an illumination bomb at the point.

-

POINT_VEC2:IsAtCoordinate2D(Coordinate, Precision)

 -

Returns if the 2 coordinates are at the same 2D position.

-

POINT_VEC2:IsDay(Clock)

 -

Check if it is day, i.e.

-

POINT_VEC2:IsInFlatArea(Radius, Minelevation)

 -

Function to check if a coordinate is in a flat (<8% elevation) area of the map

-

POINT_VEC2:IsInRadius(Coordinate, Radius)

 -

Returns if a Coordinate is in a certain Radius of this Coordinate in 2D plane using the X and Z axis.

-

POINT_VEC2:IsInSphere(ToCoordinate, Radius, Coordinate)

 -

Returns if a Coordinate is in a certain radius of this Coordinate in 3D space using the X, Y and Z axis.

-

POINT_VEC2:IsInSteepArea(Radius, Minelevation)

 -

Function to check if a coordinate is in a steep (>8% elevation) area of the map

-

POINT_VEC2:IsLOS(ToCoordinate, Offset)

 -

Returns if a Coordinate has Line of Sight (LOS) with the ToCoordinate.

-

POINT_VEC2:IsNight(Clock)

 -

Check if it is night, i.e.

-

POINT_VEC2:IsSurfaceTypeLand()

 -

Checks if the surface type is on land.

-

POINT_VEC2:IsSurfaceTypeRoad()

 -

Checks if the surface type is road.

-

POINT_VEC2:IsSurfaceTypeRunway()

 -

Checks if the surface type is runway.

-

POINT_VEC2:IsSurfaceTypeShallowWater()

 -

Checks if the surface type is shallow water.

-

POINT_VEC2:IsSurfaceTypeWater()

 -

Checks if the surface type is water.

-

POINT_VEC2:LineToAll(Endpoint, Coalition, Color, Alpha, LineType, ReadOnly, Text)

 -

Line to all.

-

POINT_VEC2:MarkToAll(MarkText, ReadOnly, Text)

 -

Mark to All

-

POINT_VEC2:MarkToCoalition(MarkText, Coalition, ReadOnly, Text)

 -

Mark to Coalition

-

POINT_VEC2:MarkToCoalitionBlue(MarkText, ReadOnly, Text)

 -

Mark to Blue Coalition

-

POINT_VEC2:MarkToCoalitionRed(MarkText, ReadOnly, Text)

 -

Mark to Red Coalition

-

POINT_VEC2:MarkToGroup(MarkText, MarkGroup, ReadOnly, Text)

 -

Mark to Group

-

POINT_VEC2:MarkupToAllFreeForm(Coordinates, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

 -

Creates a free form shape on the F10 map.

-

POINT_VEC2:New(x, y, z)

 -

COORDINATE constructor.

-

POINT_VEC2:NewFromCoordinate(Coordinate)

 -

COORDINATE constructor.

-

POINT_VEC2:NewFromLLDD(latitude, longitude, altitude)

 -

Returns the coordinate from the latitude and longitude given in decimal degrees.

-

POINT_VEC2:NewFromVec2(Vec2, LandHeightAdd)

 -

Create a new COORDINATE object from Vec2 coordinates.

-

POINT_VEC2:NewFromVec3(Vec3)

 -

Create a new COORDINATE object from Vec3 coordinates.

-

POINT_VEC2:NewFromWaypoint(Waypoint)

 -

Create a new COORDINATE object from a waypoint.

-

POINT_VEC2:QuadToAll(Coord2, Coord3, Coord4, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

 -

Creates a shape defined by 4 points on the F10 map.

-

POINT_VEC2:RectToAll(Endpoint, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

 -

Rectangle to all.

-

POINT_VEC2:RemoveMark(MarkID)

 -

Remove a mark

-

POINT_VEC2:Rotate2D(Angle)

 -

Rotate coordinate in 2D (x,z) space.

-

POINT_VEC2:ScanObjects(radius, scanunits, scanstatics, scanscenery)

 -

Scan/find objects (units, statics, scenery) within a certain radius around the coordinate using the world.searchObjects() DCS API function.

-

POINT_VEC2:ScanScenery(radius)

 -

Scan/find SCENERY objects within a certain radius around the coordinate using the world.searchObjects() DCS API function.

-

POINT_VEC2:ScanStatics(radius)

 -

Scan/find STATICS within a certain radius around the coordinate using the world.searchObjects() DCS API function.

-

POINT_VEC2:ScanUnits(radius)

 -

Scan/find UNITS within a certain radius around the coordinate using the world.searchObjects() DCS API function.

-

POINT_VEC2:SetAltitude(altitude, asl)

 -

Set altitude.

-

POINT_VEC2:SetAtLandheight()

 -

Set altitude to be at land height (i.e.

-

POINT_VEC2:SetHeading(Heading)

 -

Set the heading of the coordinate, if applicable.

-

POINT_VEC2:SetVelocity(Velocity)

 -

Set the velocity of the COORDINATE.

-

POINT_VEC2:Smoke(SmokeColor)

 -

Smokes the point in a color.

-

POINT_VEC2:SmokeBlue()

 -

Smoke the COORDINATE Blue.

-

POINT_VEC2:SmokeGreen()

 -

Smoke the COORDINATE Green.

-

POINT_VEC2:SmokeOrange()

 -

Smoke the COORDINATE Orange.

-

POINT_VEC2:SmokeRed()

 -

Smoke the COORDINATE Red.

-

POINT_VEC2:SmokeWhite()

 -

Smoke the COORDINATE White.

-

POINT_VEC2:StopBigSmokeAndFire(name)

 -

Stop big smoke and fire at the coordinate.

-

POINT_VEC2:TextToAll(Text, Coalition, Color, Alpha, FillColor, FillAlpha, FontSize, ReadOnly)

 -

Text to all.

-

POINT_VEC2:ToString(Controllable, Settings, Task)

 -

Provides a coordinate string of the point, based on a coordinate format system: - * Uses default settings in COORDINATE.

-

POINT_VEC2:ToStringA2A(Controllable, Settings, MagVar)

 -

Provides a coordinate string of the point, based on the A2A coordinate format system.

-

POINT_VEC2:ToStringA2G(Controllable, Settings, MagVar)

 -

Provides a coordinate string of the point, based on the A2G coordinate format system.

-

POINT_VEC2:ToStringAspect(TargetCoordinate)

 -

Return an aspect string from a COORDINATE to the Angle of the object.

-

POINT_VEC2:ToStringBR(FromCoordinate, Settings, MagVar)

 -

Return a BR string from a COORDINATE to the COORDINATE.

-

POINT_VEC2:ToStringBRA(FromCoordinate, Settings, MagVar)

 -

Return a BRA string from a COORDINATE to the COORDINATE.

-

POINT_VEC2:ToStringBRAANATO(FromCoordinate, Bogey, Spades, SSML, Angels, Zeros)

 -

Create a BRAA NATO call string to this COORDINATE from the FromCOORDINATE.

-

POINT_VEC2:ToStringBULLS(Coalition, Settings, MagVar)

 -

Return a BULLS string out of the BULLS of the coalition to the COORDINATE.

-

POINT_VEC2:ToStringFromRP(ReferenceCoord, ReferenceName, Controllable, Settings, MagVar)

 -

Provides a coordinate string of the point, based on a coordinate format system: - * Uses default settings in COORDINATE.

-

POINT_VEC2:ToStringFromRPShort(ReferenceCoord, ReferenceName, Controllable, Settings, MagVar)

 -

Provides a coordinate string of the point, based on a coordinate format system: - * Uses default settings in COORDINATE.

-

POINT_VEC2:ToStringLLDDM(Settings)

 -

Provides a Lat Lon string in Degree Decimal Minute format.

-

POINT_VEC2:ToStringLLDMS(Settings)

 -

Provides a Lat Lon string in Degree Minute Second format.

-

POINT_VEC2:ToStringMGRS(Settings)

 -

Provides a MGRS string

-

POINT_VEC2:ToStringPressure(Controllable, Settings)

 -

Provides a pressure string of the point, based on a measurement system: - * Uses default settings in COORDINATE.

-

POINT_VEC2:ToStringTemperature(Controllable, Core, Settings)

 -

Provides a temperature string of the point, based on a measurement system: - * Uses default settings in COORDINATE.

-

POINT_VEC2:ToStringWind(Controllable, Settings)

 -

Provides a wind string of the point, based on a measurement system: - * Uses default settings in COORDINATE.

-

POINT_VEC2:Translate(Distance, Angle, Keepalt, Overwrite)

 -

Add a Distance in meters from the COORDINATE orthonormal plane, with the given angle, and calculate the new COORDINATE.

-

POINT_VEC2:UpdateFromCoordinate(Coordinate)

 -

Update x,y,z coordinates from another given COORDINATE.

-

POINT_VEC2:UpdateFromVec2(Vec2)

 -

Update x and z coordinates from a given 2D vector.

-

POINT_VEC2:UpdateFromVec3(Vec3)

 -

Update x,y,z coordinates from a given 3D vector.

-

POINT_VEC2.Velocity

 -

Velocity in meters per second. Needs to be set first.

-

POINT_VEC2.WaypointAction

 - -

POINT_VEC2:WaypointAir(AltType, Type, Action, Speed, SpeedLocked, airbase, DCSTasks, description, timeReFuAr)

 -

Build an air type route point.

-

POINT_VEC2:WaypointAirFlyOverPoint(AltType, Speed)

 -

Build a Waypoint Air "Fly Over Point".

-

POINT_VEC2:WaypointAirLanding(Speed, airbase, DCSTasks, description)

 -

Build a Waypoint Air "Landing".

-

POINT_VEC2:WaypointAirLandingReFu(Speed, airbase, timeReFuAr, DCSTasks, description)

 -

Build a Waypoint Air "LandingReFuAr".

-

POINT_VEC2:WaypointAirTakeOffParking(AltType, Speed)

 -

Build a Waypoint Air "Take Off Parking".

-

POINT_VEC2:WaypointAirTakeOffParkingHot(AltType, Speed)

 -

Build a Waypoint Air "Take Off Parking Hot".

-

POINT_VEC2:WaypointAirTakeOffRunway(AltType, Speed)

 -

Build a Waypoint Air "Take Off Runway".

-

POINT_VEC2:WaypointAirTurningPoint(AltType, Speed, DCSTasks, description)

 -

Build a Waypoint Air "Turning Point".

-

POINT_VEC2.WaypointAltType

 - -

POINT_VEC2:WaypointGround(Speed, Formation, DCSTasks)

 -

Build an ground type route point.

-

POINT_VEC2:WaypointNaval(Speed, Depth, DCSTasks)

 -

Build route waypoint point for Naval units.

-

POINT_VEC2.WaypointType

 - -

POINT_VEC2.firename

 - -

POINT_VEC2.x

 -

Component of the 3D vector.

-

POINT_VEC2.y

 -

Component of the 3D vector.

-

POINT_VEC2.z

 -

Component of the 3D vector.

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from BASEDescription

POINT_VEC2.ClassID

 -

The ID number of the class.

-

POINT_VEC2.ClassName

 -

The name of the class.

-

POINT_VEC2.ClassNameAndID

 -

The name of the class concatenated with the ID number of the class.

-

POINT_VEC2:ClearState(Object, StateName)

 -

Clear the state of an object.

-

POINT_VEC2:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

 -

Creation of a Birth Event.

-

POINT_VEC2:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Crash Event.

-

POINT_VEC2:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Dead Event.

-

POINT_VEC2:CreateEventPlayerEnterAircraft(PlayerUnit)

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

-

POINT_VEC2:CreateEventRemoveUnit(EventTime, Initiator)

 -

Creation of a Remove Unit Event.

-

POINT_VEC2:CreateEventTakeoff(EventTime, Initiator)

 -

Creation of a Takeoff Event.

-

POINT_VEC2:CreateEventUnitLost(EventTime, Initiator)

 -

Creation of a Crash Event.

-

POINT_VEC2:E(Arguments)

 -

Log an exception which will be traced always.

-

POINT_VEC2:EventDispatcher()

 -

Returns the event dispatcher

-

POINT_VEC2:EventRemoveAll()

 -

Remove all subscribed events

-

POINT_VEC2:F(Arguments)

 -

Trace a function call.

-

POINT_VEC2:F2(Arguments)

 -

Trace a function call level 2.

-

POINT_VEC2:F3(Arguments)

 -

Trace a function call level 3.

-

POINT_VEC2:GetClassID()

 -

Get the ClassID of the class instance.

-

POINT_VEC2:GetClassName()

 -

Get the ClassName of the class instance.

-

POINT_VEC2:GetClassNameAndID()

 -

Get the ClassName + ClassID of the class instance.

-

POINT_VEC2:GetEventPriority()

 -

Get the Class Core.Event processing Priority.

-

POINT_VEC2:GetParent(Child, FromClass)

 -

This is the worker method to retrieve the Parent class.

-

POINT_VEC2:GetState(Object, Key)

 -

Get a Value given a Key from the Object.

-

POINT_VEC2:HandleEvent(EventID, EventFunction)

 -

Subscribe to a DCS Event.

-

POINT_VEC2:I(Arguments)

 -

Log an information which will be traced always.

-

POINT_VEC2:Inherit(Child, Parent)

 -

This is the worker method to inherit from a parent class.

-

POINT_VEC2:IsInstanceOf(ClassName)

 -

This is the worker method to check if an object is an (sub)instance of a class.

-

POINT_VEC2:IsTrace()

 -

Enquires if tracing is on (for the class).

-

POINT_VEC2:New()

 -

BASE constructor.

-

POINT_VEC2:OnEvent(EventData)

 -

Occurs when an Event for an object is triggered.

-

POINT_VEC2:OnEventBDA(EventData)

 -

BDA.

-

POINT_VEC2:OnEventBaseCaptured(EventData)

 -

Occurs when a ground unit captures either an airbase or a farp.

-

POINT_VEC2:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

POINT_VEC2:OnEventCrash(EventData)

 -

Occurs when any aircraft crashes into the ground and is completely destroyed.

-

POINT_VEC2:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

POINT_VEC2:OnEventDetailedFailure(EventData)

 -

Unknown precisely what creates this event, likely tied into newer damage model.

-

POINT_VEC2:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

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

-

POINT_VEC2:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

POINT_VEC2:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

POINT_VEC2:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

POINT_VEC2:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

POINT_VEC2:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

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

-

POINT_VEC2:OnEventLandingAfterEjection(EventData)

 -

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

-

POINT_VEC2:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

POINT_VEC2:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

POINT_VEC2:OnEventMarkChange(EventData)

 -

Occurs when a mark text was changed.

-

POINT_VEC2:OnEventMarkRemoved(EventData)

 -

Occurs when a mark was removed.

-

POINT_VEC2:OnEventMissionEnd(EventData)

 -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

POINT_VEC2:OnEventMissionStart(EventData)

 -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

POINT_VEC2:OnEventParatrooperLanding(EventData)

 -

Weapon add.

-

POINT_VEC2:OnEventPilotDead(EventData)

 -

Occurs when the pilot of an aircraft is killed.

-

POINT_VEC2:OnEventPlayerEnterAircraft(EventData)

 -

Occurs when a player enters a slot and takes control of an aircraft.

-

POINT_VEC2:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-

POINT_VEC2:OnEventPlayerLeaveUnit(EventData)

 -

Occurs when any player relieves control of a unit to the AI.

-

POINT_VEC2:OnEventRefueling(EventData)

 -

Occurs when an aircraft connects with a tanker and begins taking on fuel.

-

POINT_VEC2:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-

POINT_VEC2:OnEventScore(EventData)

 -

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

-

POINT_VEC2:OnEventShootingEnd(EventData)

 -

Occurs when any unit stops firing its weapon.

-

POINT_VEC2:OnEventShootingStart(EventData)

 -

Occurs when any unit begins firing a weapon that has a high rate of fire.

-

POINT_VEC2:OnEventShot(EventData)

 -

Occurs whenever any unit in a mission fires a weapon.

-

POINT_VEC2:OnEventTakeoff(EventData)

 -

Occurs when an aircraft takes off from an airbase, farp, or ship.

-

POINT_VEC2:OnEventTriggerZone(EventData)

 -

Trigger zone.

-

POINT_VEC2:OnEventUnitLost(EventData)

 -

Occurs when the game thinks an object is destroyed.

-

POINT_VEC2:ScheduleOnce(Start, SchedulerFunction, ...)

 -

Schedule a new time event.

-

POINT_VEC2:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

 -

Schedule a new time event.

-

POINT_VEC2:ScheduleStop(SchedulerID)

 -

Stops the Schedule.

-

POINT_VEC2.Scheduler

 - -

POINT_VEC2:SetEventPriority(EventPriority)

 -

Set the Class Core.Event processing Priority.

-

POINT_VEC2:SetState(Object, Key, Value)

 -

Set a state or property of the Object given a Key and a Value.

-

POINT_VEC2:T(Arguments)

 -

Trace a function logic level 1.

-

POINT_VEC2:T2(Arguments)

 -

Trace a function logic level 2.

-

POINT_VEC2:T3(Arguments)

 -

Trace a function logic level 3.

-

POINT_VEC2:TraceAll(TraceAll)

 -

Trace all methods in MOOSE

-

POINT_VEC2:TraceClass(Class)

 -

Set tracing for a class

-

POINT_VEC2:TraceClassMethod(Class, Method)

 -

Set tracing for a specific method of class

-

POINT_VEC2:TraceLevel(Level)

 -

Set trace level

-

POINT_VEC2:TraceOff()

 -

Set trace off.

-

POINT_VEC2:TraceOn()

 -

Set trace on.

-

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

-

POINT_VEC2:UnHandleEvent(EventID)

 -

UnSubscribe to a DCS event.

-

POINT_VEC2._

 - -

POINT_VEC2:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function call.

-

POINT_VEC2:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function logic.

-

POINT_VEC2.__

 - -

POINT_VEC2:onEvent(event)

 -

The main event handling function...
@@ -5516,21 +3473,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string -COORDINATE.ClassName -

Name of the class

- -
- -
-
-
- - #number COORDINATE.Heading -

Heading in degrees. Needs to be set first.

+
@@ -5538,10 +3484,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + COORDINATE.Velocity -

Velocity in meters per second. Needs to be set first.

+
@@ -5582,10 +3528,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + COORDINATE.x -

Component of the 3D vector.

+ + + +

Coordinates.

@@ -5593,10 +3542,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + COORDINATE.y -

Component of the 3D vector.

+
@@ -5604,10 +3553,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + COORDINATE.z -

Component of the 3D vector.

+
@@ -11091,6 +9040,133 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
+
+
+ +
+ +
+

COORDINATE:NewFromMGRS(UTMZone, MGRSDigraph, Easting, Northing)

+
+ +

Provides a COORDINATE from an MGRS Coordinate

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameters:

+
+
+

+ #string + UTMZone +

+
+
+ +

UTM Zone, e.g. "37T"

+ +
+
+
+
+

+ #string + MGRSDigraph +

+
+
+ +

Digraph, e.g. "DK"

+ +
+
+
+
+

+ #number + Easting +

+
+
+ +

Meters easting

+ +
+
+
+
+

+ #number + Northing +

+
+
+ +

Meters northing

+ +
+
+

Return value:

+
+
+

#COORDINATE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

COORDINATE:NewFromMGRSString(MGRSString)

+
+ +

Provides a COORDINATE from an MGRS String

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #string + MGRSString +

+
+
+ +

MGRS String, e.g. "MGRS 37T DK 12345 12345"

+ +
+
+

Return value:

+
+
+

#COORDINATE:

+
+
+ +

self

+ +
+
+
+
@@ -14461,3458 +12537,6 @@ Creates a line on the F10 map from one point to another.

-
-

Field(s)

-
-
-
- - #string -COORDINATE.ClassName - -

Name of the class

- -
- -
-
-
- - #number -COORDINATE.Heading - -

Heading in degrees. Needs to be set first.

- -
- -
-
-
- - #number -COORDINATE.Velocity - -

Velocity in meters per second. Needs to be set first.

- -
- -
- - - -
-
- - #number -COORDINATE.x - -

Component of the 3D vector.

- -
- -
-
-
- - #number -COORDINATE.y - -

Component of the 3D vector.

- -
- -
-
-
- - #number -COORDINATE.z - -

Component of the 3D vector.

- -
- -
-
-

Function(s)

-
-
- -
-

COORDINATE:ClearState(Object, StateName)

-
- -

Clear the state of an object.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Object -

-
-
- -

The object that holds the Value set by the Key.

- -
-
-
-
-

- StateName -

-
-
- -

The key that is should be cleared.

- -
-
-
- -
-
- -
- -
-

COORDINATE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

-
- -

Creation of a Birth Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
-
-

- #string - IniUnitName -

-
-
- -

The initiating unit name.

- -
-
-
-
-

- place -

-
-
-

-
-
-
-
-

- subplace -

-
-
-

-
-
-
- -
-
- -
- -
-

COORDINATE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

-
- -

Creation of a Crash Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

COORDINATE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

-
- -

Creation of a Dead Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

COORDINATE:CreateEventPlayerEnterAircraft(PlayerUnit)

-
- -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.Unit#UNIT - PlayerUnit -

-
-
- -

The aircraft unit the player entered.

- -
-
-
- -
-
- -
- -
-

COORDINATE:CreateEventRemoveUnit(EventTime, Initiator)

-
- -

Creation of a Remove Unit Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

COORDINATE:CreateEventTakeoff(EventTime, Initiator)

-
- -

Creation of a Takeoff Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

COORDINATE:CreateEventUnitLost(EventTime, Initiator)

-
- -

Creation of a Crash Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

COORDINATE:E(Arguments)

-
- -

Log an exception which will be traced always.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

COORDINATE:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

Core.Event#EVENT:

-
-
- - - -
-
-
- -
-
- -
- -
-

COORDINATE:EventRemoveAll()

-
- -

Remove all subscribed events

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

COORDINATE:F(Arguments)

-
- -

Trace a function call.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

COORDINATE:F2(Arguments)

-
- -

Trace a function call level 2.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

COORDINATE:F3(Arguments)

-
- -

Trace a function call level 3.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

COORDINATE:GetClassID()

-
- -

Get the ClassID of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

COORDINATE:GetClassName()

-
- -

Get the ClassName of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName of the class instance.

- -
-
-
- -
-
- -
- -
-

COORDINATE:GetClassNameAndID()

-
- -

Get the ClassName + ClassID of the class instance.

- - -

The ClassName + ClassID is formatted as '%s#%09d'.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName + ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

COORDINATE:GetEventPriority()

-
- -

Get the Class Core.Event processing Priority.

- - -

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#number:

-
-
- -

The Core.Event processing Priority.

- -
-
-
- -
-
- -
- -
-

COORDINATE:GetParent(Child, FromClass)

-
- -

This is the worker method to retrieve the Parent class.

- - -

Note that the Parent class must be passed to call the parent class method.

- -
self:GetParent(self):ParentMethod()
-
- - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #BASE - Child -

-
-
- -

This is the Child class from which the Parent class needs to be retrieved.

- -
-
-
-
-

- #BASE - FromClass -

-
-
- -

(Optional) The class from which to get the parent.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

COORDINATE:GetState(Object, Key)

-
- -

Get a Value given a Key from the Object.

- - -

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Object -

-
-
- -

The object that holds the Value set by the Key.

- -
-
-
-
-

- Key -

-
-
- -

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

- -
-
-

Return value:

-
-
-
-
- -

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

- -
-
-
- -
-
- -
- -
-

COORDINATE:HandleEvent(EventID, EventFunction)

-
- -

Subscribe to a DCS Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-
-
-

- #function - EventFunction -

-
-
- -

(optional) The function to be called when the event occurs for the unit.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

COORDINATE:I(Arguments)

-
- -

Log an information which will be traced always.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

COORDINATE:Inherit(Child, Parent)

-
- -

This is the worker method to inherit from a parent class.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Child -

-
-
- -

is the Child class that inherits.

- -
-
-
-
-

- #BASE - Parent -

-
-
- -

is the Parent class that the Child inherits from.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

Child

- -
-
-
- -
-
- -
- -
-

COORDINATE:IsInstanceOf(ClassName)

-
- -

This is the worker method to check if an object is an (sub)instance of a class.

- - - -

Examples:

- -
    -

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- ClassName -

-
-
- -

is the name of the class or the class itself to run the check against

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

COORDINATE:IsTrace()

-
- -

Enquires if tracing is on (for the class).

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

COORDINATE:New()

-
- -

BASE constructor.

- - - -

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

- -
function EVENT:New()
-  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
-  return self
-end
-
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

COORDINATE:OnEvent(EventData)

-
- -

Occurs when an Event for an object is triggered.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that triggered the event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventBDA(EventData)

-
- -

BDA.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventBaseCaptured(EventData)

-
- -

Occurs when a ground unit captures either an airbase or a farp.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that captured the base -place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventBirth(EventData)

-
- -

Occurs when any object is spawned into the mission.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was spawned

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventCrash(EventData)

-
- -

Occurs when any aircraft crashes into the ground and is completely destroyed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that has crashed

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventDead(EventData)

-
- -

Occurs when an object is dead.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is dead.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventDetailedFailure(EventData)

-
- -

Unknown precisely what creates this event, likely tied into newer damage model.

- - -

Will update this page when new information become available.

- -
    -
  • initiator: The unit that had the failure.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventDiscardChairAfterEjection(EventData)

-
- -

Discard chair after ejection.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- - -

initiator : The unit that has ejected

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventEngineShutdown(EventData)

-
- -

Occurs when any aircraft shuts down its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is stopping its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventEngineStartup(EventData)

-
- -

Occurs when any aircraft starts its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is starting its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventHit(EventData)

-
- -

Occurs whenever an object is hit by a weapon.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit object the fired the weapon -weapon: Weapon object that hit the target -target: The Object that was hit.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventHumanFailure(EventData)

-
- -

Occurs when any system fails on a human controlled aircraft.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that had the failure

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventKill(EventData)

-
- -

Occurs on the death of a unit.

- - -

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: The unit that killed the target
    • -
  • target: Target Object
    • -
  • weapon: Weapon Object
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- - -

initiator : The unit that has landed -place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventLandingAfterEjection(EventData)

-
- -

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

- - -

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
    • -
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
    • -
  • subplace: is always 0 for unknown reasons.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventLandingQualityMark(EventData)

-
- -

Landing quality mark.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventMarkAdded(EventData)

-
- -

Occurs when a new mark was added.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventMarkChange(EventData)

-
- -

Occurs when a mark text was changed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventMarkRemoved(EventData)

-
- -

Occurs when a mark was removed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventMissionEnd(EventData)

-
- -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventMissionStart(EventData)

-
- -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventParatrooperLanding(EventData)

-
- -

Weapon add.

- - -

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventPilotDead(EventData)

-
- -

Occurs when the pilot of an aircraft is killed.

- - -

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the pilot has died in.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventPlayerEnterAircraft(EventData)

-
- -

Occurs when a player enters a slot and takes control of an aircraft.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. -initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventPlayerEnterUnit(EventData)

-
- -

Occurs when any player assumes direct control of a unit.

- - -

Note - not Mulitplayer safe. Use PlayerEnterAircraft. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventPlayerLeaveUnit(EventData)

-
- -

Occurs when any player relieves control of a unit to the AI.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the player left.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventRefueling(EventData)

-
- -

Occurs when an aircraft connects with a tanker and begins taking on fuel.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventRefuelingStop(EventData)

-
- -

Occurs when an aircraft is finished taking fuel.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventScore(EventData)

-
- -

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

- - -

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventShootingEnd(EventData)

-
- -

Occurs when any unit stops firing its weapon.

- - -

Event will always correspond with a shooting start event. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was doing the shooting.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventShootingStart(EventData)

-
- -

Occurs when any unit begins firing a weapon that has a high rate of fire.

- - -

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is doing the shooting. -target: The unit that is being targeted.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventShot(EventData)

-
- -

Occurs whenever any unit in a mission fires a weapon.

- - -

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventTakeoff(EventData)

-
- -

Occurs when an aircraft takes off from an airbase, farp, or ship.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that tookoff -place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventTriggerZone(EventData)

-
- -

Trigger zone.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:OnEventUnitLost(EventData)

-
- -

Occurs when the game thinks an object is destroyed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: The unit that is was destroyed.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

COORDINATE:ScheduleOnce(Start, SchedulerFunction, ...)

-
- -

Schedule a new time event.

- - -

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #number - Start -

-
-
- -

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

- -
-
-
-
-

- #function - SchedulerFunction -

-
-
- -

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

- -
-
-
-
-

- #table - ... -

-
-
- -

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

- -
-
-
- -
-
- -
- -
-

COORDINATE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

-
- -

Schedule a new time event.

- - -

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #number - Start -

-
-
- -

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

- -
-
-
-
-

- #number - Repeat -

-
-
- -

Specifies the interval in seconds when the scheduler will call the event function.

- -
-
-
-
-

- #number - RandomizeFactor -

-
-
- -

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

- -
-
-
-
-

- #number - Stop -

-
-
- -

Specifies the amount of seconds when the scheduler will be stopped.

- -
-
-
-
-

- #function - SchedulerFunction -

-
-
- -

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

- -
-
-
-
-

- #table - ... -

-
-
- -

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

- -
-
-
- -
-
- -
- -
-

COORDINATE:ScheduleStop(SchedulerID)

-
- -

Stops the Schedule.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - SchedulerID -

-
-
- -

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

- -
-
-
- -
-
- -
- -
-

COORDINATE:SetEventPriority(EventPriority)

-
- -

Set the Class Core.Event processing Priority.

- - -

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - EventPriority -

-
-
- -

The Core.Event processing Priority.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

COORDINATE:SetState(Object, Key, Value)

-
- -

Set a state or property of the Object given a Key and a Value.

- - -

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Object -

-
-
- -

The object that will hold the Value set by the Key.

- -
-
-
-
-

- Key -

-
-
- -

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

- -
-
-
-
-

- Value -

-
-
- -

The value to is stored in the object.

- -
-
-

Return value:

-
-
-
-
- -

The Value set.

- -
-
-
- -
-
- -
- -
-

COORDINATE:T(Arguments)

-
- -

Trace a function logic level 1.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

COORDINATE:T2(Arguments)

-
- -

Trace a function logic level 2.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

COORDINATE:T3(Arguments)

-
- -

Trace a function logic level 3.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

COORDINATE:TraceAll(TraceAll)

-
- -

Trace all methods in MOOSE

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceAll -

-
-
- -

true = trace all methods in MOOSE.

- -
-
-
- -
-
- -
- -
-

COORDINATE:TraceClass(Class)

-
- -

Set tracing for a class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - Class -

-
-
- -

Class name.

- -
-
-
- -
-
- -
- -
-

COORDINATE:TraceClassMethod(Class, Method)

-
- -

Set tracing for a specific method of class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #string - Class -

-
-
- -

Class name.

- -
-
-
-
-

- #string - Method -

-
-
- -

Method.

- -
-
-
- -
-
- -
- -
-

COORDINATE:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - Level -

-
-
-

-
-
-
- -
-
- -
- -
-

COORDINATE:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing Off
-BASE:TraceOff()
- -
- -
-
- -
- -
-

COORDINATE:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing On
-BASE:TraceOn()
- -
- -
-
- -
- -
-

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

- - -

So tracing must be switched on manually in your mission if you are using Moose statically. -When moose is loading dynamically (for moose class development), tracing is switched on by default.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceOnOff -

-
-
- -

Switch the tracing on or off.

- -
-
-

Usage:

- 

-  -- Switch the tracing On
-  BASE:TraceOnOff( true )
-
-  -- Switch the tracing Off
-  BASE:TraceOnOff( false )
-
- -
- -
-
- -
- -
-

COORDINATE:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

COORDINATE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function call.

- - -

This function is private.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

COORDINATE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

COORDINATE:onEvent(event)

-
- -

The main event handling function...

- - -

This function captures all events generated for the class.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- DCS#Event - event -

-
-
-

-
-
-
- -
-
-
@@ -18179,21 +12803,10 @@ When moose is loading dynamically (for moose class development), tracing is swit
- DCS#Distance + POINT_VEC2.x -

The x coordinate in meters.

-
- -
-
-
- - DCS#Distance -POINT_VEC2.y - -

the y coordinate in meters.

@@ -18982,12277 +13595,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
-

Field(s)

-
-
-
- - DCS#Distance -POINT_VEC2.x - -

The x coordinate in meters.

- -
- -
-
-
- - DCS#Distance -POINT_VEC2.y - -

the y coordinate in meters.

- -
- -
-
-
- - -POINT_VEC2.z - - - -
- -
-
-

Function(s)

-
-
- -
-

POINT_VEC2:ArrowToAll(Endpoint, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

-
- -

Arrow to all.

- - -

Creates an arrow from the COORDINATE to the endpoint COORDINATE on the F10 map. There is no control over other dimensions of the arrow.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - Endpoint -

-
-
- -

COORDINATE where the tip of the arrow is pointing at.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

- -
-
-
-
-

- #table - Color -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red (default).

- -
-
-
-
-

- #number - Alpha -

-
-
- -

Transparency [0,1]. Default 1.

- -
-
-
-
-

- #table - FillColor -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value.

- -
-
-
-
-

- #number - FillAlpha -

-
-
- -

Transparency [0,1]. Default 0.15.

- -
-
-
-
-

- #number - LineType -

-
-
- -

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID, which is a number. Can be used to remove the object again.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:BigSmokeAndFire(preset, density, name)

-
- -

Big smoke and fire at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Utilities.Utils#BIGSMOKEPRESET - preset -

-
-
- -

Smoke preset (1=small smoke and fire, 2=medium smoke and fire, 3=large smoke and fire, 4=huge smoke and fire, 5=small smoke, 6=medium smoke, 7=large smoke, 8=huge smoke).

- -
-
-
-
-

- #number - density -

-
-
- -

(Optional) Smoke density. Number in [0,...,1]. Default 0.5.

- -
-
-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:BigSmokeAndFireHuge(density, name)

-
- -

Huge smoke and fire at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - density -

-
-
- -

(Optional) Smoke density. Number between 0 and 1. Default 0.5.

- -
-
-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:BigSmokeAndFireLarge(density, name)

-
- -

Large smoke and fire at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - density -

-
-
- -

(Optional) Smoke density. Number between 0 and 1. Default 0.5.

- -
-
-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:BigSmokeAndFireMedium(density, name)

-
- -

Medium smoke and fire at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - density -

-
-
- -

(Optional) Smoke density. Number between 0 and 1. Default 0.5.

- -
-
-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:BigSmokeAndFireSmall(density, name)

-
- -

Small smoke and fire at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - density -

-
-
- -

(Optional) Smoke density. Number between 0 and 1. Default 0.5.

- -
-
-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:BigSmokeHuge(density, name)

-
- -

Huge smoke at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - density -

-
-
- -

(Optional) Smoke density. Number between 0 and 1. Default 0.5.

- -
-
-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:BigSmokeLarge(density, name)

-
- -

Large smoke at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - density -

-
-
- -

(Optional) Smoke density. Number between 0 and 1. Default 0.5.

- -
-
-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:BigSmokeMedium(number, name, density)

-
- -

Medium smoke at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- number -

-
-
- -

density (Optional) Smoke density. Number between 0 and 1. Default 0.5.

- -
-
-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.

- -
-
-
-
-

- density -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:BigSmokeSmall(density, name)

-
- -

Small smoke at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - density -

-
-
- -

(Optional) Smoke density. Number between 0 and 1. Default 0.5.

- -
-
-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:CircleToAll(Radius, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

-
- -

Circle to all.

- - -

Creates a circle on the map with a given radius, color, fill color, and outline.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Radius -

-
-
- -

Radius in meters. Default 1000 m.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

- -
-
-
-
-

- #table - Color -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red (default).

- -
-
-
-
-

- #number - Alpha -

-
-
- -

Transparency [0,1]. Default 1.

- -
-
-
-
-

- #table - FillColor -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value.

- -
-
-
-
-

- #number - FillAlpha -

-
-
- -

Transparency [0,1]. Default 0.15.

- -
-
-
-
-

- #number - LineType -

-
-
- -

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID, which is a number. Can be used to remove the object again.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:DistanceFromPointVec2(PointVec2Reference)

-
- -

Calculate the distance from a reference #COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #COORDINATE - PointVec2Reference -

-
-
- -

The reference #COORDINATE.

- -
-
-

Return value:

-
-
-

DCS#Distance:

-
-
- -

The distance from the reference #COORDINATE in meters.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:Explosion(ExplosionIntensity, Delay)

-
- -

Creates an explosion at the point of a certain intensity.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - ExplosionIntensity -

-
-
- -

Intensity of the explosion in kg TNT. Default 100 kg.

- -
-
-
-
-

- #number - Delay -

-
-
- -

(Optional) Delay before explosion is triggered in seconds.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:FindClosestScenery(radius)

-
- -

Find the closest scenery to the COORDINATE within a certain radius.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #number - radius -

-
-
- -

Scan radius in meters. Default 100 m.

- -
-
-

Return value:

-
-
-

Wrapper.Scenery#SCENERY:

-
-
- -

The closest scenery or #nil if no object is inside the given radius.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:FindClosestStatic(radius)

-
- -

Find the closest static to the COORDINATE within a certain radius.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #number - radius -

-
-
- -

Scan radius in meters. Default 100 m.

- -
-
-

Return value:

-
-
-

Wrapper.Static#STATIC:

-
-
- -

The closest static or #nil if no unit is inside the given radius.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:FindClosestUnit(radius)

-
- -

Find the closest unit to the COORDINATE within a certain radius.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #number - radius -

-
-
- -

Scan radius in meters. Default 100 m.

- -
-
-

Return value:

-
-
-

Wrapper.Unit#UNIT:

-
-
- -

The closest unit or #nil if no unit is inside the given radius.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:Flare(FlareColor, Azimuth)

-
- -

Flares the point in a color.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Utilities.Utils#FLARECOLOR - FlareColor -

-
-
-

-
-
-
-
-

- DCS#Azimuth - Azimuth -

-
-
- -

(optional) The azimuth of the flare direction. The default azimuth is 0.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:FlareGreen(Azimuth)

-
- -

Flare the COORDINATE Green.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Azimuth - Azimuth -

-
-
- -

(optional) The azimuth of the flare direction. The default azimuth is 0.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:FlareRed(Azimuth)

-
- -

Flare the COORDINATE Red.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- Azimuth -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:FlareWhite(Azimuth)

-
- -

Flare the COORDINATE White.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Azimuth - Azimuth -

-
-
- -

(optional) The azimuth of the flare direction. The default azimuth is 0.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:FlareYellow(Azimuth)

-
- -

Flare the COORDINATE Yellow.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Azimuth - Azimuth -

-
-
- -

(optional) The azimuth of the flare direction. The default azimuth is 0.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:Get2DDistance(TargetCoordinate)

-
- -

Return the 2D distance in meters between the target COORDINATE and the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #COORDINATE - TargetCoordinate -

-
-
- -

The target COORDINATE. Can also be a DCS#Vec3.

- -
-
-

Return value:

-
-
-

DCS#Distance:

-
-
- -

Distance The distance in meters.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:Get3DDistance(TargetCoordinate)

-
- -

Return the 3D distance in meters between the target COORDINATE and the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #COORDINATE - TargetCoordinate -

-
-
- -

The target COORDINATE. Can also be a DCS#Vec3.

- -
-
-

Return value:

-
-
-

DCS#Distance:

-
-
- -

Distance The distance in meters.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetAltitudeText(Settings, Language)

-
- -

Return the altitude text of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Settings -

-
-
-

-
-
-
-
-

- Language -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- -

Altitude text.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetAngleDegrees(DirectionVec3)

-
- -

Return an angle in degrees from the COORDINATE using a direction vector in Vec3 format.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Vec3 - DirectionVec3 -

-
-
- -

The direction vector in Vec3 format.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

DirectionRadians The angle in degrees.

- -
-
-

Usage:

- 
        local directionAngle = currentCoordinate:GetAngleDegrees(currentCoordinate:GetDirectionVec3(sourceCoordinate:GetVec3()))
- -
- -
-
- -
- -
-

POINT_VEC2:GetAngleRadians(DirectionVec3)

-
- -

Return an angle in radians from the COORDINATE using a direction vector in Vec3 format.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Vec3 - DirectionVec3 -

-
-
- -

The direction vector in Vec3 format.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

DirectionRadians The angle in radians.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetBRAText(AngleRadians, Distance, Settings, Language, MagVar)

-
- -

Provides a Bearing / Range / Altitude string

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - AngleRadians -

-
-
- -

The angle in randians

- -
-
-
-
-

- #number - Distance -

-
-
- -

The distance

- -
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
-

-
-
-
-
-

- #string - Language -

-
-
- -

(Optional) Language "en" or "ru"

- -
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true, also state angle in magnetic

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The BRA Text

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetBRText(AngleRadians, Distance, Settings, Language, MagVar)

-
- -

Provides a Bearing / Range string

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - AngleRadians -

-
-
- -

The angle in randians

- -
-
-
-
-

- #number - Distance -

-
-
- -

The distance

- -
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
-

-
-
-
-
-

- #string - Language -

-
-
- -

(Optional) Language "en" or "ru"

- -
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true, also state angle in magnetic

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The BR Text

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetBearingText(AngleRadians, Precision, Settings, MagVar)

-
- -

Provides a bearing text in degrees.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - AngleRadians -

-
-
- -

The angle in randians.

- -
-
-
-
-

- #number - Precision -

-
-
- -

The precision.

- -
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
-

-
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true, include magentic degrees

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The bearing text in degrees.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2.GetBullseyeCoordinate(Coalition)

-
- -

Return the BULLSEYE as COORDINATE Object

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #number - Coalition -

-
-
- -

Coalition of the bulls eye to return, e.g. coalition.side.BLUE

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-

Usage:

- 
         -- note the dot (.) here,not using the colon (:)
-         local redbulls = COORDINATE.GetBullseyeCoordinate(coalition.side.RED)
- -
- -
-
- -
- -
-

POINT_VEC2:GetClosestAirbase(Category, Coalition)

-
- -

Gets the nearest airbase with respect to the current coordinates.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Category -

-
-
- -

(Optional) Category of the airbase. Enumerator of Wrapper.Airbase#AIRBASE.Category.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

(Optional) Coalition of the airbase.

- -
-
-

Return values:

-
-
-

Wrapper.Airbase#AIRBASE:

-
-
- -

Closest Airbase to the given coordinate.

- -
-
-

#number:

-
-
- -

Distance to the closest airbase in meters.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetClosestAirbase2(Category, Coalition)

-
- -

[kept for downwards compatibility only] Gets the nearest airbase with respect to the current coordinates.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Category -

-
-
- -

(Optional) Category of the airbase. Enumerator of Wrapper.Airbase#AIRBASE.Category.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

(Optional) Coalition of the airbase.

- -
-
-

Return values:

-
-
-

Wrapper.Airbase#AIRBASE:

-
-
- -

Closest Airbase to the given coordinate.

- -
-
-

#number:

-
-
- -

Distance to the closest airbase in meters.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetClosestFreeParkingSpot(airbase, terminaltype)

-
- -

Gets the nearest free parking spot.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - airbase -

-
-
- -

(Optional) Search only parking spots at that airbase.

- -
-
-
-
-

- Wrapper.Airbase#Terminaltype - terminaltype -

-
-
- -

(Optional) Type of the terminal.

- -
-
-

Return values:

-
-
-

#COORDINATE:

-
-
- -

Coordinate of the nearest free parking spot.

- -
-
-

#number:

-
-
- -

Terminal ID.

- -
-
-

#number:

-
-
- -

Distance to closest free parking spot in meters.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetClosestOccupiedParkingSpot(airbase, terminaltype)

-
- -

Gets the nearest occupied parking spot.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - airbase -

-
-
- -

(Optional) Search only parking spots at that airbase.

- -
-
-
-
-

- Wrapper.Airbase#Terminaltype - terminaltype -

-
-
- -

(Optional) Type of the terminal.

- -
-
-

Return values:

-
-
-

#COORDINATE:

-
-
- -

Coordinate of the nearest occupied parking spot.

- -
-
-

#number:

-
-
- -

Terminal ID.

- -
-
-

#number:

-
-
- -

Distance to closest occupied parking spot in meters.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetClosestParkingSpot(airbase, terminaltype, free)

-
- -

Gets the nearest parking spot.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - airbase -

-
-
- -

(Optional) Search only parking spots at this airbase.

- -
-
-
-
-

- Wrapper.Airbase#Terminaltype - terminaltype -

-
-
- -

(Optional) Type of the terminal. Default any execpt valid spawn points on runway.

- -
-
-
-
-

- #boolean - free -

-
-
- -

(Optional) If true, returns the closest free spot. If false, returns the closest occupied spot. If nil, returns the closest spot regardless of free or occupied.

- -
-
-

Return values:

-
-
-

Core.Point#COORDINATE:

-
-
- -

Coordinate of the nearest parking spot.

- -
-
-

#number:

-
-
- -

Terminal ID.

- -
-
-

#number:

-
-
- -

Distance to closest parking spot in meters.

- -
-
-

Wrapper.Airbase#AIRBASE:

-
-
- -

ParkingSpot Parking spot table.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetClosestPointToRoad(Railroad)

-
- -

Gets the nearest coordinate to a road (or railroad).

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #boolean - Railroad -

-
-
- -

(Optional) If true, closest point to railroad is returned rather than closest point to conventional road. Default false.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

Coordinate of the nearest road.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetCoordinate()

-
- -

Return the coordinates itself.

- - -

Sounds stupid but can be useful for compatibility.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetDirectionVec3(TargetCoordinate)

-
- -

Return a direction vector Vec3 from COORDINATE to the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #COORDINATE - TargetCoordinate -

-
-
- -

The target COORDINATE.

- -
-
-

Return value:

-
-
-

DCS#Vec3:

-
-
- -

DirectionVec3 The direction vector in Vec3 format.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetDistanceText(Distance, Settings, Language, Precision)

-
- -

Provides a distance text expressed in the units of measurement.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Distance -

-
-
- -

The distance in meters.

- -
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
-

-
-
-
-
-

- #string - Language -

-
-
- -

(optional) "EN" or "RU"

- -
-
-
-
-

- #number - Precision -

-
-
- -

(optional) round to this many decimal places

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The distance text expressed in the units of measurement.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetHeading()

-
- -

Get the heading of the coordinate, if applicable.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#number:

-
-
- -

or nil

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetHeadingText(Settings)

-
- -

Return the heading text of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- Settings -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- -

Heading text.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetIntermediateCoordinate(ToCoordinate, Fraction)

-
- -

Return an intermediate COORDINATE between this an another coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - ToCoordinate -

-
-
- -

The other coordinate.

- -
-
-
-
-

- #number - Fraction -

-
-
- -

The fraction (0,1) where the new coordinate is created. Default 0.5, i.e. in the middle.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

Coordinate between this and the other coordinate.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetLLDDM()

-
- -

Get Latitude and Longitude in Degrees Decimal Minutes (DDM).

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return values:

-
-
-

#number:

-
-
- -

Latitude in DDM.

- -
-
-

#number:

-
-
- -

Lontitude in DDM.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetLandHeight()

-
- -

Return the height of the land at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#number:

-
-
- -

Land height (ASL) in meters.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetMagneticDeclination(Month, Year)

-
- -

Returns the magnetic declination at the given coordinate.

- - -

NOTE that this needs require to be available so you need to desanitize the MissionScripting.lua file in your DCS/Scrips folder. -If require is not available, a constant value for the whole map.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Month -

-
-
- -

(Optional) The month at which the declination is calculated. Default is the mission month.

- -
-
-
-
-

- #number - Year -

-
-
- -

(Optional) The year at which the declination is calculated. Default is the mission year.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

Magnetic declination in degrees.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetMinutesToSunrise(OnlyToday)

-
- -

Get minutes until the next sun rise at this coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- OnlyToday -

-
-
- -

If true, only calculate the sun rise of today. If sun has already risen, the time in negative minutes since sunrise is reported.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

Minutes to the next sunrise.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetMinutesToSunset(OnlyToday)

-
- -

Get minutes until the next sun set at this coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- OnlyToday -

-
-
- -

If true, only calculate the sun set of today. If sun has already set, the time in negative minutes since sunset is reported.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

Minutes to the next sunrise.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetMovingText(Settings)

-
- -

Return velocity text of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- Settings -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetName()

-
- -

Return the "name" of the COORDINATE.

- - -

Obviously, a coordinate does not have a name like a unit, static or group. So here we take the MGRS coordinates of the position.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#string:

-
-
- -

MGRS coordinates.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetNorthCorrectionRadians()

-
- -

Get a correction in radians of the real magnetic north of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#number:

-
-
- -

CorrectionRadians The correction in radians.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetPathOnRoad(ToCoord, IncludeEndpoints, Railroad, MarkPath, SmokePath)

-
- -

Returns a table of coordinates to a destination using only roads or railroads.

- - -

The first point is the closest point on road of the given coordinate. -By default, the last point is the closest point on road of the ToCoord. Hence, the coordinate itself and the final ToCoord are not necessarily included in the path.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - ToCoord -

-
-
- -

Coordinate of destination.

- -
-
-
-
-

- #boolean - IncludeEndpoints -

-
-
- -

(Optional) Include the coordinate itself and the ToCoordinate in the path.

- -
-
-
-
-

- #boolean - Railroad -

-
-
- -

(Optional) If true, path on railroad is returned. Default false.

- -
-
-
-
-

- #boolean - MarkPath -

-
-
- -

(Optional) If true, place markers on F10 map along the path.

- -
-
-
-
-

- #boolean - SmokePath -

-
-
- -

(Optional) If true, put (green) smoke along the

- -
-
-

Return values:

-
-
-

#table:

-
-
- -

Table of coordinates on road. If no path on road can be found, nil is returned or just the endpoints.

- -
-
-

#number:

-
-
- -

Tonal length of path.

- -
-
-

#boolean:

-
-
- -

If true a valid path on road/rail was found. If false, only the direct way is possible.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetPressure(height)

-
- -

Returns the pressure in hPa.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- height -

-
-
- -

(Optional) parameter specifying the height ASL. E.g. set height=0 for QNH.

- -
-
-

Return value:

-
-
-
-
- -

Pressure in hPa.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetPressureText(height, Settings)

-
- -

Returns a text of the pressure according the measurement system Core.Settings.

- - -

The text will contain always the pressure in hPa and:

- -
    -
  • For Russian and European aircraft using the metric system - hPa and mmHg
    • -
  • For American and European aircraft we link to the imperial system - hPa and inHg
    • -
- -

A text containing a pressure will look like this:

- -
    -
  • QFE: x hPa (y mmHg)
    • -
  • QFE: x hPa (y inHg)
    • -
- - -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- height -

-
-
- -

(Optional) parameter specifying the height ASL. E.g. set height=0 for QNH.

- -
-
-
-
-

- Settings -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- -

Pressure in hPa and mmHg or inHg depending on the measurement system Core.Settings.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetRandomCoordinateInRadius(OuterRadius, InnerRadius)

-
- -

Return a random Coordinate within an Outer Radius and optionally NOT within an Inner Radius of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- DCS#Distance - OuterRadius -

-
-
- -

Outer radius in meters.

- -
-
-
-
-

- DCS#Distance - InnerRadius -

-
-
- -

Inner radius in meters.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetRandomVec2InRadius(OuterRadius, InnerRadius)

-
- -

Return a random Vec2 within an Outer Radius and optionally NOT within an Inner Radius of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- DCS#Distance - OuterRadius -

-
-
-

-
-
-
-
-

- DCS#Distance - InnerRadius -

-
-
-

-
-
-

Return value:

-
-
-

DCS#Vec2:

-
-
- -

Vec2

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetRandomVec3InRadius(OuterRadius, InnerRadius)

-
- -

Return a random Vec3 within an Outer Radius and optionally NOT within an Inner Radius of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- DCS#Distance - OuterRadius -

-
-
-

-
-
-
-
-

- DCS#Distance - InnerRadius -

-
-
-

-
-
-

Return value:

-
-
-

DCS#Vec3:

-
-
- -

Vec3

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetSunrise(InSeconds)

-
- -

Get todays sun rise time.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #boolean - InSeconds -

-
-
- -

If true, return the sun rise time in seconds.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

Sunrise time, e.g. "05:41".

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetSunriseAtDate(Day, Month, Year, InSeconds)

-
- -

Get sun rise time for a specific date at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Day -

-
-
- -

The day.

- -
-
-
-
-

- #number - Month -

-
-
- -

The month.

- -
-
-
-
-

- #number - Year -

-
-
- -

The year.

- -
-
-
-
-

- #boolean - InSeconds -

-
-
- -

If true, return the sun rise time in seconds.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

Sunrise time, e.g. "05:41".

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetSunriseAtDayOfYear(DayOfYear, InSeconds)

-
- -

Get sun rise time for a specific day of the year at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - DayOfYear -

-
-
- -

The day of the year.

- -
-
-
-
-

- #boolean - InSeconds -

-
-
- -

If true, return the sun rise time in seconds.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

Sunrise time, e.g. "05:41".

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetSunset(InSeconds)

-
- -

Get todays sun set time.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #boolean - InSeconds -

-
-
- -

If true, return the sun set time in seconds.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

Sunrise time, e.g. "20:41".

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetSunsetAtDate(Day, Month, Year, InSeconds)

-
- -

Get sun set time for a specific date at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Day -

-
-
- -

The day.

- -
-
-
-
-

- #number - Month -

-
-
- -

The month.

- -
-
-
-
-

- #number - Year -

-
-
- -

The year.

- -
-
-
-
-

- #boolean - InSeconds -

-
-
- -

If true, return the sun rise time in seconds.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

Sunset time, e.g. "20:41".

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetSurfaceType()

-
- -

Gets the surface type at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

DCS#SurfaceType:

-
-
- -

Surface type.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetTemperature(height)

-
- -

Returns the temperature in Degrees Celsius.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- height -

-
-
- -

(Optional) parameter specifying the height ASL.

- -
-
-

Return value:

-
-
-
-
- -

Temperature in Degrees Celsius.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetTemperatureText(height, Settings)

-
- -

Returns a text of the temperature according the measurement system Core.Settings.

- - -

The text will reflect the temperature like this:

- -
    -
  • For Russian and European aircraft using the metric system - Degrees Celcius (°C)
    • -
  • For American aircraft we link to the imperial system - Degrees Fahrenheit (°F)
    • -
- -

A text containing a pressure will look like this:

- -
    -
  • Temperature: %n.d °C
    • -
  • Temperature: %n.d °F
    • -
- - -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- height -

-
-
- -

(Optional) parameter specifying the height ASL.

- -
-
-
-
-

- Settings -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- -

Temperature according the measurement system Core.Settings.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetVec2()

-
- -

Return the coordinates of the COORDINATE in Vec2 format.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

DCS#Vec2:

-
-
- -

The Vec2 format coordinate.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetVec3()

-
- -

Return the coordinates of the COORDINATE in Vec3 format.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

DCS#Vec3:

-
-
- -

The Vec3 format coordinate.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetVelocity()

-
- -

Return the velocity of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#number:

-
-
- -

Velocity in meters per second.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetVelocityText(Settings)

-
- -

Return the velocity text of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- Settings -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- -

Velocity text.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetWind(height, turbulence)

-
- -

Returns the wind direction (from) and strength.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - height -

-
-
- -

(Optional) parameter specifying the height ASL. The minimum height will be always be the land height since the wind is zero below the ground.

- -
-
-
-
-

- #boolean - turbulence -

-
-
- -

If true, include turbulence. If false or nil, wind without turbulence.

- -
-
-

Return values:

-
-
-

#number:

-
-
- -

Direction the wind is blowing from in degrees.

- -
-
-

#number:

-
-
- -

Wind strength in m/s.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetWindText(height, Settings)

-
- -

Returns a text documenting the wind direction (from) and strength according the measurement system Core.Settings.

- - -

The text will reflect the wind like this:

- -
    -
  • For Russian and European aircraft using the metric system - Wind direction in degrees (°) and wind speed in meters per second (mps).
    • -
  • For American aircraft we link to the imperial system - Wind direction in degrees (°) and wind speed in knots per second (kps).
    • -
- -

A text containing a pressure will look like this:

- -
    -
  • Wind: %n ° at n.d mps
    • -
  • Wind: %n ° at n.d kps
    • -
- - -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- height -

-
-
- -

(Optional) parameter specifying the height ASL. The minimum height will be always be the land height since the wind is zero below the ground.

- -
-
-
-
-

- Settings -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- -

Wind direction and strength according the measurement system Core.Settings.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetWindVec3(height, turbulence)

-
- -

Returns the 3D wind direction vector.

- - -

Note that vector points into the direction the wind in blowing to.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - height -

-
-
- -

(Optional) parameter specifying the height ASL in meters. The minimum height will be always be the land height since the wind is zero below the ground.

- -
-
-
-
-

- #boolean - turbulence -

-
-
- -

(Optional) If true, include turbulence.

- -
-
-

Return value:

-
-
-

DCS#Vec3:

-
-
- -

Wind 3D vector. Components in m/s.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetWindWithTurbulenceVec3(height)

-
- -

Returns the wind direction (from) and strength.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- height -

-
-
- -

(Optional) parameter specifying the height ASL. The minimum height will be always be the land height since the wind is zero below the ground.

- -
-
-

Return value:

-
-
-
-
- -

Direction the wind is blowing from in degrees.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:HeadingTo(ToCoordinate)

-
- -

Returns the heading from this to another coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #COORDINATE - ToCoordinate -

-
-
-

-
-
-

Return value:

-
-
-

#number:

-
-
- -

Heading in degrees.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IlluminationBomb(Power, Delay)

-
- -

Creates an illumination bomb at the point.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Power -

-
-
- -

Power of illumination bomb in Candela. Default 1000 cd.

- -
-
-
-
-

- #number - Delay -

-
-
- -

(Optional) Delay before bomb is ignited in seconds.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsAtCoordinate2D(Coordinate, Precision)

-
- -

Returns if the 2 coordinates are at the same 2D position.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - Coordinate -

-
-
-

-
-
-
-
-

- #number - Precision -

-
-
-

-
-
-

Return value:

-
-
-

#boolean:

-
-
- -

true if at the same position.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsDay(Clock)

-
- -

Check if it is day, i.e.

- - -

if the sun has risen about the horizon at this coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #string - Clock -

-
-
- -

(Optional) Time in format "HH:MM:SS+D", e.g. "05:40:00+3" to check if is day at 5:40 at third day after mission start. Default is to check right now.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, it is day. If false, it is night time.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsInFlatArea(Radius, Minelevation)

-
- -

Function to check if a coordinate is in a flat (<8% elevation) area of the map

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Radius -

-
-
- -

(Optional) Radius to check around the coordinate, defaults to 50m (100m diameter)

- -
-
-
-
-

- #number - Minelevation -

-
-
- -

(Optional) Elevation from which on a area is defined as steep, defaults to 8% (8m height gain across 100 meters)

- -
-
-

Return values:

-
-
-

#boolen:

-
-
- -

IsFlat If true, area is flat

- -
-
-

#number:

-
-
- -

MaxElevation Elevation in meters measured over 100m

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsInRadius(Coordinate, Radius)

-
- -

Returns if a Coordinate is in a certain Radius of this Coordinate in 2D plane using the X and Z axis.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - Coordinate -

-
-
- -

The coordinate that will be tested if it is in the radius of this coordinate.

- -
-
-
-
-

- #number - Radius -

-
-
- -

The radius of the circle on the 2D plane around this coordinate.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

true if in the Radius.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsInSphere(ToCoordinate, Radius, Coordinate)

-
- -

Returns if a Coordinate is in a certain radius of this Coordinate in 3D space using the X, Y and Z axis.

- - -

So Radius defines the radius of the a Sphere in 3D space around this coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - ToCoordinate -

-
-
- -

The coordinate that will be tested if it is in the radius of this coordinate.

- -
-
-
-
-

- #number - Radius -

-
-
- -

The radius of the sphere in the 3D space around this coordinate.

- -
-
-
-
-

- Coordinate -

-
-
-

-
-
-

Return value:

-
-
-

#boolean:

-
-
- -

true if in the Sphere.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsInSteepArea(Radius, Minelevation)

-
- -

Function to check if a coordinate is in a steep (>8% elevation) area of the map

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Radius -

-
-
- -

(Optional) Radius to check around the coordinate, defaults to 50m (100m diameter)

- -
-
-
-
-

- #number - Minelevation -

-
-
- -

(Optional) Elevation from which on a area is defined as steep, defaults to 8% (8m height gain across 100 meters)

- -
-
-

Return values:

-
-
-

#boolen:

-
-
- -

IsSteep If true, area is steep

- -
-
-

#number:

-
-
- -

MaxElevation Elevation in meters measured over 100m

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsLOS(ToCoordinate, Offset)

-
- -

Returns if a Coordinate has Line of Sight (LOS) with the ToCoordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - ToCoordinate -

-
-
-

-
-
-
-
-

- #number - Offset -

-
-
- -

Height offset in meters. Default 2 m.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

true If the ToCoordinate has LOS with the Coordinate, otherwise false.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsNight(Clock)

-
- -

Check if it is night, i.e.

- - -

if the sun has set below the horizon at this coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #string - Clock -

-
-
- -

(Optional) Time in format "HH:MM:SS+D", e.g. "05:40:00+3" to check if is night at 5:40 at third day after mission start. Default is to check right now.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, it is night. If false, it is day time.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsSurfaceTypeLand()

-
- -

Checks if the surface type is on land.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, the surface type at the coordinate is land.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsSurfaceTypeRoad()

-
- -

Checks if the surface type is road.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, the surface type at the coordinate is a road.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsSurfaceTypeRunway()

-
- -

Checks if the surface type is runway.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, the surface type at the coordinate is a runway or taxi way.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsSurfaceTypeShallowWater()

-
- -

Checks if the surface type is shallow water.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, the surface type at the coordinate is a shallow water.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsSurfaceTypeWater()

-
- -

Checks if the surface type is water.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, the surface type at the coordinate is a deep water.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:LineToAll(Endpoint, Coalition, Color, Alpha, LineType, ReadOnly, Text)

-
- -

Line to all.

- - -

Creates a line on the F10 map from one point to another.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - Endpoint -

-
-
- -

COORDINATE to where the line is drawn.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

- -
-
-
-
-

- #table - Color -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red (default).

- -
-
-
-
-

- #number - Alpha -

-
-
- -

Transparency [0,1]. Default 1.

- -
-
-
-
-

- #number - LineType -

-
-
- -

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID, which is a number. Can be used to remove the object again.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:MarkToAll(MarkText, ReadOnly, Text)

-
- -

Mark to All

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #string - MarkText -

-
-
- -

Free format text that shows the marking clarification.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID which is a number.

- -
-
-

Usage:

- 
  local TargetCoord = TargetGroup:GetCoordinate()
-  local MarkID = TargetCoord:MarkToAll( "This is a target for all players" )
- -
- -
-
- -
- -
-

POINT_VEC2:MarkToCoalition(MarkText, Coalition, ReadOnly, Text)

-
- -

Mark to Coalition

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #string - MarkText -

-
-
- -

Free format text that shows the marking clarification.

- -
-
-
-
-

- Coalition -

-
-
-

-
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID which is a number.

- -
-
-

Usage:

- 
  local TargetCoord = TargetGroup:GetCoordinate()
-  local MarkID = TargetCoord:MarkToCoalition( "This is a target for the red coalition", coalition.side.RED )
- -
- -
-
- -
- -
-

POINT_VEC2:MarkToCoalitionBlue(MarkText, ReadOnly, Text)

-
- -

Mark to Blue Coalition

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #string - MarkText -

-
-
- -

Free format text that shows the marking clarification.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID which is a number.

- -
-
-

Usage:

- 
  local TargetCoord = TargetGroup:GetCoordinate()
-  local MarkID = TargetCoord:MarkToCoalitionBlue( "This is a target for the blue coalition" )
- -
- -
-
- -
- -
-

POINT_VEC2:MarkToCoalitionRed(MarkText, ReadOnly, Text)

-
- -

Mark to Red Coalition

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #string - MarkText -

-
-
- -

Free format text that shows the marking clarification.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID which is a number.

- -
-
-

Usage:

- 
  local TargetCoord = TargetGroup:GetCoordinate()
-  local MarkID = TargetCoord:MarkToCoalitionRed( "This is a target for the red coalition" )
- -
- -
-
- -
- -
-

POINT_VEC2:MarkToGroup(MarkText, MarkGroup, ReadOnly, Text)

-
- -

Mark to Group

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #string - MarkText -

-
-
- -

Free format text that shows the marking clarification.

- -
-
-
-
-

- Wrapper.Group#GROUP - MarkGroup -

-
-
- -

The Wrapper.Group that receives the mark.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID which is a number.

- -
-
-

Usage:

- 
  local TargetCoord = TargetGroup:GetCoordinate()
-  local MarkGroup = GROUP:FindByName( "AttackGroup" )
-  local MarkID = TargetCoord:MarkToGroup( "This is a target for the attack group", AttackGroup )
- -
- -
-
- -
- -
-

POINT_VEC2:MarkupToAllFreeForm(Coordinates, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

-
- -

Creates a free form shape on the F10 map.

- - -

The first point is the current COORDINATE. The remaining points need to be specified.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #table - Coordinates -

-
-
- -

Table of coordinates of the remaining points of the shape.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

- -
-
-
-
-

- #table - Color -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red (default).

- -
-
-
-
-

- #number - Alpha -

-
-
- -

Transparency [0,1]. Default 1.

- -
-
-
-
-

- #table - FillColor -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value.

- -
-
-
-
-

- #number - FillAlpha -

-
-
- -

Transparency [0,1]. Default 0.15.

- -
-
-
-
-

- #number - LineType -

-
-
- -

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID, which is a number. Can be used to remove the object again.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:New(x, y, z)

-
- -

COORDINATE constructor.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- DCS#Distance - x -

-
-
- -

The x coordinate of the Vec3 point, pointing to the North.

- -
-
-
-
-

- DCS#Distance - y -

-
-
- -

The y coordinate of the Vec3 point, pointing to up.

- -
-
-
-
-

- DCS#Distance - z -

-
-
- -

The z coordinate of the Vec3 point, pointing to the right.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:NewFromCoordinate(Coordinate)

-
- -

COORDINATE constructor.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #COORDINATE - Coordinate -

-
-
-

-
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:NewFromLLDD(latitude, longitude, altitude)

-
- -

Returns the coordinate from the latitude and longitude given in decimal degrees.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - latitude -

-
-
- -

Latitude in decimal degrees.

- -
-
-
-
-

- #number - longitude -

-
-
- -

Longitude in decimal degrees.

- -
-
-
-
-

- #number - altitude -

-
-
- -

(Optional) Altitude in meters. Default is the land height at the coordinate.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:NewFromVec2(Vec2, LandHeightAdd)

-
- -

Create a new COORDINATE object from Vec2 coordinates.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- DCS#Vec2 - Vec2 -

-
-
- -

The Vec2 point.

- -
-
-
-
-

- DCS#Distance - LandHeightAdd -

-
-
- -

(Optional) The default height if required to be evaluated will be the land height of the x, y coordinate. You can specify an extra height to be added to the land height.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:NewFromVec3(Vec3)

-
- -

Create a new COORDINATE object from Vec3 coordinates.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Vec3 - Vec3 -

-
-
- -

The Vec3 point.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:NewFromWaypoint(Waypoint)

-
- -

Create a new COORDINATE object from a waypoint.

- - -

This uses the components

- -
    -
  • waypoint.x
    • -
  • waypoint.alt
    • -
  • waypoint.y -
    • -
- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Waypoint - Waypoint -

-
-
- -

The waypoint.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:QuadToAll(Coord2, Coord3, Coord4, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

-
- -

Creates a shape defined by 4 points on the F10 map.

- - -

The first point is the current COORDINATE. The remaining three points need to be specified.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - Coord2 -

-
-
- -

Second COORDINATE of the quad shape.

- -
-
-
-
-

- #COORDINATE - Coord3 -

-
-
- -

Third COORDINATE of the quad shape.

- -
-
-
-
-

- #COORDINATE - Coord4 -

-
-
- -

Fourth COORDINATE of the quad shape.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

- -
-
-
-
-

- #table - Color -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red (default).

- -
-
-
-
-

- #number - Alpha -

-
-
- -

Transparency [0,1]. Default 1.

- -
-
-
-
-

- #table - FillColor -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value.

- -
-
-
-
-

- #number - FillAlpha -

-
-
- -

Transparency [0,1]. Default 0.15.

- -
-
-
-
-

- #number - LineType -

-
-
- -

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID, which is a number. Can be used to remove the object again.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:RectToAll(Endpoint, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

-
- -

Rectangle to all.

- - -

Creates a rectangle on the map from the COORDINATE in one corner to the end COORDINATE in the opposite corner. -Creates a line on the F10 map from one point to another.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - Endpoint -

-
-
- -

COORDINATE in the opposite corner.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

- -
-
-
-
-

- #table - Color -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red (default).

- -
-
-
-
-

- #number - Alpha -

-
-
- -

Transparency [0,1]. Default 1.

- -
-
-
-
-

- #table - FillColor -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value.

- -
-
-
-
-

- #number - FillAlpha -

-
-
- -

Transparency [0,1]. Default 0.15.

- -
-
-
-
-

- #number - LineType -

-
-
- -

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-
-
-

- #string - Text -

-
-
- -

(Optional) Text displayed when mark is added. Default none.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID, which is a number. Can be used to remove the object again.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:RemoveMark(MarkID)

-
- -

Remove a mark

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #number - MarkID -

-
-
- -

The ID of the mark to be removed.

- -
-
-

Usage:

- 
  local TargetCoord = TargetGroup:GetCoordinate()
-  local MarkGroup = GROUP:FindByName( "AttackGroup" )
-  local MarkID = TargetCoord:MarkToGroup( "This is a target for the attack group", AttackGroup )
-  <<< logic >>>
-  RemoveMark( MarkID ) -- The mark is now removed
- -
- -
-
- -
- -
-

POINT_VEC2:Rotate2D(Angle)

-
- -

Rotate coordinate in 2D (x,z) space.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Angle - Angle -

-
-
- -

Angle of rotation in degrees.

- -
-
-

Return value:

-
-
-

Core.Point#COORDINATE:

-
-
- -

The rotated coordinate.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ScanObjects(radius, scanunits, scanstatics, scanscenery)

-
- -

Scan/find objects (units, statics, scenery) within a certain radius around the coordinate using the world.searchObjects() DCS API function.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - radius -

-
-
- -

(Optional) Scan radius in meters. Default 100 m.

- -
-
-
-
-

- #boolean - scanunits -

-
-
- -

(Optional) If true scan for units. Default true.

- -
-
-
-
-

- #boolean - scanstatics -

-
-
- -

(Optional) If true scan for static objects. Default true.

- -
-
-
-
-

- #boolean - scanscenery -

-
-
- -

(Optional) If true scan for scenery objects. Default false.

- -
-
-

Return values:

-
-
-

#boolean:

-
-
- -

True if units were found.

- -
-
-

#boolean:

-
-
- -

True if statics were found.

- -
-
-

#boolean:

-
-
- -

True if scenery objects were found.

- -
-
-

#table:

-
-
- -

Table of MOOSE Wrapper.Unit#UNIT objects found.

- -
-
-

#table:

-
-
- -

Table of DCS static objects found.

- -
-
-

#table:

-
-
- -

Table of DCS scenery objects found.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ScanScenery(radius)

-
- -

Scan/find SCENERY objects within a certain radius around the coordinate using the world.searchObjects() DCS API function.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #number - radius -

-
-
- -

(Optional) Scan radius in meters. Default 100 m.

- -
-
-

Return value:

-
-
-
-
- -

table Table of SCENERY objects.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ScanStatics(radius)

-
- -

Scan/find STATICS within a certain radius around the coordinate using the world.searchObjects() DCS API function.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #number - radius -

-
-
- -

(Optional) Scan radius in meters. Default 100 m.

- -
-
-

Return value:

-
-
-

Core.Set#SET_UNIT:

-
-
- -

Set of units.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ScanUnits(radius)

-
- -

Scan/find UNITS within a certain radius around the coordinate using the world.searchObjects() DCS API function.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #number - radius -

-
-
- -

(Optional) Scan radius in meters. Default 100 m.

- -
-
-

Return value:

-
-
-

Core.Set#SET_UNIT:

-
-
- -

Set of units.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:SetAltitude(altitude, asl)

-
- -

Set altitude.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - altitude -

-
-
- -

New altitude in meters.

- -
-
-
-
-

- #boolean - asl -

-
-
- -

Altitude above sea level. Default is above ground level.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

The COORDINATE with adjusted altitude.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:SetAtLandheight()

-
- -

Set altitude to be at land height (i.e.

- - -

on the ground!)

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-
- -
-
- -
- -
-

POINT_VEC2:SetHeading(Heading)

-
- -

Set the heading of the coordinate, if applicable.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- Heading -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:SetVelocity(Velocity)

-
- -

Set the velocity of the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #string - Velocity -

-
-
- -

Velocity in meters per second.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:Smoke(SmokeColor)

-
- -

Smokes the point in a color.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- Utilities.Utils#SMOKECOLOR - SmokeColor -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:SmokeBlue()

-
- -

Smoke the COORDINATE Blue.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-
- -
-
- -
- -
-

POINT_VEC2:SmokeGreen()

-
- -

Smoke the COORDINATE Green.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-
- -
-
- -
- -
-

POINT_VEC2:SmokeOrange()

-
- -

Smoke the COORDINATE Orange.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-
- -
-
- -
- -
-

POINT_VEC2:SmokeRed()

-
- -

Smoke the COORDINATE Red.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-
- -
-
- -
- -
-

POINT_VEC2:SmokeWhite()

-
- -

Smoke the COORDINATE White.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-
- -
-
- -
- -
-

POINT_VEC2:StopBigSmokeAndFire(name)

-
- -

Stop big smoke and fire at the coordinate.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #string - name -

-
-
- -

(Optional) Name of the fire to stop it, if not using the same COORDINATE object.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:TextToAll(Text, Coalition, Color, Alpha, FillColor, FillAlpha, FontSize, ReadOnly)

-
- -

Text to all.

- - -

Creates a text imposed on the map at the COORDINATE. Text scales with the map.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #string - Text -

-
-
- -

Text displayed on the F10 map.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

- -
-
-
-
-

- #table - Color -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red (default).

- -
-
-
-
-

- #number - Alpha -

-
-
- -

Transparency [0,1]. Default 1.

- -
-
-
-
-

- #table - FillColor -

-
-
- -

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value.

- -
-
-
-
-

- #number - FillAlpha -

-
-
- -

Transparency [0,1]. Default 0.3.

- -
-
-
-
-

- #number - FontSize -

-
-
- -

Font size. Default 14.

- -
-
-
-
-

- #boolean - ReadOnly -

-
-
- -

(Optional) Mark is readonly and cannot be removed by users. Default false.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

The resulting Mark ID, which is a number. Can be used to remove the object again.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToString(Controllable, Settings, Task)

-
- -

Provides a coordinate string of the point, based on a coordinate format system: - * Uses default settings in COORDINATE.

- - -
    -
  • Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
    • -
- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
- -

The controllable to retrieve the settings from, otherwise the default settings will be chosen.

- -
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-
-
-

- Tasking.Task#TASK - Task -

-
-
- -

The task for which coordinates need to be calculated.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The coordinate Text in the configured coordinate system.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringA2A(Controllable, Settings, MagVar)

-
- -

Provides a coordinate string of the point, based on the A2A coordinate format system.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
-

-
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true, also get angle in MagVar for BR/BRA

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The coordinate Text in the configured coordinate system.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringA2G(Controllable, Settings, MagVar)

-
- -

Provides a coordinate string of the point, based on the A2G coordinate format system.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
-

-
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true, also get angle in MagVar for BR/BRA

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The coordinate Text in the configured coordinate system.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringAspect(TargetCoordinate)

-
- -

Return an aspect string from a COORDINATE to the Angle of the object.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #COORDINATE - TargetCoordinate -

-
-
- -

The target COORDINATE.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The Aspect string, which is Hot, Cold or Flanking.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringBR(FromCoordinate, Settings, MagVar)

-
- -

Return a BR string from a COORDINATE to the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - FromCoordinate -

-
-
- -

The coordinate to measure the distance and the bearing from.

- -
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true, also get angle in MagVar for BR/BRA

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The BR text.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringBRA(FromCoordinate, Settings, MagVar)

-
- -

Return a BRA string from a COORDINATE to the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - FromCoordinate -

-
-
- -

The coordinate to measure the distance and the bearing from.

- -
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true, also get angle in MagVar for BR/BRA

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The BR text.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringBRAANATO(FromCoordinate, Bogey, Spades, SSML, Angels, Zeros)

-
- -

Create a BRAA NATO call string to this COORDINATE from the FromCOORDINATE.

- - -

Note - BRA delivered if no aspect can be obtained and "Merged" if range < 3nm

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - FromCoordinate -

-
-
- -

The coordinate to measure the distance and the bearing from.

- -
-
-
-
-

- #boolean - Bogey -

-
-
- -

Add "Bogey" at the end if true (not yet declared hostile or friendly)

- -
-
-
-
-

- #boolean - Spades -

-
-
- -

Add "Spades" at the end if true (no IFF/VID ID yet known)

- -
-
-
-
-

- #boolean - SSML -

-
-
- -

Add SSML tags speaking aspect as 0 1 2 and "brah" instead of BRAA

- -
-
-
-
-

- #boolean - Angels -

-
-
- -

If true, altitude is e.g. "Angels 25" (i.e., a friendly plane), else "25 thousand"

- -
-
-
-
-

- #boolean - Zeros -

-
-
- -

If using SSML, be aware that Google TTS will say "oh" and not "zero" for "0"; if Zeros is set to true, "0" will be replaced with "zero"

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The BRAA text.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringBULLS(Coalition, Settings, MagVar)

-
- -

Return a BULLS string out of the BULLS of the coalition to the COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- DCS#coalition.side - Coalition -

-
-
- -

The coalition.

- -
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true, als get angle in magnetic

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The BR text.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringFromRP(ReferenceCoord, ReferenceName, Controllable, Settings, MagVar)

-
- -

Provides a coordinate string of the point, based on a coordinate format system: - * Uses default settings in COORDINATE.

- - -
    -
  • Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
    • -
- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - ReferenceCoord -

-
-
- -

The reference coordinate.

- -
-
-
-
-

- #string - ReferenceName -

-
-
- -

The reference name.

- -
-
-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
-

-
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true also show angle in magnetic

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The coordinate Text in the configured coordinate system.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringFromRPShort(ReferenceCoord, ReferenceName, Controllable, Settings, MagVar)

-
- -

Provides a coordinate string of the point, based on a coordinate format system: - * Uses default settings in COORDINATE.

- - -
    -
  • Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
    • -
- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE - ReferenceCoord -

-
-
- -

The reference coordinate.

- -
-
-
-
-

- #string - ReferenceName -

-
-
- -

The reference name.

- -
-
-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
-

-
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-
-
-

- #boolean - MagVar -

-
-
- -

If true also get the angle as magnetic

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The coordinate Text in the configured coordinate system.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringLLDDM(Settings)

-
- -

Provides a Lat Lon string in Degree Decimal Minute format.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The LL DDM Text

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringLLDMS(Settings)

-
- -

Provides a Lat Lon string in Degree Minute Second format.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The LL DMS Text

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringMGRS(Settings)

-
- -

Provides a MGRS string

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The MGRS Text

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringPressure(Controllable, Settings)

-
- -

Provides a pressure string of the point, based on a measurement system: - * Uses default settings in COORDINATE.

- - -
    -
  • Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
    • -
- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
-

-
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The pressure text in the configured measurement system.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringTemperature(Controllable, Core, Settings)

-
- -

Provides a temperature string of the point, based on a measurement system: - * Uses default settings in COORDINATE.

- - -
    -
  • Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
    • -
- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
-

-
-
-
-
-

- Core -

-
-
- -

Settings#SETTINGS

- -
-
-
-
-

- Settings -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- -

The temperature text in the configured measurement system.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ToStringWind(Controllable, Settings)

-
- -

Provides a wind string of the point, based on a measurement system: - * Uses default settings in COORDINATE.

- - -
    -
  • Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
    • -
- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
-

-
-
-
-
-

- Core.Settings#SETTINGS - Settings -

-
-
- -

(optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The wind text in the configured measurement system.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:Translate(Distance, Angle, Keepalt, Overwrite)

-
- -

Add a Distance in meters from the COORDINATE orthonormal plane, with the given angle, and calculate the new COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- DCS#Distance - Distance -

-
-
- -

The Distance to be added in meters.

- -
-
-
-
-

- DCS#Angle - Angle -

-
-
- -

The Angle in degrees. Defaults to 0 if not specified (nil).

- -
-
-
-
-

- #boolean - Keepalt -

-
-
- -

If true, keep altitude of original coordinate. Default is that the new coordinate is created at the translated land height.

- -
-
-
-
-

- #boolean - Overwrite -

-
-
- -

If true, overwrite the original COORDINATE with the translated one. Otherwise, create a new COORDINATE.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

The new calculated COORDINATE.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:UpdateFromCoordinate(Coordinate)

-
- -

Update x,y,z coordinates from another given COORDINATE.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- #COORDINATE - Coordinate -

-
-
- -

The coordinate with the new x,y,z positions.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

The modified COORDINATE itself.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:UpdateFromVec2(Vec2)

-
- -

Update x and z coordinates from a given 2D vector.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Vec2 - Vec2 -

-
-
- -

The 2D vector with x,y components. x is overwriting COORDINATE.x while y is overwriting COORDINATE.z.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

The modified COORDINATE itself.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:UpdateFromVec3(Vec3)

-
- -

Update x,y,z coordinates from a given 3D vector.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameter:

-
-
-

- DCS#Vec3 - Vec3 -

-
-
- -

The 3D vector with x,y,z components.

- -
-
-

Return value:

-
-
-

#COORDINATE:

-
-
- -

The modified COORDINATE itself.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:WaypointAir(AltType, Type, Action, Speed, SpeedLocked, airbase, DCSTasks, description, timeReFuAr)

-
- -

Build an air type route point.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE.WaypointAltType - AltType -

-
-
- -

The altitude type.

- -
-
-
-
-

- #COORDINATE.WaypointType - Type -

-
-
- -

The route point type.

- -
-
-
-
-

- #COORDINATE.WaypointAction - Action -

-
-
- -

The route point action.

- -
-
-
-
-

- DCS#Speed - Speed -

-
-
- -

Airspeed in km/h. Default is 500 km/h.

- -
-
-
-
-

- #boolean - SpeedLocked -

-
-
- -

true means the speed is locked.

- -
-
-
-
-

- Wrapper.Airbase#AIRBASE - airbase -

-
-
- -

The airbase for takeoff and landing points.

- -
-
-
-
-

- #table - DCSTasks -

-
-
- -

A table of DCS#Task items which are executed at the waypoint.

- -
-
-
-
-

- #string - description -

-
-
- -

A text description of the waypoint, which will be shown on the F10 map.

- -
-
-
-
-

- #number - timeReFuAr -

-
-
- -

Time in minutes the aircraft stays at the airport for ReFueling and ReArming.

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:WaypointAirFlyOverPoint(AltType, Speed)

-
- -

Build a Waypoint Air "Fly Over Point".

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE.WaypointAltType - AltType -

-
-
- -

The altitude type.

- -
-
-
-
-

- DCS#Speed - Speed -

-
-
- -

Airspeed in km/h.

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:WaypointAirLanding(Speed, airbase, DCSTasks, description)

-
- -

Build a Waypoint Air "Landing".

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- DCS#Speed - Speed -

-
-
- -

Airspeed in km/h.

- -
-
-
-
-

- Wrapper.Airbase#AIRBASE - airbase -

-
-
- -

The airbase for takeoff and landing points.

- -
-
-
-
-

- #table - DCSTasks -

-
-
- -

A table of DCS#Task items which are executed at the waypoint.

- -
-
-
-
-

- #string - description -

-
-
- -

A text description of the waypoint, which will be shown on the F10 map.

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-

Usage:

- 

-   LandingZone = ZONE:New( "LandingZone" )
-   LandingCoord = LandingZone:GetCoordinate()
-   LandingWaypoint = LandingCoord:WaypointAirLanding( 60 )
-   HeliGroup:Route( { LandWaypoint }, 1 ) -- Start landing the helicopter in one second.
-
- -
- -
-
- -
- -
-

POINT_VEC2:WaypointAirLandingReFu(Speed, airbase, timeReFuAr, DCSTasks, description)

-
- -

Build a Waypoint Air "LandingReFuAr".

- - -

Mimics the aircraft ReFueling and ReArming.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- DCS#Speed - Speed -

-
-
- -

Airspeed in km/h.

- -
-
-
-
-

- Wrapper.Airbase#AIRBASE - airbase -

-
-
- -

The airbase for takeoff and landing points.

- -
-
-
-
-

- #number - timeReFuAr -

-
-
- -

Time in minutes, the aircraft stays at the airbase. Default 10 min.

- -
-
-
-
-

- #table - DCSTasks -

-
-
- -

A table of DCS#Task items which are executed at the waypoint.

- -
-
-
-
-

- #string - description -

-
-
- -

A text description of the waypoint, which will be shown on the F10 map.

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:WaypointAirTakeOffParking(AltType, Speed)

-
- -

Build a Waypoint Air "Take Off Parking".

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE.WaypointAltType - AltType -

-
-
- -

The altitude type.

- -
-
-
-
-

- DCS#Speed - Speed -

-
-
- -

Airspeed in km/h.

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:WaypointAirTakeOffParkingHot(AltType, Speed)

-
- -

Build a Waypoint Air "Take Off Parking Hot".

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE.WaypointAltType - AltType -

-
-
- -

The altitude type.

- -
-
-
-
-

- DCS#Speed - Speed -

-
-
- -

Airspeed in km/h.

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:WaypointAirTakeOffRunway(AltType, Speed)

-
- -

Build a Waypoint Air "Take Off Runway".

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE.WaypointAltType - AltType -

-
-
- -

The altitude type.

- -
-
-
-
-

- DCS#Speed - Speed -

-
-
- -

Airspeed in km/h.

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:WaypointAirTurningPoint(AltType, Speed, DCSTasks, description)

-
- -

Build a Waypoint Air "Turning Point".

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #COORDINATE.WaypointAltType - AltType -

-
-
- -

The altitude type.

- -
-
-
-
-

- DCS#Speed - Speed -

-
-
- -

Airspeed in km/h.

- -
-
-
-
-

- #table - DCSTasks -

-
-
- -

(Optional) A table of DCS#Task items which are executed at the waypoint.

- -
-
-
-
-

- #string - description -

-
-
- -

(Optional) A text description of the waypoint, which will be shown on the F10 map.

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:WaypointGround(Speed, Formation, DCSTasks)

-
- -

Build an ground type route point.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Speed -

-
-
- -

(Optional) Speed in km/h. The default speed is 20 km/h.

- -
-
-
-
-

- #string - Formation -

-
-
- -

(Optional) The route point Formation, which is a text string that specifies exactly the Text in the Type of the route point, like "Vee", "Echelon Right".

- -
-
-
-
-

- #table - DCSTasks -

-
-
- -

(Optional) A table of DCS tasks that are executed at the waypoints. Mind the curly brackets {}!

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:WaypointNaval(Speed, Depth, DCSTasks)

-
- -

Build route waypoint point for Naval units.

- -
-
-

Defined in:

-
-

Core.Point#COORDINATE

-
-

Parameters:

-
-
-

- #number - Speed -

-
-
- -

(Optional) Speed in km/h. The default speed is 20 km/h.

- -
-
-
-
-

- #string - Depth -

-
-
- -

(Optional) Dive depth in meters. Only for submarines. Default is COORDINATE.y component.

- -
-
-
-
-

- #table - DCSTasks -

-
-
- -

(Optional) A table of DCS tasks that are executed at the waypoints. Mind the curly brackets {}!

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

The route point.

- -
-
-
- -
-
- -
-

Field(s)

-
-
-
- - DCS#Distance -POINT_VEC2.x - -

The x coordinate in meters.

- -
- -
-
-
- - DCS#Distance -POINT_VEC2.y - -

the y coordinate in meters.

- -
- -
-
-
- - -POINT_VEC2.z - - - -
- -
-
-

Function(s)

-
-
- -
-

POINT_VEC2:ClearState(Object, StateName)

-
- -

Clear the state of an object.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Object -

-
-
- -

The object that holds the Value set by the Key.

- -
-
-
-
-

- StateName -

-
-
- -

The key that is should be cleared.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

-
- -

Creation of a Birth Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
-
-

- #string - IniUnitName -

-
-
- -

The initiating unit name.

- -
-
-
-
-

- place -

-
-
-

-
-
-
-
-

- subplace -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

-
- -

Creation of a Crash Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:CreateEventDead(EventTime, Initiator, IniObjectCategory)

-
- -

Creation of a Dead Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:CreateEventPlayerEnterAircraft(PlayerUnit)

-
- -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.Unit#UNIT - PlayerUnit -

-
-
- -

The aircraft unit the player entered.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:CreateEventRemoveUnit(EventTime, Initiator)

-
- -

Creation of a Remove Unit Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:CreateEventTakeoff(EventTime, Initiator)

-
- -

Creation of a Takeoff Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:CreateEventUnitLost(EventTime, Initiator)

-
- -

Creation of a Crash Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:E(Arguments)

-
- -

Log an exception which will be traced always.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

Core.Event#EVENT:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:EventRemoveAll()

-
- -

Remove all subscribed events

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:F(Arguments)

-
- -

Trace a function call.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:F2(Arguments)

-
- -

Trace a function call level 2.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:F3(Arguments)

-
- -

Trace a function call level 3.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetClassID()

-
- -

Get the ClassID of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetClassName()

-
- -

Get the ClassName of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName of the class instance.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetClassNameAndID()

-
- -

Get the ClassName + ClassID of the class instance.

- - -

The ClassName + ClassID is formatted as '%s#%09d'.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName + ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetEventPriority()

-
- -

Get the Class Core.Event processing Priority.

- - -

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#number:

-
-
- -

The Core.Event processing Priority.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetParent(Child, FromClass)

-
- -

This is the worker method to retrieve the Parent class.

- - -

Note that the Parent class must be passed to call the parent class method.

- -
self:GetParent(self):ParentMethod()
-
- - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #BASE - Child -

-
-
- -

This is the Child class from which the Parent class needs to be retrieved.

- -
-
-
-
-

- #BASE - FromClass -

-
-
- -

(Optional) The class from which to get the parent.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:GetState(Object, Key)

-
- -

Get a Value given a Key from the Object.

- - -

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Object -

-
-
- -

The object that holds the Value set by the Key.

- -
-
-
-
-

- Key -

-
-
- -

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

- -
-
-

Return value:

-
-
-
-
- -

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:HandleEvent(EventID, EventFunction)

-
- -

Subscribe to a DCS Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-
-
-

- #function - EventFunction -

-
-
- -

(optional) The function to be called when the event occurs for the unit.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:I(Arguments)

-
- -

Log an information which will be traced always.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:Inherit(Child, Parent)

-
- -

This is the worker method to inherit from a parent class.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Child -

-
-
- -

is the Child class that inherits.

- -
-
-
-
-

- #BASE - Parent -

-
-
- -

is the Parent class that the Child inherits from.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

Child

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsInstanceOf(ClassName)

-
- -

This is the worker method to check if an object is an (sub)instance of a class.

- - - -

Examples:

- -
    -

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- ClassName -

-
-
- -

is the name of the class or the class itself to run the check against

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:IsTrace()

-
- -

Enquires if tracing is on (for the class).

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:New()

-
- -

BASE constructor.

- - - -

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

- -
function EVENT:New()
-  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
-  return self
-end
-
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEvent(EventData)

-
- -

Occurs when an Event for an object is triggered.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that triggered the event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventBDA(EventData)

-
- -

BDA.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventBaseCaptured(EventData)

-
- -

Occurs when a ground unit captures either an airbase or a farp.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that captured the base -place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventBirth(EventData)

-
- -

Occurs when any object is spawned into the mission.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was spawned

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventCrash(EventData)

-
- -

Occurs when any aircraft crashes into the ground and is completely destroyed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that has crashed

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventDead(EventData)

-
- -

Occurs when an object is dead.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is dead.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventDetailedFailure(EventData)

-
- -

Unknown precisely what creates this event, likely tied into newer damage model.

- - -

Will update this page when new information become available.

- -
    -
  • initiator: The unit that had the failure.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventDiscardChairAfterEjection(EventData)

-
- -

Discard chair after ejection.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- - -

initiator : The unit that has ejected

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventEngineShutdown(EventData)

-
- -

Occurs when any aircraft shuts down its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is stopping its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventEngineStartup(EventData)

-
- -

Occurs when any aircraft starts its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is starting its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventHit(EventData)

-
- -

Occurs whenever an object is hit by a weapon.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit object the fired the weapon -weapon: Weapon object that hit the target -target: The Object that was hit.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventHumanFailure(EventData)

-
- -

Occurs when any system fails on a human controlled aircraft.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that had the failure

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventKill(EventData)

-
- -

Occurs on the death of a unit.

- - -

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: The unit that killed the target
    • -
  • target: Target Object
    • -
  • weapon: Weapon Object
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- - -

initiator : The unit that has landed -place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventLandingAfterEjection(EventData)

-
- -

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

- - -

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
    • -
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
    • -
  • subplace: is always 0 for unknown reasons.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventLandingQualityMark(EventData)

-
- -

Landing quality mark.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventMarkAdded(EventData)

-
- -

Occurs when a new mark was added.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventMarkChange(EventData)

-
- -

Occurs when a mark text was changed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventMarkRemoved(EventData)

-
- -

Occurs when a mark was removed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventMissionEnd(EventData)

-
- -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventMissionStart(EventData)

-
- -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventParatrooperLanding(EventData)

-
- -

Weapon add.

- - -

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventPilotDead(EventData)

-
- -

Occurs when the pilot of an aircraft is killed.

- - -

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the pilot has died in.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventPlayerEnterAircraft(EventData)

-
- -

Occurs when a player enters a slot and takes control of an aircraft.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. -initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventPlayerEnterUnit(EventData)

-
- -

Occurs when any player assumes direct control of a unit.

- - -

Note - not Mulitplayer safe. Use PlayerEnterAircraft. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventPlayerLeaveUnit(EventData)

-
- -

Occurs when any player relieves control of a unit to the AI.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the player left.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventRefueling(EventData)

-
- -

Occurs when an aircraft connects with a tanker and begins taking on fuel.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventRefuelingStop(EventData)

-
- -

Occurs when an aircraft is finished taking fuel.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventScore(EventData)

-
- -

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

- - -

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventShootingEnd(EventData)

-
- -

Occurs when any unit stops firing its weapon.

- - -

Event will always correspond with a shooting start event. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was doing the shooting.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventShootingStart(EventData)

-
- -

Occurs when any unit begins firing a weapon that has a high rate of fire.

- - -

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is doing the shooting. -target: The unit that is being targeted.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventShot(EventData)

-
- -

Occurs whenever any unit in a mission fires a weapon.

- - -

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventTakeoff(EventData)

-
- -

Occurs when an aircraft takes off from an airbase, farp, or ship.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that tookoff -place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventTriggerZone(EventData)

-
- -

Trigger zone.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:OnEventUnitLost(EventData)

-
- -

Occurs when the game thinks an object is destroyed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: The unit that is was destroyed.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ScheduleOnce(Start, SchedulerFunction, ...)

-
- -

Schedule a new time event.

- - -

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #number - Start -

-
-
- -

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

- -
-
-
-
-

- #function - SchedulerFunction -

-
-
- -

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

- -
-
-
-
-

- #table - ... -

-
-
- -

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

-
- -

Schedule a new time event.

- - -

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #number - Start -

-
-
- -

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

- -
-
-
-
-

- #number - Repeat -

-
-
- -

Specifies the interval in seconds when the scheduler will call the event function.

- -
-
-
-
-

- #number - RandomizeFactor -

-
-
- -

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

- -
-
-
-
-

- #number - Stop -

-
-
- -

Specifies the amount of seconds when the scheduler will be stopped.

- -
-
-
-
-

- #function - SchedulerFunction -

-
-
- -

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

- -
-
-
-
-

- #table - ... -

-
-
- -

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:ScheduleStop(SchedulerID)

-
- -

Stops the Schedule.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - SchedulerID -

-
-
- -

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:SetEventPriority(EventPriority)

-
- -

Set the Class Core.Event processing Priority.

- - -

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - EventPriority -

-
-
- -

The Core.Event processing Priority.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:SetState(Object, Key, Value)

-
- -

Set a state or property of the Object given a Key and a Value.

- - -

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Object -

-
-
- -

The object that will hold the Value set by the Key.

- -
-
-
-
-

- Key -

-
-
- -

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

- -
-
-
-
-

- Value -

-
-
- -

The value to is stored in the object.

- -
-
-

Return value:

-
-
-
-
- -

The Value set.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:T(Arguments)

-
- -

Trace a function logic level 1.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:T2(Arguments)

-
- -

Trace a function logic level 2.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:T3(Arguments)

-
- -

Trace a function logic level 3.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:TraceAll(TraceAll)

-
- -

Trace all methods in MOOSE

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceAll -

-
-
- -

true = trace all methods in MOOSE.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:TraceClass(Class)

-
- -

Set tracing for a class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - Class -

-
-
- -

Class name.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:TraceClassMethod(Class, Method)

-
- -

Set tracing for a specific method of class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #string - Class -

-
-
- -

Class name.

- -
-
-
-
-

- #string - Method -

-
-
- -

Method.

- -
-
-
- -
-
- -
- -
-

POINT_VEC2:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - Level -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing Off
-BASE:TraceOff()
- -
- -
-
- -
- -
-

POINT_VEC2:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing On
-BASE:TraceOn()
- -
- -
-
- -
- -
-

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

- - -

So tracing must be switched on manually in your mission if you are using Moose statically. -When moose is loading dynamically (for moose class development), tracing is switched on by default.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceOnOff -

-
-
- -

Switch the tracing on or off.

- -
-
-

Usage:

- 

-  -- Switch the tracing On
-  BASE:TraceOnOff( true )
-
-  -- Switch the tracing Off
-  BASE:TraceOnOff( false )
-
- -
- -
-
- -
- -
-

POINT_VEC2:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

POINT_VEC2:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function call.

- - -

This function is private.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:onEvent(event)

-
- -

The main event handling function...

- - -

This function captures all events generated for the class.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- DCS#Event - event -

-
-
-

-
-
-
- -
-
-
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 74a036ca2..e99508e15 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2864,7 +2864,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -2908,7 +2908,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric @@ -5021,7 +5021,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem @@ -5065,7 +5065,7 @@ It is advised to use this method at the start of the mission.

- #boolean + SETTINGS.Metric diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index b5e4c5119..05888b54f 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2988,6 +2988,36 @@ and any spaces before and after the resulting name are removed.

SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

+ + + +

SPAWN.communication

+ + + + + +

SPAWN.frequency

+ + + + + +

SPAWN.livery_id

+ + + + + +

SPAWN.modulation

+ + + + + +

SPAWN.skill

+ + @@ -3547,14 +3577,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

-
@@ -3682,20 +3709,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

-
@@ -3729,6 +3742,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnGrouping + + +
@@ -3809,6 +3833,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3875,9 +3910,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

By default, no InitLimit

-
@@ -3885,29 +3917,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModexPostfix - - - -
- -
-
-
- - -SPAWN.SpawnInitModexPrefix +SPAWN.SpawnInitLivery @@ -3953,7 +3963,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3967,7 +3977,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -4246,6 +4256,61 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + + +
+ +
+
+
+ + +SPAWN.skill + + +
@@ -9488,14 +9553,11 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

-
@@ -9623,20 +9685,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

-
@@ -9670,6 +9718,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + +SPAWN.SpawnGrouping + + +
@@ -9750,6 +9809,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -9816,9 +9886,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

-
@@ -9826,29 +9893,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

-SPAWN.SpawnInitModex - - - - - - -
-
- - -SPAWN.SpawnInitModexPostfix - - - -
- -
-
-
- - -SPAWN.SpawnInitModexPrefix +SPAWN.SpawnInitLivery @@ -9894,7 +9939,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #number + SPAWN.SpawnMaxGroups @@ -9908,7 +9953,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #number + SPAWN.SpawnMaxUnitsAlive @@ -10187,6 +10232,61 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + + +
+ +
+
+
+ + +SPAWN.skill + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 5285688c4..27c7a141a 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1996,6 +1996,24 @@ such as position and heading.

SPAWNSTATIC:_SpawnStatic(Template, CountryID)

Spawns a new static using a given template.

+ + + +

SPAWNSTATIC.heliport_callsign_id

+ + + + + +

SPAWNSTATIC.heliport_frequency

+ + + + + +

SPAWNSTATIC.heliport_modulation

+ + @@ -2910,6 +2928,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
@@ -4263,6 +4314,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index de04fc749..a3e956874 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2815,6 +2815,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -4098,6 +4131,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -5620,6 +5686,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index 863dca688..6baccaf35 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -3878,7 +3878,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + ATC_GROUND.Airbases @@ -4466,7 +4466,7 @@ An airbase can be specified to set the maximum kick speed for.

- #table + ATC_GROUND.Airbases diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 09a0f1744..8d4d5fae9 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -3955,17 +3955,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The #DETECTION_AREAS object for AWACS

-
- -
-
-
- - #table -MANTIS.AcceptZones - - -
@@ -3999,17 +3988,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #table -MANTIS.ConflictZones - - -
@@ -4109,17 +4087,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The ME name of the HQ object

- - - -
-
- - #table -MANTIS.RejectZones - - -
@@ -4635,6 +4602,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

switch alarm state RED

+ @@ -4646,9 +4616,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

self.SAMCheckRanges = {}

- @@ -8611,17 +8578,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The #DETECTION_AREAS object for AWACS

- - - -
-
- - #table -MANTIS.AcceptZones - - -
@@ -8655,17 +8611,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` - - - -
-
- - #table -MANTIS.ConflictZones - - -
@@ -8765,17 +8710,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The ME name of the HQ object

- - - -
-
- - #table -MANTIS.RejectZones - - -
@@ -9291,6 +9225,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` + +

switch alarm state RED

+ @@ -9302,9 +9239,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` - -

self.SAMCheckRanges = {}

- diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index 32f0e964a..0838a1314 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -4570,6 +4570,36 @@ and any spaces before and after the resulting name are removed.

RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

+ + + +

RAT.communication

+ + + + + +

RAT.frequency

+ + + + + +

RAT.livery_id

+ + + + + +

RAT.modulation

+ + + + + +

RAT.skill

+ + diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index fe7c39ef5..6b69d5329 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -2866,11 +2866,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.AutoSave + +

Create the CSV file.

+
@@ -3053,7 +3056,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.penaltyoncoalitionchange @@ -5452,11 +5455,14 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.AutoSave + +

Create the CSV file.

+
@@ -5639,7 +5645,7 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.penaltyoncoalitionchange diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 4d2b80d3a..ef397ba9c 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -9600,17 +9600,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

-
- -
-
-
- - -AIRBOSS.RQLid - - -
@@ -9622,17 +9611,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of marshal.

-
- -
-
-
- - -AIRBOSS.RQMid - - -
@@ -29821,17 +29799,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

- - - -
-
- - -AIRBOSS.RQLid - - -
@@ -29843,17 +29810,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -32922,17 +32878,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

- - - -
-
- - -AIRBOSS.RQLid - - -
@@ -32944,17 +32889,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -40562,6 +40496,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

Set case of f

+ @@ -40630,7 +40567,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Also decrease flag for section members of flight.

+

Decrease stack/flag. Human player needs to take care himself.

@@ -40657,17 +40594,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.

- - - -
-
- - #boolean -AIRBOSS.PlayerData.holding - - -
@@ -40803,6 +40729,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

Set section lead of player flight.

+ @@ -40825,9 +40754,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Set Stable Hover

- @@ -40862,7 +40788,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Set new time stamp.

+

Set time stamp.

diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index fdc33a390..4315471e3 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -2605,12 +2605,6 @@ Dropped troop noMessage and forcedesc parameters aren't saved.

CSAR.inTransitGroups

- - - -

CSAR.index

- - @@ -4457,11 +4451,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -4585,17 +4593,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

contain a table for each SAR with all units he has with the original names

- - - -
-
- - -CSAR.index - - -
@@ -10500,11 +10497,25 @@ callsigns from playername or group name.

- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -10628,17 +10639,6 @@ callsigns from playername or group name.

contain a table for each SAR with all units he has with the original names

- - - -
-
- - -CSAR.index - - -
@@ -13028,11 +13028,25 @@ callsigns from playername or group name.

- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -13156,17 +13170,6 @@ callsigns from playername or group name.

contain a table for each SAR with all units he has with the original names

- - - -
-
- - -CSAR.index - - -
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 6e74e4a28..5dd9df170 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -7710,17 +7710,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Name of the class.

- - - -
-
- - #number -CTLD.CrateCounter - - -
@@ -7741,7 +7730,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.CtldUnits @@ -7763,7 +7752,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.DroppedTroops @@ -7788,14 +7777,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.EngineersInField - -

holds #CTLD_ENGINEERING objects

-
@@ -8476,7 +8462,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

time to repairor build a unit/group

+

noob catch

@@ -18007,17 +17993,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

-
- -
-
-
- - #number -CTLD.CrateCounter - - -
@@ -18038,7 +18013,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -18060,7 +18035,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.DroppedTroops @@ -18085,14 +18060,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.EngineersInField - -

holds #CTLD_ENGINEERING objects

-
@@ -18773,7 +18745,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

time to repairor build a unit/group

+

noob catch

@@ -20438,17 +20410,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

-
- -
-
-
- - #number -CTLD.CrateCounter - - -
@@ -20469,7 +20430,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -20491,7 +20452,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.DroppedTroops @@ -20516,14 +20477,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.EngineersInField - -

holds #CTLD_ENGINEERING objects

-
@@ -21204,7 +21162,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

time to repairor build a unit/group

+

noob catch

@@ -25492,17 +25450,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Flag for direct loading.

-
- -
-
-
- - -CTLD_CARGO.Mark - - -
@@ -26629,17 +26576,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Flag for direct loading.

-
- -
-
-
- - -CTLD_CARGO.Mark - - -
diff --git a/Documentation/Sound.SRS.html b/Documentation/Sound.SRS.html index e2d0652cc..472f12ec6 100644 --- a/Documentation/Sound.SRS.html +++ b/Documentation/Sound.SRS.html @@ -2162,12 +2162,6 @@ atis:Start()

MSRS.google

Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".

- - - -

MSRS.key

- - @@ -3932,17 +3926,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".

-
- - -
-
- - -MSRS.key - - -
@@ -6334,17 +6317,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".

- - - -
-
- - -MSRS.key - - -
diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 28ba18190..23435a0e7 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2938,17 +2938,6 @@ but can separately be modified later in your mission using the - - - -
-
- - -TASK.TaskControlMenu - - -
@@ -7585,17 +7574,6 @@ If the Unit is part of the Task, true is returned.

- - - -
-
- - -TASK.TaskControlMenu - - -
diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index b0f6202ea..34058e877 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2939,7 +2939,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -3664,7 +3664,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -4840,7 +4840,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -6318,7 +6318,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask diff --git a/Documentation/Tasking.Task_CARGO.html b/Documentation/Tasking.Task_CARGO.html index c213a94f7..b15e0e485 100644 --- a/Documentation/Tasking.Task_CARGO.html +++ b/Documentation/Tasking.Task_CARGO.html @@ -3230,7 +3230,7 @@ based on the tasking capabilities defined in
- + Cargo.Cargo#CARGO FSM_PROCESS.Cargo diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 379749b42..f34580b2d 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3213,6 +3213,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -3227,11 +3271,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + @@ -4319,6 +4374,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -4333,11 +4432,22 @@ This method can only be used once!

+ @@ -5177,6 +5287,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -5191,11 +5345,22 @@ This method can only be used once!

+ @@ -6666,6 +6831,50 @@ This method can only be used once!

Field(s)

+ + + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
@@ -6680,11 +6889,22 @@ This method can only be used once!

+ diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index 9f4ee0aa3..1cfc181f2 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -7609,6 +7609,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+
+
+ + #number +LIFO.uniquecounter + + +
@@ -8458,6 +8469,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+
+
+ + #number +LIFO.uniquecounter + + +
diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 70a16f17d..616aeeaa6 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -3022,28 +3022,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -3128,7 +3106,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -5161,28 +5139,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -5267,7 +5223,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall @@ -6771,28 +6727,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

-
- -
-
-
- - -MARKER.groupid - - - -
- -
-
-
- - -MARKER.groupname - - -
@@ -6877,7 +6811,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.togroup +MARKER.toall