diff --git a/Moose Development/Moose/Core/Point.lua b/Moose Development/Moose/Core/Point.lua index 6b06bfe75..7067dc690 100644 --- a/Moose Development/Moose/Core/Point.lua +++ b/Moose Development/Moose/Core/Point.lua @@ -1,91 +1,22 @@ --- **Core** - **POINT\_VEC** classes define an **extensive API** to **manage 3D points** in the simulation space. --- --- 1) @{Point#POINT_VEC3} class, extends @{Base#BASE} --- ================================================== --- The @{Point#POINT_VEC3} class defines a 3D point in the simulator. --- --- **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 of the MIST framework was created by Grimes, who you can find on the Eagle Dynamics Forums. --- --- ## 1.1) POINT_VEC3 constructor --- --- A new POINT_VEC3 instance can be created with: --- --- * @{Point#POINT_VEC3.New}(): a 3D point. --- * @{Point#POINT_VEC3.NewFromVec3}(): a 3D point created from a @{DCSTypes#Vec3}. --- --- ## 1.2) Manupulate the X, Y, Z coordinates of the point --- --- A POINT_VEC3 class works in 3D space. It contains internally an X, Y, Z coordinate. --- Methods exist to manupulate these coordinates. --- --- The current X, Y, Z axis can be retrieved with the methods @{#POINT_VEC3.GetX}(), @{#POINT_VEC3.GetY}(), @{#POINT_VEC3.GetZ}() respectively. --- The methods @{#POINT_VEC3.SetX}(), @{#POINT_VEC3.SetY}(), @{#POINT_VEC3.SetZ}() change the respective axis with a new value. --- The current axis values can be changed by using the methods @{#POINT_VEC3.AddX}(), @{#POINT_VEC3.AddY}(), @{#POINT_VEC3.AddZ}() --- to add or substract a value from the current respective axis value. --- Note that the Set and Add methods return the current POINT_VEC3 object, so these manipulation methods can be chained... For example: --- --- local Vec3 = PointVec3:AddX( 100 ):AddZ( 150 ):GetVec3() --- --- ## 1.3) Create waypoints for routes --- --- A POINT_VEC3 can prepare waypoints for Ground, Air and Naval groups to be embedded into a Route. --- --- --- ## 1.5) Smoke, flare, explode, illuminate --- --- At the point a smoke, flare, explosion and illumination bomb can be triggered. Use the following methods: --- --- ### 1.5.1) Smoke --- --- * @{#POINT_VEC3.Smoke}(): To smoke the point in a certain color. --- * @{#POINT_VEC3.SmokeBlue}(): To smoke the point in blue. --- * @{#POINT_VEC3.SmokeRed}(): To smoke the point in red. --- * @{#POINT_VEC3.SmokeOrange}(): To smoke the point in orange. --- * @{#POINT_VEC3.SmokeWhite}(): To smoke the point in white. --- * @{#POINT_VEC3.SmokeGreen}(): To smoke the point in green. --- --- ### 1.5.2) Flare --- --- * @{#POINT_VEC3.Flare}(): To flare the point in a certain color. --- * @{#POINT_VEC3.FlareRed}(): To flare the point in red. --- * @{#POINT_VEC3.FlareYellow}(): To flare the point in yellow. --- * @{#POINT_VEC3.FlareWhite}(): To flare the point in white. --- * @{#POINT_VEC3.FlareGreen}(): To flare the point in green. --- --- ### 1.5.3) Explode --- --- * @{#POINT_VEC3.Explosion}(): To explode the point with a certain intensity. --- --- ### 1.5.4) Illuminate --- --- * @{#POINT_VEC3.IlluminationBomb}(): To illuminate the point. --- -- --- 2) @{Point#POINT_VEC2} class, extends @{Point#POINT_VEC3} --- ========================================================= --- The @{Point#POINT_VEC2} class defines a 2D point in the simulator. The height coordinate (if needed) will be the land height + an optional added height specified. +-- ![Banner Image](..\Presentations\POINT\Dia1.JPG) +-- +-- ==== -- --- 2.1) POINT_VEC2 constructor --- --------------------------- --- A new POINT_VEC2 instance can be created with: +-- # Demo Missions -- --- * @{Point#POINT_VEC2.New}(): a 2D point, taking an additional height parameter. --- * @{Point#POINT_VEC2.NewFromVec2}(): a 2D point created from a @{DCSTypes#Vec2}. +-- ### [POINT_VEC Demo Missions source code]() -- --- ## 1.2) Manupulate the X, Altitude, Y coordinates of the 2D point +-- ### [POINT_VEC Demo Missions, only for beta testers]() +-- +-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases) -- --- A POINT_VEC2 class works in 2D space, with an altitude setting. It contains internally an X, Altitude, Y coordinate. --- Methods exist to manupulate these coordinates. +-- ==== -- --- The current X, Altitude, Y axis can be retrieved with the methods @{#POINT_VEC2.GetX}(), @{#POINT_VEC2.GetAlt}(), @{#POINT_VEC2.GetY}() respectively. --- The methods @{#POINT_VEC2.SetX}(), @{#POINT_VEC2.SetAlt}(), @{#POINT_VEC2.SetY}() change the respective axis with a new value. --- The current Lat(itude), Alt(itude), Lon(gitude) values can also be retrieved with the methods @{#POINT_VEC2.GetLat}(), @{#POINT_VEC2.GetAlt}(), @{#POINT_VEC2.GetLon}() respectively. --- The current axis values can be changed by using the methods @{#POINT_VEC2.AddX}(), @{#POINT_VEC2.AddAlt}(), @{#POINT_VEC2.AddY}() --- to add or substract a value from the current respective axis value. --- Note that the Set and Add methods return the current POINT_VEC2 object, so these manipulation methods can be chained... For example: +-- # YouTube Channel -- --- local Vec2 = PointVec2:AddX( 100 ):AddY( 2000 ):GetVec2() +-- ### [POINT_VEC YouTube Channel]() -- -- === -- @@ -133,6 +64,126 @@ -- @field #POINT_VEC3.RoutePointType RoutePointType -- @field #POINT_VEC3.RoutePointAction RoutePointAction -- @extends Core.Base#BASE + +--- # POINT_VEC3 class, extends @{Base#BASE} +-- +-- POINT_VEC3 defines a 3D point in the simulator and with its methods, you can use or manipulate the point in 3D space. +-- +-- **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, +-- who you can find on the Eagle Dynamics Forums. +-- +-- +-- ## POINT_VEC3 constructor +-- +-- A new POINT_VEC3 object can be created with: +-- +-- * @{#POINT_VEC3.New}(): a 3D point. +-- * @{#POINT_VEC3.NewFromVec3}(): a 3D point created from a @{DCSTypes#Vec3}. +-- +-- +-- ## Manupulate the X, Y, Z coordinates of the POINT_VEC3 +-- +-- A POINT_VEC3 class works in 3D space. It contains internally an X, Y, Z coordinate. +-- Methods exist to manupulate these coordinates. +-- +-- The current X, Y, Z axis can be retrieved with the methods @{#POINT_VEC3.GetX}(), @{#POINT_VEC3.GetY}(), @{#POINT_VEC3.GetZ}() respectively. +-- The methods @{#POINT_VEC3.SetX}(), @{#POINT_VEC3.SetY}(), @{#POINT_VEC3.SetZ}() change the respective axis with a new value. +-- The current axis values can be changed by using the methods @{#POINT_VEC3.AddX}(), @{#POINT_VEC3.AddY}(), @{#POINT_VEC3.AddZ}() +-- to add or substract a value from the current respective axis value. +-- Note that the Set and Add methods return the current POINT_VEC3 object, so these manipulation methods can be chained... For example: +-- +-- local Vec3 = PointVec3:AddX( 100 ):AddZ( 150 ):GetVec3() +-- +-- +-- ## Create waypoints for routes +-- +-- A POINT_VEC3 can prepare waypoints for Ground and Air groups to be embedded into a Route. +-- +-- * @{#POINT_VEC3.RoutePointAir}(): Build an air route point. +-- * @{#POINT_VEC3.RoutePointGround}(): Build a ground route point. +-- +-- Route points can be used in the Route methods of the @{Group#GROUP} class. +-- +-- +-- ## Smoke, flare, explode, illuminate +-- +-- At the point a smoke, flare, explosion and illumination bomb can be triggered. Use the following methods: +-- +-- ### Smoke +-- +-- * @{#POINT_VEC3.Smoke}(): To smoke the point in a certain color. +-- * @{#POINT_VEC3.SmokeBlue}(): To smoke the point in blue. +-- * @{#POINT_VEC3.SmokeRed}(): To smoke the point in red. +-- * @{#POINT_VEC3.SmokeOrange}(): To smoke the point in orange. +-- * @{#POINT_VEC3.SmokeWhite}(): To smoke the point in white. +-- * @{#POINT_VEC3.SmokeGreen}(): To smoke the point in green. +-- +-- ### Flare +-- +-- * @{#POINT_VEC3.Flare}(): To flare the point in a certain color. +-- * @{#POINT_VEC3.FlareRed}(): To flare the point in red. +-- * @{#POINT_VEC3.FlareYellow}(): To flare the point in yellow. +-- * @{#POINT_VEC3.FlareWhite}(): To flare the point in white. +-- * @{#POINT_VEC3.FlareGreen}(): To flare the point in green. +-- +-- ### Explode +-- +-- * @{#POINT_VEC3.Explosion}(): To explode the point with a certain intensity. +-- +-- ### Illuminate +-- +-- * @{#POINT_VEC3.IlluminationBomb}(): To illuminate the point. +-- +-- +-- ## 3D calculation methods +-- +-- Various calculation methods exist to use or manipulate 3D space. Find below a short description of each method: +-- +-- ### Distance +-- +-- * @{#POINT_VEC3.Get3DDistance}(): Obtain the distance from the current 3D point to the provided 3D point in 3D space. +-- * @{#POINT_VEC3.Get2DDistance}(): Obtain the distance from the current 3D point to the provided 3D point in 2D space. +-- +-- ### Angle +-- +-- * @{#POINT_VEC3.GetAngleDegrees}(): Obtain the angle in degrees from the current 3D point with the provided 3D direction vector. +-- * @{#POINT_VEC3.GetAngleRadians}(): Obtain the angle in radians from the current 3D point with the provided 3D direction vector. +-- * @{#POINT_VEC3.GetDirectionVec3}(): Obtain the 3D direction vector from the current 3D point to the provided 3D point. +-- +-- ### Translation +-- +-- * @{#POINT_VEC3.Translate}(): Translate the current 3D point towards an other 3D point using the given Distance and Angle. +-- +-- ### Get the North correction of the current location +-- +-- * @{#POINT_VEC3.GetNorthCorrection}(): Obtains the north correction at the current 3D point. +-- +-- +-- ## Point Randomization +-- +-- Various methods exist to calculate random locations around a given 3D point. +-- +-- * @{#POINT_VEC3.GetRandomPointVec2InRadius}(): Provides a random 2D point around the current 3D point, in the given inner to outer band. +-- * @{#POINT_VEC3.GetRandomPointVec3InRadius}(): Provides a random 3D point around the current 3D point, in the given inner to outer band. +-- * @{#POINT_VEC3.GetRandomVec2InRadius}(): Provides a random 2D vector around the current 3D point, in the given inner to outer band. +-- * @{#POINT_VEC3.GetRandomVec3InRadius}(): Provides a random 3D vector around the current 3D point, in the given inner to outer band. +-- +-- +-- ## Metric system +-- +-- * @{#POINT_VEC3.IsMetric}(): Returns if the 3D point is Metric or Nautical Miles. +-- * @{#POINT_VEC3.SetMetric}(): Sets the 3D point to Metric or Nautical Miles. +-- +-- +-- ## Coorinate text generation +-- +-- * @{#POINT_VEC3.ToStringBR}(): Generates a Bearing & Range text in the format of DDD for DI where DDD is degrees and DI is distance. +-- * @{#POINT_VEC3.ToStringLL}(): Generates a Latutude & Longutude text. +-- +-- @field #POINT_VEC3 POINT_VEC3 +-- POINT_VEC3 = { ClassName = "POINT_VEC3", Metric = true, @@ -149,11 +200,38 @@ POINT_VEC3 = { }, } ---- The POINT_VEC2 class --- @type POINT_VEC2 +--- @type POINT_VEC2 -- @field Dcs.DCSTypes#Distance x The x coordinate in meters. -- @field Dcs.DCSTypes#Distance y the y coordinate in meters. -- @extends Core.Point#POINT_VEC3 + +--- # POINT_VEC2 class, extends @{Point#POINT_VEC3} +-- +-- The @{Point#POINT_VEC2} class defines a 2D point in the simulator. The height coordinate (if needed) will be the land height + an optional added height specified. +-- +-- ## POINT_VEC2 constructor +-- +-- A new POINT_VEC2 instance can be created with: +-- +-- * @{Point#POINT_VEC2.New}(): a 2D point, taking an additional height parameter. +-- * @{Point#POINT_VEC2.NewFromVec2}(): a 2D point created from a @{DCSTypes#Vec2}. +-- +-- ## Manupulate the X, Altitude, Y coordinates of the 2D point +-- +-- A POINT_VEC2 class works in 2D space, with an altitude setting. It contains internally an X, Altitude, Y coordinate. +-- Methods exist to manupulate these coordinates. +-- +-- The current X, Altitude, Y axis can be retrieved with the methods @{#POINT_VEC2.GetX}(), @{#POINT_VEC2.GetAlt}(), @{#POINT_VEC2.GetY}() respectively. +-- The methods @{#POINT_VEC2.SetX}(), @{#POINT_VEC2.SetAlt}(), @{#POINT_VEC2.SetY}() change the respective axis with a new value. +-- The current Lat(itude), Alt(itude), Lon(gitude) values can also be retrieved with the methods @{#POINT_VEC2.GetLat}(), @{#POINT_VEC2.GetAlt}(), @{#POINT_VEC2.GetLon}() respectively. +-- The current axis values can be changed by using the methods @{#POINT_VEC2.AddX}(), @{#POINT_VEC2.AddAlt}(), @{#POINT_VEC2.AddY}() +-- to add or substract a value from the current respective axis value. +-- Note that the Set and Add methods return the current POINT_VEC2 object, so these manipulation methods can be chained... For example: +-- +-- local Vec2 = PointVec2:AddX( 100 ):AddY( 2000 ):GetVec2() +-- +-- @field #POINT_VEC2 POINT_VEC2 +-- POINT_VEC2 = { ClassName = "POINT_VEC2", } diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 19046ba83..a97780b33 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -198,6 +198,12 @@ CARGO.CargoObject

The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...

+ + + + CARGO.CargoScheduler + + @@ -583,13 +589,7 @@

Type CARGO_REPRESENTABLE

- - - - - + @@ -598,6 +598,12 @@ + + + +
CARGO_REPRESENTABLE.ClassName - -
CARGO_REPRESENTABLE:New(CargoObject, Type, Name, Weight, ReportRadius, NearRadius)CARGO_REPRESENTABLE:New(Type, Name, Weight, ReportRadius, NearRadius, CargoObject)

CARGO_REPRESENTABLE Constructor.

CARGO_REPRESENTABLE:RouteTo(ToPointVec2, Speed)

Route a cargo unit to a PointVec2.

+
CARGO_REPRESENTABLE.test +
@@ -911,6 +917,20 @@ The radius when the cargo will board the Carrier (to avoid collision).

The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...

+ + +
+
+ + + +CARGO.CargoScheduler + +
+
+ + +
@@ -2696,22 +2716,8 @@ The range till cargo will board.

- #string - -CARGO_REPRESENTABLE.ClassName - -
-
- - - -
-
-
-
- -CARGO_REPRESENTABLE:New(CargoObject, Type, Name, Weight, ReportRadius, NearRadius) +CARGO_REPRESENTABLE:New(Type, Name, Weight, ReportRadius, NearRadius, CargoObject)
@@ -2722,11 +2728,6 @@ The range till cargo will board.

  • -

    Wrapper.Controllable#Controllable CargoObject :

    - -
    • -
  • -

    #string Type :

    • @@ -2751,6 +2752,11 @@ The range till cargo will board.

    #number NearRadius : (optional)

    + +
  • + +

    CargoObject :

    +

Return value

@@ -2789,11 +2795,27 @@ The range till cargo will board.

#CARGO_REPRESENTABLE:

+
+
+
+
+ + +CARGO_REPRESENTABLE.test + +
+
+ + +

Type CARGO_UNIT

-

Field(s)

+ +

Hello

+ +

Field(s)

diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index 75eb0145f..c17360e5a 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2172,7 +2172,6 @@ self

- #number DETECTION_BASE.DetectedItemCount @@ -2186,7 +2185,6 @@ self

- #number DETECTION_BASE.DetectedItemMax @@ -2300,7 +2298,7 @@ self

- #number + DETECTION_BASE.DetectionInterval diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index d3966610d..1a64cbb26 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -211,6 +211,7 @@ on defined intervals (currently every minute).

+ #number MOVEMENT.AliveUnits @@ -219,6 +220,9 @@ on defined intervals (currently every minute).

+ +

Contains the counter how many units are currently alive

+
diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index b321acabb..2243bb9cc 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -97,103 +97,23 @@ -

1) Point#POINT_VEC3 class, extends Base#BASE

