From 6799cd776e95d41d1e949b4aca19a7163e28d7b9 Mon Sep 17 00:00:00 2001 From: FlightControl_Master Date: Fri, 15 Sep 2017 16:17:08 +0200 Subject: [PATCH] RAT documentation update --- docs/Documentation/Designate.html | 1 + docs/Documentation/Detection.html | 4 +- docs/Documentation/Fsm.html | 3 +- docs/Documentation/Movement.html | 4 - docs/Documentation/Positionable.html | 1 - docs/Documentation/Rat.html | 277 ++++++++++++++++++++++++++- docs/Documentation/Settings.html | 2 +- docs/Documentation/Spawn.html | 14 +- docs/Documentation/SpawnStatic.html | 1 + docs/Documentation/Task_Cargo.html | 3 +- 10 files changed, 287 insertions(+), 23 deletions(-) diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index ff349e1b5..8ecc57ea8 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -1151,6 +1151,7 @@ function below will use the range 1-7 just in case

+ DESIGNATE.LaserCodes diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index db832f4d5..da950516a 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2460,7 +2460,6 @@ The index of the DetectedItem.

- #number DETECTION_BASE.DetectedItemCount @@ -2474,7 +2473,6 @@ The index of the DetectedItem.

- #number DETECTION_BASE.DetectedItemMax @@ -4052,7 +4050,7 @@ Return false to cancel Transition.

- #number + DETECTION_BASE.RefreshTimeInterval diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index dc67c7520..b58946d17 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -1599,7 +1599,7 @@ A string defining the start state.

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

- FSM.current diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index 3123488df..dfb86750e 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -228,7 +228,6 @@ on defined intervals (currently every minute).

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

- -

Contains the counter how many units are currently alive

-
diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index 35cac07a2..e531312d4 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -1974,7 +1974,6 @@ The height in meters to add to the altitude of the positionable.

- Core.Spot#SPOT POSITIONABLE.Spot diff --git a/docs/Documentation/Rat.html b/docs/Documentation/Rat.html index 41cd88aa0..93e33ac5f 100644 --- a/docs/Documentation/Rat.html +++ b/docs/Documentation/Rat.html @@ -223,6 +223,12 @@ RAT.FLuser

Flight level set by users explicitly.

+ + + + RAT:Livery(skins) + +

Set livery of aircraft.

@@ -283,6 +289,12 @@ RAT:SetCoalition(friendly)

Set the friendly coalitions from which the airports can be used as departure or destination.

+ + + + RAT:SetCruiseAltitude(alt) + +

Set cruising altitude.

@@ -325,6 +337,12 @@ RAT:SetFLmin(height)

Set min flight level.

+ + + + RAT:SetMaCruiseAltitude(alt) + +

Set max cruising altitude above sea level.

@@ -337,6 +355,12 @@ RAT:SetMaxDistance(dist)

Set maximum distance between departure and destination.

+ + + + RAT:SetMinCruiseAltitude(alt) + +

Set min cruising altitude above sea level.

@@ -408,7 +432,7 @@ RAT.Tinactive -

Time in seconds after which inactive units will be destroyed. Default is 180 seconds.

+

Time in seconds after which inactive units will be destroyed. Default is 300 seconds.

@@ -493,6 +517,12 @@ RAT:_InitAircraft(DCSgroup)

Initialize basic parameters of the aircraft based on its (template) group in the mission editor.

+ + + + RAT:_MinDistance(alpha, beta, h) + +

Calculate min distance between departure and destination for given minimum flight level and climb/decent rates

@@ -739,12 +769,24 @@ RAT.friendly

Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red.

+ + + + RAT:has_value(tab, val) + +

Utility function which checks if table contains a specific value.

RAT.id

Some ID to identify who we are in output of the DCS.log file.

+ + + + RAT.livery + +

Livery of the aircraft set by user.

@@ -775,6 +817,12 @@ RAT.ngroups

Number of groups to be spawned in total.

+ + + + RAT.onboard_num + + @@ -829,6 +877,12 @@ RAT.rot

ROT of spawned groups, default is no reaction. Possible: "noreaction", "passive", "evade".

+ + + + RAT.skill + +

Skill of AI.

@@ -902,7 +956,7 @@
  • A specific departure and/or destination airport can be chosen.
    • -
  • Valid coalitions can be set, e.g. only red, blue or neutral, all three �colours�.
    • +
  • Valid coalitions can be set, e.g. only red, blue or neutral, all three "colours".
  • It is possible to start in air within a zone defined in the mission editor or within a zone above an airport of the map.
