From a226e6eab7849f837c3c048bd9b576cf6b64403c Mon Sep 17 00:00:00 2001 From: MooseBotter Date: Sun, 6 Apr 2025 14:30:42 +0000 Subject: [PATCH] Auto commit by GitHub Actions Workflow --- Documentation/AI.AI_Air.html | 88 + Documentation/AI.AI_Air_Dispatcher.html | 44 + Documentation/AI.AI_Air_Squadron.html | 11 + Documentation/AI.AI_Cargo.html | 5 +- Documentation/AI.AI_Cargo_Airplane.html | 68 - Documentation/AI.AI_Cargo_Helicopter.html | 40 +- Documentation/Cargo.Cargo.html | 42 +- Documentation/Cargo.CargoCrate.html | 4 +- Documentation/Cargo.CargoGroup.html | 40 +- Documentation/Cargo.CargoSlingload.html | 2 +- Documentation/Cargo.CargoUnit.html | 10 +- Documentation/Core.Point.html | 16832 +++++++++++++++- Documentation/Core.Set.html | 238 +- Documentation/Core.Settings.html | 22 + Documentation/Core.Spawn.html | 338 +- Documentation/Core.SpawnStatic.html | 96 +- Documentation/Core.Zone.html | 180 +- Documentation/Functional.ATC_Ground.html | 10 +- Documentation/Functional.Designate.html | 11 - Documentation/Functional.Detection.html | 33 - Documentation/Functional.Mantis.html | 46 +- Documentation/Functional.Movement.html | 28 + Documentation/Functional.RAT.html | 87 +- Documentation/Functional.Scoring.html | 4 +- .../Functional.ZoneCaptureCoalition.html | 16 +- Documentation/Functional.ZoneGoal.html | 16 +- Documentation/Functional.ZoneGoalCargo.html | 16 +- .../Functional.ZoneGoalCoalition.html | 16 +- Documentation/Ops.Airboss.html | 87 +- Documentation/Ops.CSAR.html | 15 +- Documentation/Ops.CTLD.html | 366 +- .../Tasking.Task_A2A_Dispatcher.html | 8 +- .../Tasking.Task_A2G_Dispatcher.html | 20 +- Documentation/Tasking.Task_CARGO.html | 19 +- .../Tasking.Task_Cargo_Dispatcher.html | 88 + Documentation/Utilities.FiFo.html | 22 - Documentation/Wrapper.Airbase.html | 14 +- Documentation/Wrapper.Client.html | 186 +- Documentation/Wrapper.Controllable.html | 296 +- Documentation/Wrapper.DynamicCargo.html | 83 +- Documentation/Wrapper.Group.html | 194 +- Documentation/Wrapper.Positionable.html | 22 +- Documentation/Wrapper.Scenery.html | 14 +- Documentation/Wrapper.Static.html | 14 +- Documentation/Wrapper.Unit.html | 186 +- Documentation/Wrapper.Weapon.html | 14 +- 46 files changed, 18059 insertions(+), 1932 deletions(-) diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index f81693f24..8c12281fc 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -3349,6 +3349,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
@@ -6202,6 +6224,28 @@ A random value in this bracket is then applied in the waypoint routing generatio + + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
@@ -6938,6 +6982,28 @@ A random value in this bracket is then applied in the waypoint routing generatio + + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
@@ -8562,6 +8628,28 @@ 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 96e64cf9a..6cffb7e6f 100644 --- a/Documentation/AI.AI_Air_Dispatcher.html +++ b/Documentation/AI.AI_Air_Dispatcher.html @@ -4665,6 +4665,17 @@ 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 + + +
@@ -9984,6 +9995,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_AIR_DISPATCHER.DefenderPatrolIndex + + +
@@ -12916,6 +12949,17 @@ 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 7f37dd6bc..c73347c30 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2109,6 +2109,17 @@ Therefore, this class is considered to be deprecated

+ + + +
+
+ + +AI_AIR_SQUADRON.ResourceCount + + +
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index d4a57b856..8f29ecc77 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -1951,7 +1951,7 @@ Therefore, this class is considered to be deprecated

- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -1989,6 +1989,9 @@ Therefore, this class is considered to be deprecated

+ +

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 9c0054769..dc18ec9ba 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2907,20 +2907,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.

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

Aircraft is on a depoly mission.

-
@@ -4700,20 +4683,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.

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

Aircraft is on a depoly mission.

-
@@ -5335,20 +5301,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.

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

Aircraft is on a depoly mission.

-
@@ -6858,20 +6807,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.

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

Aircraft is on a depoly mission.

-
diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index 51ef5eb77..2412cfc34 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -3072,22 +3072,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -4990,22 +4996,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -5660,22 +5672,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -7218,22 +7236,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
diff --git a/Documentation/Cargo.Cargo.html b/Documentation/Cargo.Cargo.html index f524e3e52..95898cb01 100644 --- a/Documentation/Cargo.Cargo.html +++ b/Documentation/Cargo.Cargo.html @@ -2775,6 +2775,17 @@ All derived classes from CARGO follow the same state machine, expose the same ca + + + +
+
+ + Wrapper.Group#GROUP +CARGO.CargoObject + + +
@@ -2896,6 +2907,17 @@ All derived classes from CARGO follow the same state machine, expose the same ca + + + +
+
+ + +CARGO.Weight + + +
@@ -3473,7 +3495,7 @@ The cargo must be in the UnLoaded state.

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

@@ -5247,13 +5269,13 @@ The cargo must be in the Loaded state.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

-