-

The Point#POINT_VEC3 class defines a 3D point in the simulator.

+

Banner Image

-

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 of the MIST framework was created by Grimes, who you can find on the Eagle Dynamics Forums.

+
-

1.1) POINT_VEC3 constructor

+

Demo Missions

-

A new POINT_VEC3 instance can be created with:

+

POINT_VEC Demo Missions source code

- +

POINT_VEC Demo Missions, only for beta testers

-

1.2) Manupulate the X, Y, Z coordinates of the point

+

ALL Demo Missions pack of the last release

-

A POINT_VEC3 class works in 3D space. It contains internally an X, Y, Z coordinate. -Methods exist to manupulate these coordinates.

+
-

The current X, Y, Z axis can be retrieved with the methods POINT_VEC3.GetX(), POINT_VEC3.GetY(), POINT_VEC3.GetZ() respectively. -The methods POINT_VEC3.SetX(), POINT_VEC3.SetY(), POINT_VEC3.SetZ() change the respective axis with a new value. -The current axis values can be changed by using the methods POINT_VEC3.AddX(), POINT_VEC3.AddY(), POINT_VEC3.AddZ() -to add or substract a value from the current respective axis value. -Note that the Set and Add methods return the current POINT_VEC3 object, so these manipulation methods can be chained... For example:

+

YouTube Channel

-
 local Vec3 = PointVec3:AddX( 100 ):AddZ( 150 ):GetVec3()
-
- -

1.3) Create waypoints for routes

- -

A POINT_VEC3 can prepare waypoints for Ground, Air and Naval groups to be embedded into a Route.

- - -

1.5) Smoke, flare, explode, illuminate

- -

At the point a smoke, flare, explosion and illumination bomb can be triggered. Use the following methods:

- -

1.5.1) Smoke

- - - -

1.5.2) Flare

- - - -

1.5.3) Explode

- - - -

1.5.4) Illuminate

- - - - -

2) Point#POINT_VEC2 class, extends Point#POINT_VEC3

-

The Point#POINT_VEC2 class defines a 2D point in the simulator. The height coordinate (if needed) will be the land height + an optional added height specified.

- -

2.1) POINT_VEC2 constructor

-

A new POINT_VEC2 instance can be created with:

- - - -

1.2) Manupulate the X, Altitude, Y coordinates of the 2D point

- -

A POINT_VEC2 class works in 2D space, with an altitude setting. It contains internally an X, Altitude, Y coordinate. -Methods exist to manupulate these coordinates.

- -

The current X, Altitude, Y axis can be retrieved with the methods POINT_VEC2.GetX(), POINT_VEC2.GetAlt(), POINT_VEC2.GetY() respectively. -The methods POINT_VEC2.SetX(), POINT_VEC2.SetAlt(), POINT_VEC2.SetY() change the respective axis with a new value. -The current Lat(itude), Alt(itude), Lon(gitude) values can also be retrieved with the methods POINT_VEC2.GetLat(), POINT_VEC2.GetAlt(), POINT_VEC2.GetLon() respectively. -The current axis values can be changed by using the methods POINT_VEC2.AddX(), POINT_VEC2.AddAlt(), POINT_VEC2.AddY() -to add or substract a value from the current respective axis value. -Note that the Set and Add methods return the current POINT_VEC2 object, so these manipulation methods can be chained... For example:

- -
 local Vec2 = PointVec2:AddX( 100 ):AddY( 2000 ):GetVec2()
-
+

POINT_VEC YouTube Channel

@@ -238,13 +158,17 @@ Note that the Set and Add methods return the current POINT_VEC2 object, so these POINT_VEC2 +

POINT_VEC2 class, extends Point#POINT_VEC3

+

The Point#POINT_VEC2 class defines a 2D point in the simulator.

POINT_VEC3 +

POINT_VEC3 class, extends Base#BASE

+

POINT_VEC3 defines a 3D point in the simulator and with its methods, you can use or manipulate the point in 3D space.

@@ -266,12 +190,6 @@ Note that the Set and Add methods return the current POINT_VEC2 object, so these POINT_VEC2:AddY(y)

Add to the y coordinate of the POINT_VEC2.

- - - - POINT_VEC2.ClassName - - @@ -414,12 +332,6 @@ Note that the Set and Add methods return the current POINT_VEC2 object, so these POINT_VEC3:AddZ(z)

Add to the z coordinate of the POINT_VEC3.

- - - - POINT_VEC3.ClassName - - @@ -483,15 +395,21 @@ Note that the Set and Add methods return the current POINT_VEC2 object, so these - POINT_VEC3:GetBRText(TargetPointVec3) + POINT_VEC3:GetAngleDegrees(DirectionVec3) -

Return a BR string from a POINTVEC3 to the POINTVEC3.

+

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

- POINT_VEC3:GetDirectionRadians(DirectionVec3) + POINT_VEC3:GetAngleRadians(DirectionVec3) -

Return a direction in radians from the POINT_VEC3 using a direction vector in Vec3 format.

+

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

+ + + + POINT_VEC3:GetBRText(TargetPointVec3) + +

Return a BR string from a POINTVEC3 to the POINTVEC3.

@@ -783,7 +701,37 @@ Note that the Set and Add methods return the current POINT_VEC2 object, so these
+

POINT_VEC2 class, extends Point#POINT_VEC3

+

The Point#POINT_VEC2 class defines a 2D point in the simulator.

+ + +

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

+ +

POINT_VEC2 constructor

+ +

A new POINT_VEC2 instance can be created with:

+ + + +

Manupulate the X, Altitude, Y coordinates of the 2D point

+ +

A POINT_VEC2 class works in 2D space, with an altitude setting. It contains internally an X, Altitude, Y coordinate. +Methods exist to manupulate these coordinates.

+ +

The current X, Altitude, Y axis can be retrieved with the methods POINT_VEC2.GetX(), POINT_VEC2.GetAlt(), POINT_VEC2.GetY() respectively. +The methods POINT_VEC2.SetX(), POINT_VEC2.SetAlt(), POINT_VEC2.SetY() change the respective axis with a new value. +The current Lat(itude), Alt(itude), Lon(gitude) values can also be retrieved with the methods POINT_VEC2.GetLat(), POINT_VEC2.GetAlt(), POINT_VEC2.GetLon() respectively. +The current axis values can be changed by using the methods POINT_VEC2.AddX(), POINT_VEC2.AddAlt(), POINT_VEC2.AddY() +to add or substract a value from the current respective axis value. +Note that the Set and Add methods return the current POINT_VEC2 object, so these manipulation methods can be chained... For example:

+ +
 local Vec2 = PointVec2:AddX( 100 ):AddY( 2000 ):GetVec2()
+ 
+
@@ -797,17 +745,159 @@ Note that the Set and Add methods return the current POINT_VEC2 object, so these
+

POINT_VEC3 class, extends Base#BASE

+

POINT_VEC3 defines a 3D point in the simulator and with its methods, you can use or manipulate the point in 3D space.

+ + + +

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, +who you can find on the Eagle Dynamics Forums.

+ + +

POINT_VEC3 constructor

+ +

A new POINT_VEC3 object can be created with:

+ + + + +

Manupulate the X, Y, Z coordinates of the POINT_VEC3

+ +

A POINT_VEC3 class works in 3D space. It contains internally an X, Y, Z coordinate. +Methods exist to manupulate these coordinates.

+ +

The current X, Y, Z axis can be retrieved with the methods POINT_VEC3.GetX(), POINT_VEC3.GetY(), POINT_VEC3.GetZ() respectively. +The methods POINT_VEC3.SetX(), POINT_VEC3.SetY(), POINT_VEC3.SetZ() change the respective axis with a new value. +The current axis values can be changed by using the methods POINT_VEC3.AddX(), POINT_VEC3.AddY(), POINT_VEC3.AddZ() +to add or substract a value from the current respective axis value. +Note that the Set and Add methods return the current POINT_VEC3 object, so these manipulation methods can be chained... For example:

+ +
 local Vec3 = PointVec3:AddX( 100 ):AddZ( 150 ):GetVec3()
+
+ + +

Create waypoints for routes

+ +

A POINT_VEC3 can prepare waypoints for Ground and Air groups to be embedded into a Route.

+ + + +

Route points can be used in the Route methods of the Group#GROUP class.

+ + +

Smoke, flare, explode, illuminate

+ +

At the point a smoke, flare, explosion and illumination bomb can be triggered. Use the following methods:

+ +

Smoke

+ + + +

Flare

+ + + +

Explode

+ + + +

Illuminate

+ + + + +

3D calculation methods

+ +

Various calculation methods exist to use or manipulate 3D space. Find below a short description of each method:

+ +

Distance

+ + + +

Angle

+ + + +

Translation

+ +
    +
  • POINT_VEC3.Translate(): Translate the current 3D point towards an other 3D point using the given Distance and Angle.
    • +
+ +

Get the North correction of the current location

+ + + + +

Point Randomization

+ +

Various methods exist to calculate random locations around a given 3D point.

+ + + + +

Metric system

+ + + + +

Coorinate text generation

+ +

Type Point

Type POINT_VEC2

- -

The POINT_VEC2 class

- -

Field(s)

+

Field(s)

@@ -887,20 +977,6 @@ The y coordinate.

#POINT_VEC2:

- -
-
-
- - #string - -POINT_VEC2.ClassName - -
-
- - -
@@ -1463,20 +1539,6 @@ The z coordinate value to add to the current z coodinate.

#POINT_VEC3:

- -
-
-
- - #string - -POINT_VEC3.ClassName - -
-
- - -
@@ -1723,6 +1785,60 @@ Altitude text.

+ +POINT_VEC3:GetAngleDegrees(DirectionVec3) + +
+
+ +

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

+ +

Parameter

+ +

Return value

+ +

#number: +DirectionRadians The angle in degrees.

+ +
+
+
+
+ + +POINT_VEC3:GetAngleRadians(DirectionVec3) + +
+
+ +

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

+ +

Parameter

+ +

Return value

+ +

#number: +DirectionRadians The angle in radians.

+ +
+
+
+
+ POINT_VEC3:GetBRText(TargetPointVec3) @@ -1750,33 +1866,6 @@ The BR text.

