From 8a334b667138251073a6e78e7dae2b41f03a47e6 Mon Sep 17 00:00:00 2001 From: FlightControl_Master Date: Tue, 8 Aug 2017 16:11:31 +0200 Subject: [PATCH] Documentation --- .../Moose/Wrapper/Controllable.lua | 35 ++++++++- docs/Documentation/Cargo.html | 1 - docs/Documentation/Controllable.html | 77 ++++++++++++++++++- docs/Documentation/Fsm.html | 3 +- docs/Documentation/Movement.html | 4 + docs/Documentation/Spot.html | 4 - docs/Documentation/Task_Cargo.html | 5 +- 7 files changed, 116 insertions(+), 13 deletions(-) diff --git a/Moose Development/Moose/Wrapper/Controllable.lua b/Moose Development/Moose/Wrapper/Controllable.lua index 2e42342a5..bb49e4414 100644 --- a/Moose Development/Moose/Wrapper/Controllable.lua +++ b/Moose Development/Moose/Wrapper/Controllable.lua @@ -124,7 +124,15 @@ -- * @{#CONTROLLABLE.CommandDoScript}: Do Script command. -- * @{#CONTROLLABLE.CommandSwitchWayPoint}: Perform a switch waypoint command. -- --- ## CONTROLLABLE Option methods +-- ## Routing of Controllables +-- +-- Different routing methods exist to route GROUPs and UNITs to different locations: +-- +-- * @{#CONTROLLABLE.Route}(): Make the Controllable to follow a given route. +-- * @{#CONTROLLABLE.RouteGroundTo}(): Make the GROUND Controllable to drive towards a specific coordinate. +-- * @{#CONTROLLABLE.RouteAirTo}(): Make the AIR Controllable to fly towards a specific coordinate. +-- +-- ## Option methods -- -- Controllable **Option methods** change the behaviour of the Controllable while being alive. -- @@ -1762,7 +1770,7 @@ function CONTROLLABLE:Route( Route, DelaySeconds ) end ---- Make the GROUND controllable to drive towards a specific point. +--- Make the GROUND Controllable to drive towards a specific point. -- @param #CONTROLLABLE self -- @param Core.Point#COORDINATE ToCoordinate A Coordinate to drive to. -- @param #number Speed (optional) Speed in km/h. The default speed is 999 km/h. @@ -1781,6 +1789,29 @@ function CONTROLLABLE:RouteGroundTo( ToCoordinate, Speed, Formation, DelaySecond return self end + +--- Make the AIR Controllable fly towards a specific point. +-- @param #CONTROLLABLE self +-- @param Core.Point#COORDINATE ToCoordinate A Coordinate to drive to. +-- @param Core.Point#COORDINATE.RoutePointAltType AltType The altitude type. +-- @param Core.Point#COORDINATE.RoutePointType Type The route point type. +-- @param Core.Point#COORDINATE.RoutePointAction Action The route point action. +-- @param #number Speed (optional) Speed in km/h. The default speed is 999 km/h. +-- @param #number DelaySeconds Wait for the specified seconds before executing the Route. +-- @return #CONTROLLABLE The CONTROLLABLE. +function CONTROLLABLE:RouteAirTo( ToCoordinate, AltType, Type, Action, Speed, DelaySeconds ) + + local FromCoordinate = self:GetCoordinate() + local FromWP = FromCoordinate:WaypointAir() + + local ToWP = ToCoordinate:WaypointAir( AltType, Type, Action, Speed ) + + self:Route( { FromWP, ToWP }, DelaySeconds ) + + return self +end + + --- (AIR + GROUND) Route the controllable to a given zone. -- The controllable final destination point can be randomized. -- A speed can be given in km/h. diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index a11fd4dba..9f6098452 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -3417,7 +3417,6 @@ The range till cargo will board.

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

Make the controllable to follow a given route.

+ + + + CONTROLLABLE:RouteAirTo(ToCoordinate, AltType, Type, Action, Speed, DelaySeconds) + +

Make the AIR Controllable fly towards a specific point.

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

Make the GROUND controllable to drive towards a specific point.

+

Make the GROUND Controllable to drive towards a specific point.

@@ -820,6 +826,16 @@ The method CONTROLLABLE.SetTaskAtWa
  • CONTROLLABLE.CommandSwitchWayPoint: Perform a switch waypoint command.
    • +

    Routing of Controllables

    + +

    Different routing methods exist to route GROUPs and UNITs to different locations:

    + + +

    CONTROLLABLE Option methods

    Controllable Option methods change the behaviour of the Controllable while being alive.

    @@ -2220,13 +2236,70 @@ The CONTROLLABLE.

    + +CONTROLLABLE:RouteAirTo(ToCoordinate, AltType, Type, Action, Speed, DelaySeconds) + +
    +
    + +

    Make the AIR Controllable fly towards a specific point.

    + +

    Parameters

    + +

    Return value

    + +

    #CONTROLLABLE: +The CONTROLLABLE.

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

    Make the GROUND controllable to drive towards a specific point.

    +

    Make the GROUND Controllable to drive towards a specific point.

    Parameters

      diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index e0276d335..177f34281 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,7 +1897,6 @@ A string defining the start state.

      - FSM.current diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index 4307c3aaa..be5ce073c 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -227,6 +227,7 @@ on defined intervals (currently every minute).

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

      + +

      Contains the counter how many units are currently alive

      +
    diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index 5fdc3b305..ead3792db 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -765,7 +765,6 @@ true if it is lasing

    - SPOT.ScheduleID @@ -779,7 +778,6 @@ true if it is lasing

    - SPOT.SpotIR @@ -793,7 +791,6 @@ true if it is lasing

    - SPOT.SpotLaser @@ -807,7 +804,6 @@ true if it is lasing

    - SPOT.Target diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index cb7e1e28f..349f0de89 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 + Core.Cargo#CARGO_GROUP FSM_PROCESS.Cargo @@ -566,6 +566,7 @@ based on the tasking capabilities defined in Task#TA
    + FSM_PROCESS.DeployZone @@ -630,7 +631,7 @@ based on the tasking capabilities defined in Task#TA
    - + #number TASK_CARGO.CargoLimit