(optional) @{Core.Point#POINT_VEC2) to where the cargo should run after onboarding. If not provided, the cargo will run to 60 meters behind the Carrier location.

+

(optional) @{Core.Point#COORDINATE) to where the cargo should run after onboarding. If not provided, the cargo will run to 60 meters behind the Carrier location.

@@ -5284,13 +5306,13 @@ The cargo must be in the Loaded state.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

-

(optional) @{Core.Point#POINT_VEC2) to where the cargo will be placed after unloading. If not provided, the cargo will be placed 60 meters behind the Carrier location.

+

(optional) @{Core.Point#COORDINATE) to where the cargo will be placed after unloading. If not provided, the cargo will be placed 60 meters behind the Carrier location.

@@ -5447,13 +5469,13 @@ The cargo must be in the Loaded state.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

-

(optional) @{Core.Point#POINT_VEC2) to where the cargo should run after onboarding. If not provided, the cargo will run to 60 meters behind the Carrier location.

+

(optional) @{Core.Point#COORDINATE) to where the cargo should run after onboarding. If not provided, the cargo will run to 60 meters behind the Carrier location.

@@ -5497,13 +5519,13 @@ The cargo must be in the Loaded state.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

-

(optional) @{Core.Point#POINT_VEC2) to where the cargo will be placed after unloading. If not provided, the cargo will be placed 60 meters behind the Carrier location.

+

(optional) @{Core.Point#COORDINATE) to where the cargo will be placed after unloading. If not provided, the cargo will be placed 60 meters behind the Carrier location.

@@ -5776,7 +5798,7 @@ The cargo must be in the Loaded state.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index e7d56ed43..877a1d245 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -2600,7 +2600,7 @@ Therefore, this class is considered to be deprecated

-

Point#POINT_VEC2

+

Point#COORDINATE

@@ -2857,7 +2857,7 @@ Therefore, this class is considered to be deprecated

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 7b51586fb..59448cd4a 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1973,6 +1973,12 @@ Therefore, this class is considered to be deprecated

CARGO_GROUP:onafterUnLoad(Event, From, To, ToPointVec2, ...)

Enter UnLoaded State.

+ + + +

CARGO_GROUP.

+ +

CargoCarrier The carrier group.

@@ -2012,6 +2018,9 @@ Therefore, this class is considered to be deprecated

+ +

Then we register the new group in the database

+
@@ -2023,6 +2032,20 @@ Therefore, this class is considered to be deprecated

+ + + +
+
+ + +CARGO_GROUP.CargoObject + + + + +

Now we spawn the new group based on the template created.

+
@@ -2100,6 +2123,17 @@ Therefore, this class is considered to be deprecated

+ + + +
+
+ + Wrapper.Group#GROU +CARGO_GROUP. + +

CargoCarrier The carrier group.

+
@@ -3108,7 +3142,7 @@ This works for ground only groups.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

@@ -3195,7 +3229,7 @@ This works for ground only groups.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

@@ -3282,7 +3316,7 @@ This works for ground only groups.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

diff --git a/Documentation/Cargo.CargoSlingload.html b/Documentation/Cargo.CargoSlingload.html index d39937c80..de9bb9338 100644 --- a/Documentation/Cargo.CargoSlingload.html +++ b/Documentation/Cargo.CargoSlingload.html @@ -2691,7 +2691,7 @@ Therefore, this class is considered to be deprecated

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index a5a871496..08303815f 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -2281,7 +2281,7 @@ Therefore, this class is considered to be deprecated

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

@@ -2422,7 +2422,7 @@ Therefore, this class is considered to be deprecated

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

@@ -2504,7 +2504,7 @@ Therefore, this class is considered to be deprecated

-

Point#POINT_VEC2

+

Point#COORDINATE

@@ -2574,7 +2574,7 @@ Therefore, this class is considered to be deprecated

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

@@ -2841,7 +2841,7 @@ Therefore, this class is considered to be deprecated

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE ToPointVec2

diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index b42728b50..5e07c9e26 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -1957,6 +1957,8 @@ the most optimal path following the road between two coordinates.

The height coordinate (if needed) will be the land height + an optional added height specified.

+

DEPRECATED - PLEASE USE COORDINATE!

+

POINT_VEC2 constructor

A new POINT_VEC2 instance can be created with:

@@ -2005,6 +2007,8 @@ Note that the Set and Add methods return the current POINT_VEC2 object, so these +

DEPRECATED - PLEASE USE COORDINATE!

+

Important Note: Most of the functions in this section were taken from MIST, and reworked to OO concepts. In order to keep the credibility of the the author, I want to emphasize that the formulas embedded in the MIST framework were created by Grimes or previous authors, @@ -2066,6 +2070,30 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these Fields and Methods inherited from COORDINATE Description + +

COORDINATE:AddAlt(Altitude)

+ +

Add to the current land height an altitude.

+ + + +

COORDINATE:AddX(x)

+ +

Add to the x coordinate of the COORDINATE.

+ + + +

COORDINATE:AddY(y)

+ +

Add to the y coordinate of the COORDINATE.

+ + + +

COORDINATE:AddZ(z)

+ +

Add to the z coordinate of the COORDINATE.

+ +

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

@@ -2208,6 +2236,12 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these

COORDINATE:Get3DDistance(TargetCoordinate)

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

+ + + +

COORDINATE:GetAlt()

+ +

Return the altitude (height) of the land at the COORDINATE.

@@ -2334,6 +2368,18 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these

COORDINATE:GetLandHeight()

Return the height of the land at the coordinate.

+ + + +

COORDINATE:GetLat()

+ +

Return Return the Lat(itude) coordinate of the COORDINATE (ie: (parent)COORDINATE.x).

+ + + +

COORDINATE:GetLon()

+ +

Return the Lon(gitude) coordinate of the COORDINATE (ie: (parent)COORDINATE.z).

@@ -2394,6 +2440,18 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these

COORDINATE:GetRandomCoordinateInRadius(OuterRadius, InnerRadius)

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

+ + + +

COORDINATE:GetRandomPointVec2InRadius(OuterRadius, InnerRadius)

+ +

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

+ + + +

COORDINATE:GetRandomPointVec3InRadius(OuterRadius, InnerRadius)

+ +

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

@@ -2502,6 +2560,24 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these

COORDINATE:GetWindWithTurbulenceVec3(height)

Returns the wind direction (from) and strength.

+ + + +

COORDINATE:GetX()

+ +

Return the x coordinate of the COORDINATE.

+ + + +

COORDINATE:GetY()

+ +

Return the y coordinate of the COORDINATE.

+ + + +

COORDINATE:GetZ()

+ +

Return the z coordinate of the COORDINATE.

@@ -2736,6 +2812,12 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these

COORDINATE:ScanUnits(radius)

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

+ + + +

COORDINATE:SetAlt(Altitude)

+ +

Set the altitude of the COORDINATE.

@@ -2754,12 +2836,42 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these

COORDINATE:SetHeading(Heading)

Set the heading of the coordinate, if applicable.

+ + + +

COORDINATE:SetLat(x)

+ +

Set the Lat(itude) coordinate of the COORDINATE (ie: COORDINATE.x).

+ + + +

COORDINATE:SetLon(y, z)

+ +

Set the Lon(gitude) coordinate of the COORDINATE (ie: COORDINATE.z).

COORDINATE:SetVelocity(Velocity)

Set the velocity of the COORDINATE.

+ + + +

COORDINATE:SetX(x)

+ +

Set the x coordinate of the COORDINATE.

+ + + +

COORDINATE:SetY(y)

+ +

Set the y coordinate of the COORDINATE.

+ + + +

COORDINATE:SetZ(z)

+ +

Set the z coordinate of the COORDINATE.

@@ -3829,6 +3941,8 @@ 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
@@ -3836,6 +3950,32 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + + + + + + + + + + +
Fields and Methods inherited from POINT_VEC2 Description

POINT_VEC2:New(x, y, LandHeightAdd)

 +

POINT_VEC2 constructor.

+

POINT_VEC2.x

 +

The x coordinate in meters.

+

POINT_VEC2.y

 +

the y coordinate in meters.

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

POINT_VEC2:AddAlt(Altitude)

 @@ -3845,121 +3985,1707 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

POINT_VEC2:AddX(x)

 -

Add to the x coordinate of the POINT_VEC2.

+

Add to the x coordinate of the COORDINATE.

POINT_VEC2:AddY(y)

 -

Add to the y coordinate of the POINT_VEC2.

+

Add to the y coordinate of the COORDINATE.

+

POINT_VEC2:AddZ(z)

 +

Add to the z coordinate of the COORDINATE.

+

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:GetAlt()

 -

Return the altitude (height) of the land at the POINT_VEC2.

+

Return the altitude (height) of the land at 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, Precision)

 +

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:GetLat()

 -

Return Return the Lat(itude) coordinate of the POINT_VEC2 (ie: (parent)POINT_VEC3.x).

+

Return Return the Lat(itude) coordinate of the COORDINATE (ie: (parent)COORDINATE.x).

POINT_VEC2:GetLon()

 -

Return the Lon(gitude) coordinate of the POINT_VEC2 (ie: (parent)POINT_VEC3.z).

+

Return the Lon(gitude) coordinate of the COORDINATE (ie: (parent)COORDINATE.z).

+

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:GetRandomPointVec2InRadius(OuterRadius, InnerRadius)

 -

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

+

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

+

POINT_VEC2:GetRandomPointVec3InRadius(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:GetX()

 -

Return the x coordinate of the POINT_VEC2.

+

Return the x coordinate of the COORDINATE.

POINT_VEC2:GetY()

 -

Return the y coordinate of the POINT_VEC2.

+

Return the y coordinate of the COORDINATE.

POINT_VEC2:New(x, y, LandHeightAdd)

POINT_VEC2:GetZ()

 -

POINT_VEC2 constructor.

+

Return the z coordinate of the COORDINATE.

+

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:NewFromMGRS(UTMZone, MGRSDigraph, Easting, Northing)

 +

Provides a COORDINATE from an MGRS Coordinate

+

POINT_VEC2:NewFromMGRSString(MGRSString)

 +

Provides a COORDINATE from an MGRS String

POINT_VEC2:NewFromVec2(Vec2, LandHeightAdd)

 -

Create a new POINT_VEC2 object from Vec2 coordinates.

+

Create a new COORDINATE object from Vec2 coordinates.

POINT_VEC2:NewFromVec3(Vec3)

 -

Create a new POINT_VEC2 object from Vec3 coordinates.

+

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:SetAlt(Altitude)

 -

Set the altitude of the POINT_VEC2.

+

Set the altitude of the COORDINATE.

+

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:SetLat(x)

 -

Set the Lat(itude) coordinate of the POINT_VEC2 (ie: POINT_VEC3.x).

+

Set the Lat(itude) coordinate of the COORDINATE (ie: COORDINATE.x).

POINT_VEC2:SetLon(y, z)

 -

Set the Lon(gitude) coordinate of the POINT_VEC2 (ie: POINT_VEC3.z).

+

Set the Lon(gitude) coordinate of the COORDINATE (ie: COORDINATE.z).

+

POINT_VEC2:SetVelocity(Velocity)

 +

Set the velocity of the COORDINATE.

POINT_VEC2:SetX(x)

 -

Set the x coordinate of the POINT_VEC2.

+

Set the x coordinate of the COORDINATE.

POINT_VEC2:SetY(y)

 -

Set the y coordinate of the POINT_VEC2.

+

Set the y coordinate of the COORDINATE.

+

POINT_VEC2:SetZ(z)

 +

Set the z coordinate of the COORDINATE.

+

POINT_VEC2:Smoke(SmokeColor, name)

 +

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:StopSmoke(name)

 +

Stops smoking the point in a color.

+

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

 +

Text to all.

+

POINT_VEC2:ToString(Controllable, Settings)

 +

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, Precision)

 +

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:ToStringLL(Settings)

 +

Get Latitude & Longitude text.

+

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:CreateEventDynamicCargoLoaded(DynamicCargo)

 +

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

+

POINT_VEC2:CreateEventDynamicCargoRemoved(DynamicCargo)

 +

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

+

POINT_VEC2:CreateEventDynamicCargoUnloaded(DynamicCargo)

 +

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

+

POINT_VEC2:CreateEventNewDynamicCargo(DynamicCargo)

 +

Creation of a S_EVENT_NEW_DYNAMIC_CARGO 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:GetProperties()

 +

Get all of the properties of an object in a table.

+

POINT_VEC2:GetProperty(Key)

 +

Get one property of an object by the key.

+

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:OnEventDynamicCargoLoaded(EventData)

 +

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

+

POINT_VEC2:OnEventDynamicCargoRemoved(EventData)

 +

Occurs when a dynamic cargo crate is removed.

+

POINT_VEC2:OnEventDynamicCargoUnloaded(EventData)

 +

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

+

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:OnEventNewDynamicCargo(EventData)

 +

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

+

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

 +

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

 +

The scheduler object.

+

POINT_VEC2:SetEventPriority(EventPriority)

 +

Set the Class Core.Event processing Priority.

+

POINT_VEC2:SetProperty(Key, Value)

 +

Set one property of an object.

+

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:_Serialize(Arguments)

 +

(Internal) Serialize arguments

+

POINT_VEC2:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

POINT_VEC2.__

 + +

POINT_VEC2:onEvent(event)

 +

The main event handling function...
@@ -3976,70 +5702,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from POINT_VEC3 Description - -

POINT_VEC3:AddX(x)

- -

Add to the x coordinate of the POINT_VEC3.

- - - -

POINT_VEC3:AddY(y)

- -

Add to the y coordinate of the POINT_VEC3.

- - - -

POINT_VEC3:AddZ(z)

- -

Add to the z coordinate of the POINT_VEC3.

- -

POINT_VEC3.FlareColor

- - - -

POINT_VEC3:GetRandomPointVec3InRadius(OuterRadius, InnerRadius)

- -

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

- - - -

POINT_VEC3:GetX()

- -

Return the x coordinate of the POINT_VEC3.

- - - -

POINT_VEC3:GetY()

- -

Return the y coordinate of the POINT_VEC3.

- - - -

POINT_VEC3:GetZ()

- -

Return the z coordinate of the POINT_VEC3.

POINT_VEC3:New(x, y, z)

Create a new POINT_VEC3 object.

- - - -

POINT_VEC3:NewFromVec2(Vec2, LandHeightAdd)

- -

Create a new POINT_VEC3 object from Vec2 coordinates.

- - - -

POINT_VEC3:NewFromVec3(Vec3)

- -

Create a new POINT_VEC3 object from Vec3 coordinates.

@@ -4058,24 +5730,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

POINT_VEC3.RoutePointType

- - - -

POINT_VEC3:SetX(x)

- -

Set the x coordinate of the POINT_VEC3.

- - - -

POINT_VEC3:SetY(y)

- -

Set the y coordinate of the POINT_VEC3.

- - - -

POINT_VEC3:SetZ(z)

- -

Set the z coordinate of the POINT_VEC3.

@@ -4290,6 +5944,182 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+

COORDINATE:AddAlt(Altitude)

+
+ +

Add to the current land height an altitude.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #number + Altitude +

+
+
+ +

The Altitude to add. If nothing (nil) is given, then the current land altitude is set.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

COORDINATE:AddX(x)

+
+ +

Add to the x coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #number + x +

+
+
+ +

The x coordinate value to add to the current x coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

COORDINATE:AddY(y)

+
+ +

Add to the y coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #number + y +

+
+
+ +

The y coordinate value to add to the current y coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

COORDINATE:AddZ(z)

+
+ +

Add to the z coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #number + z +

+
+
+ +

The z coordinate value to add to the current z coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

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

@@ -5517,6 +7347,36 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+ +
+ +
+

COORDINATE:GetAlt()

+
+ +

Return the altitude (height) of the land at the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The land altitude.

+ +
+
+
+
@@ -6757,6 +8617,66 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+ + +
+ +
+

COORDINATE:GetLat()

+
+ +

Return Return the Lat(itude) coordinate of the COORDINATE (ie: (parent)COORDINATE.x).

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The x coordinate.

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

COORDINATE:GetLon()

+
+ +

Return the Lon(gitude) coordinate of the COORDINATE (ie: (parent)COORDINATE.z).

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The y coordinate.

+ +
+
+
+
@@ -7292,6 +9212,112 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t + + + +
+ +
+

COORDINATE:GetRandomPointVec2InRadius(OuterRadius, InnerRadius)

+
+ +

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

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameters:

+
+
+

+ DCS#Distance + OuterRadius +

+
+
+

+
+
+
+
+

+ DCS#Distance + InnerRadius +

+
+
+

+
+
+

Return value:

+
+
+

#COORDINATE:

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

COORDINATE:GetRandomPointVec3InRadius(OuterRadius, InnerRadius)

+
+ +

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

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameters:

+
+
+

+ DCS#Distance + OuterRadius +

+
+
+

+
+
+
+
+

+ DCS#Distance + InnerRadius +

+
+
+

+
+
+

Return value:

+
+
+

#COORDINATE:

+
+
+ + + +
+
+
+
@@ -8217,6 +10243,96 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t + + + +
+ +
+

COORDINATE:GetX()

+
+ +

Return the x coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The x coordinate.

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

COORDINATE:GetY()

+
+ +

Return the y coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The y coordinate.

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

COORDINATE:GetZ()

+
+ +

Return the z coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The z coordinate.

+ +
+
+
+
@@ -10726,6 +12842,50 @@ Creates a line on the F10 map from one point to another.

+ + + +
+ +
+

COORDINATE:SetAlt(Altitude)

+
+ +

Set the altitude of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #number + Altitude +

+
+
+ +

The land altitude. If nothing (nil) is given, then the current land altitude is set.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

+
+
+ + + +
+
+
+
@@ -10835,6 +12995,104 @@ Creates a line on the F10 map from one point to another.

+ + + +
+ +
+

COORDINATE:SetLat(x)

+
+ +

Set the Lat(itude) coordinate of the COORDINATE (ie: COORDINATE.x).

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #number + x +

+
+
+ +

The x coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

COORDINATE:SetLon(y, z)

+
+ +

Set the Lon(gitude) coordinate of the COORDINATE (ie: COORDINATE.z).

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameters:

+
+
+

+ #number + y +

+
+
+ +

The y coordinate.

+ +
+
+
+
+

+ z +

+
+
+

+
+
+

Return value:

+
+
+

#COORDINATE:

+
+
+ + + +
+
+
+
@@ -10868,6 +13126,138 @@ Creates a line on the F10 map from one point to another.

+ + + +
+ +
+

COORDINATE:SetX(x)

+
+ +

Set the x coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #number + x +

+
+
+ +

The x coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

COORDINATE:SetY(y)

+
+ +

Set the y coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #number + y +

+
+
+ +

The y coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

COORDINATE:SetZ(z)

+
+ +

Set the z coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

COORDINATE

+
+

Parameter:

+
+
+

+ #number + z +

+
+
+ +

The z coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

+
+
+ + + +
+
+
+
@@ -17516,10 +19906,21 @@ 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.

@@ -17529,378 +19930,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
-

POINT_VEC2:AddAlt(Altitude)

-
- -

Add to the current land height an altitude.

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Parameter:

-
-
-

- #number - Altitude -

-
-
- -

The Altitude to add. If nothing (nil) is given, then the current land altitude is set.

- -
-
-

Return value:

-
-
-

#POINT_VEC2:

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

POINT_VEC2:AddX(x)

-
- -

Add to the x coordinate of the POINT_VEC2.

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Parameter:

-
-
-

- #number - x -

-
-
- -

The x coordinate.

- -
-
-

Return value:

-
-
-

#POINT_VEC2:

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

POINT_VEC2:AddY(y)

-
- -

Add to the y coordinate of the POINT_VEC2.

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Parameter:

-
-
-

- #number - y -

-
-
- -

The y coordinate.

- -
-
-

Return value:

-
-
-

#POINT_VEC2:

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

POINT_VEC2:DistanceFromPointVec2(PointVec2Reference)

-
- - - - -

TODO: Check this to replace -- Calculate the distance from a reference #POINT_VEC2. - @param #POINT_VEC2 self - @param #POINT_VEC2 PointVec2Reference The reference #POINT_VEC2. - @return DCS#Distance The distance from the reference #POINT_VEC2 in meters.

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Parameter:

-
-
-

- PointVec2Reference -

-
-
-

-
-
-
- -
-
- -
- -
-

POINT_VEC2:GetAlt()

-
- -

Return the altitude (height) of the land at the POINT_VEC2.

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Return value:

-
-
-

#number:

-
-
- -

The land altitude.

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

POINT_VEC2:GetLat()

-
- -

Return Return the Lat(itude) coordinate of the POINT_VEC2 (ie: (parent)POINT_VEC3.x).

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Return value:

-
-
-

#number:

-
-
- -

The x coordinate.

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

POINT_VEC2:GetLon()

-
- -

Return the Lon(gitude) coordinate of the POINT_VEC2 (ie: (parent)POINT_VEC3.z).

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Return value:

-
-
-

#number:

-
-
- -

The y coordinate.

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

POINT_VEC2:GetRandomPointVec2InRadius(OuterRadius, InnerRadius)

-
- -

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

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Parameters:

-
-
-

- DCS#Distance - OuterRadius -

-
-
-

-
-
-
-
-

- DCS#Distance - InnerRadius -

-
-
-

-
-
-

Return value:

-
-
-

#POINT_VEC2:

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

POINT_VEC2:GetX()

-
- -

Return the x coordinate of the POINT_VEC2.

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Return value:

-
-
-

#number:

-
-
- -

The x coordinate.

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

POINT_VEC2:GetY()

-
- -

Return the y coordinate of the POINT_VEC2.

- -
-
-

Defined in:

-
-

POINT_VEC2

-
-

Return value:

-
-
-

#number:

-
-
- -

The y coordinate.

- -
-
-
- -
-
- -
-

POINT_VEC2:New(x, y, LandHeightAdd)

@@ -17966,6 +19995,6115 @@ 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.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

POINT_VEC2:AddAlt(Altitude)

+
+ +

Add to the current land height an altitude.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameter:

+
+
+

+ #number + Altitude +

+
+
+ +

The Altitude to add. If nothing (nil) is given, then the current land altitude is set.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

POINT_VEC2:AddX(x)

+
+ +

Add to the x coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameter:

+
+
+

+ #number + x +

+
+
+ +

The x coordinate value to add to the current x coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

POINT_VEC2:AddY(y)

+
+ +

Add to the y coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameter:

+
+
+

+ #number + y +

+
+
+ +

The y coordinate value to add to the current y coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

POINT_VEC2:AddZ(z)

+
+ +

Add to the z coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameter:

+
+
+

+ #number + z +

+
+
+ +

The z coordinate value to add to the current z coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

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:GetAlt()

+
+ +

Return the altitude (height) of the land at the COORDINATE.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The land altitude.

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

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, Precision)

+
+ +

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

+ +
+
+
+
+

+ #number + Precision +

+
+
+ +

Rounding precision, defaults to 0

+ +
+
+

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:GetLat()

+
+ +

Return Return the Lat(itude) coordinate of the COORDINATE (ie: (parent)COORDINATE.x).

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The x coordinate.

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

POINT_VEC2:GetLon()

+
+ +

Return the Lon(gitude) coordinate of the COORDINATE (ie: (parent)COORDINATE.z).

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The y coordinate.

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

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:

+ + + +

A text containing a pressure will look like this:

+ + + + +
+
+

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:GetRandomPointVec2InRadius(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 +

+
+
+

+
+
+
+
+

+ DCS#Distance + InnerRadius +

+
+
+

+
+
+

Return value:

+
+
+

#COORDINATE:

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

POINT_VEC2:GetRandomPointVec3InRadius(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 +

+
+
+

+
+
+
+
+

+ DCS#Distance + InnerRadius +

+
+
+

+
+
+

Return value:

+
+
+

#COORDINATE:

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

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:

+ + + +

A text containing a pressure will look like this:

+ + + + +
+
+

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:

+ + + +

A text containing a pressure will look like this:

+ + + + +
+
+

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:GetX()

+
+ +

Return the x coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The x coordinate.

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

POINT_VEC2:GetY()

+
+ +

Return the y coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The y coordinate.

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

POINT_VEC2:GetZ()

+
+ +

Return the z coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The z coordinate.

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

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:

+
+
+

#boolean:

+
+
+ +

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:

+
+
+

#boolean:

+
+
+ +

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:NewFromMGRS(UTMZone, MGRSDigraph, Easting, Northing)

+
+ +

Provides a COORDINATE from an MGRS Coordinate

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameters:

+
+
+

+ #string + UTMZone +

+
+
+ +

UTM Zone, e.g. "37T"

+ +
+
+
+
+

+ #string + MGRSDigraph +

+
+
+ +

Digraph, e.g. "DK"

+ +
+
+
+
+

+ #string + Easting +

+
+
+ +

Meters easting - string in order to allow for leading zeros, e.g. "01234". Should be 5 digits.

+ +
+
+
+
+

+ #string + Northing +

+
+
+ +

Meters northing - string in order to allow for leading zeros, e.g. "12340". Should be 5 digits.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

+
+
+ +

self

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

POINT_VEC2:NewFromMGRSString(MGRSString)

+
+ +

Provides a COORDINATE from an MGRS String

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameter:

+
+
+

+ #string + MGRSString +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#COORDINATE:

+
+
+ +

self

+ +
+
+
+
@@ -17975,13 +26113,13 @@ When moose is loading dynamically (for moose class development), tracing is swit

POINT_VEC2:NewFromVec2(Vec2, LandHeightAdd)

-

Create a new POINT_VEC2 object from Vec2 coordinates.

+

Create a new COORDINATE object from Vec2 coordinates.

Defined in:

-

POINT_VEC2

+

Core.Point#COORDINATE

Parameters:

@@ -18000,17 +26138,20 @@ When moose is loading dynamically (for moose class development), tracing is swit

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

-

Core.Point#POINT_VEC2:

+

#COORDINATE:

@@ -18029,13 +26170,13 @@ When moose is loading dynamically (for moose class development), tracing is swit

POINT_VEC2:NewFromVec3(Vec3)

-

Create a new POINT_VEC2 object from Vec3 coordinates.

+

Create a new COORDINATE object from Vec3 coordinates.

Defined in:

-

POINT_VEC2

+

Core.Point#COORDINATE

Parameter:

@@ -18054,7 +26195,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

Core.Point#POINT_VEC2:

+

#COORDINATE:

@@ -18064,6 +26205,727 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
+ +
+ +
+

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 >>>
+  TargetCoord: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.

+ +
+
+
+
@@ -18073,13 +26935,13 @@ When moose is loading dynamically (for moose class development), tracing is swit

POINT_VEC2:SetAlt(Altitude)

-

Set the altitude of the POINT_VEC2.

+

Set the altitude of the COORDINATE.

Defined in:

-

POINT_VEC2

+

Core.Point#COORDINATE

Parameter:

@@ -18098,7 +26960,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

#POINT_VEC2:

+

#COORDINATE:

@@ -18108,6 +26970,115 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
+ +
+ +
+

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 +

+
+
+

+
+
+
+
@@ -18117,13 +27088,13 @@ When moose is loading dynamically (for moose class development), tracing is swit

POINT_VEC2:SetLat(x)

-

Set the Lat(itude) coordinate of the POINT_VEC2 (ie: POINT_VEC3.x).

+

Set the Lat(itude) coordinate of the COORDINATE (ie: COORDINATE.x).

Defined in:

-

POINT_VEC2

+

Core.Point#COORDINATE

Parameter:

@@ -18142,7 +27113,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

#POINT_VEC2:

+

#COORDINATE:

@@ -18161,13 +27132,13 @@ When moose is loading dynamically (for moose class development), tracing is swit

POINT_VEC2:SetLon(y, z)

-

Set the Lon(gitude) coordinate of the POINT_VEC2 (ie: POINT_VEC3.z).

+

Set the Lon(gitude) coordinate of the COORDINATE (ie: COORDINATE.z).

Defined in:

-

POINT_VEC2

+

Core.Point#COORDINATE

Parameters:

@@ -18196,7 +27167,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

#POINT_VEC2:

+

#COORDINATE:

@@ -18206,6 +27177,39 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
+ +
+ +
+

POINT_VEC2:SetVelocity(Velocity)

+
+ +

Set the velocity of the COORDINATE.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameter:

+
+
+

+ #string + Velocity +

+
+
+ +

Velocity in meters per second.

+ +
+
+
+
@@ -18215,13 +27219,13 @@ When moose is loading dynamically (for moose class development), tracing is swit

POINT_VEC2:SetX(x)

-

Set the x coordinate of the POINT_VEC2.

+

Set the x coordinate of the COORDINATE.

Defined in:

-

POINT_VEC2

+

Core.Point#COORDINATE

Parameter:

@@ -18240,7 +27244,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

#POINT_VEC2:

+

#COORDINATE:

@@ -18259,13 +27263,13 @@ When moose is loading dynamically (for moose class development), tracing is swit

POINT_VEC2:SetY(y)

-

Set the y coordinate of the POINT_VEC2.

+

Set the y coordinate of the COORDINATE.

Defined in:

-

POINT_VEC2

+

Core.Point#COORDINATE

Parameter:

@@ -18284,7 +27288,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

#POINT_VEC2:

+

#COORDINATE:

@@ -18294,6 +27298,6352 @@ When moose is loading dynamically (for moose class development), tracing is swit
+
+
+ +
+ +
+

POINT_VEC2:SetZ(z)

+
+ +

Set the z coordinate of the COORDINATE.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameter:

+
+
+

+ #number + z +

+
+
+ +

The z coordinate.

+ +
+
+

Return value:

+
+
+

#COORDINATE:

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

POINT_VEC2:Smoke(SmokeColor, name)

+
+ +

Smokes the point in a color.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameters:

+
+
+

+ Utilities.Utils#SMOKECOLOR + SmokeColor +

+
+
+

+
+
+
+
+

+ #string + name +

+
+
+ +

(Optional) Name if you want to stop the smoke early (normal duration: 5mins)

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

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:StopSmoke(name)

+
+ +

Stops smoking the point in a color.

+ +
+
+

Defined in:

+
+

Core.Point#COORDINATE

+
+

Parameter:

+
+
+

+ #string + name +

+
+
+ +

(Optional) Name if you want to stop the smoke early (normal duration: 5mins)

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

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)

+
+ +

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.

+ +
+
+

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, Precision)

+
+ +

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

+ +
+
+
+
+

+ #number + Precision +

+
+
+ +

Rounding precision, currently full km as default (=0)

+ +
+
+

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:ToStringLL(Settings)

+
+ +

Get Latitude & Longitude text.

+ +
+
+

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:

+
+
+ +

LLText

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

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.

+ +
+ +
+
+

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:CreateEventDynamicCargoLoaded(DynamicCargo)

+
+ +

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.DynamicCargo#DYNAMICCARGO + DynamicCargo +

+
+
+ +

the dynamic cargo object

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

POINT_VEC2:CreateEventDynamicCargoRemoved(DynamicCargo)

+
+ +

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.DynamicCargo#DYNAMICCARGO + DynamicCargo +

+
+
+ +

the dynamic cargo object

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

POINT_VEC2:CreateEventDynamicCargoUnloaded(DynamicCargo)

+
+ +

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.DynamicCargo#DYNAMICCARGO + DynamicCargo +

+
+
+ +

the dynamic cargo object

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

POINT_VEC2:CreateEventNewDynamicCargo(DynamicCargo)

+
+ +

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.DynamicCargo#DYNAMICCARGO + DynamicCargo +

+
+
+ +

the dynamic cargo object

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

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:GetProperties()

+
+ +

Get all of the properties of an object in a table.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#table:

+
+
+ +

of values, indexed by keys.

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

POINT_VEC2:GetProperty(Key)

+
+ +

Get one property of an object by the key.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ 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!

+ +
+
+

Return value:

+
+
+
+
+ +

Value The value that is stored. Note that the value can be a #string, but it can also be any other type! Nil if not found.

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

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:OnEventDynamicCargoLoaded(EventData)

+
+ +

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

+ + +

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

POINT_VEC2:OnEventDynamicCargoRemoved(EventData)

+
+ +

Occurs when a dynamic cargo crate is removed.

+ + +

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

POINT_VEC2:OnEventDynamicCargoUnloaded(EventData)

+
+ +

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

+ + +

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

+ +
+
+

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:OnEventNewDynamicCargo(EventData)

+
+ +

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

+ + +

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

+ +
+
+

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:SetProperty(Key, Value)

+
+ +

Set one property of an object.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ 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 that is stored. Note that the value can be a #string, but it can also be any other type!

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

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:_Serialize(Arguments)

+
+ +

(Internal) Serialize arguments

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #table + Arguments +

+
+
+

+
+
+

Return value:

+
+
+

#string:

+
+
+ +

Text

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

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 +

+
+
+

+
+
+
+
@@ -18402,281 +33752,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-
-

POINT_VEC3:AddX(x)

-
- -

Add to the x coordinate of the POINT_VEC3.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Parameter:

-
-
-

- #number - x -

-
-
- -

The x coordinate value to add to the current x coordinate.

- -
-
-

Return value:

-
-
-

#POINT_VEC3:

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

POINT_VEC3:AddY(y)

-
- -

Add to the y coordinate of the POINT_VEC3.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Parameter:

-
-
-

- #number - y -

-
-
- -

The y coordinate value to add to the current y coordinate.

- -
-
-

Return value:

-
-
-

#POINT_VEC3:

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

POINT_VEC3:AddZ(z)

-
- -

Add to the z coordinate of the POINT_VEC3.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Parameter:

-
-
-

- #number - z -

-
-
- -

The z coordinate value to add to the current z coordinate.

- -
-
-

Return value:

-
-
-

#POINT_VEC3:

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

POINT_VEC3:GetRandomPointVec3InRadius(OuterRadius, InnerRadius)

-
- -

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

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Parameters:

-
-
-

- DCS#Distance - OuterRadius -

-
-
-

-
-
-
-
-

- DCS#Distance - InnerRadius -

-
-
-

-
-
-

Return value:

-
-
-

#POINT_VEC3:

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

POINT_VEC3:GetX()

-
- -

Return the x coordinate of the POINT_VEC3.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Return value:

-
-
-

#number:

-
-
- -

The x coordinate.

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

POINT_VEC3:GetY()

-
- -

Return the y coordinate of the POINT_VEC3.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Return value:

-
-
-

#number:

-
-
- -

The y coordinate.

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

POINT_VEC3:GetZ()

-
- -

Return the z coordinate of the POINT_VEC3.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Return value:

-
-
-

#number:

-
-
- -

The z coordinate.

- -
-
-
- -
-
- -
-

POINT_VEC3:New(x, y, z)

@@ -18738,239 +33813,6 @@ When moose is loading dynamically (for moose class development), tracing is swit -
-
-
- -
-
- -
- -
-

POINT_VEC3:NewFromVec2(Vec2, LandHeightAdd)

-
- -

Create a new POINT_VEC3 object from Vec2 coordinates.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Parameters:

-
-
-

- DCS#Vec2 - Vec2 -

-
-
- -

The Vec2 point.

- -
-
-
-
-

- DCS#Distance - LandHeightAdd -

-
-
- -

(optional) Add a landheight.

- -
-
-

Return value:

-
-
-

Core.Point#POINT_VEC3:

-
-
- -

self

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

POINT_VEC3:NewFromVec3(Vec3)

-
- -

Create a new POINT_VEC3 object from Vec3 coordinates.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Parameter:

-
-
-

- DCS#Vec3 - Vec3 -

-
-
- -

The Vec3 point.

- -
-
-

Return value:

-
-
-

Core.Point#POINT_VEC3:

-
-
- -

self

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

POINT_VEC3:SetX(x)

-
- -

Set the x coordinate of the POINT_VEC3.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Parameter:

-
-
-

- #number - x -

-
-
- -

The x coordinate.

- -
-
-

Return value:

-
-
-

#POINT_VEC3:

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

POINT_VEC3:SetY(y)

-
- -

Set the y coordinate of the POINT_VEC3.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Parameter:

-
-
-

- #number - y -

-
-
- -

The y coordinate.

- -
-
-

Return value:

-
-
-

#POINT_VEC3:

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

POINT_VEC3:SetZ(z)

-
- -

Set the z coordinate of the POINT_VEC3.

- -
-
-

Defined in:

-
-

POINT_VEC3

-
-

Parameter:

-
-
-

- #number - z -

-
-
- -

The z coordinate.

- -
-
-

Return value:

-
-
-

#POINT_VEC3:

-
-
- - -
diff --git a/Documentation/Core.Set.html b/Documentation/Core.Set.html index 14b19bbaa..d215b960d 100644 --- a/Documentation/Core.Set.html +++ b/Documentation/Core.Set.html @@ -3061,9 +3061,9 @@ The following iterator methods are currently available within the SET_ZONE_GOAL: -

SET_AIRBASE:FindNearestAirbaseFromPointVec2(PointVec2)

+

SET_AIRBASE:FindNearestAirbaseFromPointVec2(Coordinate)

-

Iterate the SET_AIRBASE while identifying the nearest Wrapper.Airbase#AIRBASE from a Core.Point#POINT_VEC2.

+

Iterate the SET_AIRBASE while identifying the nearest Wrapper.Airbase#AIRBASE from a Core.Point#COORDINATE.

@@ -3207,9 +3207,9 @@ The following iterator methods are currently available within the SET_ZONE_GOAL: -

SET_AIRBASE:FindNearestObjectFromPointVec2(PointVec2)

+

SET_AIRBASE:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_BASE:FindNearestObjectFromPointVec2(PointVec2)

+

SET_BASE:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_CARGO:FindNearestCargoFromPointVec2(PointVec2)

+

SET_CARGO:FindNearestCargoFromPointVec2(Coordinate)

-

(R2.1) Iterate the SET_CARGO while identifying the nearest Cargo.Cargo#CARGO from a Core.Point#POINT_VEC2.

+

(R2.1) Iterate the SET_CARGO while identifying the nearest Cargo.Cargo#CARGO from a Core.Point#COORDINATE.

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

SET_CARGO:FindNearestObjectFromPointVec2(PointVec2)

+

SET_CARGO:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_CLIENT:FindNearestObjectFromPointVec2(PointVec2)

+

SET_CLIENT:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_DYNAMICCARGO:FindNearestObjectFromPointVec2(PointVec2)

+

SET_DYNAMICCARGO:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -8630,9 +8630,9 @@ provides an easy to use shortcut...

-

SET_GROUP:FindNearestGroupFromPointVec2(PointVec2)

+

SET_GROUP:FindNearestGroupFromPointVec2(Coordinate)

-

Iterate the SET_GROUP while identifying the nearest object from a Core.Point#POINT_VEC2.

+

Iterate the SET_GROUP while identifying the nearest object from a Core.Point#COORDINATE.

@@ -8856,9 +8856,9 @@ mission designer to add a dedicated method

-

SET_GROUP:FindNearestObjectFromPointVec2(PointVec2)

+

SET_GROUP:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_OPSGROUP:FindNearestObjectFromPointVec2(PointVec2)

+

SET_OPSGROUP:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_OPSZONE:FindNearestObjectFromPointVec2(PointVec2)

+

SET_OPSZONE:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_PLAYER:FindNearestObjectFromPointVec2(PointVec2)

+

SET_PLAYER:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_SCENERY:FindNearestObjectFromPointVec2(PointVec2)

+

SET_SCENERY:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_STATIC:FindNearestObjectFromPointVec2(PointVec2)

+

SET_STATIC:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_UNIT:FindNearestObjectFromPointVec2(PointVec2)

+

SET_UNIT:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_ZONE:FindNearestObjectFromPointVec2(PointVec2)

+

SET_ZONE:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

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

SET_ZONE_GOAL:FindNearestObjectFromPointVec2(PointVec2)

+

SET_ZONE_GOAL:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -19043,10 +19043,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

SET_AIRBASE:FindNearestAirbaseFromPointVec2(PointVec2)

+

SET_AIRBASE:FindNearestAirbaseFromPointVec2(Coordinate)

-

Iterate the SET_AIRBASE while identifying the nearest Wrapper.Airbase#AIRBASE from a Core.Point#POINT_VEC2.

+

Iterate the SET_AIRBASE while identifying the nearest Wrapper.Airbase#AIRBASE from a Core.Point#COORDINATE.

@@ -19058,13 +19058,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#POINT_VEC2 object from where to evaluate the closest Wrapper.Airbase#AIRBASE.

+

A Core.Point#COORDINATE object from where to evaluate the closest Wrapper.Airbase#AIRBASE.

@@ -19841,10 +19841,10 @@ DatabaseSet = SET_AIRBASE:New()
-

SET_AIRBASE:FindNearestObjectFromPointVec2(PointVec2)

+

SET_AIRBASE:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -19856,13 +19856,13 @@ DatabaseSet = SET_AIRBASE:New()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -25608,10 +25608,10 @@ When moose is loading dynamically (for moose class development), tracing is swit
-

SET_BASE:FindNearestObjectFromPointVec2(PointVec2)

+

SET_BASE:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -25623,13 +25623,13 @@ When moose is loading dynamically (for moose class development), tracing is swit

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -31424,10 +31424,10 @@ When moose is loading dynamically (for moose class development), tracing is swit
-

SET_CARGO:FindNearestCargoFromPointVec2(PointVec2)

+

SET_CARGO:FindNearestCargoFromPointVec2(Coordinate)

-

(R2.1) Iterate the SET_CARGO while identifying the nearest Cargo.Cargo#CARGO from a Core.Point#POINT_VEC2.

+

(R2.1) Iterate the SET_CARGO while identifying the nearest Cargo.Cargo#CARGO from a Core.Point#COORDINATE.

@@ -31439,13 +31439,13 @@ When moose is loading dynamically (for moose class development), tracing is swit

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#POINT_VEC2 object from where to evaluate the closest Cargo.Cargo#CARGO.

+

A Core.Point#COORDINATE object from where to evaluate the closest Cargo.Cargo#CARGO.

@@ -32373,10 +32373,10 @@ DatabaseSet = SET_CARGO:New()
-

SET_CARGO:FindNearestObjectFromPointVec2(PointVec2)

+

SET_CARGO:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -32388,13 +32388,13 @@ DatabaseSet = SET_CARGO:New()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -39460,10 +39460,10 @@ DBObject = SET_CLIENT:New()
-

SET_CLIENT:FindNearestObjectFromPointVec2(PointVec2)

+

SET_CLIENT:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -39475,13 +39475,13 @@ DBObject = SET_CLIENT:New()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -46301,10 +46301,10 @@ DBObject = SET_DYNAMICCARGO:New()
-

SET_DYNAMICCARGO:FindNearestObjectFromPointVec2(PointVec2)

+

SET_DYNAMICCARGO:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -46316,13 +46316,13 @@ DBObject = SET_DYNAMICCARGO:New()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -53060,10 +53060,10 @@ to warrant a check of below 10 seconds.

-

SET_GROUP:FindNearestGroupFromPointVec2(PointVec2)

+

SET_GROUP:FindNearestGroupFromPointVec2(Coordinate)

-

Iterate the SET_GROUP while identifying the nearest object from a Core.Point#POINT_VEC2.

+

Iterate the SET_GROUP while identifying the nearest object from a Core.Point#COORDINATE.

@@ -53075,13 +53075,13 @@ to warrant a check of below 10 seconds.

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#POINT_VEC2 object from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object from where to evaluate the closest object in the set.

@@ -54497,10 +54497,10 @@ MySetGroup:SetCargoBayWeightLimit()
-

SET_GROUP:FindNearestObjectFromPointVec2(PointVec2)

+

SET_GROUP:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -54512,13 +54512,13 @@ MySetGroup:SetCargoBayWeightLimit()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -61505,10 +61505,10 @@ GroupSet = SET_OPSGROUP:New():FilterActive( false ):FilterCoalition( "blue" ):Fi
-

SET_OPSGROUP:FindNearestObjectFromPointVec2(PointVec2)

+

SET_OPSGROUP:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -61520,13 +61520,13 @@ GroupSet = SET_OPSGROUP:New():FilterActive( false ):FilterCoalition( "blue" ):Fi

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -68082,10 +68082,10 @@ If zones overlap, the first zone that validates the test is returned.

-

SET_OPSZONE:FindNearestObjectFromPointVec2(PointVec2)

+

SET_OPSZONE:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -68097,13 +68097,13 @@ If zones overlap, the first zone that validates the test is returned.

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -74593,10 +74593,10 @@ DBObject = SET_PLAYER:New()
-

SET_PLAYER:FindNearestObjectFromPointVec2(PointVec2)

+

SET_PLAYER:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -74608,13 +74608,13 @@ DBObject = SET_PLAYER:New()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -81024,10 +81024,10 @@ Thus we will get a smooth percentage decrease, if you use this e.g. as success c
-

SET_SCENERY:FindNearestObjectFromPointVec2(PointVec2)

+

SET_SCENERY:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -81039,13 +81039,13 @@ Thus we will get a smooth percentage decrease, if you use this e.g. as success c

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -88139,10 +88139,10 @@ DBObject = SET_STATIC:New()
-

SET_STATIC:FindNearestObjectFromPointVec2(PointVec2)

+

SET_STATIC:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -88154,13 +88154,13 @@ DBObject = SET_STATIC:New()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -95869,10 +95869,10 @@ MySetUnit:SetCargoBayWeightLimit()
-

SET_UNIT:FindNearestObjectFromPointVec2(PointVec2)

+

SET_UNIT:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -95884,13 +95884,13 @@ MySetUnit:SetCargoBayWeightLimit()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -103027,10 +103027,10 @@ DatabaseSet = SET_ZONE:New()
-

SET_ZONE:FindNearestObjectFromPointVec2(PointVec2)

+

SET_ZONE:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -103042,13 +103042,13 @@ DatabaseSet = SET_ZONE:New()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

@@ -109423,10 +109423,10 @@ DatabaseSet = SET_ZONE_GOAL:New()
-

SET_ZONE_GOAL:FindNearestObjectFromPointVec2(PointVec2)

+

SET_ZONE_GOAL:FindNearestObjectFromPointVec2(Coordinate)

-

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#POINT_VEC2.

+

Iterate the SET_BASE while identifying the nearest object in the set from a Core.Point#COORDINATE.

@@ -109438,13 +109438,13 @@ DatabaseSet = SET_ZONE_GOAL:New()

- Core.Point#POINT_VEC2 - PointVec2 + Core.Point#COORDINATE + Coordinate

-

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+

A Core.Point#COORDINATE object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 88b421b62..3b7a05981 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -3074,6 +3074,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -5231,6 +5242,17 @@ It is advised to use this method at the start of the mission.

+
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 7bc8018b2..56b3b52a7 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2571,7 +2571,7 @@ and any spaces before and after the resulting name are removed.

SPAWN:SpawnFromPointVec2(PointVec2, MinHeight, MaxHeight, SpawnIndex)

-

Will spawn a group from a POINT_VEC2 in 3D space.

+

Will spawn a group from a COORDINATE in 3D space.

@@ -3208,6 +3208,42 @@ and any spaces before and after the resulting name are removed.

SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

+ + + +

SPAWN.communication

+ + + + + +

SPAWN.frequency

+ + + + + +

SPAWN.hidden

+ + + + + +

SPAWN.livery_id

+ + + + + +

SPAWN.modulation

+ + + + + +

SPAWN.skill

+ + @@ -3882,14 +3918,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.

-
@@ -4036,20 +4069,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.

-
@@ -4083,6 +4102,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnGrouping + + +
@@ -4273,6 +4303,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Overwrite unit names by default with group name.

+
@@ -4298,39 +4331,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModexPostfix - - - -
- -
- @@ -4558,6 +4558,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -4592,7 +4603,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

@@ -4666,6 +4677,72 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.hidden + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + + +
+ +
+
+
+ + +SPAWN.skill + + +
@@ -8536,7 +8613,7 @@ You can use the returned group to further define the route to be followed.

SPAWN:SpawnFromPointVec2(PointVec2, MinHeight, MaxHeight, SpawnIndex)

-

Will spawn a group from a POINT_VEC2 in 3D space.

+

Will spawn a group from a COORDINATE in 3D space.

This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. @@ -8553,13 +8630,13 @@ You can use the returned group to further define the route to be followed.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE PointVec2

-

The PointVec2 coordinates where to spawn the group.

+

The coordinates where to spawn the group.

@@ -8652,13 +8729,13 @@ You can use the returned group to further define the route to be followed.

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE PointVec3

-

The PointVec3 coordinates where to spawn the group.

+

The COORDINATE coordinates where to spawn the group.

@@ -10373,14 +10450,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.

-
@@ -10527,20 +10601,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.

-
@@ -10574,6 +10634,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + +SPAWN.SpawnGrouping + + +
@@ -10764,6 +10835,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Overwrite unit names by default with group name.

+
@@ -10789,39 +10863,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - -SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModexPostfix - - - -
- -
- @@ -11049,6 +11090,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -11083,7 +11135,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

@@ -11157,6 +11209,72 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.hidden + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + + +
+ +
+
+
+ + +SPAWN.skill + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 130cb7488..2e531c1e8 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1798,7 +1798,7 @@ such as position and heading.

  • SPAWNSTATIC.Spawn(Heading, NewName) spawns the static with the set parameters. Optionally, heading and name can be given. The name must be unique!
  • SPAWNSTATIC.SpawnFromCoordinate(Coordinate, Heading, NewName) spawn the static at the given coordinate. Optionally, heading and name can be given. The name must be unique!
    • -
  • SPAWNSTATIC.SpawnFromPointVec2(PointVec2, Heading, NewName) spawns the static at a POINT_VEC2 coordinate. Optionally, heading and name can be given. The name must be unique!
    • +
  • SPAWNSTATIC.SpawnFromPointVec2(PointVec2, Heading, NewName) spawns the static at a COORDINATE coordinate. Optionally, heading and name can be given. The name must be unique!
  • SPAWNSTATIC.SpawnFromZone(Zone, Heading, NewName) spawns the static at the center of a Core.Zone. Optionally, heading and name can be given. The name must be unique!
@@ -2067,7 +2067,7 @@ such as position and heading.

SPAWNSTATIC:SpawnFromPointVec2(PointVec2, Heading, NewName)

-

Creates a new Wrapper.Static from a POINT_VEC2.

+

Creates a new Wrapper.Static from a COORDINATE.

@@ -2116,6 +2116,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

+ + @@ -3125,11 +3143,44 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+ @@ -4248,7 +4299,7 @@ Handy if you spawn from cargo statics which have resources already set.

SPAWNSTATIC:SpawnFromPointVec2(PointVec2, Heading, NewName)

-

Creates a new Wrapper.Static from a POINT_VEC2.

+

Creates a new Wrapper.Static from a COORDINATE.

@@ -4260,7 +4311,7 @@ Handy if you spawn from cargo statics which have resources already set.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE PointVec2

@@ -4737,11 +4788,44 @@ Handy if you spawn from cargo statics which have resources already set.

+ +
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+ diff --git a/Documentation/Core.Zone.html b/Documentation/Core.Zone.html index b5f643d36..0a9f0d65d 100644 --- a/Documentation/Core.Zone.html +++ b/Documentation/Core.Zone.html @@ -2072,8 +2072,8 @@ This class is an abstract BASE class for derived classes, and is not meant to be

Draw zone

@@ -2136,8 +2136,8 @@ This class is an abstract BASE class for derived classes, and is not meant to be

Draw zone

@@ -2255,7 +2255,7 @@ This class implements the inherited functions from #ZONE

ZONE_AIRBASE:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

@@ -2420,13 +2420,13 @@ This class implements the inherited functions from #ZONE

ZONE_BASE:GetPointVec2(Height)

-

Returns a Core.Point#POINT_VEC2 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

ZONE_BASE:GetPointVec3(Height)

-

Returns a Core.Point#POINT_VEC3 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

@@ -2438,13 +2438,13 @@ This class implements the inherited functions from #ZONE

ZONE_BASE:GetRandomPointVec2()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

ZONE_BASE:GetRandomPointVec3()

-

Define a random Core.Point#POINT_VEC3 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

@@ -3737,7 +3737,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_GROUP:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

@@ -3825,13 +3825,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_OVAL:GetRandomPointVec2()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

ZONE_OVAL:GetRandomPointVec3()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

@@ -4019,13 +4019,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_OVAL:GetPointVec2(Height)

-

Returns a Core.Point#POINT_VEC2 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

ZONE_OVAL:GetPointVec3(Height)

-

Returns a Core.Point#POINT_VEC3 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

@@ -4037,13 +4037,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_OVAL:GetRandomPointVec2()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

ZONE_OVAL:GetRandomPointVec3()

-

Define a random Core.Point#POINT_VEC3 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

@@ -5407,13 +5407,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_POLYGON_BASE:GetRandomPointVec2()

-

Return a Core.Point#POINT_VEC2 object representing a random 2D point at landheight within the zone.

+

Return a Core.Point#COORDINATE object representing a random 2D point at landheight within the zone.

ZONE_POLYGON_BASE:GetRandomPointVec3()

-

Return a Core.Point#POINT_VEC3 object representing a random 3D point at landheight within the zone.

+

Return a Core.Point#COORDINATE object representing a random 3D point at landheight within the zone.

@@ -5637,13 +5637,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_RADIUS:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

ZONE_RADIUS:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

@@ -5960,13 +5960,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_UNIT:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

ZONE_UNIT:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

@@ -6338,13 +6338,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

_ZONE_TRIANGLE:GetPointVec2(Height)

-

Returns a Core.Point#POINT_VEC2 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

_ZONE_TRIANGLE:GetPointVec3(Height)

-

Returns a Core.Point#POINT_VEC3 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

@@ -6356,13 +6356,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

_ZONE_TRIANGLE:GetRandomPointVec2()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

_ZONE_TRIANGLE:GetRandomPointVec3()

-

Define a random Core.Point#POINT_VEC3 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

@@ -7672,7 +7672,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_AIRBASE:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -7713,11 +7713,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -8428,7 +8428,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_BASE:GetPointVec2(Height)

-

Returns a Core.Point#POINT_VEC2 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

@@ -8453,11 +8453,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The PointVec2 of the zone.

+

The COORDINATE of the zone.

@@ -8472,7 +8472,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_BASE:GetPointVec3(Height)

-

Returns a Core.Point#POINT_VEC3 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

@@ -8497,7 +8497,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

@@ -8567,7 +8567,7 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

ZONE_BASE:GetRandomPointVec2()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -8581,11 +8581,11 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The PointVec2 coordinates.

+

The COORDINATE coordinates.

@@ -8600,7 +8600,7 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

ZONE_BASE:GetRandomPointVec3()

-

Define a random Core.Point#POINT_VEC3 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -8614,11 +8614,11 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

-

The PointVec3 coordinates.

+

The COORDINATE coordinates.

@@ -8960,7 +8960,7 @@ end

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE PointVec3

@@ -16229,7 +16229,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

ZONE_GROUP:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -16270,11 +16270,11 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -16753,7 +16753,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

ZONE_OVAL:GetRandomPointVec2()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -16767,11 +16767,11 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The PointVec2 coordinates.

+

The COORDINATE coordinates.

@@ -16786,7 +16786,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

ZONE_OVAL:GetRandomPointVec3()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -16800,11 +16800,11 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The PointVec2 coordinates.

+

The COORDINATE coordinates.

@@ -17658,7 +17658,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

ZONE_OVAL:GetPointVec2(Height)

-

Returns a Core.Point#POINT_VEC2 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

@@ -17683,11 +17683,11 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The PointVec2 of the zone.

+

The COORDINATE of the zone.

@@ -17702,7 +17702,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

ZONE_OVAL:GetPointVec3(Height)

-

Returns a Core.Point#POINT_VEC3 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

@@ -17727,7 +17727,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

@@ -17797,7 +17797,7 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

ZONE_OVAL:GetRandomPointVec2()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -17811,11 +17811,11 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The PointVec2 coordinates.

+

The COORDINATE coordinates.

@@ -17830,7 +17830,7 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

ZONE_OVAL:GetRandomPointVec3()

-

Define a random Core.Point#POINT_VEC3 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -17844,11 +17844,11 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

-

The PointVec3 coordinates.

+

The COORDINATE coordinates.

@@ -18190,7 +18190,7 @@ end

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE PointVec3

@@ -26145,7 +26145,7 @@ Note that only after a zone has been scanned, the zone can be e

ZONE_POLYGON_BASE:GetRandomPointVec2()

-

Return a Core.Point#POINT_VEC2 object representing a random 2D point at landheight within the zone.

+

Return a Core.Point#COORDINATE object representing a random 2D point at landheight within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -26162,7 +26162,7 @@ Note that only after a zone has been scanned, the zone can be e
-

Core.Point#POINT_VEC2

+

Core.Point#COORDINATE

@@ -26177,7 +26177,7 @@ Note that only after a zone has been scanned, the zone can be e

ZONE_POLYGON_BASE:GetRandomPointVec3()

-

Return a Core.Point#POINT_VEC3 object representing a random 3D point at landheight within the zone.

+

Return a Core.Point#COORDINATE object representing a random 3D point at landheight within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -26194,7 +26194,7 @@ Note that only after a zone has been scanned, the zone can be e
-

Core.Point#POINT_VEC3

+

Core.Point#COORDINATE

@@ -27806,7 +27806,7 @@ Note that only after a zone has been scanned, the zone can be e

ZONE_RADIUS:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -27847,11 +27847,11 @@ Note that only after a zone has been scanned, the zone can be e

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -27866,7 +27866,7 @@ Note that only after a zone has been scanned, the zone can be e

ZONE_RADIUS:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -27907,11 +27907,11 @@ Note that only after a zone has been scanned, the zone can be e

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC3 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -30082,7 +30082,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the

ZONE_UNIT:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -30123,11 +30123,11 @@ Note that once a zone has been scanned, multiple evaluations can be done on the

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -30142,7 +30142,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the

ZONE_UNIT:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -30183,11 +30183,11 @@ Note that once a zone has been scanned, multiple evaluations can be done on the

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC3 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -32356,7 +32356,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the

_ZONE_TRIANGLE:GetPointVec2(Height)

-

Returns a Core.Point#POINT_VEC2 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

@@ -32381,11 +32381,11 @@ Note that once a zone has been scanned, multiple evaluations can be done on the

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The PointVec2 of the zone.

+

The COORDINATE of the zone.

@@ -32400,7 +32400,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the

_ZONE_TRIANGLE:GetPointVec3(Height)

-

Returns a Core.Point#POINT_VEC3 of the zone.

+

Returns a Core.Point#COORDINATE of the zone.

@@ -32425,7 +32425,7 @@ Note that once a zone has been scanned, multiple evaluations can be done on the

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

@@ -32495,7 +32495,7 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

_ZONE_TRIANGLE:GetRandomPointVec2()

-

Define a random Core.Point#POINT_VEC2 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -32509,11 +32509,11 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The PointVec2 coordinates.

+

The COORDINATE coordinates.

@@ -32528,7 +32528,7 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

_ZONE_TRIANGLE:GetRandomPointVec3()

-

Define a random Core.Point#POINT_VEC3 within the zone.

+

Define a random Core.Point#COORDINATE within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -32542,11 +32542,11 @@ local PropertyValue = PropertiesZone:GetProperty(Property)

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

-

The PointVec3 coordinates.

+

The COORDINATE coordinates.

@@ -32888,7 +32888,7 @@ end

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE PointVec3

diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index 0578a9ac0..6f354826b 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -4116,7 +4116,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table ATC_GROUND.Airbases @@ -4132,6 +4132,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Kickspeed

+
@@ -4701,7 +4704,7 @@ An airbase can be specified to set the maximum kick speed for.

- + #table ATC_GROUND.Airbases @@ -4717,6 +4720,9 @@ An airbase can be specified to set the maximum kick speed for.

+ +

Kickspeed

+
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 0c5fd7bd8..fd387ab40 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2646,17 +2646,6 @@ Use the method DESIGNATE.SetMission() to -
- -
-
-
- - -DESIGNATE.LaseDuration - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 8f6581a55..ae441bbc3 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -20322,17 +20322,6 @@ When moose is loading dynamically (for moose class development), tracing is swit -
- -
-
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -25087,17 +25076,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -26840,17 +26818,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #boolean -DETECTION_BASE.Locking - - -
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index d60a06990..fc8c8780a 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -4332,17 +4332,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The #DETECTION_AREAS object for AWACS

-
- -
-
-
- - -MANTIS.AWACS_Prefix - - -
@@ -4492,7 +4481,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_Long @@ -4503,7 +4492,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_Medium @@ -4514,7 +4503,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_PointDef @@ -4525,7 +4514,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_Short @@ -4682,8 +4671,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -MANTIS.SkateZones + #number +MANTIS.SkateNumber @@ -9123,17 +9112,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The #DETECTION_AREAS object for AWACS

-
- -
-
-
- - -MANTIS.AWACS_Prefix - - -
@@ -9283,7 +9261,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_Long @@ -9294,7 +9272,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_Medium @@ -9305,7 +9283,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_PointDef @@ -9316,7 +9294,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_Short @@ -9473,8 +9451,8 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- -MANTIS.SkateZones + #number +MANTIS.SkateNumber diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index da8283880..a07f5db09 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -2429,6 +2429,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + #number +MOVEMENT.AliveUnits + + + + +

Contains the counter how many units are currently alive.

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

Field(s)

+
+
+ + #number +MOVEMENT.AliveUnits + + + + +

Contains the counter how many units are currently alive.

+ +
+ +
diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index 5cb86005e..da4493c89 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -3551,12 +3551,6 @@ manager:Stop(7200)

RAT.termtype

Type of terminal to be used when spawning at an airbase.

- - - -

RAT.type

- - @@ -4127,7 +4121,7 @@ and any spaces before and after the resulting name are removed.

RAT:SpawnFromPointVec2(PointVec2, MinHeight, MaxHeight, SpawnIndex)

-

Will spawn a group from a POINT_VEC2 in 3D space.

+

Will spawn a group from a COORDINATE in 3D space.

@@ -4764,6 +4758,42 @@ and any spaces before and after the resulting name are removed.

RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

+ + + +

RAT.communication

+ + + + + +

RAT.frequency

+ + + + + +

RAT.hidden

+ + + + + +

RAT.livery_id

+ + + + + +

RAT.modulation

+ + + + + +

RAT.skill

+ + @@ -7311,17 +7341,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Type of terminal to be used when spawning at an airbase.

-
- -
-
-
- - -RAT.type - - -
@@ -15202,17 +15221,6 @@ Initializes the ratcraft array and group menu.

Type of terminal to be used when spawning at an airbase.

-
- -
-
-
- - -RAT.type - - -
@@ -19149,7 +19157,7 @@ You can use the returned group to further define the route to be followed.

RAT:SpawnFromPointVec2(PointVec2, MinHeight, MaxHeight, SpawnIndex)

-

Will spawn a group from a POINT_VEC2 in 3D space.

+

Will spawn a group from a COORDINATE in 3D space.

This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. @@ -19166,13 +19174,13 @@ You can use the returned group to further define the route to be followed.

- Core.Point#POINT_VEC2 + Core.Point#COORDINATE PointVec2

-

The PointVec2 coordinates where to spawn the group.

+

The coordinates where to spawn the group.

@@ -19265,13 +19273,13 @@ You can use the returned group to further define the route to be followed.

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE PointVec3

-

The PointVec3 coordinates where to spawn the group.

+

The COORDINATE coordinates where to spawn the group.

@@ -22116,17 +22124,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Type of terminal to be used when spawning at an airbase.

-
- -
-
-
- - -RAT.type - - -
diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index cb56f15ff..6a3e48b55 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -3278,7 +3278,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SCORING.penaltyonfratricide @@ -6201,7 +6201,7 @@ The scale magnifies the scores given to the players.

- #boolean + SCORING.penaltyonfratricide diff --git a/Documentation/Functional.ZoneCaptureCoalition.html b/Documentation/Functional.ZoneCaptureCoalition.html index 572bda1b3..3fe1dbee3 100644 --- a/Documentation/Functional.ZoneCaptureCoalition.html +++ b/Documentation/Functional.ZoneCaptureCoalition.html @@ -2628,13 +2628,13 @@ We start the monitoring after 5 seconds, and will repeat every 30 seconds a chec

ZONE_CAPTURE_COALITION:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

ZONE_CAPTURE_COALITION:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

@@ -5966,7 +5966,7 @@ end

ZONE_CAPTURE_COALITION:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -6007,11 +6007,11 @@ end

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -6026,7 +6026,7 @@ end

ZONE_CAPTURE_COALITION:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -6067,11 +6067,11 @@ end

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC3 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

diff --git a/Documentation/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index 7b1370bee..a5bbdef8b 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -1943,13 +1943,13 @@ Derived classes implement the ways how the achievements can be realized.

ZONE_GOAL:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

ZONE_GOAL:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

@@ -3291,7 +3291,7 @@ Derived classes implement the ways how the achievements can be realized.

ZONE_GOAL:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -3332,11 +3332,11 @@ Derived classes implement the ways how the achievements can be realized.

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -3351,7 +3351,7 @@ Derived classes implement the ways how the achievements can be realized.

ZONE_GOAL:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -3392,11 +3392,11 @@ Derived classes implement the ways how the achievements can be realized.

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC3 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

diff --git a/Documentation/Functional.ZoneGoalCargo.html b/Documentation/Functional.ZoneGoalCargo.html index 2a718c4e8..250fb5b49 100644 --- a/Documentation/Functional.ZoneGoalCargo.html +++ b/Documentation/Functional.ZoneGoalCargo.html @@ -2186,13 +2186,13 @@ Therefore, this class is considered to be deprecated

ZONE_GOAL_CARGO:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

ZONE_GOAL_CARGO:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

@@ -4631,7 +4631,7 @@ Therefore, this class is considered to be deprecated

ZONE_GOAL_CARGO:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -4672,11 +4672,11 @@ Therefore, this class is considered to be deprecated

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -4691,7 +4691,7 @@ Therefore, this class is considered to be deprecated

ZONE_GOAL_CARGO:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -4732,11 +4732,11 @@ Therefore, this class is considered to be deprecated

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC3 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

diff --git a/Documentation/Functional.ZoneGoalCoalition.html b/Documentation/Functional.ZoneGoalCoalition.html index c77d78385..2d670c4f2 100644 --- a/Documentation/Functional.ZoneGoalCoalition.html +++ b/Documentation/Functional.ZoneGoalCoalition.html @@ -2029,13 +2029,13 @@ Derived classes implement the ways how the achievements can be realized.

ZONE_GOAL_COALITION:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

ZONE_GOAL_COALITION:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

@@ -3774,7 +3774,7 @@ Derived classes implement the ways how the achievements can be realized.

ZONE_GOAL_COALITION:GetRandomPointVec2(inner, outer)

-

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

@@ -3815,11 +3815,11 @@ Derived classes implement the ways how the achievements can be realized.

Return value:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

@@ -3834,7 +3834,7 @@ Derived classes implement the ways how the achievements can be realized.

ZONE_GOAL_COALITION:GetRandomPointVec3(inner, outer)

-

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

+

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

@@ -3875,11 +3875,11 @@ Derived classes implement the ways how the achievements can be realized.

Return value:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

-

The Core.Point#POINT_VEC3 object reflecting the random 3D location within the zone.

+

The Core.Point#COORDINATE object reflecting the random 3D location within the zone.

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index db0352ca3..77c719a7d 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -9779,6 +9779,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

+
+ +
+
+
+ + +AIRBOSS.RQLid + + +
@@ -9790,6 +9801,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of marshal.

+
+ +
+
+
+ + +AIRBOSS.RQMid + + +
@@ -30127,6 +30149,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

+
+ +
+
+
+ + +AIRBOSS.RQLid + + +
@@ -30138,6 +30171,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

+
+ +
+
+
+ + +AIRBOSS.RQMid + + +
@@ -33217,6 +33261,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

+
+ +
+
+
+ + +AIRBOSS.RQLid + + +
@@ -33228,6 +33283,17 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

+
+ +
+
+
+ + +AIRBOSS.RQMid + + +
@@ -41280,9 +41346,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Set case of f

-
@@ -41351,7 +41414,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Set stack flag.

+

Also decrease flag for section members of flight.

@@ -41514,7 +41577,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Make player section lead if he was not before.

+

Set section lead of player flight.

@@ -41574,6 +41637,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

Set new time stamp.

+
@@ -41732,6 +41798,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

Band modulation.

+
+ +
+
+
+ + +AIRBOSS.Radio.voice + + +
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 3f5d0b595..6e888bbc2 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -4671,14 +4671,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.csarUnits - -

table of CSAR unit names

-
@@ -10924,14 +10921,11 @@ callsigns from playername or group name.

- #table + CSAR.csarUnits - -

table of CSAR unit names

-
@@ -13443,14 +13437,11 @@ callsigns from playername or group name.

- #table + CSAR.csarUnits - -

table of CSAR unit names

-
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index d4e3f3ef6..305cddeeb 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -2306,6 +2306,21 @@ If you use units build by multiple templates, they will effectively double on lo end +

8. Transport crates and troops with CA (Combined Arms) trucks

+ +

You can optionally also allow to CTLD with CA trucks and other vehicles:

+ +
     -- Create a SET_CLIENT to capture CA vehicles steered by players
+     local truckers = SET_CLIENT:New():HandleCASlots():FilterCoalitions("blue"):FilterPrefixes("Truck"):FilterStart()
+     -- Allow CA transport
+     my_ctld:AllowCATransport(true,truckers)
+     -- Set truck capability by typename
+     my_ctld:SetUnitCapabilities("M 818", true, true, 2, 12, 9, 4500)
+     -- Alternatively set truck capability with a UNIT object
+     local GazTruck = UNIT:FindByName("GazTruck-1-1")
+     my_ctld:SetUnitCapabilities(GazTruck, true, true, 2, 12, 9, 4500)
+
+
@@ -2463,12 +2478,24 @@ If you use units build by multiple templates, they will effectively double on lo

CTLD:AddZone(Zone)

User function - Add a #CTLD.CargoZoneType zone for this CTLD instance.

+ + + +

CTLD:AllowCATransport(OnOff, ClientSet)

+ +

(User) Function to allow transport via Combined Arms Trucks.

CTLD:AutoHoverLoad(Unit)

(Internal) Autoload if we can do crates, have capacity free and are in a load zone.

+ + + +

CTLD.CATransportSet

+ + @@ -3489,6 +3516,12 @@ If you use units build by multiple templates, they will effectively double on lo

CTLD.alias

+ + + +

CTLD.allowCATransport

+ + @@ -5108,6 +5141,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

CTLD.UnitTypeCapabilities.Ka-50_3

+ + + +

CTLD.UnitTypeCapabilities.M 818

+ + @@ -8380,6 +8419,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+ +
+
+ + #number +CTLD.CargoCounter + + + +
+ +
@@ -8520,6 +8581,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ + #number +CTLD.Engineers + + + + +

use as counter

+ +
+
@@ -8616,7 +8691,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeFMFrequencies @@ -8638,7 +8713,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.FreeVHFFrequencies @@ -8696,14 +8771,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.PilotGroups - -

tables

-
@@ -8732,14 +8804,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string CTLD.RadioPath - -

Folderpath.

-
@@ -8786,7 +8855,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#table -CTLD.Spawned_Cargo +CTLD.Spawned_Crates @@ -8796,8 +8865,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table -CTLD.Spawned_Crates + #number +CTLD.TroopCounter @@ -8852,7 +8921,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-CTLD.UserSetGroup +CTLD.alias @@ -8862,8 +8931,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -CTLD.alias + #boolean +CTLD.allowCATransport @@ -8992,17 +9061,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#1570

-
- -
-
-
- - #table -CTLD.droppedBeacons - - -
@@ -9295,7 +9353,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

noob catch

+

time to repairor build a unit/group

@@ -9394,7 +9452,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + CTLD.troopdropzoneradius @@ -9432,6 +9490,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

sub categories

+
@@ -10677,6 +10738,63 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+ +
+ +
+

CTLD:AllowCATransport(OnOff, ClientSet)

+
+ +

(User) Function to allow transport via Combined Arms Trucks.

+ +
+
+

Defined in:

+
+

CTLD

+
+

Parameters:

+
+
+

+ #boolean + OnOff +

+
+
+ +

Switch on (true) or off (false).

+ +
+
+
+
+

+ Core.Set#SET_CLIENT + ClientSet +

+
+
+ +

The CA handling client set for ground transport.

+ +
+
+

Return value:

+
+
+

#CTLD:

+
+
+ +

self

+ +
+
+
+
@@ -20113,6 +20231,28 @@ However, if you create a new folder inside the miz file, which contains the soun

Field(s)

+ +
+
+ + #number +CTLD.CargoCounter + + + +
+ +
@@ -20253,6 +20393,20 @@ However, if you create a new folder inside the miz file, which contains the soun
+
+
+
+ + #number +CTLD.Engineers + + + + +

use as counter

+ +
+
@@ -20349,7 +20503,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeFMFrequencies @@ -20371,7 +20525,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies @@ -20429,14 +20583,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.PilotGroups - -

tables

-
@@ -20465,14 +20616,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #string CTLD.RadioPath - -

Folderpath.

-
@@ -20519,7 +20667,7 @@ However, if you create a new folder inside the miz file, which contains the soun
#table -CTLD.Spawned_Cargo +CTLD.Spawned_Crates @@ -20529,8 +20677,8 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table -CTLD.Spawned_Crates + #number +CTLD.TroopCounter @@ -20585,7 +20733,7 @@ However, if you create a new folder inside the miz file, which contains the soun
-CTLD.UserSetGroup +CTLD.alias @@ -20595,8 +20743,8 @@ However, if you create a new folder inside the miz file, which contains the soun
- -CTLD.alias + #boolean +CTLD.allowCATransport @@ -20725,17 +20873,6 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

-
- -
-
-
- - #table -CTLD.droppedBeacons - - -
@@ -21028,7 +21165,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

noob catch

+

time to repairor build a unit/group

@@ -21127,7 +21264,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number + CTLD.troopdropzoneradius @@ -21165,6 +21302,9 @@ However, if you create a new folder inside the miz file, which contains the soun + +

sub categories

+
@@ -22646,6 +22786,28 @@ However, if you create a new folder inside the miz file, which contains the soun

Field(s)

+ +
+
+ + #number +CTLD.CargoCounter + + + +
+ +
@@ -22786,6 +22948,20 @@ However, if you create a new folder inside the miz file, which contains the soun
+
+
+
+ + #number +CTLD.Engineers + + + + +

use as counter

+ +
+
@@ -22882,7 +23058,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeFMFrequencies @@ -22904,7 +23080,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies @@ -22962,14 +23138,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.PilotGroups - -

tables

-
@@ -22998,14 +23171,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #string CTLD.RadioPath - -

Folderpath.

-
@@ -23052,7 +23222,7 @@ However, if you create a new folder inside the miz file, which contains the soun
#table -CTLD.Spawned_Cargo +CTLD.Spawned_Crates @@ -23062,8 +23232,8 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table -CTLD.Spawned_Crates + #number +CTLD.TroopCounter @@ -23118,7 +23288,7 @@ However, if you create a new folder inside the miz file, which contains the soun
-CTLD.UserSetGroup +CTLD.alias @@ -23128,8 +23298,8 @@ However, if you create a new folder inside the miz file, which contains the soun
- -CTLD.alias + #boolean +CTLD.allowCATransport @@ -23258,17 +23428,6 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

-
- -
-
-
- - #table -CTLD.droppedBeacons - - -
@@ -23561,7 +23720,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

noob catch

+

time to repairor build a unit/group

@@ -23660,7 +23819,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number + CTLD.troopdropzoneradius @@ -23698,6 +23857,9 @@ However, if you create a new folder inside the miz file, which contains the soun + +

sub categories

+
@@ -28024,6 +28186,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+
+
+ + #table +CTLD.UnitTypeCapabilities.M 818 + + +
@@ -28222,17 +28395,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Can transport crate.

-
- -
-
-
- - #number -CTLD.UnitTypeCapabilities.length - - -
@@ -39097,7 +39259,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE Cargo_Drop_Position

@@ -39170,7 +39332,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE Cargo_Drop_Position

@@ -39419,7 +39581,7 @@ When moose is loading dynamically (for moose class development), tracing is swit

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE Cargo_Drop_Position

@@ -39827,7 +39989,7 @@ Use either this method to integrate the Hercules **or** the one from the "normal

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE Cargo_Drop_Position

diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 3fbda809f..75b45b01d 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -3100,7 +3100,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -3825,7 +3825,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -5001,7 +5001,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -6479,7 +6479,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_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 2c9701c2b..ba10b8f82 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -3370,11 +3370,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -3947,11 +3950,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -5134,11 +5140,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -6623,11 +6632,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
diff --git a/Documentation/Tasking.Task_CARGO.html b/Documentation/Tasking.Task_CARGO.html index 2f31081ee..079e6b201 100644 --- a/Documentation/Tasking.Task_CARGO.html +++ b/Documentation/Tasking.Task_CARGO.html @@ -3313,22 +3313,11 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo -
- -
-
-
- - -FSM_PROCESS.DeployZone - - -
@@ -3361,7 +3350,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4783,7 +4772,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -9315,7 +9304,7 @@ If the Unit is part of the Task, true is returned.

- #number + TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 337d1d0a5..d08ba0fb4 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3415,6 +3415,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
@@ -3426,6 +3437,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+ @@ -4554,6 +4576,17 @@ This method can only be used once!

+
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
@@ -4565,6 +4598,17 @@ This method can only be used once!

+
+ +
+ @@ -5445,6 +5489,17 @@ This method can only be used once!

+
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
@@ -5456,6 +5511,17 @@ This method can only be used once!

+
+ +
+ @@ -6967,6 +7033,17 @@ This method can only be used once!

+
+ +
+
+
+ + #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
@@ -6978,6 +7055,17 @@ This method can only be used once!

+
+ +
+ diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index 66a6a4905..599958ff0 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -8282,17 +8282,6 @@ When moose is loading dynamically (for moose class development), tracing is swit -
- -
-
-
- - #number -LIFO.uniquecounter - - -
@@ -9142,17 +9131,6 @@ When moose is loading dynamically (for moose class development), tracing is swit -
- -
-
-
- - #number -LIFO.uniquecounter - - -
diff --git a/Documentation/Wrapper.Airbase.html b/Documentation/Wrapper.Airbase.html index 099b1d742..8b5a1a215 100644 --- a/Documentation/Wrapper.Airbase.html +++ b/Documentation/Wrapper.Airbase.html @@ -2958,13 +2958,13 @@ Waiting for Ugra and ED to fix this issue.

AIRBASE:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

AIRBASE:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -9921,7 +9921,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

AIRBASE:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -9932,11 +9932,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -9959,7 +9959,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

AIRBASE:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -9970,7 +9970,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 0e6251439..d0f911739 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -2641,6 +2641,24 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return

CLIENT:CommandSetUnlimitedFuel(OnOff, Delay)

Set unlimited fuel.

+ + + +

CLIENT:CommandSmokeOFF(Delay)

+ +

[AIR] Set smoke off.

+ + + +

CLIENT:CommandSmokeON(Delay)

+ +

[AIR] Set smoke on.

+ + + +

CLIENT:CommandSmokeOnOff(OnOff, Delay)

+ +

[AIR] Set smoke on or off.

@@ -4010,13 +4028,13 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return

CLIENT:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

CLIENT:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -10799,6 +10817,160 @@ Note that a controllable can only have one beacon activated at a time with the e
+
+
+ +
+ +
+

CLIENT:CommandSmokeOFF(Delay)

+
+ +

[AIR] Set smoke off.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

Wrapper.Controllable#CONTROLLABLE

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

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

CLIENT:CommandSmokeON(Delay)

+
+ +

[AIR] Set smoke on.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

Wrapper.Controllable#CONTROLLABLE

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

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

CLIENT:CommandSmokeOnOff(OnOff, Delay)

+
+ +

[AIR] Set smoke on or off.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

Wrapper.Controllable#CONTROLLABLE

+
+

Parameters:

+
+
+

+ #boolean + OnOff +

+
+
+ +

Set to true for on and false for off. Defaults to true.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

+ +
+
+
+
@@ -24493,7 +24665,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

CLIENT:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -24504,11 +24676,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -24531,7 +24703,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

CLIENT:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -24542,7 +24714,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

diff --git a/Documentation/Wrapper.Controllable.html b/Documentation/Wrapper.Controllable.html index 5b5a00d75..df7cd26a1 100644 --- a/Documentation/Wrapper.Controllable.html +++ b/Documentation/Wrapper.Controllable.html @@ -2023,6 +2023,24 @@ The method CONTROLLABLE.SetTaskWaypoi

CONTROLLABLE:CommandSetUnlimitedFuel(OnOff, Delay)

Set unlimited fuel.

+ + + +

CONTROLLABLE:CommandSmokeOFF(Delay)

+ +

[AIR] Set smoke off.

+ + + +

CONTROLLABLE:CommandSmokeON(Delay)

+ +

[AIR] Set smoke on.

+ + + +

CONTROLLABLE:CommandSmokeOnOff(OnOff, Delay)

+ +

[AIR] Set smoke on or off.

@@ -3392,13 +3410,13 @@ The method CONTROLLABLE.SetTaskWaypoi

CONTROLLABLE:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

CONTROLLABLE:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -4533,17 +4551,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The DCS controllable class.

-
- -
-
-
- - #boolean -CONTROLLABLE.IRMarkerUnit - - -
@@ -4566,17 +4573,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -CONTROLLABLE.timer - - -
@@ -5620,6 +5616,160 @@ Note that a controllable can only have one beacon activated at a time with the e
+
+
+ +
+ +
+

CONTROLLABLE:CommandSmokeOFF(Delay)

+
+ +

[AIR] Set smoke off.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

CONTROLLABLE

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

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

CONTROLLABLE:CommandSmokeON(Delay)

+
+ +

[AIR] Set smoke on.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

CONTROLLABLE

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

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

CONTROLLABLE:CommandSmokeOnOff(OnOff, Delay)

+
+ +

[AIR] Set smoke on or off.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

CONTROLLABLE

+
+

Parameters:

+
+
+

+ #boolean + OnOff +

+
+
+ +

Set to true for on and false for off. Defaults to true.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

+ +
+
+
+
@@ -17643,17 +17793,6 @@ mygroup:WayPointExecute()

The DCS controllable class.

-
- -
-
-
- - #boolean -CONTROLLABLE.IRMarkerUnit - - -
@@ -17676,17 +17815,6 @@ mygroup:WayPointExecute() -
- -
-
-
- - -CONTROLLABLE.timer - - -
@@ -19201,7 +19329,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

CONTROLLABLE:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -19212,11 +19340,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -19239,7 +19367,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

CONTROLLABLE:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -19250,7 +19378,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

@@ -21666,17 +21794,6 @@ Coordinates are dependent on the position of the maps origin.

The DCS controllable class.

-
- -
-
-
- - #boolean -CONTROLLABLE.IRMarkerUnit - - -
@@ -21699,17 +21816,6 @@ Coordinates are dependent on the position of the maps origin.

-
- -
-
-
- - -CONTROLLABLE.timer - - -
@@ -22241,17 +22347,6 @@ If the Identifiable is alive, true is returned.

The DCS controllable class.

-
- -
-
-
- - #boolean -CONTROLLABLE.IRMarkerUnit - - -
@@ -22274,17 +22369,6 @@ If the Identifiable is alive, true is returned.

-
- -
-
-
- - -CONTROLLABLE.timer - - -
@@ -22417,17 +22501,6 @@ If the Identifiable is alive, true is returned.

The DCS controllable class.

-
- -
-
-
- - #boolean -CONTROLLABLE.IRMarkerUnit - - -
@@ -22450,17 +22523,6 @@ If the Identifiable is alive, true is returned.

-
- -
-
-
- - -CONTROLLABLE.timer - - -
diff --git a/Documentation/Wrapper.DynamicCargo.html b/Documentation/Wrapper.DynamicCargo.html index e05d7faf1..695056705 100644 --- a/Documentation/Wrapper.DynamicCargo.html +++ b/Documentation/Wrapper.DynamicCargo.html @@ -1694,18 +1694,18 @@

Main Features:

    -
  • Convenient access to DCS API functions
    • +
  • Convenient access to Ground Crew created cargo items.

Example Missions:

-

Demo missions can be found on github.

+

Demo missions can be found on github.

-

Author: Applevangelist

+

Author: Applevangelist; additional checks Chesster

@@ -1961,6 +1961,12 @@

DYNAMICCARGO:_GetPossibleHeloNearby(pos, loading)

[Internal] _Get Possible Player Helo Nearby

+ + + +

DYNAMICCARGO:_HeloHovering(Unit, ropelength)

+ +

[Internal] _Get helo hovering intel

@@ -2256,13 +2262,13 @@

DYNAMICCARGO:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

DYNAMICCARGO:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -4507,6 +4513,63 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+ +
+ +
+

DYNAMICCARGO:_HeloHovering(Unit, ropelength)

+
+ +

[Internal] _Get helo hovering intel

+ +
+
+

Defined in:

+
+

DYNAMICCARGO

+
+

Parameters:

+
+
+

+ Wrapper.Unit#UNIT + Unit +

+
+
+ +

The Unit to test

+ +
+
+
+
+

+ #number + ropelength +

+
+
+ +

Ropelength to test

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Outcome

+ +
+
+
+
@@ -6263,7 +6326,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

DYNAMICCARGO:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -6274,11 +6337,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -6301,7 +6364,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

DYNAMICCARGO:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -6312,7 +6375,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index a735068e9..1a55f9e5b 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -2233,7 +2233,7 @@ amount of fuel in the group.

GROUP:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the first UNIT of the GROUP within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the first UNIT of the GROUP within the mission.

@@ -2812,6 +2812,24 @@ amount of fuel in the group.

GROUP:CommandSetUnlimitedFuel(OnOff, Delay)

Set unlimited fuel.

+ + + +

GROUP:CommandSmokeOFF(Delay)

+ +

[AIR] Set smoke off.

+ + + +

GROUP:CommandSmokeON(Delay)

+ +

[AIR] Set smoke on.

+ + + +

GROUP:CommandSmokeOnOff(OnOff, Delay)

+ +

[AIR] Set smoke on or off.

@@ -4181,13 +4199,13 @@ amount of fuel in the group.

GROUP:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

GROUP:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -7709,7 +7727,7 @@ Each unit within the group gets evaluated, and the maximum height (= the unit wh

GROUP:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the first UNIT of the GROUP within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the first UNIT of the GROUP within the mission.

@@ -7720,11 +7738,11 @@ Each unit within the group gets evaluated, and the maximum height (= the unit wh

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the first DCS Unit of the GROUP.

+

The 3D point vector of the first DCS Unit of the GROUP.

@@ -11762,6 +11780,160 @@ Note that a controllable can only have one beacon activated at a time with the e
+
+
+ +
+ +
+

GROUP:CommandSmokeOFF(Delay)

+
+ +

[AIR] Set smoke off.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

Wrapper.Controllable#CONTROLLABLE

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

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

GROUP:CommandSmokeON(Delay)

+
+ +

[AIR] Set smoke on.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

Wrapper.Controllable#CONTROLLABLE

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

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

GROUP:CommandSmokeOnOff(OnOff, Delay)

+
+ +

[AIR] Set smoke on or off.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

Wrapper.Controllable#CONTROLLABLE

+
+

Parameters:

+
+
+

+ #boolean + OnOff +

+
+
+ +

Set to true for on and false for off. Defaults to true.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

+ +
+
+
+
@@ -25459,7 +25631,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

GROUP:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -25470,11 +25642,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -25497,7 +25669,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

GROUP:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -25508,7 +25680,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 78bd933b6..7bf2eae9f 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -2027,13 +2027,13 @@ The method POSITIONABLE.GetVelocity()

POSITIONABLE:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

POSITIONABLE:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -4010,7 +4010,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Core.Point#POINT_VEC3 + Core.Point#COORDINATE POSITIONABLE.pointvec3

Point Vec3 object.

@@ -5529,7 +5529,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

POSITIONABLE:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -5540,11 +5540,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -5567,7 +5567,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

POSITIONABLE:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -5578,7 +5578,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

@@ -8055,7 +8055,7 @@ Coordinates are dependent on the position of the maps origin.

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE POSITIONABLE.pointvec3

Point Vec3 object.

@@ -8652,7 +8652,7 @@ If the Identifiable is alive, true is returned.

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE POSITIONABLE.pointvec3

Point Vec3 object.

@@ -8850,7 +8850,7 @@ If the Identifiable is alive, true is returned.

- Core.Point#POINT_VEC3 + Core.Point#COORDINATE POSITIONABLE.pointvec3

Point Vec3 object.

diff --git a/Documentation/Wrapper.Scenery.html b/Documentation/Wrapper.Scenery.html index 8d1b4aeec..47e9fc8fe 100644 --- a/Documentation/Wrapper.Scenery.html +++ b/Documentation/Wrapper.Scenery.html @@ -2138,13 +2138,13 @@

SCENERY:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

SCENERY:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -5698,7 +5698,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

SCENERY:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -5709,11 +5709,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -5736,7 +5736,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

SCENERY:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -5747,7 +5747,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

diff --git a/Documentation/Wrapper.Static.html b/Documentation/Wrapper.Static.html index 0dba118f9..9aa6d2dfc 100644 --- a/Documentation/Wrapper.Static.html +++ b/Documentation/Wrapper.Static.html @@ -2123,13 +2123,13 @@ If the DCS Static object does not exist or is nil, the STATIC methods will retur

STATIC:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

STATIC:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -5501,7 +5501,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

STATIC:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -5512,11 +5512,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -5539,7 +5539,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

STATIC:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -5550,7 +5550,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

diff --git a/Documentation/Wrapper.Unit.html b/Documentation/Wrapper.Unit.html index 6a47ec846..756c442d1 100644 --- a/Documentation/Wrapper.Unit.html +++ b/Documentation/Wrapper.Unit.html @@ -2411,6 +2411,24 @@ If you want to obtain the complete 3D position including orient

UNIT:CommandSetUnlimitedFuel(OnOff, Delay)

Set unlimited fuel.

+ + + +

UNIT:CommandSmokeOFF(Delay)

+ +

[AIR] Set smoke off.

+ + + +

UNIT:CommandSmokeON(Delay)

+ +

[AIR] Set smoke on.

+ + + +

UNIT:CommandSmokeOnOff(OnOff, Delay)

+ +

[AIR] Set smoke on or off.

@@ -3780,13 +3798,13 @@ If you want to obtain the complete 3D position including orient

UNIT:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

UNIT:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -9089,6 +9107,160 @@ Note that a controllable can only have one beacon activated at a time with the e
+
+
+ +
+ +
+

UNIT:CommandSmokeOFF(Delay)

+
+ +

[AIR] Set smoke off.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

Wrapper.Controllable#CONTROLLABLE

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

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

UNIT:CommandSmokeON(Delay)

+
+ +

[AIR] Set smoke on.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

Wrapper.Controllable#CONTROLLABLE

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

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

UNIT:CommandSmokeOnOff(OnOff, Delay)

+
+ +

[AIR] Set smoke on or off.

+ + +

See DCS command smoke on off

+ +
+
+

Defined in:

+
+

Wrapper.Controllable#CONTROLLABLE

+
+

Parameters:

+
+
+

+ #boolean + OnOff +

+
+
+ +

Set to true for on and false for off. Defaults to true.

+ +
+
+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay the command by this many seconds.

+ +
+
+

Return value:

+
+
+

#CONTROLLABLE:

+
+
+ +

self

+ +
+
+
+
@@ -22681,7 +22853,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

UNIT:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -22692,11 +22864,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -22719,7 +22891,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

UNIT:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -22730,7 +22902,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE:

diff --git a/Documentation/Wrapper.Weapon.html b/Documentation/Wrapper.Weapon.html index 28304401d..1044b1f45 100644 --- a/Documentation/Wrapper.Weapon.html +++ b/Documentation/Wrapper.Weapon.html @@ -2611,13 +2611,13 @@ but it could also be a STATIC object.

WEAPON:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

WEAPON:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -7801,7 +7801,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

WEAPON:GetPointVec2()

-

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 2D of the POSITIONABLE within the mission.

@@ -7812,11 +7812,11 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC2:

+

Core.Point#COORDINATE:

-

The 2D point vector of the POSITIONABLE.

+

The 3D point vector of the POSITIONABLE.

@@ -7839,7 +7839,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

WEAPON:GetPointVec3()

-

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

@@ -7850,7 +7850,7 @@ preferred as it will return a fresh new COORDINATE and thus avoid potentially un

Return values:

-

Core.Point#POINT_VEC3:

+

Core.Point#COORDINATE: