From 6dec92168ecfe0ebb7a73ec01dc94230ebd5fd6f Mon Sep 17 00:00:00 2001 From: FlightControl_Master Date: Tue, 8 Aug 2017 15:56:17 +0200 Subject: [PATCH] Documentation --- docs/Documentation/AI_Patrol.html | 3 + docs/Documentation/Cargo.html | 1 + docs/Documentation/Controllable.html | 71 ++++++++-- docs/Documentation/Detection.html | 2 +- docs/Documentation/Fsm.html | 3 +- docs/Documentation/Group.html | 12 +- docs/Documentation/Point.html | 197 ++++++++++++++------------- docs/Documentation/Positionable.html | 12 +- docs/Documentation/Spawn.html | 7 +- docs/Documentation/Task_Cargo.html | 5 +- 10 files changed, 173 insertions(+), 140 deletions(-) diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index fa84b7673..1e25ded90 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -926,6 +926,9 @@ Use the method AIPATROLZONE.M + +

This table contains the targets detected during patrol.

+
diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 9f6098452..a11fd4dba 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -3417,6 +3417,7 @@ The range till cargo will board.

+ CARGO_UNIT.CargoCarrier diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html index 4290ac3d0..4110e6b8d 100644 --- a/docs/Documentation/Controllable.html +++ b/docs/Documentation/Controllable.html @@ -433,6 +433,12 @@ CONTROLLABLE:Route(Route, DelaySeconds)

Make the controllable to follow a given route.

+ + + + CONTROLLABLE:RouteGroundTo(ToCoordinate, Speed, Formation, DelaySeconds) + +

Make the GROUND controllable to drive towards a specific point.

@@ -460,7 +466,7 @@ - CONTROLLABLE:SetTaskAtWaypoint(RouteList, WaypointNumber, Task) + CONTROLLABLE:SetTaskWaypoint(Waypoint, Task)

Set a Task at a Waypoint using a Route list.

@@ -2214,6 +2220,51 @@ The CONTROLLABLE.

+ +CONTROLLABLE:RouteGroundTo(ToCoordinate, Speed, Formation, DelaySeconds) + +
+
+ +

Make the GROUND controllable to drive towards a specific point.

+ +

Parameters

+
    +
  • + +

    Core.Point#COORDINATE ToCoordinate : +A Coordinate to drive to.

    + +
    • +
  • + +

    #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".

    + +
    • +
  • + +

    #number DelaySeconds : +Wait for the specified seconds before executing the Route.

    + +
    • +
+

Return value

+ +

#CONTROLLABLE: +The CONTROLLABLE.

+ +
+
+
+
+ CONTROLLABLE:RouteToVec2(Point, Speed) @@ -2337,8 +2388,8 @@ self

- -CONTROLLABLE:SetTaskAtWaypoint(RouteList, WaypointNumber, Task) + +CONTROLLABLE:SetTaskWaypoint(Waypoint, Task)
@@ -2349,14 +2400,8 @@ self

  • -

    Wrapper.Controllable#CONTROLLABLE.RouteList RouteList : -A list of Waypoints.

    - -
    • -
  • - -

    #number WaypointNumber : -The number of the Waypoint. The first Waypoint starts at 1!

    +

    #table Waypoint : +The Waypoint!

  • @@ -3124,8 +3169,8 @@ The variable arguments passed to the function when called! These arguments can b local ToCoord = RandomZone:GetCoordinate() -- Create a "ground route point", which is a "point" structure that can be given as a parameter to a Task - Route[#Route+1] = FromCoord:RoutePointGround( 72 ) - Route[#Route+1] = ToCoord:RoutePointGround( 60, "Vee" ) + Route[#Route+1] = FromCoord:WaypointGround( 72 ) + Route[#Route+1] = ToCoord:WaypointGround( 60, "Vee" ) local TaskRouteToZone = Vehicle:TaskFunction( "RouteToZone", RandomZone ) diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index c9238637b..d30bf87be 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2642,7 +2642,7 @@ The group to generate the report for.

    - #number + DETECTION_BASE.DetectionInterval diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 177f34281..e0276d335 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -1598,7 +1598,7 @@ A string defining the start state.

    - #string + FSM._StartState @@ -1897,6 +1897,7 @@ A string defining the start state.

    + FSM.current diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html index 095665155..7a3c2368b 100644 --- a/docs/Documentation/Group.html +++ b/docs/Documentation/Group.html @@ -918,21 +918,11 @@ The coalition side of the DCS Group.

    Returns a COORDINATE object indicating the point of the first UNIT of the GROUP within the mission.

    -

    Return values

    -
      -
    1. +

      Return value

      Core.Point#COORDINATE: The COORDINATE of the GROUP.

      -
      2. -
    2. - -

      #nil: -The POSITIONABLE is not existing or alive.

      - -
      3. -
diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index 864921e2a..90f96d0c2 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -333,18 +333,6 @@ COORDINATE:NewFromVec3(Vec3)

Create a new COORDINATE object from Vec3 coordinates.

- - - - COORDINATE:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked) - -

Build an air type route point.

- - - - COORDINATE:RoutePointGround(Speed, Formation) - -

Build an ground type route point.

@@ -443,6 +431,18 @@ COORDINATE:Translate(Distance, Angle)

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

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

Build an air type route point.

+ + + + COORDINATE:WaypointGround(Speed, Formation) + +

Build an ground type route point.

@@ -799,8 +799,8 @@

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

@@ -1776,90 +1776,6 @@ The Vec3 point.

#COORDINATE:

- -
-
-
- - -COORDINATE:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked) - -
-
- -

Build an air type route point.

- -

Parameters

- -

Return value

- -

#table: -The route point.

- -
-
-
-
- - -COORDINATE:RoutePointGround(Speed, Formation) - -
-
- -

Build an ground type route point.

- -

Parameters

- -

Return value

- -

#table: -The route point.

-
@@ -2277,6 +2193,90 @@ The Angle in degrees.

#COORDINATE: The new calculated COORDINATE.

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

Build an air type route point.

+ +

Parameters

+ +

Return value

+ +

#table: +The route point.

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

+
@@ -2829,6 +2829,7 @@ The y coordinate.

+ POINT_VEC2.z diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index 82d94f58f..fa05e1be4 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -760,21 +760,11 @@ The POSITIONABLE is not existing or alive.

Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

-

Return values

-
    -
  1. +

    Return value

    Core.Point#COORDINATE: The COORDINATE of the POSITIONABLE.

    -
    2. -
  2. - -

    #nil: -The POSITIONABLE is not existing or alive.

    - -
    3. -
diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 20fe7f177..d292c0d76 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2735,6 +2735,9 @@ when nothing was spawned.

+ +

Overwrite unit names by default with group name.

+
@@ -3132,7 +3135,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
- + #boolean SPAWN.SpawnUnControlled @@ -3156,7 +3159,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

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

+

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

diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 349f0de89..cb7e1e28f 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -552,7 +552,7 @@ based on the tasking capabilities defined in Task#TA
- Core.Cargo#CARGO_GROUP + Core.Cargo#CARGO FSM_PROCESS.Cargo @@ -566,7 +566,6 @@ based on the tasking capabilities defined in Task#TA
- FSM_PROCESS.DeployZone @@ -631,7 +630,7 @@ based on the tasking capabilities defined in Task#TA
- #number + TASK_CARGO.CargoLimit