@@ -936,7 +990,7 @@
  • Activate the "LATE ACTIVATION" tick box. Note that this aircraft will not be spawned itself but serves a template for each RAT aircraft spawned when the mission starts.
    • -

    Voil�, your already done!

    +

    Voilà, your already done!

    Optionally, you can set a specific livery for the aircraft or give it some weapons. However, the aircraft will by default not engage any enemies. Think of them as beeing on a peaceful or ferry mission.

    @@ -1158,6 +1212,31 @@ Turn journey on=true or off=false. If no value is given switch=true.

    Flight level set by users explicitly.

    + +
    +
    +
    + + +RAT:Livery(skins) + +
    +
    + +

    Set livery of aircraft.

    + + +

    If more than one livery is specified in a table, the actually used one is chosen randomly from the selection.

    + +

    Parameter

    +
      +
    • + +

      #string skins : +Name of livery or table of names of liveries.

      + +
      • +
    @@ -1394,6 +1473,31 @@ Default is "same", so aircraft will use airports of the coalition their spawn te
    + +RAT:SetCruiseAltitude(alt) + +
    +
    + +

    Set cruising altitude.

    + + +

    This is still be checked for consitancy with selected route and prone to radomization.

    + +

    Parameter

    +
      +
    • + +

      #number alt : +Cruising altitude ASL in meters.

      + +
      • +
    +
    +
    +
    +
    + RAT:SetDeparture(names) @@ -1580,6 +1684,28 @@ Maximum FL in hundrets of feet.

    + +RAT:SetMaCruiseAltitude(alt) + +
    +
    + +

    Set max cruising altitude above sea level.

    + +

    Parameter

    +
      +
    • + +

      #number alt : +Altitude ASL in meters.

      + +
      • +
    +
    +
    +
    +
    + RAT:SetMaxCruiseSpeed(speed) @@ -1627,6 +1753,28 @@ Distance in km.

    + +RAT:SetMinCruiseAltitude(alt) + +
    +
    + +

    Set min cruising altitude above sea level.

    + +

    Parameter

    +
      +
    • + +

      #number alt : +Altitude ASL in meters.

      + +
      • +
    +
    +
    +
    +
    + RAT:SetMinDistance(dist) @@ -1890,7 +2038,7 @@ true=on, false=off.

    Set the time after which inactive groups will be destroyed.

    -

    Default is 180 seconds.

    +

    Default is 300 seconds.

    Parameter

      @@ -1913,7 +2061,7 @@ Time in seconds.

    -

    Time in seconds after which inactive units will be destroyed. Default is 180 seconds.

    +

    Time in seconds after which inactive units will be destroyed. Default is 300 seconds.

    @@ -2140,7 +2288,7 @@ Height [m] of departure airport. Note we implicitly assume that the height diffe

    Return value

    #number: - Maximal flight level in meters.

    +Maximal flight level in meters.

    @@ -2274,6 +2422,45 @@ Group of the aircraft in the mission editor.

    + +RAT:_MinDistance(alpha, beta, h) + +
    +
    + +

    Calculate min distance between departure and destination for given minimum flight level and climb/decent rates

    + +

    Parameters

    +
      +
    • + +

      #number alpha : +Angle of climb [rad].

      + +
      • +
    • + +

      #number beta : +Angle of descent [rad].

      + +
      • +
    • + +

      #number h : +min height AGL.

      + +
      • +
    +

    Return value

    + +

    #number: +Minimum distance between departure and destiantion.

    + +
    +
    +
    +
    + RAT:_ModifySpawnTemplate(waypoints) @@ -3253,6 +3440,39 @@ Waypoints for DCS task route or spawn template.

    Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red.

    + +
    +
    +
    + + +RAT:has_value(tab, val) + +
    +
    + +

    Utility function which checks if table contains a specific value.

    + +

    Parameters

    +
      +
    • + +

      #table tab : +Table with elements to check.

      + +
      • +
    • + +

      #string val : +The value we are looking for.

      + +
      • +
    +

    Return value

    + +

    #boolean: +True if element in the list, false otherwise.

    +
    @@ -3267,6 +3487,20 @@ Waypoints for DCS task route or spawn template.

    Some ID to identify who we are in output of the DCS.log file.

    + +
    +
    +
    + + #string + +RAT.livery + +
    +
    + +

    Livery of the aircraft set by user.

    +
    @@ -3337,6 +3571,23 @@ Waypoints for DCS task route or spawn template.

    Number of groups to be spawned in total.

    + +
    +
    +
    + + + +RAT.onboard_num + +
    +
    + + + + +

    Onboard number.

    +
    @@ -3463,6 +3714,20 @@ Waypoints for DCS task route or spawn template.

    ROT of spawned groups, default is no reaction. Possible: "noreaction", "passive", "evade".

    + +
    +
    +
    + + #string + +RAT.skill + +
    +
    + +

    Skill of AI.

    +
    diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 274a10019..0ff600a3c 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -1241,7 +1241,7 @@ true if metric.

    - #boolean + SETTINGS.Metric diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 2a77723ca..039d0dee1 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2192,6 +2192,9 @@ 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.

    +
    @@ -2780,6 +2783,9 @@ when nothing was spawned.

    + +

    By default, no InitLimit

    +
    @@ -2815,7 +2821,7 @@ when nothing was spawned.

    - + #number SPAWN.SpawnMaxGroups @@ -2832,7 +2838,7 @@ when nothing was spawned.

    - + #number SPAWN.SpawnMaxUnitsAlive @@ -3160,7 +3166,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
    - + #boolean SPAWN.SpawnUnControlled @@ -3184,7 +3190,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/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index 487563b09..251693d35 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -437,6 +437,7 @@ ptional) The name of the new static.

    + #number SPAWNSTATIC.SpawnIndex diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 2f9cb7b3a..ce24d8062 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -553,7 +553,7 @@ based on the tasking capabilities defined in Task#TA
    - Core.Cargo#CARGO_GROUP + FSM_PROCESS.Cargo @@ -567,7 +567,6 @@ based on the tasking capabilities defined in Task#TA
    - FSM_PROCESS.DeployZone