Module Point

COORDINATE:GetRandomVec2InRadius(OuterRadius, InnerRadius)

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

Parameters

Dcs.DCSTypes#Distance OuterRadius :
Dcs.DCSTypes#Distance InnerRadius :

Return value

Dcs.DCSTypes#Vec2: Vec2

COORDINATE:GetRandomVec3InRadius(OuterRadius, InnerRadius)

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

Parameters

Dcs.DCSTypes#Distance OuterRadius :
Dcs.DCSTypes#Distance InnerRadius :

Return value

Dcs.DCSTypes#Vec3: Vec3

COORDINATE:GetTemperature(height)

Returns the temperature in Degrees Celsius.

Parameter

height : (Optional) parameter specifying the height ASL.

Return value

Temperature in Degrees Celsius.

COORDINATE:GetTemperatureText(height, Settings)

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

The text will reflect the temperature like this:

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

A text containing a pressure will look like this:

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

Parameters

height : (Optional) parameter specifying the height ASL.
Settings :

Return value

#string: Temperature according the measurement system Settings.

COORDINATE:GetVec2()

Return the coordinates of the COORDINATE in Vec2 format.

Return value

Dcs.DCSTypes#Vec2: The Vec2 format coordinate.

COORDINATE:GetVec3()

Return the coordinates of the COORDINATE in Vec3 format.

Return value

Dcs.DCSTypes#Vec3: The Vec3 format coordinate.

COORDINATE:GetVelocity()

Return the velocity of the COORDINATE.

Return value

#number: Velocity in meters per second.

COORDINATE:GetVelocityText(Settings)

Return the velocity text of the COORDINATE.

Parameter

Settings :

Return value

#string: Velocity text.

COORDINATE:GetWind(height)

Returns the wind direction (from) and strength.

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 values

Direction the wind is blowing from in degrees.
Wind strength in m/s.

COORDINATE:GetWindText(height, Settings)

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

The text will reflect the wind like this:

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

A text containing a pressure will look like this:

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

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

COORDINATE.Heading

COORDINATE:IlluminationBomb(): Creates an illumination bomb at the point.

COORDINATE:IsAtCoordinate2D(Coordinate, Precision)

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

Parameters

#COORDINATE Coordinate :
#number Precision :

Return value

#boolean: true if at the same position.

COORDINATE:IsInRadius(ToCoordinate, Radius, Coordinate)

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

Parameters

#COORDINATE ToCoordinate : 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.
Coordinate :

Return value

#boolean: true if in the Radius.

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

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.

COORDINATE:IsLOS(ToCoordinate)

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

Parameter

#COORDINATE ToCoordinate :

Return value

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

COORDINATE:MarkToAll(MarkText)

Mark to All

Parameter

#string MarkText : Free format text that shows the marking clarification.

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" )

COORDINATE:MarkToCoalition(MarkText, Coalition)

Mark to Coalition

Parameters

#string MarkText : Free format text that shows the marking clarification.
Coalition :

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 )

COORDINATE:MarkToCoalitionBlue(MarkText)

Mark to Blue Coalition

Parameter

#string MarkText : Free format text that shows the marking clarification.

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" )

COORDINATE:MarkToCoalitionRed(MarkText)

Mark to Red Coalition

Parameter

#string MarkText : Free format text that shows the marking clarification.

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" )

COORDINATE:MarkToGroup(MarkText, MarkGroup)

Mark to Group

Parameters

#string MarkText : Free format text that shows the marking clarification.
Wrapper.Group#GROUP MarkGroup : The Group that receives the mark.

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 )

COORDINATE:New(x, y, z)

COORDINATE constructor.

Parameters

Dcs.DCSTypes#Distance x : The x coordinate of the Vec3 point, pointing to the North.
Dcs.DCSTypes#Distance y : The y coordinate of the Vec3 point, pointing to the Right.
Dcs.DCSTypes#Distance z : The z coordinate of the Vec3 point, pointing to the Right.

Return value

COORDINATE:NewFromCoordinate(Coordinate)

COORDINATE constructor.

