From ede7813a94794dd8b8f83415904987ce88fbe986 Mon Sep 17 00:00:00 2001 From: FlightControl Date: Sat, 23 Jul 2016 10:32:41 +0200 Subject: [PATCH] Updated documentation --- Moose Training/Documentation/Point.html | 136 +++++++++++++++ Moose Training/Documentation/Spawn.html | 204 ++++++++++++++++++++++- Moose Training/Documentation/Static.html | 26 ++- 3 files changed, 361 insertions(+), 5 deletions(-) diff --git a/Moose Training/Documentation/Point.html b/Moose Training/Documentation/Point.html index b12c4d602..38ce6a40d 100644 --- a/Moose Training/Documentation/Point.html +++ b/Moose Training/Documentation/Point.html @@ -167,6 +167,12 @@ In order to keep the credibility of the the author, I want to emphasize that the POINT_VEC2:New(x, y, LandHeightAdd)

Create a new POINT_VEC2 object.

+ + + + POINT_VEC2:NewFromVec2(Vec2, LandHeightAdd) + +

Create a new POINT_VEC2 object from Vec2 coordinates.

@@ -261,6 +267,24 @@ In order to keep the credibility of the the author, I want to emphasize that the POINT_VEC3:GetNorthCorrectionRadians()

Get a correction in radians of the real magnetic north of the POINT_VEC3.

+ + + + POINT_VEC3:GetRandomVec2InRadius(OuterRadius, InnerRadius) + +

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

+ + + + POINT_VEC3:GetRandomVec3InRadius(OuterRadius, InnerRadius) + +

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

+ + + + POINT_VEC3:GetVec2() + +

Return the coordinates of the POINT_VEC3 in Vec2 format.

@@ -654,6 +678,38 @@ The y coordinate of the Vec3 point, pointing to the Right.

Point#POINT_VEC2:

+ + +
+
+ + +POINT_VEC2:NewFromVec2(Vec2, LandHeightAdd) + +
+
+ +

Create a new POINT_VEC2 object from Vec2 coordinates.

+ +

Parameters

+
    +
  • + +

    DCSTypes#Vec2 Vec2 : +The Vec2 point.

    + +
    • +
  • + +

    LandHeightAdd :

    + +
    • +
+

Return value

+ +

Point#POINT_VEC2: +self

+
@@ -1018,6 +1074,86 @@ CorrectionRadians The correction in radians.

+ +POINT_VEC3:GetRandomVec2InRadius(OuterRadius, InnerRadius) + +
+
+ +

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

+ +

Parameters

+ +

Return value

+ +

DCSTypes#Vec2: +Vec2

+ +
+
+
+
+ + +POINT_VEC3:GetRandomVec3InRadius(OuterRadius, InnerRadius) + +
+
+ +

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

+ +

Parameters

+ +

Return value

+ +

DCSTypes#Vec3: +Vec3

+ +
+
+
+
+ + +POINT_VEC3:GetVec2() + +
+
+ +

Return the coordinates of the POINT_VEC3 in Vec2 format.

+ +

Return value

+ +

DCSTypes#Vec2: +The Vec2 coodinate.