- -POINT_VEC3:GetDirectionRadians(DirectionVec3) - -
-
- -

Return a direction in radians from the POINT_VEC3 using a direction vector in Vec3 format.

- -

Parameter

- -

Return value

- -

#number: -DirectionRadians The direction in radians.

- -
-
-
-
- POINT_VEC3:GetDirectionVec3(TargetPointVec3) diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index b82a161cb..c3524f500 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2111,9 +2111,6 @@ The group that was spawned. You can use this group for further actions.

- -

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

-
@@ -2584,9 +2581,6 @@ when nothing was spawned.

- -

By default, no InitLimit

-
@@ -2622,7 +2616,7 @@ when nothing was spawned.

- #number + SPAWN.SpawnMaxGroups @@ -2639,7 +2633,7 @@ when nothing was spawned.

- #number + SPAWN.SpawnMaxUnitsAlive @@ -2967,7 +2961,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
- #boolean + SPAWN.SpawnUnControlled diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html index edde8df5d..04fcba929 100644 --- a/docs/Documentation/Task.html +++ b/docs/Documentation/Task.html @@ -1452,7 +1452,7 @@ self

Add a PlayerUnit to join the Task.

-

For each Group within the Task, the Unit is check if it can join the Task. +

For each Group within the Task, the Unit is checked if it can join the Task. If the Unit was not part of the Task, false is returned. If the Unit is part of the Task, true is returned.

diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index d6a95cfc8..b2cbf3569 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -190,6 +190,18 @@ and various dedicated deployment zones.

TASK_CARGO.DeployZones + + + + TASK_CARGO:GetCargoSet() + + + + + + TASK_CARGO:GetDeployZones() + + @@ -272,6 +284,12 @@ and various dedicated deployment zones.

TASK_CARGO_TRANSPORT.ClassName + + + + TASK_CARGO_TRANSPORT:IsAllCargoTransported() + + @@ -512,6 +530,42 @@ based on the tasking capabilities defined in Task#TA
+ +TASK_CARGO:GetCargoSet() + +
+
+ + + +

Return value

+ +

Core.Set#SET_CARGO: +The Cargo Set.

+ +
+
+
+
+ + +TASK_CARGO:GetDeployZones() + +
+
+ + + +

Return value

+ +

#list: +Core.Zone#ZONE_BASE> The Deployment Zones.

+ +
+
+
+
+ TASK_CARGO:GetPlannedMenuText() @@ -889,6 +943,24 @@ The score in points.

+ +
+
+
+ + +TASK_CARGO_TRANSPORT:IsAllCargoTransported() + +
+
+ + + +

Return value

+ +

#boolean:

+ +
@@ -936,6 +1008,8 @@ self

+

Type list

+ diff --git a/docs/Presentations/EVENT.pptx b/docs/Presentations/EVENT.pptx deleted file mode 100644 index 5ae8628cb..000000000 Binary files a/docs/Presentations/EVENT.pptx and /dev/null differ diff --git a/docs/Presentations/POINT/Dia1.JPG b/docs/Presentations/POINT/Dia1.JPG new file mode 100644 index 000000000..2f3a683bb Binary files /dev/null and b/docs/Presentations/POINT/Dia1.JPG differ diff --git a/docs/Presentations/SCORING.pptx b/docs/Presentations/SCORING.pptx deleted file mode 100644 index 511f83f82..000000000 Binary files a/docs/Presentations/SCORING.pptx and /dev/null differ diff --git a/docs/Presentations/SPAWNSTATIC.pptx b/docs/Presentations/SPAWNSTATIC.pptx deleted file mode 100644 index 53e14f0dc..000000000 Binary files a/docs/Presentations/SPAWNSTATIC.pptx and /dev/null differ diff --git a/docs/Presentations/ZONE/Dia1.JPG b/docs/Presentations/ZONE/Dia1.JPG index ca4dd2b3f..8341de972 100644 Binary files a/docs/Presentations/ZONE/Dia1.JPG and b/docs/Presentations/ZONE/Dia1.JPG differ