Parameter

#COORDINATE Coordinate :

Return value

COORDINATE:NewFromVec2(Vec2, LandHeightAdd)

Create a new COORDINATE object from Vec2 coordinates.

Parameters

Dcs.DCSTypes#Vec2 Vec2 : The Vec2 point.
Dcs.DCSTypes#Distance LandHeightAdd : (optional) The default height if required to be evaluated will be the land height of the x, y coordinate. You can specify an extra height to be added to the land height.

Return value

COORDINATE:NewFromVec3(Vec3)

Create a new COORDINATE object from Vec3 coordinates.

Parameter

Dcs.DCSTypes#Vec3 Vec3 : The Vec3 point.

Return value

COORDINATE:RemoveMark(MarkID)

Remove a mark

Parameter

#number MarkID : The ID of the mark to be removed.

Usage:

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

COORDINATE:SetHeading(Heading)

Set the heading of the coordinate, if applicable.

Parameter

Heading :

COORDINATE:SetVelocity(Velocity)

Set the velocity of the COORDINATE.

Parameter

#string Velocity : Velocity in meters per second.

COORDINATE:Smoke(SmokeColor)

Smokes the point in a color.

Parameter

Utilities.Utils#SMOKECOLOR SmokeColor :

COORDINATE:SmokeBlue(): Smoke the COORDINATE Blue.

COORDINATE:SmokeGreen(): Smoke the COORDINATE Green.

COORDINATE:SmokeOrange(): Smoke the COORDINATE Orange.

COORDINATE:SmokeRed(): Smoke the COORDINATE Red.

COORDINATE:SmokeWhite(): Smoke the COORDINATE White.

COORDINATE:ToString(Controllable, Settings, Task)

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

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

Parameters

Wrapper.Controllable#CONTROLLABLE Controllable :
Core.Settings#SETTINGS Settings :
Tasking.Task#TASK Task : The task for which coordinates need to be calculated.

Return value

#string: The coordinate Text in the configured coordinate system.

COORDINATE:ToStringA2A(Controllable, Settings)

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

Parameters

Wrapper.Controllable#CONTROLLABLE Controllable :
Core.Settings#SETTINGS Settings :

Return value

#string: The coordinate Text in the configured coordinate system.

COORDINATE:ToStringA2G(Controllable, Settings)

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

Parameters

Wrapper.Controllable#CONTROLLABLE Controllable :
Core.Settings#SETTINGS Settings :

Return value

#string: The coordinate Text in the configured coordinate system.

COORDINATE:ToStringAspect(TargetCoordinate)

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

Parameter

#COORDINATE TargetCoordinate : The target COORDINATE.

Return value

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

COORDINATE:ToStringBR(TargetCoordinate, FromCoordinate, Settings)

Return a BR string from a COORDINATE to the COORDINATE.

Parameters

#COORDINATE TargetCoordinate : The target COORDINATE.
FromCoordinate :
Settings :

Return value

#string: The BR text.

COORDINATE:ToStringBRA(TargetCoordinate, FromCoordinate, Settings)

Return a BRAA string from a COORDINATE to the COORDINATE.

Parameters

#COORDINATE TargetCoordinate : The target COORDINATE.
FromCoordinate :
Settings :

Return value

#string: The BR text.

COORDINATE:ToStringBULLS(Coalition, Settings)

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

Parameters

Dcs.DCSCoalition#coalition.side Coalition : The coalition.
Settings :

Return value

#string: The BR text.

COORDINATE:ToStringFromRP(Controllable, Settings, ReferenceCoord, ReferenceName)

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.

Parameters

Wrapper.Controllable#CONTROLLABLE Controllable :
Core.Settings#SETTINGS Settings :
ReferenceCoord :
ReferenceName :

Return value

#string: The coordinate Text in the configured coordinate system.

COORDINATE:ToStringLLDDM(Settings)

Provides a Lat Lon string in Degree Decimal Minute format.

Parameter

Core.Settings#SETTINGS Settings : (optional) Settings

Return value

#string: The LL DDM Text