+ +
+
+
+
+ POINT_VEC3:GetVec3() diff --git a/Moose Training/Documentation/Spawn.html b/Moose Training/Documentation/Spawn.html index 2bd2d813f..cf7bb763b 100644 --- a/Moose Training/Documentation/Spawn.html +++ b/Moose Training/Documentation/Spawn.html @@ -153,6 +153,9 @@ So in principle, the group list will contain all parameters and configurations a
  • SPAWN.Spawn: Spawn one new group based on the last spawned index.
  • SPAWN.ReSpawn: Re-spawn a group based on a given index.
  • SPAWN.SpawnScheduled: Spawn groups at scheduled but randomized intervals. You can use SPAWN.SpawnScheduleStart and SPAWN.SpawnScheduleStop to start and stop the schedule respectively.
    • +
  • SPAWN.SpawnFromVec3: Spawn a new group from a Vec3 coordinate. (The group will can be spawned at a point in the air).
    • +
  • SPAWN.SpawnFromVec2: Spawn a new group from a Vec2 coordinate. (The group will be spawned at land height ).
    • +
  • SPAWN.SpawnFromStatic: Spawn a new group from a structure, taking the position of a STATIC.
  • SPAWN.SpawnFromUnit: Spawn a new group taking the position of a UNIT.
  • SPAWN.SpawnInZone: Spawn a new group in a ZONE.
    • @@ -350,12 +353,30 @@ Check the SPAWN.CleanUp for further info.

    SPAWN.SpawnCleanUpTimeStamps + + + + SPAWN:SpawnFromStatic(HostStatic, OuterRadius, InnerRadius, SpawnIndex) + +

    Will spawn a group from a hosting static.

    SPAWN:SpawnFromUnit(HostUnit, OuterRadius, InnerRadius, SpawnIndex)

    Will spawn a group from a hosting unit.

    + + + + SPAWN:SpawnFromVec2(Vec2, OuterRadius, InnerRadius, SpawnIndex) + +

    Will spawn a group from a Vec2 in 3D space.

    + + + + SPAWN:SpawnFromVec3(Vec3, OuterRadius, InnerRadius, SpawnIndex) + +

    Will spawn a group from a Vec3 in 3D space.

    @@ -1358,6 +1379,65 @@ The group that was spawned. You can use this group for further actions.

    + +
    +
    +
    + + +SPAWN:SpawnFromStatic(HostStatic, OuterRadius, InnerRadius, SpawnIndex) + +
    +
    + +

    Will spawn a group from a hosting static.

    + + +

    This function is mostly advisable to be used if you want to simulate spawning from buldings and structures (static buildings). +You can use the returned group to further define the route to be followed.

    + +

    Parameters

    +
      +
    • + +

      Static#STATIC HostStatic : +The static dropping or unloading the group.

      + +
      • +
    • + +

      #number OuterRadius : +(Optional) The outer radius in meters where the new group will be spawned.

      + +
      • +
    • + +

      #number InnerRadius : +(Optional) The inner radius in meters where the new group will NOT be spawned.

      + +
      • +
    • + +

      #number SpawnIndex : +(Optional) The index which group to spawn within the given zone.

      + +
      • +
    +

    Return values

    +
      +
    1. + +

      Group#GROUP: +that was spawned.

      + +
      2. +
    2. + +

      #nil: +Nothing was spawned.

      + +
      3. +
    @@ -1387,13 +1467,133 @@ The air or ground unit dropping or unloading the group.

  • #number OuterRadius : -The outer radius in meters where the new group will be spawned.

    +(Optional) The outer radius in meters where the new group will be spawned.

  • #number InnerRadius : -The inner radius in meters where the new group will NOT be spawned.

    +(Optional) The inner radius in meters where the new group will NOT be spawned.

    + +
    • +
  • + +

    #number SpawnIndex : +(Optional) The index which group to spawn within the given zone.

    + +
    • + +

    Return values

    +
      +
    1. + +

      Group#GROUP: +that was spawned.

      + +
      2. +
    2. + +

      #nil: +Nothing was spawned.

      + +
      3. +
    + +
    +
    +
    + + +SPAWN:SpawnFromVec2(Vec2, OuterRadius, InnerRadius, SpawnIndex) + +
    +
    + +

    Will spawn a group from a Vec2 in 3D space.

    + + +

    This function is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. +Note that each point in the route assigned to the spawning group is reset to the point of the spawn. +You can use the returned group to further define the route to be followed.

    + +

    Parameters

    +
      +
    • + +

      DCSTypes#Vec2 Vec2 : +The Vec2 coordinates where to spawn the group.

      + +
      • +
    • + +

      #number OuterRadius : +(Optional) The outer radius in meters where the new group will be spawned.

      + +
      • +
    • + +

      #number InnerRadius : +(Optional) The inner radius in meters where the new group will NOT be spawned.

      + +
      • +
    • + +

      #number SpawnIndex : +(Optional) The index which group to spawn within the given zone.

      + +
      • +
    +

    Return values

    +
      +
    1. + +

      Group#GROUP: +that was spawned.

      + +
      2. +
    2. + +

      #nil: +Nothing was spawned.

      + +
      3. +
    +
    +
    +
    +
    + + +SPAWN:SpawnFromVec3(Vec3, OuterRadius, InnerRadius, SpawnIndex) + +
    +
    + +

    Will spawn a group from a Vec3 in 3D space.

    + + +

    This function is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. +Note that each point in the route assigned to the spawning group is reset to the point of the spawn. +You can use the returned group to further define the route to be followed.

    + +

    Parameters

    +
      +
    • + +

      DCSTypes#Vec3 Vec3 : +The Vec3 coordinates where to spawn the group.

      + +
      • +
    • + +

      #number OuterRadius : +(Optional) The outer radius in meters where the new group will be spawned.

      + +
      • +
    • + +

      #number InnerRadius : +(Optional) The inner radius in meters where the new group will NOT be spawned.

    • diff --git a/Moose Training/Documentation/Static.html b/Moose Training/Documentation/Static.html index 2485c6ec9..94315f2ae 100644 --- a/Moose Training/Documentation/Static.html +++ b/Moose Training/Documentation/Static.html @@ -151,7 +151,7 @@ If the DCS Static object does not exist or is nil, the STATIC methods will retur - STATIC:GetDCSUnit() + STATIC:GetDCSObject() @@ -160,6 +160,12 @@ If the DCS Static object does not exist or is nil, the STATIC methods will retur STATIC:Register(StaticName) + + + + STATIC.StaticName + + @@ -233,8 +239,8 @@ Name of the DCS Static as defined within the Mission Editor.

      - -STATIC:GetDCSUnit() + +STATIC:GetDCSObject()
      @@ -262,6 +268,20 @@ Name of the DCS Static as defined within the Mission Editor.

    +
    +
    +
    +
    + + + +STATIC.StaticName + +
    +
    + + +