COORDINATE:ToStringLLDMS(Settings)

Provides a Lat Lon string in Degree Minute Second format.

Parameter

Core.Settings#SETTINGS Settings : (optional) Settings

Return value

#string: The LL DMS Text

COORDINATE:ToStringMGRS(Settings)

Provides a MGRS string

Parameter

Core.Settings#SETTINGS Settings : (optional) Settings

Return value

#string: The MGRS Text

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

Parameters

Wrapper.Controllable#CONTROLLABLE Controllable :
Core.Settings#SETTINGS Settings :

Return value

#string: The pressure text in the configured measurement system.

COORDINATE:ToStringTemperature(Controllable, 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.

Parameters

Wrapper.Controllable#CONTROLLABLE Controllable :
Core.Settings#SETTINGS Settings :

Return value

#string: The temperature text in the configured measurement system.

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

Parameters

Wrapper.Controllable#CONTROLLABLE Controllable :
Core.Settings#SETTINGS Settings :

Return value

#string: The wind text in the configured measurement system.

COORDINATE:Translate(Distance, Angle)

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

Parameters

Dcs.DCSTypes#Distance Distance : The Distance to be added in meters.
Dcs.DCSTypes#Angle Angle : The Angle in degrees.

Return value

#COORDINATE: The new calculated COORDINATE.

COORDINATE.Velocity

COORDINATE.WaypointAction

COORDINATE:WaypointAir(AltType, Type, Action, Speed, SpeedLocked)

Build an air type route point.

Parameters

#COORDINATE.WaypointAltType AltType : The altitude type.
#COORDINATE.WaypointType Type : The route point type.
#COORDINATE.WaypointAction Action : The route point action.
Dcs.DCSTypes#Speed Speed : Airspeed in km/h.
#boolean SpeedLocked : true means the speed is locked.

Return value

#table: The route point.

COORDINATE:WaypointAirFlyOverPoint(AltType, Speed)

Build a Waypoint Air "Fly Over Point".

Parameters

#COORDINATE.WaypointAltType AltType : The altitude type.
Dcs.DCSTypes#Speed Speed : Airspeed in km/h.

Return value

#table: The route point.

COORDINATE:WaypointAirLanding(Speed)

Build a Waypoint Air "Landing".

Parameter

Dcs.DCSTypes#Speed Speed : Airspeed in km/h.

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.

COORDINATE:WaypointAirTakeOffParking(AltType, Speed)

Build a Waypoint Air "Take Off Parking".

Parameters

#COORDINATE.WaypointAltType AltType : The altitude type.
Dcs.DCSTypes#Speed Speed : Airspeed in km/h.

Return value

#table: The route point.

COORDINATE:WaypointAirTakeOffParkingHot(AltType, Speed)

Build a Waypoint Air "Take Off Parking Hot".

Parameters

#COORDINATE.WaypointAltType AltType : The altitude type.
Dcs.DCSTypes#Speed Speed : Airspeed in km/h.

Return value

#table: The route point.

COORDINATE:WaypointAirTakeOffRunway(AltType, Speed)

Build a Waypoint Air "Take Off Runway".

Parameters

#COORDINATE.WaypointAltType AltType : The altitude type.
Dcs.DCSTypes#Speed Speed : Airspeed in km/h.

Return value

#table: The route point.

COORDINATE:WaypointAirTurningPoint(AltType, Speed)

Build a Waypoint Air "Turning Point".

Parameters

#COORDINATE.WaypointAltType AltType : The altitude type.
Dcs.DCSTypes#Speed Speed : Airspeed in km/h.

Return value

#table: The route point.

COORDINATE.WaypointAltType

COORDINATE:WaypointGround(Speed, Formation)

Build an ground type route point.

Parameters

#number Speed : (optional) Speed in km/h. The default speed is 999 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".

Return value

#table: The route point.

COORDINATE.WaypointType

COORDINATE.x

COORDINATE.y

COORDINATE.z

Type `COORDINATE.WaypointAction`

Type `COORDINATE.WaypointAltType`

Type `COORDINATE.WaypointType`

Type `POINT_VEC2`

Field(s)

POINT_VEC2:AddAlt(Altitude)

Add to the current land height an altitude.

Parameter

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

Return value

POINT_VEC2:AddX(x)

Add to the x coordinate of the POINT_VEC2.

Parameter

#number x : The x coordinate.

Return value

POINT_VEC2:AddY(y)

Add to the y coordinate of the POINT_VEC2.

Parameter

#number y : The y coordinate.

Return value

POINT_VEC2:DistanceFromPointVec2(PointVec2Reference)

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

Parameter

PointVec2Reference :

POINT_VEC2:GetAlt()

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

Return value

#number: The land altitude.

POINT_VEC2:GetLat()

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

Return value

#number: The x coodinate.

POINT_VEC2:GetLon()

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

Return value

#number: The y coodinate.

POINT_VEC2:GetRandomPointVec2InRadius(OuterRadius, InnerRadius)

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

Parameters

Dcs.DCSTypes#Distance OuterRadius :
Dcs.DCSTypes#Distance InnerRadius :

Return value

POINT_VEC2:New(x, y, LandHeightAdd)

POINT_VEC2:GetX()

Return the x coordinate of the POINT_VEC2.

Return value

#number: The x coodinate.

POINT_VEC2:GetY()

Return the y coordinate of the POINT_VEC2.

Return value

#number: The y coodinate.

POINT_VEC2 constructor.

Parameters

Dcs.DCSTypes#Distance x : The x coordinate of the Vec3 point, pointing to the North.
Dcs.DCSTypes#Distance y : The y coordinate of the Vec3 point, pointing to the Right.
Dcs.DCSTypes#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:

POINT_VEC2:NewFromVec2(Vec2, LandHeightAdd)

Create a new POINT_VEC2 object from Vec2 coordinates.

Parameters

Dcs.DCSTypes#Vec2 Vec2 : The Vec2 point.
LandHeightAdd :

Return value

Core.Point#POINT_VEC2: self

POINT_VEC2:NewFromVec3(Vec3)

Create a new POINT_VEC2 object from Vec3 coordinates.

Parameter

Dcs.DCSTypes#Vec3 Vec3 : The Vec3 point.

Return value

Core.Point#POINT_VEC2: self

POINT_VEC2:SetAlt(Altitude)

Set the altitude of the POINT_VEC2.

Parameter

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

Return value

POINT_VEC2:SetLat(x)

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

Parameter

#number x : The x coordinate.

Return value

POINT_VEC2:SetLon(y, z)

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

Parameters

#number y : The y coordinate.
z :

Return value

POINT_VEC2:SetX(x)

Set the x coordinate of the POINT_VEC2.

Parameter

#number x : The x coordinate.

Return value

POINT_VEC2:SetY(y)

Set the y coordinate of the POINT_VEC2.

Parameter

#number y : The y coordinate.

Return value

Dcs.DCSTypes#Distance POINT_VEC2.x: The x coordinate in meters.

Dcs.DCSTypes#Distance POINT_VEC2.y: the y coordinate in meters.

POINT_VEC2.z

Type `POINT_VEC3`

The POINT_VEC3 class

Field(s)

POINT_VEC3:AddX(x)

Add to the x coordinate of the POINT_VEC3.

Parameter

#number x : The x coordinate value to add to the current x coodinate.

Return value

POINT_VEC3:AddY(y)

Add to the y coordinate of the POINT_VEC3.

Parameter

#number y : The y coordinate value to add to the current y coodinate.

Return value

POINT_VEC3:AddZ(z)

Add to the z coordinate of the POINT_VEC3.

Parameter

#number z : The z coordinate value to add to the current z coodinate.

Return value

POINT_VEC3:GetRandomPointVec3InRadius(OuterRadius, InnerRadius)

Utilities.Utils#FLARECOLOR POINT_VEC3.FlareColor

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

Parameters

Dcs.DCSTypes#Distance OuterRadius :
Dcs.DCSTypes#Distance InnerRadius :

Return value