From fb1e9972a55adfabfa9f2de11005b1c9de85d9e2 Mon Sep 17 00:00:00 2001 From: FlightControl Date: Tue, 23 May 2017 22:20:29 +0200 Subject: [PATCH] Documentation --- .../bin/TreeHierarchy.csv | 74 +- docs/Documentation/AI_BAI.html | 3 + docs/Documentation/AI_Balancer.html | 3 + docs/Documentation/AI_Cap.html | 3 + docs/Documentation/AI_Cas.html | 3 + docs/Documentation/AI_Formation.html | 3 + docs/Documentation/AI_Patrol.html | 6 + docs/Documentation/Account.html | 3 + docs/Documentation/Airbase.html | 3 + docs/Documentation/AirbasePolice.html | 3 + docs/Documentation/Assign.html | 3 + docs/Documentation/Base.html | 13 +- docs/Documentation/Cargo.html | 3 + docs/Documentation/CleanUp.html | 3 + docs/Documentation/Client.html | 3 + docs/Documentation/CommandCenter.html | 3 + docs/Documentation/Controllable.html | 27 + docs/Documentation/DCSAirbase.html | 3 + docs/Documentation/DCSCoalitionObject.html | 3 + docs/Documentation/DCSCommand.html | 3 + docs/Documentation/DCSController.html | 3 + docs/Documentation/DCSGroup.html | 3 + docs/Documentation/DCSObject.html | 3 + docs/Documentation/DCSTask.html | 3 + docs/Documentation/DCSTypes.html | 3 + docs/Documentation/DCSUnit.html | 3 + docs/Documentation/DCSVec3.html | 3 + docs/Documentation/DCSWorld.html | 3 + docs/Documentation/DCSZone.html | 3 + docs/Documentation/DCScountry.html | 3 + docs/Documentation/DCStimer.html | 3 + docs/Documentation/DCStrigger.html | 3 + docs/Documentation/Database.html | 214 +- docs/Documentation/Designate.html | 3 + docs/Documentation/Detection.html | 423 ++- docs/Documentation/DetectionManager.html | 3 + docs/Documentation/Escort.html | 3 + docs/Documentation/Event.html | 3 + docs/Documentation/Fsm.html | 3 + docs/Documentation/Group.html | 37 + docs/Documentation/Identifiable.html | 3 + docs/Documentation/Menu.html | 3 + docs/Documentation/Message.html | 3 + docs/Documentation/MissileTrainer.html | 3 + docs/Documentation/Mission.html | 121 +- docs/Documentation/Movement.html | 7 +- docs/Documentation/Object.html | 3 + docs/Documentation/Point.html | 2588 +++++++++-------- docs/Documentation/Positionable.html | 3 + docs/Documentation/Process_JTAC.html | 3 + docs/Documentation/Process_Pickup.html | 3 + docs/Documentation/Radio.html | 3 + docs/Documentation/Route.html | 346 ++- docs/Documentation/Scenery.html | 3 + docs/Documentation/ScheduleDispatcher.html | 3 + docs/Documentation/Scheduler.html | 3 + docs/Documentation/Scoring.html | 31 + docs/Documentation/Sead.html | 3 + docs/Documentation/Set.html | 3 + docs/Documentation/Settings.html | 1450 +++++++++ docs/Documentation/Smoke.html | 3 + docs/Documentation/Spawn.html | 12 +- docs/Documentation/SpawnStatic.html | 4 +- docs/Documentation/Spot.html | 3 + docs/Documentation/Static.html | 3 + docs/Documentation/StaticObject.html | 3 + docs/Documentation/Task.html | 27 +- docs/Documentation/Task_A2A.html | 1012 +++++++ docs/Documentation/Task_A2A_Dispatcher.html | 639 ++++ docs/Documentation/Task_A2G.html | 43 +- docs/Documentation/Task_A2G_Dispatcher.html | 3 + docs/Documentation/Task_Cargo.html | 5 +- docs/Documentation/Task_PICKUP.html | 3 + docs/Documentation/Unit.html | 3 + docs/Documentation/Utils.html | 3 + docs/Documentation/Zone.html | 3 + docs/Documentation/env.html | 3 + docs/Documentation/index.html | 21 + docs/Documentation/land.html | 3 + docs/Documentation/routines.html | 3 + 80 files changed, 5769 insertions(+), 1508 deletions(-) create mode 100644 docs/Documentation/Settings.html create mode 100644 docs/Documentation/Task_A2A.html create mode 100644 docs/Documentation/Task_A2A_Dispatcher.html diff --git a/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv b/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv index 94fc57631..c5a17961d 100644 --- a/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv +++ b/Utils/Slate Documentation Generator/bin/TreeHierarchy.csv @@ -1,35 +1,41 @@ +@K=function, @M=Task_A2A, @N=onafterRouteToRendezVous, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2A.lua, @C=4756, +@K=function, @M=Task_A2A, @N=OnAfterArriveAtRendezVous, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2A.lua, @C=5417, +@K=function, @M=Task_A2A, @N=onafterEngage, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2A.lua, @C=5814, +@K=function, @M=Task_A2A, @N=onafterRouteToTarget, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2A.lua, @C=6136, +@K=function, @M=Task_A2A, @N=onafterRouteToTargets, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2A.lua, @C=7017, @K=function, @M=Task_A2G, @N=onafterRouteToRendezVous, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=5157, -@K=function, @M=Task_A2G, @N=OnAfterArriveAtRendezVous, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=5817, -@K=function, @M=Task_A2G, @N=onafterEngage, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=6214, -@K=function, @M=Task_A2G, @N=onafterRouteToTarget, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=6536, -@K=function, @M=Task_A2G, @N=onafterRouteToTargets, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=7408, -@K=function, @M=Task_Cargo, @N=onafterSelectAction, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=10439, -@K=function, @M=Task_Cargo, @N=OnLeaveWaitingForCommand, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=13084, -@K=function, @M=Task_Cargo, @N=onafterRouteToPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=13860, -@K=function, @M=Task_Cargo, @N=onafterArriveAtPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=14479, -@K=function, @M=Task_Cargo, @N=onafterRouteToDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15020, -@K=function, @M=Task_Cargo, @N=onafterArriveAtDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15467, -@K=function, @M=Task_Cargo, @N=onafterLand, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15897, -@K=function, @M=Task_Cargo, @N=onafterLanded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=16856, -@K=function, @M=Task_Cargo, @N=onafterPrepareBoarding, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=17622, -@K=function, @M=Task_Cargo, @N=onafterBoard, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=18082, -@K=function, @M=Task_Cargo, @N=onafterBoarded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=19023, -@K=function, @M=Task_Cargo, @N=onafterPrepareUnBoarding, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=19706, -@K=function, @M=Task_Cargo, @N=onafterUnBoard, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=20666, -@K=function, @M=Task_Cargo, @N=onafterUnBoarded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=21541, -@K=function, @M=Designate, @N=OnBeforeLaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12232, -@K=function, @M=Designate, @N=OnAfterLaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12480, -@K=function, @M=Designate, @N=LaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12701, -@K=function, @M=Designate, @N=__LaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12824, -@K=function, @M=Designate, @N=OnBeforeLaseOff, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13114, -@K=function, @M=Designate, @N=OnAfterLaseOff, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13364, -@K=function, @M=Designate, @N=LaseOff, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13587, -@K=function, @M=Designate, @N=__LaseOff, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13712, -@K=function, @M=Designate, @N=OnBeforeSmoke, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13944, -@K=function, @M=Designate, @N=OnAfterSmoke, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=14190, -@K=function, @M=Designate, @N=Smoke, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=14409, -@K=function, @M=Designate, @N=__Smoke, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=14530, -@K=function, @M=Designate, @N=OnBeforeStatus, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=15628, -@K=function, @M=Designate, @N=OnAfterStatus, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=15876, -@K=function, @M=Designate, @N=Status, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=16097, -@K=function, @M=Designate, @N=__Status, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=16220, +@K=function, @M=Task_A2G, @N=OnAfterArriveAtRendezVous, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=5818, +@K=function, @M=Task_A2G, @N=onafterEngage, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=6215, +@K=function, @M=Task_A2G, @N=onafterRouteToTarget, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=6537, +@K=function, @M=Task_A2G, @N=onafterRouteToTargets, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_A2G.lua, @C=7416, +@K=function, @M=Task_Cargo, @N=onafterSelectAction, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=10673, +@K=function, @M=Task_Cargo, @N=OnLeaveWaitingForCommand, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=13702, +@K=function, @M=Task_Cargo, @N=onafterRouteToPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=14474, +@K=function, @M=Task_Cargo, @N=onafterArriveAtPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15093, +@K=function, @M=Task_Cargo, @N=onafterCancelRouteToPickup, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15634, +@K=function, @M=Task_Cargo, @N=onafterRouteToDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=15971, +@K=function, @M=Task_Cargo, @N=onafterArriveAtDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=16418, +@K=function, @M=Task_Cargo, @N=onafterCancelRouteToDeploy, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=16846, +@K=function, @M=Task_Cargo, @N=onafterLanded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=18133, +@K=function, @M=Task_Cargo, @N=onafterPrepareBoarding, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=18899, +@K=function, @M=Task_Cargo, @N=onafterBoard, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=19359, +@K=function, @M=Task_Cargo, @N=onafterBoarded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=20300, +@K=function, @M=Task_Cargo, @N=onafterPrepareUnBoarding, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=20983, +@K=function, @M=Task_Cargo, @N=onafterUnBoard, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=21943, +@K=function, @M=Task_Cargo, @N=onafterUnBoarded, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\Tasking\Task_CARGO.lua, @C=22962, +@K=function, @M=Designate, @N=OnBeforeLaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12218, +@K=function, @M=Designate, @N=OnAfterLaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12466, +@K=function, @M=Designate, @N=LaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12687, +@K=function, @M=Designate, @N=__LaseOn, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=12810, +@K=function, @M=Designate, @N=OnBeforeLaseOff, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13094, +@K=function, @M=Designate, @N=OnAfterLaseOff, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13344, +@K=function, @M=Designate, @N=LaseOff, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13567, +@K=function, @M=Designate, @N=__LaseOff, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13692, +@K=function, @M=Designate, @N=OnBeforeSmoke, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=13906, +@K=function, @M=Designate, @N=OnAfterSmoke, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=14152, +@K=function, @M=Designate, @N=Smoke, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=14371, +@K=function, @M=Designate, @N=__Smoke, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=14492, +@K=function, @M=Designate, @N=OnBeforeStatus, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=15578, +@K=function, @M=Designate, @N=OnAfterStatus, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=15826, +@K=function, @M=Designate, @N=Status, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=16047, +@K=function, @M=Designate, @N=__Status, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=16170, diff --git a/docs/Documentation/AI_BAI.html b/docs/Documentation/AI_BAI.html index a778055c0..5c91e2d34 100644 --- a/docs/Documentation/AI_BAI.html +++ b/docs/Documentation/AI_BAI.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html index c33e7f6ec..79bfc515b 100644 --- a/docs/Documentation/AI_Balancer.html +++ b/docs/Documentation/AI_Balancer.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/AI_Cap.html b/docs/Documentation/AI_Cap.html index 50a719558..8536cb291 100644 --- a/docs/Documentation/AI_Cap.html +++ b/docs/Documentation/AI_Cap.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/AI_Cas.html b/docs/Documentation/AI_Cas.html index d8c87f024..677dbe72c 100644 --- a/docs/Documentation/AI_Cas.html +++ b/docs/Documentation/AI_Cas.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/AI_Formation.html b/docs/Documentation/AI_Formation.html index 2809b48df..f80dc8eab 100644 --- a/docs/Documentation/AI_Formation.html +++ b/docs/Documentation/AI_Formation.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index a349f1b11..72b9c5689 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -953,6 +956,9 @@ Use the method AIPATROLZONE.M + +

    This table contains the targets detected during patrol.

    +
    diff --git a/docs/Documentation/Account.html b/docs/Documentation/Account.html index 5609f0458..4b5401289 100644 --- a/docs/Documentation/Account.html +++ b/docs/Documentation/Account.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Airbase.html b/docs/Documentation/Airbase.html index dd2f0550d..4607bb108 100644 --- a/docs/Documentation/Airbase.html +++ b/docs/Documentation/Airbase.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/AirbasePolice.html b/docs/Documentation/AirbasePolice.html index 9e5241f98..cb727ef32 100644 --- a/docs/Documentation/AirbasePolice.html +++ b/docs/Documentation/AirbasePolice.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Assign.html b/docs/Documentation/Assign.html index 24c1ac926..d02174fb7 100644 --- a/docs/Documentation/Assign.html +++ b/docs/Documentation/Assign.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Base.html b/docs/Documentation/Base.html index 13e421b67..f64ed2f97 100644 --- a/docs/Documentation/Base.html +++ b/docs/Documentation/Base.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -263,7 +266,7 @@ YYYY-MM-DD: CLASS:NewFunction( Params ) added

    - BASE:GetState(Object, Key, Value) + BASE:GetState(Object, Key)

    Get a Value given a Key from the Object.

    @@ -1152,7 +1155,7 @@ is the Child class from which the Parent class needs to be retrieved.

    -BASE:GetState(Object, Key, Value) +BASE:GetState(Object, Key)
    @@ -1175,12 +1178,6 @@ The object that holds the Value set by the Key.

    Key : The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

    - -
  • - -

    Value : -The value to is stored in the Object.

    -

    • Return value

    diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 8b2fbef53..875f99a43 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html index fd65272a9..489617a1e 100644 --- a/docs/Documentation/CleanUp.html +++ b/docs/Documentation/CleanUp.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Client.html b/docs/Documentation/Client.html index bb434479a..27e7e6a3a 100644 --- a/docs/Documentation/Client.html +++ b/docs/Documentation/Client.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html index 2b0eff299..3f64c4468 100644 --- a/docs/Documentation/CommandCenter.html +++ b/docs/Documentation/CommandCenter.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html index f5b5395af..64d62a028 100644 --- a/docs/Documentation/Controllable.html +++ b/docs/Documentation/Controllable.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -381,6 +384,12 @@ This is different from the EnRoute tasks, where the targets of the task need to CONTROLLABLE:GetWayPoints()

    Get the current WayPoints set with the WayPoint functions( Note that the WayPoints can be nil, although there ARE waypoints).

    + + + + CONTROLLABLE:IsAirPlane() + +

    Returns if the Controllable contains AirPlanes.

    @@ -1467,6 +1476,24 @@ WayPoints If WayPoints is given, then return the WayPoints structure.

    + +CONTROLLABLE:IsAirPlane() + +
    +
    + +

    Returns if the Controllable contains AirPlanes.

    + +

    Return value

    + +

    #boolean: +true if Controllable contains AirPlanes.

    + +
    +
    +
    +
    + CONTROLLABLE:IsTargetDetected(DCSObject, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK) diff --git a/docs/Documentation/DCSAirbase.html b/docs/Documentation/DCSAirbase.html index 2af4af8a7..3ac796e64 100644 --- a/docs/Documentation/DCSAirbase.html +++ b/docs/Documentation/DCSAirbase.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSCoalitionObject.html b/docs/Documentation/DCSCoalitionObject.html index db3a4f6e7..5bdce602d 100644 --- a/docs/Documentation/DCSCoalitionObject.html +++ b/docs/Documentation/DCSCoalitionObject.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSCommand.html b/docs/Documentation/DCSCommand.html index ba3c6f68b..0d0452176 100644 --- a/docs/Documentation/DCSCommand.html +++ b/docs/Documentation/DCSCommand.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSController.html b/docs/Documentation/DCSController.html index 7bb78517e..69031cbe2 100644 --- a/docs/Documentation/DCSController.html +++ b/docs/Documentation/DCSController.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSGroup.html b/docs/Documentation/DCSGroup.html index 0e46e13f7..1880115ad 100644 --- a/docs/Documentation/DCSGroup.html +++ b/docs/Documentation/DCSGroup.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSObject.html b/docs/Documentation/DCSObject.html index 16726539b..c7ce85731 100644 --- a/docs/Documentation/DCSObject.html +++ b/docs/Documentation/DCSObject.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSTask.html b/docs/Documentation/DCSTask.html index 2c2a21004..970c60afc 100644 --- a/docs/Documentation/DCSTask.html +++ b/docs/Documentation/DCSTask.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSTypes.html b/docs/Documentation/DCSTypes.html index 09159ce8a..c792b366b 100644 --- a/docs/Documentation/DCSTypes.html +++ b/docs/Documentation/DCSTypes.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSUnit.html b/docs/Documentation/DCSUnit.html index 313ba5531..a6ef53171 100644 --- a/docs/Documentation/DCSUnit.html +++ b/docs/Documentation/DCSUnit.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSVec3.html b/docs/Documentation/DCSVec3.html index c06367600..25e1cdbc1 100644 --- a/docs/Documentation/DCSVec3.html +++ b/docs/Documentation/DCSVec3.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSWorld.html b/docs/Documentation/DCSWorld.html index 3ac33e80e..54a7c9322 100644 --- a/docs/Documentation/DCSWorld.html +++ b/docs/Documentation/DCSWorld.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCSZone.html b/docs/Documentation/DCSZone.html index fcfe71bef..4cdf096a3 100644 --- a/docs/Documentation/DCSZone.html +++ b/docs/Documentation/DCSZone.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCScountry.html b/docs/Documentation/DCScountry.html index 36b19f191..cf5c3702d 100644 --- a/docs/Documentation/DCScountry.html +++ b/docs/Documentation/DCScountry.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCStimer.html b/docs/Documentation/DCStimer.html index 035f72735..0486c6e93 100644 --- a/docs/Documentation/DCStimer.html +++ b/docs/Documentation/DCStimer.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/DCStrigger.html b/docs/Documentation/DCStrigger.html index 3c76851aa..45355f827 100644 --- a/docs/Documentation/DCStrigger.html +++ b/docs/Documentation/DCStrigger.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html index 1953c3339..074b166d3 100644 --- a/docs/Documentation/Database.html +++ b/docs/Documentation/Database.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -145,6 +148,12 @@ The following iterator methods are currently available within the DATABASE:

    DATABASE + + + + PlayerCheckSchedule + + @@ -241,7 +250,7 @@ The following iterator methods are currently available within the DATABASE:

    - DATABASE:DeletePlayer(PlayerName) + DATABASE:DeletePlayer(UnitName, PlayerName)

    Deletes a player from the DATABASE based on the Player Name.

    @@ -313,21 +322,27 @@ The following iterator methods are currently available within the DATABASE:

    - DATABASE:ForEachGroup(IteratorFunction, ...) + DATABASE:ForEachGroup(IteratorFunction, FinalizeFunction, ...)

    Iterate the DATABASE and call an iterator function for each alive GROUP, providing the GROUP and optional parameters.

    - DATABASE:ForEachPlayer(IteratorFunction, ...) + DATABASE:ForEachPlayer(IteratorFunction, FinalizeFunction, ...)

    Iterate the DATABASE and call an iterator function for each ALIVE player, providing the player name and optional parameters.

    - DATABASE:ForEachPlayerJoined(IteratorFunction, ...) + DATABASE:ForEachPlayerJoined(IteratorFunction, FinalizeFunction, ...)

    Iterate the DATABASE and call an iterator function for each player who has joined the mission, providing the Unit of the player and optional parameters.

    + + + + DATABASE:ForEachPlayerUnit(IteratorFunction, FinalizeFunction, ...) + +

    Iterate the DATABASE and call an iterator function for each ALIVE player UNIT, providing the player UNIT and optional parameters.

    @@ -394,6 +409,12 @@ The following iterator methods are currently available within the DATABASE:

    DATABASE:GetGroupTemplateFromUnitName(UnitName) + + + + DATABASE:GetPlayerSettings(PlayerName) + +

    Gets the player settings

    @@ -442,18 +463,36 @@ The following iterator methods are currently available within the DATABASE:

    DATABASE.PLAYERS + + + + DATABASE.PLAYERSETTINGS + + DATABASE.PLAYERSJOINED + + + + DATABASE.PLAYERUNITS + + DATABASE.STATICS + + + + DATABASE:SetPlayerSettings(PlayerName, Settings) + +

    Sets the player settings

    @@ -579,6 +618,20 @@ The following iterator methods are currently available within the DATABASE:

    +
    +
    +
    +
    + + + +PlayerCheckSchedule + +
    +
    + + +

    Type Database

    @@ -879,17 +932,22 @@ The name of the airbase

    -DATABASE:DeletePlayer(PlayerName) +DATABASE:DeletePlayer(UnitName, PlayerName)

    Deletes a player from the DATABASE based on the Player Name.

    -

    Parameter

    +

    Parameters

    +

    Return value

    + +

    #DATABASE: +self

    + +
    + +
    +
    + + +DATABASE:ForEachPlayerUnit(IteratorFunction, FinalizeFunction, ...) + +
    +
    + +

    Iterate the DATABASE and call an iterator function for each ALIVE player UNIT, providing the player UNIT and optional parameters.

    + +

    Parameters

    +
    +
    +
    +
    + + + +DATABASE.PLAYERSETTINGS + +
    +
    + + +
    @@ -1712,6 +1862,20 @@ DBObject = DATABASE:New() + +
    +
    +
    + + + +DATABASE.PLAYERUNITS + +
    +
    + + +
    @@ -1726,6 +1890,37 @@ DBObject = DATABASE:New() + +
    +
    +
    + + +DATABASE:SetPlayerSettings(PlayerName, Settings) + +
    +
    + +

    Sets the player settings

    + +

    Parameters

    + +

    Return value

    + +

    Core.Settings#SETTINGS:

    + +
    @@ -1830,6 +2025,7 @@ self

    + #number DATABASE.UNITS_Position diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index d8950ff85..bf0481cec 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index b60e01592..a1c42a3b0 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -197,13 +200,13 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu - DETECTION_AREAS:DetectedItemMenu(Index) + DETECTION_AREAS:DetectedItemMenu(Index, AttackGroup)

    Menu of a detected item using a given numeric index.

    - DETECTION_AREAS:DetectedItemReportSummary(Index) + DETECTION_AREAS:DetectedItemReportSummary(Index, AttackGroup)

    Report summary of a detected item using a given numeric index.

    @@ -215,7 +218,7 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu - DETECTION_AREAS:DetectedReportDetailed() + DETECTION_AREAS:DetectedReportDetailed(AttackGroup)

    Report detailed of a detection result.

    @@ -248,12 +251,6 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu DETECTION_AREAS:GetTreatLevelA2G(DetectedItem)

    Returns the A2G threat level of the units in the DetectedItem

    - - - - DETECTION_AREAS:IsFriendliesNearBy(DetectedItem) - -

    Returns if there are friendlies nearby the FAC units ...

    @@ -441,13 +438,13 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu - DETECTION_BASE:DetectedItemMenu(Index) + DETECTION_BASE:DetectedItemMenu(Index, AttackGroup)

    Menu of a detected item using a given numeric index.

    - DETECTION_BASE:DetectedItemReportSummary(Index) + DETECTION_BASE:DetectedItemReportSummary(Index, AttackGroup)

    Report summary of a detected item using a given numeric index.

    @@ -471,7 +468,7 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu - DETECTION_BASE:DetectedReportDetailed() + DETECTION_BASE:DetectedReportDetailed(AttackGroup)

    Report detailed of a detectedion result.

    @@ -533,6 +530,12 @@ The different values of Unit.Category can be:

    Multiple Unit.Category entries can be given as a table and then these will be evaluated as an OR expression.

    + + + + DETECTION_BASE.FriendliesRange + + @@ -545,12 +548,24 @@ The different values of Unit.Category can be:

    DETECTION_BASE:GetDetectedItem(Index)

    Get a detected item using a given numeric index.

    + + + + DETECTION_BASE:GetDetectedItemCoordinate(Index) + +

    Get the COORDINATE of a detection item using a given numeric index.

    DETECTION_BASE:GetDetectedItemID(Index)

    Get a detected ItemID using a given numeric index.

    + + + + DETECTION_BASE:GetDetectedItemZone(Index) + +

    Get the Zone#ZONE_UNIT of a detection area using a given numeric index.

    @@ -575,18 +590,24 @@ The different values of Unit.Category can be:

    DETECTION_BASE:GetDetectedSet(Index)

    Get the Set#SET_UNIT of a detecttion area using a given numeric index.

    - - - - DETECTION_BASE:GetDetectedZone(Index) - -

    Get the Zone#ZONE_UNIT of a detection area using a given numeric index.

    DETECTION_BASE:GetDetectionSetGroup()

    Get the detection Groups.

    + + + + DETECTION_BASE:GetFriendliesNearBy(DetectedItem) + +

    Returns friendly units nearby the FAC units ...

    + + + + DETECTION_BASE:GetPlayersNearBy(DetectedItem) + +

    Returns friendly units nearby the FAC units ...

    @@ -641,6 +662,12 @@ The different values of Unit.Category can be:

    DETECTION_BASE:IsFriendliesNearBy(DetectedItem)

    Returns if there are friendlies nearby the FAC units ...

    + + + + DETECTION_BASE:IsPlayersNearBy(DetectedItem) + +

    Returns if there are friendlies nearby the FAC units ...

    @@ -785,6 +812,12 @@ The different values of Unit.Category can be:

    DETECTION_BASE:SetDistanceProbability(DistanceProbability)

    Upon a visual detection, the further away a detected object is, the less likely it is to be detected properly.

    + + + + DETECTION_BASE:SetFriendliesRange(FriendliesRange) + +

    Set the radius in meters to validate if friendlies are nearby.

    @@ -1004,19 +1037,19 @@ The different values of Unit.Category can be:

    - DETECTION_TYPES:DetectedItemMenu(Index, DetectedTypeName) + DETECTION_TYPES:DetectedItemMenu(Index, DetectedTypeName, AttackGroup)

    Menu of a DetectedItem using a given numeric index.

    - DETECTION_TYPES:DetectedItemReportSummary(Index, DetectedTypeName) + DETECTION_TYPES:DetectedItemReportSummary(Index, DetectedTypeName, AttackGroup)

    Report summary of a DetectedItem using a given numeric index.

    - DETECTION_TYPES:DetectedReportDetailed() + DETECTION_TYPES:DetectedReportDetailed(AttackGroup)

    Report detailed of a detection result.

    @@ -1086,19 +1119,19 @@ The different values of Unit.Category can be:

    - DETECTION_UNITS:DetectedItemMenu(Index) + DETECTION_UNITS:DetectedItemMenu(Index, AttackGroup)

    Menu of a DetectedItem using a given numeric index.

    - DETECTION_UNITS:DetectedItemReportSummary(Index) + DETECTION_UNITS:DetectedItemReportSummary(Index, AttackGroup)

    Report summary of a DetectedItem using a given numeric index.

    - DETECTION_UNITS:DetectedReportDetailed() + DETECTION_UNITS:DetectedReportDetailed(AttackGroup)

    Report detailed of a detection result.

    @@ -1385,6 +1418,11 @@ An example of how to use the method is shown below.

    Detection:Start() +

    Detection of Friendlies Nearby

    + +

    Use the method Detection#DETECTION_BASE.SetFriendliesRange() to set the range what will indicate when friendlies are nearby +a DetectedItem. The default range is 6000 meters. For air detections, it is advisory to use about 30.000 meters.

    +

    DETECTION_BASE is a Finite State Machine

    Various Events and State Transitions can be tailored using DETECTION_BASE.

    @@ -1556,19 +1594,24 @@ self

    -DETECTION_AREAS:DetectedItemMenu(Index) +DETECTION_AREAS:DetectedItemMenu(Index, AttackGroup)

    Menu of a detected item using a given numeric index.

    -

    Parameter

    +

    Parameters

    • Index :

      +
      • +
    • + +

      AttackGroup :

      +

    Return value

    @@ -1582,19 +1625,24 @@ self

    -DETECTION_AREAS:DetectedItemReportSummary(Index) +DETECTION_AREAS:DetectedItemReportSummary(Index, AttackGroup)

    Report summary of a detected item using a given numeric index.

    -

    Parameter

    +

    Parameters

    • Index :

      +
      • +
    • + +

      AttackGroup :

      +

    Return value

    @@ -1622,13 +1670,21 @@ self

    -DETECTION_AREAS:DetectedReportDetailed() +DETECTION_AREAS:DetectedReportDetailed(AttackGroup)

    Report detailed of a detection result.

    +

    Parameter

    +
      +
    • + +

      AttackGroup :

      + +
      • +

    Return value

    #string:

    @@ -1741,32 +1797,6 @@ a scale from 0 to 10.

    - -DETECTION_AREAS:IsFriendliesNearBy(DetectedItem) - -
    -
    - -

    Returns if there are friendlies nearby the FAC units ...

    - -

    Parameter

    -
      -
    • - -

      DetectedItem :

      - -
      • -
    -

    Return value

    - -

    #boolean: -trhe if there are friendlies nearby

    - -
    -
    -
    -
    - DETECTION_AREAS:NearestFAC(DetectedItem) @@ -2324,6 +2354,7 @@ The index of the DetectedItem.

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

    + #number DETECTION_BASE.DetectedItemMax @@ -2351,19 +2383,24 @@ The index of the DetectedItem.

    -DETECTION_BASE:DetectedItemMenu(Index) +DETECTION_BASE:DetectedItemMenu(Index, AttackGroup)

    Menu of a detected item using a given numeric index.

    -

    Parameter

    +

    Parameters

    • Index :

      +
      • +
    • + +

      AttackGroup :

      +

    Return value

    @@ -2377,19 +2414,24 @@ The index of the DetectedItem.

    -DETECTION_BASE:DetectedItemReportSummary(Index) +DETECTION_BASE:DetectedItemReportSummary(Index, AttackGroup)

    Report summary of a detected item using a given numeric index.

    -

    Parameter

    +

    Parameters

    • Index :

      +
      • +
    • + +

      AttackGroup :

      +

    Return value

    @@ -2445,13 +2487,21 @@ The index of the DetectedItem.

    -DETECTION_BASE:DetectedReportDetailed() +DETECTION_BASE:DetectedReportDetailed(AttackGroup)

    Report detailed of a detectedion result.

    +

    Parameter

    +
      +
    • + +

      AttackGroup :

      + +
      • +

    Return value

    #string:

    @@ -2611,6 +2661,20 @@ cs.DCSUnit#Unit> FilterCategories The Categories entries

    #DETECTION_BASE: self

    +
    +
    +
    +
    + + + +DETECTION_BASE.FriendliesRange + +
    +
    + + +
    @@ -2663,6 +2727,32 @@ DetectedItemID

    #DETECTION_BASE.DetectedItem:

    +
    +
    +
    +
    + + +DETECTION_BASE:GetDetectedItemCoordinate(Index) + +
    +
    + +

    Get the COORDINATE of a detection item using a given numeric index.

    + +

    Parameter

    +
      +
    • + +

      #number Index :

      + +
      • +
    +

    Return value

    + +

    Core.Point#COORDINATE:

    + +
    @@ -2694,6 +2784,32 @@ DetectedItemID

    + +DETECTION_BASE:GetDetectedItemZone(Index) + +
    +
    + +

    Get the Zone#ZONE_UNIT of a detection area using a given numeric index.

    + +

    Parameter

    +
      +
    • + +

      #number Index :

      + +
      • +
    +

    Return value

    + +

    Core.Zone#ZONE_UNIT: +DetectedZone

    + +
    +
    +
    +
    + DETECTION_BASE:GetDetectedItems() @@ -2782,32 +2898,6 @@ DetectedSet

    - -DETECTION_BASE:GetDetectedZone(Index) - -
    -
    - -

    Get the Zone#ZONE_UNIT of a detection area using a given numeric index.

    - -

    Parameter

    -
      -
    • - -

      #number Index :

      - -
      • -
    -

    Return value

    - -

    Core.Zone#ZONE_UNIT: -DetectedZone

    - -
    -
    -
    -
    - DETECTION_BASE:GetDetectionSetGroup() @@ -2821,6 +2911,58 @@ DetectedZone

    Core.Set#SET_GROUP:

    + +
    +
    +
    + + +DETECTION_BASE:GetFriendliesNearBy(DetectedItem) + +
    +
    + +

    Returns friendly units nearby the FAC units ...

    + +

    Parameter

    +
      +
    • + +

      DetectedItem :

      + +
      • +
    +

    Return value

    + +

    #map:

    +

    string,Wrapper.Unit#UNIT> The map of Friendly UNITs.

    + +
    +
    +
    +
    + + +DETECTION_BASE:GetPlayersNearBy(DetectedItem) + +
    +
    + +

    Returns friendly units nearby the FAC units ...

    + +

    Parameter

    +
      +
    • + +

      DetectedItem :

      + +
      • +
    +

    Return value

    + +

    #map:

    +

    string,Wrapper.Unit#UNIT> The map of Friendly UNITs.

    +
    @@ -3055,6 +3197,32 @@ trhe if there are friendlies nearby

    + +DETECTION_BASE:IsPlayersNearBy(DetectedItem) + +
    +
    + +

    Returns if there are friendlies nearby the FAC units ...

    + +

    Parameter

    +
      +
    • + +

      DetectedItem :

      + +
      • +
    +

    Return value

    + +

    #boolean: +trhe if there are friendlies nearby

    + +
    +
    +
    +
    + DETECTION_BASE:New(DetectionSetGroup) @@ -3790,6 +3958,33 @@ self

    + +DETECTION_BASE:SetFriendliesRange(FriendliesRange) + +
    +
    + +

    Set the radius in meters to validate if friendlies are nearby.

    + +

    Parameter

    +
      +
    • + +

      #number FriendliesRange : +Radius to use when checking if Friendlies are nearby.

      + +
      • +
    +

    Return value

    + +

    #DETECTION_BASE: +self

    + +
    +
    +
    +
    + DETECTION_BASE:SetRejectZones(RejectZones) @@ -4430,7 +4625,7 @@ self

    -DETECTION_TYPES:DetectedItemMenu(Index, DetectedTypeName) +DETECTION_TYPES:DetectedItemMenu(Index, DetectedTypeName, AttackGroup)
    @@ -4448,6 +4643,11 @@ self

    DetectedTypeName :

    + +
  • + +

    AttackGroup :

    +

    • Return value

    @@ -4461,7 +4661,7 @@ self

    -DETECTION_TYPES:DetectedItemReportSummary(Index, DetectedTypeName) +DETECTION_TYPES:DetectedItemReportSummary(Index, DetectedTypeName, AttackGroup)
    @@ -4479,6 +4679,11 @@ self

    DetectedTypeName :

    + +
  • + +

    AttackGroup :

    +

    • Return value

    @@ -4492,13 +4697,21 @@ self

    -DETECTION_TYPES:DetectedReportDetailed() +DETECTION_TYPES:DetectedReportDetailed(AttackGroup)

    Report detailed of a detection result.

    +

    Parameter

    +
      +
    • + +

      AttackGroup :

      + +
      • +

    Return value

    #string:

    @@ -4647,7 +4860,7 @@ self

    Type DETECTION_UNITS

    -

    2) DETECTION_UNITS class, extends Detection#DETECTION_BASE

    +

    DETECTION_UNITS class, extends Detection#DETECTION_BASE

    The DETECTION_UNITS class will detect units within the battle zone.

    @@ -4696,19 +4909,24 @@ self

    -DETECTION_UNITS:DetectedItemMenu(Index) +DETECTION_UNITS:DetectedItemMenu(Index, AttackGroup)

    Menu of a DetectedItem using a given numeric index.

    -

    Parameter

    +

    Parameters

    • Index :

      +
      • +
    • + +

      AttackGroup :

      +

    Return value

    @@ -4722,19 +4940,24 @@ self

    -DETECTION_UNITS:DetectedItemReportSummary(Index) +DETECTION_UNITS:DetectedItemReportSummary(Index, AttackGroup)

    Report summary of a DetectedItem using a given numeric index.

    -

    Parameter

    +

    Parameters

    • Index :

      +
      • +
    • + +

      AttackGroup :

      +

    Return value

    @@ -4748,13 +4971,21 @@ self

    -DETECTION_UNITS:DetectedReportDetailed() +DETECTION_UNITS:DetectedReportDetailed(AttackGroup)

    Report detailed of a detection result.

    +

    Parameter

    +
      +
    • + +

      AttackGroup :

      + +
      • +

    Return value

    #string:

    @@ -4904,6 +5135,8 @@ self

    Type list

    +

    Type map

    + diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html index dc5177289..691620d5b 100644 --- a/docs/Documentation/DetectionManager.html +++ b/docs/Documentation/DetectionManager.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Escort.html b/docs/Documentation/Escort.html index 39517ecf7..ce7a2d565 100644 --- a/docs/Documentation/Escort.html +++ b/docs/Documentation/Escort.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Event.html b/docs/Documentation/Event.html index 8c2d52ea1..7efd063d1 100644 --- a/docs/Documentation/Event.html +++ b/docs/Documentation/Event.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 9f6365bca..c5184cb8d 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html index 061abb9d6..13a3699cd 100644 --- a/docs/Documentation/Group.html +++ b/docs/Documentation/Group.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -240,6 +243,12 @@ GROUP:GetCoalition()

    Returns the coalition of the DCS Group.

    + + + + GROUP:GetCoordinate() + +

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

    @@ -858,6 +867,34 @@ The coalition side of the DCS Group.

    + +GROUP:GetCoordinate() + +
    +
    + +

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

    + +

    Return values

    +
      +
    1. + +

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

      + +
      2. +
    2. + +

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

      + +
      3. +
    +
    +
    +
    +
    + GROUP:GetCountry() diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html index 7db00fa30..61afa0732 100644 --- a/docs/Documentation/Identifiable.html +++ b/docs/Documentation/Identifiable.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html index 0bc1432fb..bea9ba7f9 100644 --- a/docs/Documentation/Menu.html +++ b/docs/Documentation/Menu.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Message.html b/docs/Documentation/Message.html index 2855c184e..c590dd63e 100644 --- a/docs/Documentation/Message.html +++ b/docs/Documentation/Message.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html index 69072fd29..ab8c725e6 100644 --- a/docs/Documentation/MissileTrainer.html +++ b/docs/Documentation/MissileTrainer.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html index 22c3cdf97..127fc4288 100644 --- a/docs/Documentation/Mission.html +++ b/docs/Documentation/Mission.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -181,7 +184,7 @@ A CLIENT needs to be registered within the MISSION:GetMenu() + MISSION:GetMenu(TaskGroup)

    Gets the mission menu for the coalition.

    @@ -274,6 +277,12 @@ A CLIENT needs to be registered within the MISSION:JoinUnit(PlayerUnit, PlayerGroup)

    Add a Unit to join the Mission.

    + + + + MISSION:MenuReportBriefing(ReportGroup) + + @@ -430,6 +439,12 @@ A CLIENT needs to be registered within the MISSION:RemoveTaskMenu(Task)

    Removes a Task menu.

    + + + + MISSION:ReportBriefing() + +

    Create a briefing report of the Mission.

    @@ -439,7 +454,7 @@ A CLIENT needs to be registered within the MISSION:ReportOverview(TaskStatus) + MISSION:ReportOverview(ReportGroup, TaskStatus)

    Create a overview report of the Mission (multiple lines).

    @@ -520,12 +535,6 @@ A CLIENT needs to be registered within the MISSION:__Stop(Delay)

    Asynchronous Event Trigger for Event Stop.

    - - - - MISSION:onbeforeComplete(From, Event, To) - - @@ -799,13 +808,21 @@ The CLIENT or UNIT of the Player crashing.

    -MISSION:GetMenu() +MISSION:GetMenu(TaskGroup)

    Gets the mission menu for the coalition.

    +

    Parameter

    +
      +
    • + +

      TaskGroup :

      + +
      • +

    Return value

    Core.Menu#MENU_COALITION: @@ -1177,6 +1194,27 @@ true if Unit is part of a Task in the Mission.

    + +MISSION:MenuReportBriefing(ReportGroup) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      ReportGroup :

      + +
      • +
    +
    +
    +
    +
    + MISSION:MenuReportOverview(TaskStatus, ReportGroup) @@ -1991,6 +2029,24 @@ The cleaned Task reference.

    #MISSION: self

    +
    +
    +
    +
    + + +MISSION:ReportBriefing() + +
    +
    + +

    Create a briefing report of the Mission.

    + +

    Return value

    + +

    #string:

    + +
    @@ -2015,17 +2071,22 @@ self

    -MISSION:ReportOverview(TaskStatus) +MISSION:ReportOverview(ReportGroup, TaskStatus)

    Create a overview report of the Mission (multiple lines).

    -

    Parameter

    +

    Parameters

    diff --git a/docs/Documentation/Object.html b/docs/Documentation/Object.html index 1b5902a84..700110791 100644 --- a/docs/Documentation/Object.html +++ b/docs/Documentation/Object.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index 6da90c9fd..990058fa7 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -132,8 +135,8 @@

    Hereby the change log:

    -

    2017-03-03: POINT_VEC3:Explosion( ExplosionIntensity ) added.
    -2017-03-03: POINT_VEC3:IlluminationBomb() added.

    +

    2017-03-03: POINT_VEC3:Explosion( ExplosionIntensity ) added. +2017-03-03: POINT_VEC3:IlluminationBomb() added.

    2017-02-18: POINT_VEC3:NewFromVec2( Vec2, LandHeightAdd ) added.

    @@ -162,7 +165,7 @@ COORDINATE -

    COORDINATE class, extends Point#COORDINATE

    +

    COORDINATE class, extends Base#BASE

    The COORDINATE class defines a 2D coordinate in the simulator.

    @@ -170,7 +173,7 @@ POINT_VEC2 -

    POINT_VEC2 class, extends Point#POINT_VEC3

    +

    POINT_VEC2 class, extends Point#COORDINATE

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

    @@ -178,7 +181,7 @@ POINT_VEC3 -

    POINT_VEC3 class, extends Base#BASE

    +

    POINT_VEC3 class, extends Point#COORDINATE

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

    @@ -187,55 +190,151 @@

    Type COORDINATE

    - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -253,34 +352,136 @@ - + + + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + +
    COORDINATE:CoordinateMenu(RootMenu)COORDINATE:Explosion(ExplosionIntensity) +

    Creates an explosion at the point of a certain intensity.

    +
    COORDINATE:Flare(FlareColor, (, Azimuth) +

    Flares the point in a color.

    +
    COORDINATE:FlareGreen((, Azimuth) +

    Flare the COORDINATE Green.

    +
    COORDINATE:FlareRed(Azimuth) +

    Flare the COORDINATE Red.

    +
    COORDINATE:FlareWhite((, Azimuth) +

    Flare the COORDINATE White.

    +
    COORDINATE:FlareYellow((, Azimuth) +

    Flare the COORDINATE Yellow.

    +
    COORDINATE:Get2DDistance(TargetCoordinate) +

    Return the 2D distance in meters between the target COORDINATE and the COORDINATE.

    +
    COORDINATE:Get3DDistance(TargetCoordinate) +

    Return the 3D distance in meters between the target COORDINATE and the COORDINATE.

    +
    COORDINATE:GetAltitudeText(Settings) +

    Return the altitude text of the COORDINATE.

    +
    COORDINATE:GetAngleDegrees(DirectionVec3) +

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

    +
    COORDINATE:GetAngleRadians(DirectionVec3) +

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

    +
    COORDINATE:GetBRAText(AngleRadians, Distance, Settings) +

    Provides a Bearing / Range / Altitude string

    +
    COORDINATE:GetBRText(AngleRadians, Distance, Settings) +

    Provides a Bearing / Range string

    +
    COORDINATE:GetBearingText(AngleRadians, Precision, Settings) +

    Provides a bearing text in degrees.

    +
    COORDINATE:GetDirectionVec3(TargetCoordinate) +

    Return a direction vector Vec3 from COORDINATE to the COORDINATE.

    +
    COORDINATE:GetDistanceText(Distance, Settings) +

    Provides a distance text expressed in the units of measurement.

    +
    COORDINATE:GetNorthCorrectionRadians() +

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

    +
    COORDINATE:GetVec2() +

    Return the coordinates of the COORDINATE in Vec2 format.

    +
    COORDINATE:GetVec3() +

    Return the coordinates of the COORDINATE in Vec3 format.

    +
    COORDINATE:IlluminationBomb() +

    Creates an illumination bomb at the point.

    +
    COORDINATE:IsLOS(ToCoordinate) +

    Returns if a Coordinate has Line of Sight (LOS) with the ToPointVec3.

    +
    COORDINATE:IsModeA2A() +

    Is the mode to A2A

    +
    COORDINATE:IsModeA2G() +

    Is the mode to A2G

    +
    COORDINATE.Mode
    COORDINATE.LL_Accuracy - -
    COORDINATE.LL_DMS - -
    COORDINATE.MGRS_Accuracy - -
    COORDINATE:MenuLL_Accuracy(LL_Accuracy) - -
    COORDINATE:MenuLL_DMS(LL_DMS) - -
    COORDINATE:MenuMGRS_Accuracy(MGRS_Accuracy) - -
    COORDINATE:MenuSystem(System) - -
    COORDINATE:New(x, y, LandHeightAdd)COORDINATE:New(x, y, z)

    COORDINATE constructor.
    COORDINATE.SystemCOORDINATE:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked) +

    Build an air type route point.

    +
    COORDINATE:RoutePointGround(Speed, Formation) +

    Build an ground type route point.

    +
    COORDINATE:SetHeading(Heading)
    COORDINATE.SystemMenuCOORDINATE:SetModeA2A() - +

    Set the mode to A2A
    COORDINATE:ToString()COORDINATE:SetModeA2G() +

    Set the mode to A2G

    +
    COORDINATE:Smoke(SmokeColor) +

    Smokes the point in a color.

    +
    COORDINATE:SmokeBlue() +

    Smoke the COORDINATE Blue.

    +
    COORDINATE:SmokeGreen() +

    Smoke the COORDINATE Green.

    +
    COORDINATE:SmokeOrange() +

    Smoke the COORDINATE Orange.

    +
    COORDINATE:SmokeRed() +

    Smoke the COORDINATE Red.

    +
    COORDINATE:SmokeWhite() +

    Smoke the COORDINATE White.

    +
    COORDINATE:ToString(Controllable, Settings)

    Provides a coordinate string of the point, based on a coordinate format system: * Uses default settings in COORDINATE.
    COORDINATE:ToStringLL(LL_Accuracy, LL_DMS)COORDINATE:ToStringAspect(TargetCoordinate) +

    Return an aspect string from a COORDINATE to the Angle of the object.

    +
    COORDINATE:ToStringBR(TargetCoordinate, FromCoordinate, Settings) +

    Return a BR string from a COORDINATE to the COORDINATE.

    +
    COORDINATE:ToStringBRA(TargetCoordinate, FromCoordinate, Settings) +

    Return a BRAA string from a COORDINATE to the COORDINATE.

    +
    COORDINATE:ToStringBULLS(Coalition, Settings) +

    Return a BULLS string from a COORDINATE to the BULLS of the coalition.

    +
    COORDINATE:ToStringLL(Settings)

    Provides a Lat Lon string
    COORDINATE:ToStringMGRS(MGRS_Accuracy)COORDINATE:ToStringMGRS(Settings)

    Provides a MGRS string

    +
    COORDINATE:Translate(Distance, Angle) +

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

    +
    COORDINATE.x + +
    COORDINATE.y + +
    COORDINATE.z +
    @@ -308,7 +509,7 @@ POINT_VEC2:DistanceFromPointVec2(PointVec2Reference) -

    Calculate the distance from a reference #POINT_VEC2.

    + @@ -321,12 +522,6 @@ POINT_VEC2:GetAlt()

    Return the altitude (height) of the land at the POINT_VEC2.

    - - - - POINT_VEC2:GetAltitudeText() - -

    Return no text for the altitude of the POINT_VEC2.

    @@ -339,6 +534,18 @@ POINT_VEC2:GetLon()

    Return the Lon(gitude) coordinate of the POINTVEC2 (ie: (parent)POINTVEC3.z).

    + + + + POINT_VEC2:GetRandomPointVec2InRadius(OuterRadius, InnerRadius) + +

    Return a random POINTVEC2 within an Outer Radius and optionally NOT within an Inner Radius of the POINTVEC2.

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

    Return a random Vec2 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC2.

    @@ -445,132 +652,24 @@ POINT_VEC3:AddZ(z)

    Add to the z coordinate of the POINT_VEC3.

    - - - - POINT_VEC3:Explosion(ExplosionIntensity) - -

    Creates an explosion at the point of a certain intensity.

    - - - - POINT_VEC3:Flare(FlareColor, (, Azimuth) - -

    Flares the point in a color.

    POINT_VEC3.FlareColor - - - - POINT_VEC3:FlareGreen((, Azimuth) - -

    Flare the POINT_VEC3 Green.

    - - - - POINT_VEC3:FlareRed(Azimuth) - -

    Flare the POINT_VEC3 Red.

    - - - - POINT_VEC3:FlareWhite((, Azimuth) - -

    Flare the POINT_VEC3 White.

    - - - - POINT_VEC3:FlareYellow((, Azimuth) - -

    Flare the POINT_VEC3 Yellow.

    - - - - POINT_VEC3:Get2DDistance(TargetPointVec3) - -

    Return the 2D distance in meters between the target POINTVEC3 and the POINTVEC3.

    - - - - POINT_VEC3:Get3DDistance(TargetPointVec3) - -

    Return the 3D distance in meters between the target POINTVEC3 and the POINTVEC3.

    - - - - POINT_VEC3:GetAltitudeText() - -

    Return the altitude text of the POINT_VEC3.

    - - - - POINT_VEC3:GetAngleDegrees(DirectionVec3) - -

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

    - - - - POINT_VEC3:GetAngleRadians(DirectionVec3) - -

    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.

    - - - - POINT_VEC3:GetDirectionVec3(TargetPointVec3) - -

    Return a direction vector Vec3 from POINTVEC3 to the POINTVEC3.

    - - - - POINT_VEC3:GetNorthCorrectionRadians() - -

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

    - - - - POINT_VEC3:GetRandomPointVec2InRadius(OuterRadius, InnerRadius) - -

    Return a random POINTVEC2 within an Outer Radius and optionally NOT within an Inner Radius of the POINTVEC3.

    POINT_VEC3:GetRandomPointVec3InRadius(OuterRadius, InnerRadius)

    Return a random POINTVEC3 within an Outer Radius and optionally NOT within an Inner Radius of the POINTVEC3.

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

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

    POINT_VEC3:GetRandomVec3InRadius(OuterRadius, InnerRadius)

    Return a random Vec3 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.

    - - - - POINT_VEC3:GetVec3() - -

    Return the coordinates of the POINT_VEC3 in Vec3 format.

    @@ -589,30 +688,6 @@ POINT_VEC3:GetZ()

    Return the z coordinate of the POINT_VEC3.

    - - - - POINT_VEC3:IlluminationBomb() - -

    Creates an illumination bomb at the point.

    - - - - POINT_VEC3:IsLOS(ToPointVec3) - -

    Returns if a PointVec3 has Line of Sight (LOS) with the ToPointVec3.

    - - - - POINT_VEC3:IsMetric() - -

    Gets if the POINT_VEC3 is metric or NM.

    - - - - POINT_VEC3.Metric - - @@ -637,36 +712,18 @@ POINT_VEC3.RoutePointAction - - - - POINT_VEC3:RoutePointAir(AltType, Type, Action, Speed, SpeedLocked) - -

    Build an air type route point.

    POINT_VEC3.RoutePointAltType - - - - POINT_VEC3:RoutePointGround(Speed, Formation) - -

    Build an ground type route point.

    POINT_VEC3.RoutePointType - - - - POINT_VEC3:SetMetric(Metric) - -

    Sets the POINT_VEC3 metric or NM.

    @@ -685,60 +742,12 @@ POINT_VEC3:SetZ(z)

    Set the z coordinate of the POINT_VEC3.

    - - - - POINT_VEC3:Smoke(SmokeColor) - -

    Smokes the point in a color.

    - - - - POINT_VEC3:SmokeBlue() - -

    Smoke the POINT_VEC3 Blue.

    POINT_VEC3.SmokeColor - - - - POINT_VEC3:SmokeGreen() - -

    Smoke the POINT_VEC3 Green.

    - - - - POINT_VEC3:SmokeOrange() - -

    Smoke the POINT_VEC3 Orange.

    - - - - POINT_VEC3:SmokeRed() - -

    Smoke the POINT_VEC3 Red.

    - - - - POINT_VEC3:SmokeWhite() - -

    Smoke the POINT_VEC3 White.

    - - - - POINT_VEC3:ToStringBR(AngleRadians, Distance) - -

    Provides a Bearing / Range string

    - - - - POINT_VEC3:Translate(Distance, Angle) - -

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

    @@ -814,7 +823,7 @@
    -

    COORDINATE class, extends Point#COORDINATE

    +

    COORDINATE class, extends Base#BASE

    The COORDINATE class defines a 2D coordinate in the simulator.

    @@ -844,9 +853,9 @@ to add or substract a value from the current respective axis value. Note that the Set and Add methods return the current COORDINATE object, so these manipulation methods can be chained... For example:

     local Vec2 = PointVec2:AddX( 100 ):AddY( 2000 ):GetVec2()
-
    +
    @@ -859,7 +868,7 @@ Note that the Set and Add methods return the current COORDINATE object, so these
    -

    POINT_VEC2 class, extends Point#POINT_VEC3

    +

    POINT_VEC2 class, extends Point#COORDINATE

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

    @@ -888,9 +897,9 @@ 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()
-
    +
    @@ -903,15 +912,15 @@ Note that the Set and Add methods return the current POINT_VEC2 object, so these
    -

    POINT_VEC3 class, extends Base#BASE

    +

    POINT_VEC3 class, extends Point#COORDINATE

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

    @@ -1046,10 +1055,10 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these +

    Type Point

    @@ -1059,160 +1068,613 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
    - -COORDINATE:CoordinateMenu(RootMenu) + +COORDINATE:Explosion(ExplosionIntensity)
    - +

    Creates an explosion at the point of a certain intensity.

    Parameter

    • -

      RootMenu :

      +

      #number ExplosionIntensity :

      + +
      • +
    +
    +
    +
    +
    + + +COORDINATE:Flare(FlareColor, (, Azimuth) + +
    +
    + +

    Flares the point in a color.

    + +

    Parameters

    + +
    +
    +
    +
    + + +COORDINATE:FlareGreen((, Azimuth) + +
    +
    + +

    Flare the COORDINATE Green.

    + +

    Parameters

    +
      +
    • + +

      Dcs.DCSTypes#Azimuth ( : +ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.

      + +
      • +
    • + +

      Azimuth :

      + +
      • +
    +
    +
    +
    +
    + + +COORDINATE:FlareRed(Azimuth) + +
    +
    + +

    Flare the COORDINATE Red.

    + +

    Parameter

    +
      +
    • + +

      Azimuth :

      + +
      • +
    +
    +
    +
    +
    + + +COORDINATE:FlareWhite((, Azimuth) + +
    +
    + +

    Flare the COORDINATE White.

    + +

    Parameters

    +
      +
    • + +

      Dcs.DCSTypes#Azimuth ( : +ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.

      + +
      • +
    • + +

      Azimuth :

      + +
      • +
    +
    +
    +
    +
    + + +COORDINATE:FlareYellow((, Azimuth) + +
    +
    + +

    Flare the COORDINATE Yellow.

    + +

    Parameters

    +
      +
    • + +

      Dcs.DCSTypes#Azimuth ( : +ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.

      + +
      • +
    • + +

      Azimuth :

      + +
      • +
    +
    +
    +
    +
    + + +COORDINATE:Get2DDistance(TargetCoordinate) + +
    +
    + +

    Return the 2D distance in meters between the target COORDINATE and the COORDINATE.

    + +

    Parameter

    +
      +
    • + +

      #COORDINATE TargetCoordinate : +The target COORDINATE.

      + +
      • +
    +

    Return value

    + +

    Dcs.DCSTypes#Distance: +Distance The distance in meters.

    + +
    +
    +
    +
    + + +COORDINATE:Get3DDistance(TargetCoordinate) + +
    +
    + +

    Return the 3D distance in meters between the target COORDINATE and the COORDINATE.

    + +

    Parameter

    +
      +
    • + +

      #COORDINATE TargetCoordinate : +The target COORDINATE.

      + +
      • +
    +

    Return value

    + +

    Dcs.DCSTypes#Distance: +Distance The distance in meters.

    + +
    +
    +
    +
    + + +COORDINATE:GetAltitudeText(Settings) + +
    +
    + +

    Return the altitude text of the COORDINATE.

    + +

    Parameter

    +
      +
    • + +

      Settings :

    Return value

    #string: -The coordinate Text in the configured coordinate system.

    +Altitude text.

    - #number - -COORDINATE.LL_Accuracy + +COORDINATE:GetAngleDegrees(DirectionVec3)
    - - -
    -
    -
    -
    - - #boolean - -COORDINATE.LL_DMS - -
    -
    - - - -
    -
    -
    -
    - - #number - -COORDINATE.MGRS_Accuracy - -
    -
    - - - -
    -
    -
    -
    - - -COORDINATE:MenuLL_Accuracy(LL_Accuracy) - -
    -
    - - +

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

    Parameter

    • -

      LL_Accuracy :

      +

      Dcs.DCSTypes#Vec3 DirectionVec3 : +The direction vector in Vec3 format.

    +

    Return value

    + +

    #number: +DirectionRadians The angle in degrees.

    +
    - -COORDINATE:MenuLL_DMS(LL_DMS) + +COORDINATE:GetAngleRadians(DirectionVec3) + +
    +
    + +

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

    + +

    Parameter

    + +

    Return value

    + +

    #number: +DirectionRadians The angle in radians.

    + +
    +
    +
    +
    + + +COORDINATE:GetBRAText(AngleRadians, Distance, Settings) + +
    +
    + +

    Provides a Bearing / Range / Altitude string

    + +

    Parameters

    +
      +
    • + +

      #number AngleRadians : +The angle in randians

      + +
      • +
    • + +

      #number Distance : +The distance

      + +
      • +
    • + +

      Core.Settings#SETTINGS Settings :

      + +
      • +
    +

    Return value

    + +

    #string: +The BRA Text

    + +
    +
    +
    +
    + + +COORDINATE:GetBRText(AngleRadians, Distance, Settings) + +
    +
    + +

    Provides a Bearing / Range string

    + +

    Parameters

    +
      +
    • + +

      #number AngleRadians : +The angle in randians

      + +
      • +
    • + +

      #number Distance : +The distance

      + +
      • +
    • + +

      Core.Settings#SETTINGS Settings :

      + +
      • +
    +

    Return value

    + +

    #string: +The BR Text

    + +
    +
    +
    +
    + + +COORDINATE:GetBearingText(AngleRadians, Precision, Settings) + +
    +
    + +

    Provides a bearing text in degrees.

    + +

    Parameters

    +
      +
    • + +

      #number AngleRadians : +The angle in randians.

      + +
      • +
    • + +

      #number Precision : +The precision.

      + +
      • +
    • + +

      Core.Settings#SETTINGS Settings :

      + +
      • +
    +

    Return value

    + +

    #string: +The bearing text in degrees.

    + +
    +
    +
    +
    + + +COORDINATE:GetDirectionVec3(TargetCoordinate) + +
    +
    + +

    Return a direction vector Vec3 from COORDINATE to the COORDINATE.

    + +

    Parameter

    +
      +
    • + +

      #COORDINATE TargetCoordinate : +The target COORDINATE.

      + +
      • +
    +

    Return value

    + +

    Dcs.DCSTypes#Vec3: +DirectionVec3 The direction vector in Vec3 format.

    + +
    +
    +
    +
    + + +COORDINATE:GetDistanceText(Distance, Settings) + +
    +
    + +

    Provides a distance text expressed in the units of measurement.

    + +

    Parameters

    + +

    Return value

    + +

    #string: +The distance text expressed in the units of measurement.

    + +
    +
    +
    +
    + + +COORDINATE:GetNorthCorrectionRadians() + +
    +
    + +

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

    + +

    Return value

    + +

    #number: +CorrectionRadians The correction in radians.

    + +
    +
    +
    +
    + + +COORDINATE:GetVec2() + +
    +
    + +

    Return the coordinates of the COORDINATE in Vec2 format.

    + +

    Return value

    + +

    Dcs.DCSTypes#Vec2: +The Vec2 format coordinate.

    + +
    +
    +
    +
    + + +COORDINATE:GetVec3() + +
    +
    + +

    Return the coordinates of the COORDINATE in Vec3 format.

    + +

    Return value

    + +

    Dcs.DCSTypes#Vec3: +The Vec3 format coordinate.

    + +
    +
    +
    +
    + + +COORDINATE:IlluminationBomb() + +
    +
    + +

    Creates an illumination bomb at the point.

    + +
    +
    +
    +
    + + +COORDINATE:IsLOS(ToCoordinate) + +
    +
    + +

    Returns if a Coordinate has Line of Sight (LOS) with the ToPointVec3.

    + +

    Parameter

    + +

    Return value

    + +

    #boolean: +true If the ToCoordinate has LOS with the Coordinate, otherwise false.

    + +
    +
    +
    +
    + + +COORDINATE:IsModeA2A() + +
    +
    + +

    Is the mode to A2A

    + +

    Return value

    + +

    #boolean:

    + + +
    +
    +
    +
    + + +COORDINATE:IsModeA2G() + +
    +
    + +

    Is the mode to A2G

    + +

    Return value

    + +

    #boolean:

    + + +
    +
    +
    +
    + + #string + +COORDINATE.Mode
    -

    Parameter

    -
      -
    • - -

      LL_DMS :

      - -
      • -
    -
    -
    -
    -
    - - -COORDINATE:MenuMGRS_Accuracy(MGRS_Accuracy) - -
    -
    - - - -

    Parameter

    -
      -
    • - -

      MGRS_Accuracy :

      - -
      • -
    -
    -
    -
    -
    - - -COORDINATE:MenuSystem(System) - -
    -
    - - - -

    Parameter

    -
      -
    • - -

      System :

      - -
      • -
    -COORDINATE:New(x, y, LandHeightAdd) +COORDINATE:New(x, y, z)
    @@ -1235,8 +1697,8 @@ The y coordinate of the Vec3 point, pointing to the Right.

  • -

    Dcs.DCSTypes#Distance LandHeightAdd : -(optional) The default height if required to be evaluated will be the land height of the x, y coordinate. You can specify an extra height to be added to the land height.

    +

    Dcs.DCSTypes#Distance z : +The z coordinate of the Vec3 point, pointing to the Right.

    • @@ -1275,8 +1737,8 @@ The Vec2 point.

    Return value

    -

    Core.Point#COORDINATE: -self

    +

    Core.Point#COORDINATE:

    +
    @@ -1302,21 +1764,7 @@ The Vec3 point.

    Return value

    -

    Core.Point#COORDINATE: -self

    - - -
    -
    -
    - - #string - -COORDINATE.System - -
    -
    - +

    Core.Point#COORDINATE:

    @@ -1324,21 +1772,235 @@ self

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

    + +
    +
    +
    +
    + + +COORDINATE:SetHeading(Heading)
    +

    Parameter

    +
      +
    • + +

      Heading :

      + +
      • +
    +
    +
    +
    +
    + + +COORDINATE:SetModeA2A() + +
    +
    + +

    Set the mode to A2A

    + +

    Return value

    + +

    #COORDINATE:

    + + +
    +
    +
    +
    + + +COORDINATE:SetModeA2G() + +
    +
    + +

    Set the mode to A2G

    + +

    Return value

    + +

    #COORDINATE:

    + + +
    +
    +
    +
    + + +COORDINATE:Smoke(SmokeColor) + +
    +
    + +

    Smokes the point in a color.

    + +

    Parameter

    + +
    +
    +
    +
    + + +COORDINATE:SmokeBlue() + +
    +
    + +

    Smoke the COORDINATE Blue.

    + +
    +
    +
    +
    + + +COORDINATE:SmokeGreen() + +
    +
    + +

    Smoke the COORDINATE Green.

    + +
    +
    +
    +
    + + +COORDINATE:SmokeOrange() + +
    +
    + +

    Smoke the COORDINATE Orange.

    + +
    +
    +
    +
    + + +COORDINATE:SmokeRed() + +
    +
    + +

    Smoke the COORDINATE Red.

    + +
    +
    +
    +
    + + +COORDINATE:SmokeWhite() + +
    +
    + +

    Smoke the COORDINATE White.

    +
    -COORDINATE:ToString() +COORDINATE:ToString(Controllable, Settings)
    @@ -1351,7 +2013,19 @@ self

  • Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
    • +

    Parameters

    +

    Return value

    #string: @@ -1362,26 +2036,153 @@ The coordinate Text in the configured coordinate system.

    + +COORDINATE:ToStringAspect(TargetCoordinate) + +
    +
    + +

    Return an aspect string from a COORDINATE to the Angle of the object.

    + +

    Parameter

    +
      +
    • + +

      #COORDINATE TargetCoordinate : +The target COORDINATE.

      + +
      • +
    +

    Return value

    + +

    #string: +The Aspect string, which is Hot, Cold or Flanking.

    + +
    +
    +
    +
    + + +COORDINATE:ToStringBR(TargetCoordinate, FromCoordinate, Settings) + +
    +
    + +

    Return a BR string from a COORDINATE to the COORDINATE.

    + +

    Parameters

    +
      +
    • + +

      #COORDINATE TargetCoordinate : +The target COORDINATE.

      + +
      • +
    • + +

      FromCoordinate :

      + +
      • +
    • + +

      Settings :

      + +
      • +
    +

    Return value

    + +

    #string: +The BR text.

    + +
    +
    +
    +
    + + +COORDINATE:ToStringBRA(TargetCoordinate, FromCoordinate, Settings) + +
    +
    + +

    Return a BRAA string from a COORDINATE to the COORDINATE.

    + +

    Parameters

    +
      +
    • + +

      #COORDINATE TargetCoordinate : +The target COORDINATE.

      + +
      • +
    • + +

      FromCoordinate :

      + +
      • +
    • + +

      Settings :

      + +
      • +
    +

    Return value

    + +

    #string: +The BR text.

    + +
    +
    +
    +
    + + +COORDINATE:ToStringBULLS(Coalition, Settings) + +
    +
    + +

    Return a BULLS string from a COORDINATE to the BULLS of the coalition.

    + +

    Parameters

    + +

    Return value

    + +

    #string: +The BR text.

    + +
    +
    +
    +
    + -COORDINATE:ToStringLL(LL_Accuracy, LL_DMS) +COORDINATE:ToStringLL(Settings)

    Provides a Lat Lon string

    -

    Parameters

    +

    Parameter

    • -

      #number LL_Accuracy : -The accurancy of significant numbers behind the comma... So Accurancy of 2 is 0.01.

      - -
      • -
    • - -

      #boolean LL_DMS : -true = Degrees, Minutes, Seconds; false = Degrees, Minutes

      +

      Core.Settings#SETTINGS Settings : +(optional) Settings

    @@ -1396,7 +2197,7 @@ The LL Text

    -COORDINATE:ToStringMGRS(MGRS_Accuracy) +COORDINATE:ToStringMGRS(Settings)
    @@ -1407,14 +2208,8 @@ The LL Text

    • -

      #number MGRS_Accuracy : -of the 5 digit code. -Precision depends on the Accuracy choosen: - * 0 = no digits - precision level 100 km - * 1 = 1 digits - precision level 10 km - * 2 = 2 digits - precision level 1 km - * 3 = 3 digits - precision level 100 m - * 4 = 4 digits - precision level 10 m.

      +

      Core.Settings#SETTINGS Settings : +(optional) Settings

    @@ -1425,7 +2220,88 @@ The MGRS Text

    +
    +
    + +COORDINATE:Translate(Distance, Angle) + +
    +
    + +

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

    + +

    Parameters

    + +

    Return value

    + +

    #COORDINATE: +The new calculated COORDINATE.

    + +
    +
    +
    +
    + + + +COORDINATE.x + +
    +
    + + + +
    +
    +
    +
    + + + +COORDINATE.y + +
    +
    + + + +
    +
    +
    +
    + + + +COORDINATE.z + +
    +
    + + + +
    +
    + +

    Type COORDINATE.RoutePointAction

    + +

    Type COORDINATE.RoutePointAltType

    + +

    Type COORDINATE.RoutePointType

    +

    Type POINT_VEC2

    Field(s)

    @@ -1518,22 +2394,23 @@ The y coordinate.

    -

    Calculate the distance from a reference #POINT_VEC2.

    + + + +

    TODO: Check this to replace +- Calculate the distance from a reference #POINT_VEC2. + @param #POINTVEC2 self + @param #POINTVEC2 PointVec2Reference The reference #POINT_VEC2. + @return Dcs.DCSTypes#Distance The distance from the reference #POINT_VEC2 in meters.

    Parameter

    -

    Return value

    - -

    Dcs.DCSTypes#Distance: -The distance from the reference #POINT_VEC2 in meters.

    -
    @@ -1584,24 +2461,6 @@ The land altitude.

    - -POINT_VEC2:GetAltitudeText() - -
    -
    - -

    Return no text for the altitude of the POINT_VEC2.

    - -

    Return value

    - -

    #string: -Empty string.

    - -
    -
    -
    -
    - POINT_VEC2:GetLat() @@ -1638,6 +2497,68 @@ The y coodinate.

    + +POINT_VEC2:GetRandomPointVec2InRadius(OuterRadius, InnerRadius) + +
    +
    + +

    Return a random POINTVEC2 within an Outer Radius and optionally NOT within an Inner Radius of the POINTVEC2.

    + +

    Parameters

    + +

    Return value

    + +

    #POINT_VEC2:

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

    Return a random Vec2 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC2.

    + +

    Parameters

    + +

    Return value

    + +

    Dcs.DCSTypes#Vec2: +Vec2

    + +
    +
    +
    +
    + POINT_VEC2:GetX() @@ -2069,59 +2990,6 @@ The z coordinate value to add to the current z coodinate.

    #POINT_VEC3:

    -
    -
    -
    -
    - - -POINT_VEC3:Explosion(ExplosionIntensity) - -
    -
    - -

    Creates an explosion at the point of a certain intensity.

    - -

    Parameter

    -
      -
    • - -

      #number ExplosionIntensity :

      - -
      • -
    -
    -
    -
    -
    - - -POINT_VEC3:Flare(FlareColor, (, Azimuth) - -
    -
    - -

    Flares the point in a color.

    - -

    Parameters

    -
    @@ -2136,337 +3004,6 @@ ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0. -
    -
    -
    - - -POINT_VEC3:FlareGreen((, Azimuth) - -
    -
    - -

    Flare the POINT_VEC3 Green.

    - -

    Parameters

    -
      -
    • - -

      Dcs.DCSTypes#Azimuth ( : -ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.

      - -
      • -
    • - -

      Azimuth :

      - -
      • -
    -
    -
    -
    -
    - - -POINT_VEC3:FlareRed(Azimuth) - -
    -
    - -

    Flare the POINT_VEC3 Red.

    - -

    Parameter

    -
      -
    • - -

      Azimuth :

      - -
      • -
    -
    -
    -
    -
    - - -POINT_VEC3:FlareWhite((, Azimuth) - -
    -
    - -

    Flare the POINT_VEC3 White.

    - -

    Parameters

    -
      -
    • - -

      Dcs.DCSTypes#Azimuth ( : -ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.

      - -
      • -
    • - -

      Azimuth :

      - -
      • -
    -
    -
    -
    -
    - - -POINT_VEC3:FlareYellow((, Azimuth) - -
    -
    - -

    Flare the POINT_VEC3 Yellow.

    - -

    Parameters

    -
      -
    • - -

      Dcs.DCSTypes#Azimuth ( : -ptional) Azimuth The azimuth of the flare direction. The default azimuth is 0.

      - -
      • -
    • - -

      Azimuth :

      - -
      • -
    -
    -
    -
    -
    - - -POINT_VEC3:Get2DDistance(TargetPointVec3) - -
    -
    - -

    Return the 2D distance in meters between the target POINTVEC3 and the POINTVEC3.

    - -

    Parameter

    -
      -
    • - -

      #POINT_VEC3 TargetPointVec3 : -The target POINT_VEC3.

      - -
      • -
    -

    Return value

    - -

    Dcs.DCSTypes#Distance: -Distance The distance in meters.

    - -
    -
    -
    -
    - - -POINT_VEC3:Get3DDistance(TargetPointVec3) - -
    -
    - -

    Return the 3D distance in meters between the target POINTVEC3 and the POINTVEC3.

    - -

    Parameter

    -
      -
    • - -

      #POINT_VEC3 TargetPointVec3 : -The target POINT_VEC3.

      - -
      • -
    -

    Return value

    - -

    Dcs.DCSTypes#Distance: -Distance The distance in meters.

    - -
    -
    -
    -
    - - -POINT_VEC3:GetAltitudeText() - -
    -
    - -

    Return the altitude text of the POINT_VEC3.

    - -

    Return value

    - -

    #string: -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) - -
    -
    - -

    Return a BR string from a POINTVEC3 to the POINTVEC3.

    - -

    Parameter

    -
      -
    • - -

      #POINT_VEC3 TargetPointVec3 : -The target POINT_VEC3.

      - -
      • -
    -

    Return value

    - -

    #string: -The BR text.

    - -
    -
    -
    -
    - - -POINT_VEC3:GetDirectionVec3(TargetPointVec3) - -
    -
    - -

    Return a direction vector Vec3 from POINTVEC3 to the POINTVEC3.

    - -

    Parameter

    -
      -
    • - -

      #POINT_VEC3 TargetPointVec3 : -The target POINT_VEC3.

      - -
      • -
    -

    Return value

    - -

    Dcs.DCSTypes#Vec3: -DirectionVec3 The direction vector in Vec3 format.

    - -
    -
    -
    -
    - - -POINT_VEC3:GetNorthCorrectionRadians() - -
    -
    - -

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

    - -

    Return value

    - -

    #number: -CorrectionRadians The correction in radians.

    - -
    -
    -
    -
    - - -POINT_VEC3:GetRandomPointVec2InRadius(OuterRadius, InnerRadius) - -
    -
    - -

    Return a random POINTVEC2 within an Outer Radius and optionally NOT within an Inner Radius of the POINTVEC3.

    - -

    Parameters

    - -

    Return value

    - -

    #POINT_VEC2:

    - -
    @@ -2498,37 +3035,6 @@ CorrectionRadians The correction in radians.

    #POINT_VEC3:

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

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

    - -

    Parameters

    - -

    Return value

    - -

    Dcs.DCSTypes#Vec2: -Vec2

    -
    @@ -2565,42 +3071,6 @@ Vec3

    - -POINT_VEC3:GetVec2() - -
    -
    - -

    Return the coordinates of the POINT_VEC3 in Vec2 format.

    - -

    Return value

    - -

    Dcs.DCSTypes#Vec2: -The Vec2 coodinate.

    - -
    -
    -
    -
    - - -POINT_VEC3:GetVec3() - -
    -
    - -

    Return the coordinates of the POINT_VEC3 in Vec3 format.

    - -

    Return value

    - -

    Dcs.DCSTypes#Vec3: -The Vec3 coodinate.

    - -
    -
    -
    -
    - POINT_VEC3:GetX() @@ -2650,77 +3120,6 @@ The y coodinate.

    #number: The z coodinate.

    - -
    -
    -
    - - -POINT_VEC3:IlluminationBomb() - -
    -
    - -

    Creates an illumination bomb at the point.

    - -
    -
    -
    -
    - - -POINT_VEC3:IsLOS(ToPointVec3) - -
    -
    - -

    Returns if a PointVec3 has Line of Sight (LOS) with the ToPointVec3.

    - -

    Parameter

    - -

    Return value

    - -

    #boolean: -true If the ToPointVec3 has LOS with the PointVec3, otherwise false.

    - -
    -
    -
    -
    - - -POINT_VEC3:IsMetric() - -
    -
    - -

    Gets if the POINT_VEC3 is metric or NM.

    - -

    Return value

    - -

    #boolean: -Metric true means metric, false means NM.

    - -
    -
    -
    -
    - - - -POINT_VEC3.Metric - -
    -
    - - -
    @@ -2757,8 +3156,8 @@ The z coordinate of the Vec3 point, pointing to the Right.

    Return value

    -

    Core.Point#POINT_VEC3: -self

    +

    Core.Point#POINT_VEC3:

    +
    @@ -2783,7 +3182,8 @@ The Vec2 point.

  • -

    LandHeightAdd :

    +

    Dcs.DCSTypes#Distance LandHeightAdd : +(optional) Add a landheight.

    • @@ -2833,57 +3233,6 @@ self

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

    Build an air type route point.

    - -

    Parameters

    - -

    Return value

    - -

    #table: -The route point.

    -
    @@ -2898,39 +3247,6 @@ The route point.

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

    Build an ground type route point.

    - -

    Parameters

    - -

    Return value

    - -

    #table: -The route point.

    -
    @@ -2945,28 +3261,6 @@ The route point.

    - -
    -
    -
    - - -POINT_VEC3:SetMetric(Metric) - -
    -
    - -

    Sets the POINT_VEC3 metric or NM.

    - -

    Parameter

    -
      -
    • - -

      #boolean Metric : -true means metric, false means NM.

      - -
      • -
    @@ -3048,40 +3342,6 @@ The z coordinate.

    #POINT_VEC3:

    - -
    -
    -
    - - -POINT_VEC3:Smoke(SmokeColor) - -
    -
    - -

    Smokes the point in a color.

    - -

    Parameter

    - -
    -
    -
    -
    - - -POINT_VEC3:SmokeBlue() - -
    -
    - -

    Smoke the POINT_VEC3 Blue.

    -
    @@ -3096,124 +3356,6 @@ The z coordinate.

    - -
    -
    -
    - - -POINT_VEC3:SmokeGreen() - -
    -
    - -

    Smoke the POINT_VEC3 Green.

    - -
    -
    -
    -
    - - -POINT_VEC3:SmokeOrange() - -
    -
    - -

    Smoke the POINT_VEC3 Orange.

    - -
    -
    -
    -
    - - -POINT_VEC3:SmokeRed() - -
    -
    - -

    Smoke the POINT_VEC3 Red.

    - -
    -
    -
    -
    - - -POINT_VEC3:SmokeWhite() - -
    -
    - -

    Smoke the POINT_VEC3 White.

    - -
    -
    -
    -
    - - -POINT_VEC3:ToStringBR(AngleRadians, Distance) - -
    -
    - -

    Provides a Bearing / Range string

    - -

    Parameters

    -
      -
    • - -

      #number AngleRadians : -The angle in randians

      - -
      • -
    • - -

      #number Distance : -The distance

      - -
      • -
    -

    Return value

    - -

    #string: -The BR Text

    - -
    -
    -
    -
    - - -POINT_VEC3:Translate(Distance, Angle) - -
    -
    - -

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

    - -

    Parameters

    - -

    Return value

    - -

    #POINT_VEC3: -The new calculated POINT_VEC3.

    -
    diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index e9d8defe0..26999f404 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Process_JTAC.html b/docs/Documentation/Process_JTAC.html index 1dbc2c736..be64e486d 100644 --- a/docs/Documentation/Process_JTAC.html +++ b/docs/Documentation/Process_JTAC.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Process_Pickup.html b/docs/Documentation/Process_Pickup.html index 2a3293148..4b57e65f0 100644 --- a/docs/Documentation/Process_Pickup.html +++ b/docs/Documentation/Process_Pickup.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html index 540e4f3b5..93a2ea611 100644 --- a/docs/Documentation/Radio.html +++ b/docs/Documentation/Radio.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Route.html b/docs/Documentation/Route.html index 324486bf7..70f8fc1d6 100644 --- a/docs/Documentation/Route.html +++ b/docs/Documentation/Route.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -210,12 +213,30 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil ACT_ROUTE.ClassName + + + + ACT_ROUTE.Coordinate + + ACT_ROUTE.DisplayCount + + + + ACT_ROUTE:GetRouteText(Controllable) + +

    Get the routing text to be displayed.

    + + + + ACT_ROUTE:MenuCancel() + + @@ -228,6 +249,24 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil ACT_ROUTE.ProcessUnit + + + + ACT_ROUTE.RouteMode + + + + + + ACT_ROUTE:SetMenuCancel(MenuGroup, MenuText, ParentMenu, MenuTime) + +

    Set a Cancel Menu item.

    + + + + ACT_ROUTE:SetRouteMode(RouteMode) + +

    Set the route mode.

    @@ -268,6 +307,12 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil ACT_ROUTE_POINT.ClassName + + + + ACT_ROUTE_POINT.Coordinate + + @@ -295,33 +340,27 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil - ACT_ROUTE_POINT:GetPointVec2() + ACT_ROUTE_POINT:GetCoordinate() -

    Get PointVec2

    +

    Get Coordinate

    ACT_ROUTE_POINT:GetRange() -

    Get Range around PointVec2

    +

    Get Range around Coordinate

    ACT_ROUTE_POINT:Init(FsmRoute) - - - - - ACT_ROUTE_POINT:New(The, Range, Zone, PointVec2) -

    Creates a new routing state machine.

    - ACT_ROUTE_POINT.PointVec2 + ACT_ROUTE_POINT:New(The, Range, Zone, Coordinate) - +

    Creates a new routing state machine.

    @@ -331,15 +370,15 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil - ACT_ROUTE_POINT:SetPointVec2(PointVec2) + ACT_ROUTE_POINT:SetCoordinate(Coordinate) -

    Set PointVec2

    +

    Set Coordinate

    ACT_ROUTE_POINT:SetRange(Range) -

    Set Range around PointVec2

    +

    Set Range around Coordinate

    @@ -349,7 +388,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil - ACT_ROUTE_POINT:onenterReporting(ProcessUnit, Event, From, To) + ACT_ROUTE_POINT:onafterReport(ProcessUnit, Event, From, To)

    StateMachine callback function

    @@ -365,6 +404,12 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil

    Type ACT_ROUTE_ZONE

    + + + + + + + + @@ -419,7 +470,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil - + @@ -437,7 +488,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil - + @@ -512,6 +563,20 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil + + +
    +
    + + Core.Point#COORDINATE + +ACT_ROUTE.Coordinate + +
    +
    + + +
    @@ -526,6 +591,48 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil + +
    +
    +
    + + +ACT_ROUTE:GetRouteText(Controllable) + +
    +
    + +

    Get the routing text to be displayed.

    + + +

    The route mode determines the text displayed.

    + +

    Parameter

    + +

    Return value

    + +

    #string:

    + + +
    +
    +
    +
    + + +ACT_ROUTE:MenuCancel() + +
    +
    + + +
    @@ -561,6 +668,96 @@ self

    + +
    +
    +
    + + + +ACT_ROUTE.RouteMode + +
    +
    + + + +
    +
    +
    +
    + + +ACT_ROUTE:SetMenuCancel(MenuGroup, MenuText, ParentMenu, MenuTime) + +
    +
    + +

    Set a Cancel Menu item.

    + +

    Parameters

    +
      +
    • + +

      MenuGroup :

      + +
      • +
    • + +

      MenuText :

      + +
      • +
    • + +

      ParentMenu :

      + +
      • +
    • + +

      MenuTime :

      + +
      • +
    +

    Return value

    + +

    #ACT_ROUTE:

    + + +
    +
    +
    +
    + + +ACT_ROUTE:SetRouteMode(RouteMode) + +
    +
    + +

    Set the route mode.

    + + +

    There are 2 route modes supported:

    + +
      +
    • SetRouteMode( "B" ): Route mode is Bearing and Range.
      • +
    • SetRouteMode( "C" ): Route mode is LL or MGRS according coordinate system setup.
      • +
    + + +

    Parameter

    +
      +
    • + +

      RouteMode :

      + +
      • +
    +

    Return value

    + +

    #ACT_ROUTE:

    + +
    @@ -707,6 +904,20 @@ self

    + +
    +
    +
    + + + +ACT_ROUTE_POINT.Coordinate + +
    +
    + + +
    @@ -771,18 +982,18 @@ self

    - -ACT_ROUTE_POINT:GetPointVec2() + +ACT_ROUTE_POINT:GetCoordinate()
    -

    Get PointVec2

    +

    Get Coordinate

    Return value

    -

    Core.Point#POINT_VEC2: -PointVec2 The PointVec2 to route to.

    +

    Core.Point#COORDINATE: +Coordinate The Coordinate to route to.

    @@ -795,7 +1006,7 @@ PointVec2 The PointVec2 to route to.

    -

    Get Range around PointVec2

    +

    Get Range around Coordinate

    Return value

    @@ -813,7 +1024,10 @@ The Range to consider the arrival. Default is 10000 meters.

    +

    Creates a new routing state machine.

    + +

    The task will route a controllable to a Coordinate until the controllable is within the Range.

    Parameter

    -
    -
    - - - -ACT_ROUTE_POINT.PointVec2 - -
    -
    - - -
    @@ -896,20 +1096,20 @@ The Distance to Target.

    - -ACT_ROUTE_POINT:SetPointVec2(PointVec2) + +ACT_ROUTE_POINT:SetCoordinate(Coordinate)
    -

    Set PointVec2

    +

    Set Coordinate

    Parameter

    @@ -924,7 +1124,7 @@ The PointVec2 to route to.

    -

    Set Range around PointVec2

    +

    Set Range around Coordinate

    Parameter

    ACT_ROUTE_ZONE.Altitude + +
    ACT_ROUTE_ZONE.ClassName @@ -398,6 +443,12 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil ACT_ROUTE_ZONE:GetZone()

    Get Zone

    +
    ACT_ROUTE_ZONE.Heading +
    ACT_ROUTE_ZONE:SetZone(Zone)ACT_ROUTE_ZONE:SetZone(Zone, Altitude, Heading)

    Set Zone
    ACT_ROUTE_ZONE:onenterReporting(ProcessUnit, Event, From, To)ACT_ROUTE_ZONE:onafterReport(ProcessUnit, Event, From, To)

    StateMachine callback function
    + + + + +
    SETTINGS +

    SETTINGS class, extends Base#BASE

    + +
    +

    Type SETTINGS

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    SETTINGS:A2AMenuSystem(A2ASystem) + +
    SETTINGS.A2ASystem + +
    SETTINGS:A2GMenuSystem(A2GSystem) + +
    SETTINGS.A2GSystem + +
    SETTINGS.DefaultMenu + +
    SETTINGS:GetLL_Accuracy() +

    Gets the SETTINGS LL accuracy.

    +
    SETTINGS:GetLL_DMS() +

    Gets the SETTINGS LL DMS.

    +
    SETTINGS:GetMGRS_Accuracy() +

    Gets the SETTINGS MGRS accuracy.

    +
    SETTINGS:IsA2A_BRA() +

    Is BRA

    +
    SETTINGS:IsA2A_BULLS() +

    Is BULLS

    +
    SETTINGS:IsA2G_BRA() +

    Is BRA

    +
    SETTINGS:IsA2G_LL() +

    Is LL

    +
    SETTINGS:IsA2G_MGRS() +

    Is MGRS

    +
    SETTINGS:IsImperial() +

    Gets if the SETTINGS is imperial.

    +
    SETTINGS:IsMetric() +

    Gets if the SETTINGS is metric.

    +
    SETTINGS.LL_Accuracy + +
    SETTINGS.LL_DMS + +
    SETTINGS.MGRS_Accuracy + +
    SETTINGS:MenuGroupA2ASystem(PlayerUnit, PlayerGroup, PlayerName, A2ASystem) + +
    SETTINGS:MenuGroupA2GSystem(PlayerUnit, PlayerGroup, PlayerName, A2GSystem) + +
    SETTINGS:MenuGroupLL_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy) + +
    SETTINGS:MenuGroupLL_DMSSystem(PlayerUnit, PlayerGroup, PlayerName, LL_DMS) + +
    SETTINGS:MenuGroupMGRS_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy) + +
    SETTINGS:MenuGroupMWSystem(PlayerUnit, PlayerGroup, PlayerName, MW) + +
    SETTINGS:MenuLL_Accuracy(LL_Accuracy) + +
    SETTINGS:MenuLL_DMS(LL_DMS) + +
    SETTINGS:MenuMGRS_Accuracy(MGRS_Accuracy) + +
    SETTINGS:MenuMWSystem(MW) + +
    SETTINGS.MenuText + +
    SETTINGS.Metric + +
    SETTINGS.Metrics + +
    SETTINGS.PlayerMenu + +
    SETTINGS:RemovePlayerMenu(RootMenu, PlayerUnit) + +
    SETTINGS:Set(PlayerName) +

    SETTINGS constructor.

    +
    SETTINGS:SetA2A_BRA() +

    Sets A2A BRA

    +
    SETTINGS:SetA2A_BULLS() +

    Sets A2A BULLS

    +
    SETTINGS:SetA2G_BRA() +

    Sets A2G BRA

    +
    SETTINGS:SetA2G_LL() +

    Sets A2G LL

    +
    SETTINGS:SetA2G_MGRS() +

    Sets A2G MGRS

    +
    SETTINGS:SetImperial() +

    Sets the SETTINGS imperial.

    +
    SETTINGS:SetLL_Accuracy(LL_Accuracy) +

    Sets the SETTINGS LL accuracy.

    +
    SETTINGS:SetLL_DMS(LL_DMS) +

    Sets the SETTINGS LL DMS.

    +
    SETTINGS:SetMGRS_Accuracy(MGRS_Accuracy) +

    Sets the SETTINGS MGRS accuracy.

    +
    SETTINGS:SetMetric() +

    Sets the SETTINGS metric.

    +
    SETTINGS:SetPlayerMenu(RootMenu, PlayerUnit, MenuText) + +
    SETTINGS:SetSystemMenu(RootMenu, MenuText) + +
    SETTINGS.SettingsMenu + +
    + +

    Global(s)

    +
    +
    + + #SETTINGS + +SETTINGS + +
    +
    + +

    SETTINGS class, extends Base#BASE

    + + +
    +
    +

    Type Settings

    + +

    Type SETTINGS

    +

    Field(s)

    +
    +
    + + +SETTINGS:A2AMenuSystem(A2ASystem) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      A2ASystem :

      + +
      • +
    +
    +
    +
    +
    + + #string + +SETTINGS.A2ASystem + +
    +
    + + + +
    +
    +
    +
    + + +SETTINGS:A2GMenuSystem(A2GSystem) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      A2GSystem :

      + +
      • +
    +
    +
    +
    +
    + + #string + +SETTINGS.A2GSystem + +
    +
    + + + +
    +
    +
    +
    + + +SETTINGS.DefaultMenu + +
    +
    + + + +
    +
    +
    +
    + + +SETTINGS:GetLL_Accuracy() + +
    +
    + +

    Gets the SETTINGS LL accuracy.

    + +

    Return value

    + +

    #number:

    + + +
    +
    +
    +
    + + +SETTINGS:GetLL_DMS() + +
    +
    + +

    Gets the SETTINGS LL DMS.

    + +

    Return value

    + +

    #number:

    + + +
    +
    +
    +
    + + +SETTINGS:GetMGRS_Accuracy() + +
    +
    + +

    Gets the SETTINGS MGRS accuracy.

    + +

    Return value

    + +

    #number:

    + + +
    +
    +
    +
    + + +SETTINGS:IsA2A_BRA() + +
    +
    + +

    Is BRA

    + +

    Return value

    + +

    #boolean: +true if BRA

    + +
    +
    +
    +
    + + +SETTINGS:IsA2A_BULLS() + +
    +
    + +

    Is BULLS

    + +

    Return value

    + +

    #boolean: +true if BULLS

    + +
    +
    +
    +
    + + +SETTINGS:IsA2G_BRA() + +
    +
    + +

    Is BRA

    + +

    Return value

    + +

    #boolean: +true if BRA

    + +
    +
    +
    +
    + + +SETTINGS:IsA2G_LL() + +
    +
    + +

    Is LL

    + +

    Return value

    + +

    #boolean: +true if LL

    + +
    +
    +
    +
    + + +SETTINGS:IsA2G_MGRS() + +
    +
    + +

    Is MGRS

    + +

    Return value

    + +

    #boolean: +true if MGRS

    + +
    +
    +
    +
    + + +SETTINGS:IsImperial() + +
    +
    + +

    Gets if the SETTINGS is imperial.

    + +

    Return value

    + +

    #boolean: +true if imperial.

    + +
    +
    +
    +
    + + +SETTINGS:IsMetric() + +
    +
    + +

    Gets if the SETTINGS is metric.

    + +

    Return value

    + +

    #boolean: +true if metric.

    + +
    +
    +
    +
    + + #number + +SETTINGS.LL_Accuracy + +
    +
    + + + +
    +
    +
    +
    + + #boolean + +SETTINGS.LL_DMS + +
    +
    + + + +
    +
    +
    +
    + + #number + +SETTINGS.MGRS_Accuracy + +
    +
    + + + +
    +
    +
    +
    + + +SETTINGS:MenuGroupA2ASystem(PlayerUnit, PlayerGroup, PlayerName, A2ASystem) + +
    +
    + + + +

    Parameters

    +
      +
    • + +

      PlayerUnit :

      + +
      • +
    • + +

      PlayerGroup :

      + +
      • +
    • + +

      PlayerName :

      + +
      • +
    • + +

      A2ASystem :

      + +
      • +
    +
    +
    +
    +
    + + +SETTINGS:MenuGroupA2GSystem(PlayerUnit, PlayerGroup, PlayerName, A2GSystem) + +
    +
    + + + +

    Parameters

    +
      +
    • + +

      PlayerUnit :

      + +
      • +
    • + +

      PlayerGroup :

      + +
      • +
    • + +

      PlayerName :

      + +
      • +
    • + +

      A2GSystem :

      + +
      • +
    +
    +
    +
    +
    + + +SETTINGS:MenuGroupLL_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy) + +
    +
    + + + +

    Parameters

    +
      +
    • + +

      PlayerUnit :

      + +
      • +
    • + +

      PlayerGroup :

      + +
      • +
    • + +

      PlayerName :

      + +
      • +
    • + +

      LL_Accuracy :

      + +
      • +
    +
    +
    +
    +
    + + +SETTINGS:MenuGroupLL_DMSSystem(PlayerUnit, PlayerGroup, PlayerName, LL_DMS) + +
    +
    + + + +

    Parameters

    +
      +
    • + +

      PlayerUnit :

      + +
      • +
    • + +

      PlayerGroup :

      + +
      • +
    • + +

      PlayerName :

      + +
      • +
    • + +

      LL_DMS :

      + +
      • +
    +
    +
    +
    +
    + + +SETTINGS:MenuGroupMGRS_AccuracySystem(PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy) + +
    +
    + + + +

    Parameters

    +
      +
    • + +

      PlayerUnit :

      + +
      • +
    • + +

      PlayerGroup :

      + +
      • +
    • + +

      PlayerName :

      + +
      • +
    • + +

      MGRS_Accuracy :

      + +
      • +
    +
    +
    +
    +
    + + +SETTINGS:MenuGroupMWSystem(PlayerUnit, PlayerGroup, PlayerName, MW) + +
    +
    + + + +

    Parameters

    +
      +
    • + +

      PlayerUnit :

      + +
      • +
    • + +

      PlayerGroup :

      + +
      • +
    • + +

      PlayerName :

      + +
      • +
    • + +

      MW :

      + +
      • +
    +
    +
    +
    +
    + + +SETTINGS:MenuLL_Accuracy(LL_Accuracy) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      LL_Accuracy :

      + +
      • +
    +
    +
    +
    +
    + + +SETTINGS:MenuLL_DMS(LL_DMS) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      LL_DMS :

      + +
      • +
    +
    +
    +
    +
    + + +SETTINGS:MenuMGRS_Accuracy(MGRS_Accuracy) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      MGRS_Accuracy :

      + +
      • +
    +
    +
    +
    +
    + + +SETTINGS:MenuMWSystem(MW) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      MW :

      + +
      • +
    +
    +
    +
    +
    + + + +SETTINGS.MenuText + +
    +
    + + + +
    +
    +
    +
    + + + +SETTINGS.Metric + +
    +
    + + + +
    +
    +
    +
    + + + +SETTINGS.Metrics + +
    +
    + + + +
    +
    +
    +
    + + + +SETTINGS.PlayerMenu + +
    +
    + + + +
    +
    +
    +
    + + +SETTINGS:RemovePlayerMenu(RootMenu, PlayerUnit) + +
    +
    + + + +

    Parameters

    + +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:Set(PlayerName) + +
    +
    + +

    SETTINGS constructor.

    + +

    Parameter

    +
      +
    • + +

      PlayerName :

      + +
      • +
    +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetA2A_BRA() + +
    +
    + +

    Sets A2A BRA

    + +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetA2A_BULLS() + +
    +
    + +

    Sets A2A BULLS

    + +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetA2G_BRA() + +
    +
    + +

    Sets A2G BRA

    + +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetA2G_LL() + +
    +
    + +

    Sets A2G LL

    + +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetA2G_MGRS() + +
    +
    + +

    Sets A2G MGRS

    + +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetImperial() + +
    +
    + +

    Sets the SETTINGS imperial.

    + +
    +
    +
    +
    + + +SETTINGS:SetLL_Accuracy(LL_Accuracy) + +
    +
    + +

    Sets the SETTINGS LL accuracy.

    + +

    Parameter

    +
      +
    • + +

      #number LL_Accuracy :

      + +
      • +
    +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetLL_DMS(LL_DMS) + +
    +
    + +

    Sets the SETTINGS LL DMS.

    + +

    Parameter

    +
      +
    • + +

      #number LL_DMS :

      + +
      • +
    +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetMGRS_Accuracy(MGRS_Accuracy) + +
    +
    + +

    Sets the SETTINGS MGRS accuracy.

    + +

    Parameter

    +
      +
    • + +

      #number MGRS_Accuracy :

      + +
      • +
    +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetMetric() + +
    +
    + +

    Sets the SETTINGS metric.

    + +
    +
    +
    +
    + + +SETTINGS:SetPlayerMenu(RootMenu, PlayerUnit, MenuText) + +
    +
    + + + +

    Parameters

    + +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + +SETTINGS:SetSystemMenu(RootMenu, MenuText) + +
    +
    + + + +

    Parameters

    +
      +
    • + +

      RootMenu :

      + +
      • +
    • + +

      MenuText :

      + +
      • +
    +

    Return value

    + +

    #SETTINGS:

    + + +
    +
    +
    +
    + + + +SETTINGS.SettingsMenu + +
    +
    + + + +
    +
    + + + + + + diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html index f025f8ba8..b2f4e1d69 100644 --- a/docs/Documentation/Smoke.html +++ b/docs/Documentation/Smoke.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 19d5a6d46..a69c39851 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -2543,9 +2546,6 @@ when nothing was spawned.

    - -

    By default, no InitLimit

    -
    @@ -2581,7 +2581,7 @@ when nothing was spawned.

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

    - #number + SPAWN.SpawnMaxUnitsAlive @@ -2950,7 +2950,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

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

    +

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

    diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index 50d544bd6..7e31f46d4 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -446,7 +449,6 @@ ptional) The name of the new static.

    - #number SPAWNSTATIC.SpawnIndex diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index 5befab5b3..018cdd833 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html index fbd841089..25c4ef050 100644 --- a/docs/Documentation/Static.html +++ b/docs/Documentation/Static.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/StaticObject.html b/docs/Documentation/StaticObject.html index 1f1abe42f..0a048aa1e 100644 --- a/docs/Documentation/StaticObject.html +++ b/docs/Documentation/StaticObject.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html index ffd356b4b..37429004e 100644 --- a/docs/Documentation/Task.html +++ b/docs/Documentation/Task.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -453,13 +456,13 @@ - TASK:ReportDetails() + TASK:ReportDetails(TaskGroup)

    Create a detailed report of the Task.

    - TASK:ReportOverview() + TASK:ReportOverview(ReportGroup)

    Create an overiew report of the Task.

    @@ -2007,7 +2010,7 @@ self

    -TASK:ReportDetails() +TASK:ReportDetails(TaskGroup)
    @@ -2017,6 +2020,14 @@ self

    List the Task Status, and the Players assigned to the Task.

    +

    Parameter

    +

    Return value

    #string:

    @@ -2028,7 +2039,7 @@ self

    -TASK:ReportOverview() +TASK:ReportOverview(ReportGroup)
    @@ -2038,6 +2049,14 @@ self

    List the Task Name and Status

    +

    Parameter

    +
      +
    • + +

      ReportGroup :

      + +
      • +

    Return value

    #string:

    diff --git a/docs/Documentation/Task_A2A.html b/docs/Documentation/Task_A2A.html new file mode 100644 index 000000000..5a87f36ca --- /dev/null +++ b/docs/Documentation/Task_A2A.html @@ -0,0 +1,1012 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module Task_A2A

    + +

    Tasking - The TASK_A2A models tasks for players in Air to Air engagements.

    + + + +

    Banner Image

    + + +

    1) TaskA2A#TASKA2A class, extends Task#TASK

    + +

    The #TASK_A2A class defines Air To Air tasks for a Set of Target Units, +based on the tasking capabilities defined in Task#TASK. +The TASK_A2A is implemented using a Statemachine#FSM_TASK, and has the following statuses:

    + +
      +
    • None: Start of the process
      • +
    • Planned: The A2A task is planned.
      • +
    • Assigned: The A2A task is assigned to a Group#GROUP.
      • +
    • Success: The A2A task is successfully completed.
      • +
    • Failed: The A2A task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.
      • +
    + +

    1.1) Set the scoring of achievements in an A2A attack.

    + +

    Scoring or penalties can be given in the following circumstances:

    + + + +

    2) TaskA2A#TASKINTERCEPT class, extends TaskA2A#TASKA2A

    + +

    The TASKA2AINTERCEPT class defines an INTERCEPT task for a Set of Target Units.

    + +
    + +

    API CHANGE HISTORY

    + +

    The underlying change log documents the API changes. Please read this carefully. The following notation is used:

    + +
      +
    • Added parts are expressed in bold type face.
      • +
    • Removed parts are expressed in italic type face.
      • +
    + +

    Hereby the change log:

    + +
    + +

    AUTHORS and CONTRIBUTIONS

    + +

    Contributions:

    + + + +

    Authors:

    + +
      +
    • FlightControl: Concept, Design & Programming. +
      • +
    + +

    Global(s)

    + + + + + + + + + + + + + +
    TASK_A2A + +
    TASK_A2A_ENGAGE + +
    TASK_A2A_INTERCEPT + +
    +

    Type TASK_A2A

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TASK_A2A.ClassName + +
    TASK_A2A:GetPlannedMenuText() + +
    TASK_A2A:GetRendezVousCoordinate(TaskUnit) + +
    TASK_A2A:GetRendezVousZone(TaskUnit) + +
    TASK_A2A:GetTargetCoordinate(TaskUnit) + +
    TASK_A2A:GetTargetZone(TaskUnit) + +
    TASK_A2A:New(Mission, SetAttack, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType, TaskBriefing) +

    Instantiates a new TASK_A2A.

    +
    TASK_A2A:SetPenaltyOnFailed(Text, Penalty, TaskUnit) +

    Set a penalty when the A2A attack has failed.

    +
    TASK_A2A:SetRendezVousCoordinate(RendezVousCoordinate, RendezVousRange, TaskUnit) + +
    TASK_A2A:SetRendezVousZone(RendezVousZone, TaskUnit) + +
    TASK_A2A:SetScoreOnDestroy(Text, Score, TaskUnit) +

    Set a score when a target in scope of the A2A attack, has been destroyed .

    +
    TASK_A2A:SetScoreOnSuccess(Text, Score, TaskUnit) +

    Set a score when all the targets in scope of the A2A attack, have been destroyed.

    +
    TASK_A2A:SetTargetCoordinate(TargetCoordinate, TaskUnit) + +
    TASK_A2A:SetTargetZone(TargetZone, TaskUnit, Altitude, Heading) + +
    TASK_A2A.TargetSetUnit + +
    + +

    Type TASK_A2A_ENGAGE

    + + + + + + + + + + + + + +
    TASK_A2A_ENGAGE.ClassName + +
    TASK_A2A_ENGAGE:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing) +

    Instantiates a new TASKA2AENGAGE.

    +
    TASK_A2A_ENGAGE.TargetSetUnit + +
    + +

    Type TASK_A2A_INTERCEPT

    + + + + + + + + + + + + + +
    TASK_A2A_INTERCEPT.ClassName + +
    TASK_A2A_INTERCEPT:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing) +

    Instantiates a new TASKA2AINTERCEPT.

    +
    TASK_A2A_INTERCEPT.TargetSetUnit + +
    + +

    Global(s)

    +
    +
    + + #TASK_A2A + +TASK_A2A + +
    +
    + + + +
    +
    +
    +
    + + #TASK_A2A_ENGAGE + +TASK_A2A_ENGAGE + +
    +
    + + + +
    +
    +
    +
    + + #TASK_A2A_INTERCEPT + +TASK_A2A_INTERCEPT + +
    +
    + + + +
    +
    +

    Type Task_A2A

    + +

    Type FSM_PROCESS

    + +

    Type TASK_A2A

    + +

    The TASK_A2A class

    + +

    Field(s)

    +
    +
    + + #string + +TASK_A2A.ClassName + +
    +
    + + + +
    +
    +
    +
    + + +TASK_A2A:GetPlannedMenuText() + +
    +
    + + + +
    +
    +
    +
    + + +TASK_A2A:GetRendezVousCoordinate(TaskUnit) + +
    +
    + + + +

    Parameter

    + +

    Return values

    +
      +
    1. + +

      Core.Point#COORDINATE: +The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.

      + +
      2. +
    2. + +

      #number: +The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.

      + +
      3. +
    +
    +
    +
    +
    + + +TASK_A2A:GetRendezVousZone(TaskUnit) + +
    +
    + + + +

    Parameter

    + +

    Return value

    + +

    Core.Zone#ZONE_BASE: +The Zone object where the RendezVous is located on the map.

    + +
    +
    +
    +
    + + +TASK_A2A:GetTargetCoordinate(TaskUnit) + +
    +
    + + + +

    Parameter

    + +

    Return value

    + +

    Core.Point#COORDINATE: +The Coordinate object where the Target is located on the map.

    + +
    +
    +
    +
    + + +TASK_A2A:GetTargetZone(TaskUnit) + +
    +
    + + + +

    Parameter

    + +

    Return value

    + +

    Core.Zone#ZONE_BASE: +The Zone object where the Target is located on the map.

    + +
    +
    +
    +
    + + +TASK_A2A:New(Mission, SetAttack, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType, TaskBriefing) + +
    +
    + +

    Instantiates a new TASK_A2A.

    + +

    Parameters

    +
      +
    • + +

      Tasking.Mission#MISSION Mission :

      + +
      • +
    • + +

      Set#SET_GROUP SetAttack : +The set of groups for which the Task can be assigned.

      + +
      • +
    • + +

      #string TaskName : +The name of the Task.

      + +
      • +
    • + +

      Set#SET_UNIT UnitSetTargets :

      + +
      • +
    • + +

      #number TargetDistance : +The distance to Target when the Player is considered to have "arrived" at the engagement range.

      + +
      • +
    • + +

      Core.Zone#ZONE_BASE TargetZone : +The target zone, if known. +If the TargetZone parameter is specified, the player will be routed to the center of the zone where all the targets are assumed to be.

      + +
      • +
    • + +

      TargetSetUnit :

      + +
      • +
    • + +

      TaskType :

      + +
      • +
    • + +

      TaskBriefing :

      + +
      • +
    +

    Return value

    + +

    #TASK_A2A: +self

    + +
    +
    +
    +
    + + +TASK_A2A:SetPenaltyOnFailed(Text, Penalty, TaskUnit) + +
    +
    + +

    Set a penalty when the A2A attack has failed.

    + +

    Parameters

    +
      +
    • + +

      #string Text : +The text to display to the player, when the A2A attack has failed.

      + +
      • +
    • + +

      #number Penalty : +The penalty in points.

      + +
      • +
    • + +

      Wrapper.Unit#UNIT TaskUnit :

      + +
      • +
    +

    Return value

    + +

    #TASK_A2A:

    + + +
    +
    +
    +
    + + +TASK_A2A:SetRendezVousCoordinate(RendezVousCoordinate, RendezVousRange, TaskUnit) + +
    +
    + + + +

    Parameters

    +
      +
    • + +

      Core.Point#COORDINATE RendezVousCoordinate : +The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.

      + +
      • +
    • + +

      #number RendezVousRange : +The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.

      + +
      • +
    • + +

      Wrapper.Unit#UNIT TaskUnit :

      + +
      • +
    +
    +
    +
    +
    + + +TASK_A2A:SetRendezVousZone(RendezVousZone, TaskUnit) + +
    +
    + + + +

    Parameters

    + +
    +
    +
    +
    + + +TASK_A2A:SetScoreOnDestroy(Text, Score, TaskUnit) + +
    +
    + +

    Set a score when a target in scope of the A2A attack, has been destroyed .

    + +

    Parameters

    +
      +
    • + +

      #string Text : +The text to display to the player, when the target has been destroyed.

      + +
      • +
    • + +

      #number Score : +The score in points.

      + +
      • +
    • + +

      Wrapper.Unit#UNIT TaskUnit :

      + +
      • +
    +

    Return value

    + +

    #TASK_A2A:

    + + +
    +
    +
    +
    + + +TASK_A2A:SetScoreOnSuccess(Text, Score, TaskUnit) + +
    +
    + +

    Set a score when all the targets in scope of the A2A attack, have been destroyed.

    + +

    Parameters

    +
      +
    • + +

      #string Text : +The text to display to the player, when all targets hav been destroyed.

      + +
      • +
    • + +

      #number Score : +The score in points.

      + +
      • +
    • + +

      Wrapper.Unit#UNIT TaskUnit :

      + +
      • +
    +

    Return value

    + +

    #TASK_A2A:

    + + +
    +
    +
    +
    + + +TASK_A2A:SetTargetCoordinate(TargetCoordinate, TaskUnit) + +
    +
    + + + +

    Parameters

    + +
    +
    +
    +
    + + +TASK_A2A:SetTargetZone(TargetZone, TaskUnit, Altitude, Heading) + +
    +
    + + + +

    Parameters

    +
      +
    • + +

      Core.Zone#ZONE_BASE TargetZone : +The Zone object where the Target is located on the map.

      + +
      • +
    • + +

      Wrapper.Unit#UNIT TaskUnit :

      + +
      • +
    • + +

      Altitude :

      + +
      • +
    • + +

      Heading :

      + +
      • +
    +
    +
    +
    +
    + + Set#SET_UNIT + +TASK_A2A.TargetSetUnit + +
    +
    + + + +
    +
    + +

    Type TASK_A2A_ENGAGE

    + +

    The TASKA2AENGAGE class

    + +

    Field(s)

    +
    +
    + + #string + +TASK_A2A_ENGAGE.ClassName + +
    +
    + + + +
    +
    +
    +
    + + +TASK_A2A_ENGAGE:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing) + +
    +
    + +

    Instantiates a new TASKA2AENGAGE.

    + +

    Parameters

    +
      +
    • + +

      Tasking.Mission#MISSION Mission :

      + +
      • +
    • + +

      Core.Set#SET_GROUP SetGroup : +The set of groups for which the Task can be assigned.

      + +
      • +
    • + +

      #string TaskName : +The name of the Task.

      + +
      • +
    • + +

      Core.Set#SET_UNIT TargetSetUnit :

      + +
      • +
    • + +

      #string TaskBriefing : +The briefing of the task.

      + +
      • +
    +

    Return value

    + +

    #TASKA2AENGAGE: +self

    + +
    +
    +
    +
    + + Set#SET_UNIT + +TASK_A2A_ENGAGE.TargetSetUnit + +
    +
    + + + +
    +
    + +

    Type TASK_A2A_INTERCEPT

    + +

    The TASKA2AINTERCEPT class

    + +

    Field(s)

    +
    +
    + + #string + +TASK_A2A_INTERCEPT.ClassName + +
    +
    + + + +
    +
    +
    +
    + + +TASK_A2A_INTERCEPT:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing) + +
    +
    + +

    Instantiates a new TASKA2AINTERCEPT.

    + +

    Parameters

    +
      +
    • + +

      Tasking.Mission#MISSION Mission :

      + +
      • +
    • + +

      Core.Set#SET_GROUP SetGroup : +The set of groups for which the Task can be assigned.

      + +
      • +
    • + +

      #string TaskName : +The name of the Task.

      + +
      • +
    • + +

      Core.Set#SET_UNIT TargetSetUnit :

      + +
      • +
    • + +

      #string TaskBriefing : +The briefing of the task.

      + +
      • +
    +

    Return value

    + +

    #TASKA2AINTERCEPT: +self

    + +
    +
    +
    +
    + + Set#SET_UNIT + +TASK_A2A_INTERCEPT.TargetSetUnit + +
    +
    + + + +
    +
    + +
    + +
    + + diff --git a/docs/Documentation/Task_A2A_Dispatcher.html b/docs/Documentation/Task_A2A_Dispatcher.html new file mode 100644 index 000000000..5faeb923b --- /dev/null +++ b/docs/Documentation/Task_A2A_Dispatcher.html @@ -0,0 +1,639 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module Task_A2A_Dispatcher

    + +

    Tasking - The TASKA2ADISPATCHER creates and manages player TASK_A2A tasks based on detected targets.

    + + + +
    + +

    1) #TASKA2ADISPATCHER class, extends #DETECTION_MANAGER

    + +

    The #TASKA2ADISPATCHER class implements the dynamic dispatching of tasks upon groups of detected units determined a Set of EWR installation groups. +The EWR will detect units, will group them, and will dispatch Tasks to groups. Depending on the type of target detected, different tasks will be dispatched. +Find a summary below describing for which situation a task type is created:

    + +
      +
    • INTERCEPT Task: Is created when the target is known, is detected and within a danger zone, and there is no friendly airborne in range.
      • +
    • SWEEP Task: Is created when the target is unknown, was detected and the last position is only known, and within a danger zone, and there is no friendly airborne in range.
      • +
    • ENGAGE Task: Is created when the target is known, is detected and within a danger zone, and there is a friendly airborne in range, that will receive this task.
      • +
    + +

    Other task types will follow...

    + +

    3.1) TASKA2ADISPATCHER constructor:

    +

    The TASKA2ADISPATCHER.New() method creates a new TASKA2ADISPATCHER instance.

    + +
    + +

    API CHANGE HISTORY

    + +

    The underlying change log documents the API changes. Please read this carefully. The following notation is used:

    + +
      +
    • Added parts are expressed in bold type face.
      • +
    • Removed parts are expressed in italic type face.
      • +
    + +

    Hereby the change log:

    + +
    + +

    AUTHORS and CONTRIBUTIONS

    + +

    Contributions:

    + +

    Authors:

    + +
      +
    • FlightControl: Concept, Design & Programming.
      • +
    + + +

    Global(s)

    + + + + + +
    TASK_A2A_DISPATCHER + +
    +

    Type TASK_A2A_DISPATCHER

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TASK_A2A_DISPATCHER.ClassName + +
    TASK_A2A_DISPATCHER.Detection +

    The DETECTION_BASE object that is used to report the detected objects. The Detection object will only function in RADAR mode!!!

    +
    TASK_A2A_DISPATCHER:EvaluateENGAGE(DetectedItem) +

    Creates an ENGAGE task when there are human friendlies airborne near the targets.

    +
    TASK_A2A_DISPATCHER:EvaluateINTERCEPT(DetectedItem) +

    Creates an INTERCEPT task when there are targets for it.

    +
    TASK_A2A_DISPATCHER:EvaluateRemoveTask(Mission, Task, Detection, DetectedItemID, DetectedItemChange, DetectedItem, DetectedItemChanged) +

    Evaluates the removal of the Task from the Mission.

    +
    TASK_A2A_DISPATCHER:GetFriendliesNearBy(DetectedItem) +

    Calculates which friendlies are nearby the area

    +
    TASK_A2A_DISPATCHER:GetPlayerFriendliesNearBy(DetectedItem) +

    Calculates which HUMAN friendlies are nearby the area

    +
    TASK_A2A_DISPATCHER.Mission + +
    TASK_A2A_DISPATCHER:New(Mission, SetGroup, Detection) +

    TASKA2ADISPATCHER constructor.

    +
    TASK_A2A_DISPATCHER:OnAfterAssign(From, Event, To, Task, TaskUnit, PlayerName) +

    OnAfter Transition Handler for Event Assign.

    +
    TASK_A2A_DISPATCHER:ProcessDetected(Detection) +

    Assigns tasks in relation to the detected items to the Set#SET_GROUP.

    +
    TASK_A2A_DISPATCHER.SetGroup +

    The groups to which the FAC will report to.

    +
    TASK_A2A_DISPATCHER.Tasks + +
    + +

    Global(s)

    +
    +
    + + #TASK_A2A_DISPATCHER + +TASK_A2A_DISPATCHER + +
    +
    + + + +
    +
    +

    Type Task_A2A_Dispatcher

    + +

    Type TASK_A2A_DISPATCHER

    + +

    TASKA2ADISPATCHER class.

    + +

    Field(s)

    +
    +
    + + #string + +TASK_A2A_DISPATCHER.ClassName + +
    +
    + + + +
    +
    +
    +
    + + Functional.Detection#DETECTION_BASE + +TASK_A2A_DISPATCHER.Detection + +
    +
    + +

    The DETECTION_BASE object that is used to report the detected objects. The Detection object will only function in RADAR mode!!!

    + +
    +
    +
    +
    + + +TASK_A2A_DISPATCHER:EvaluateENGAGE(DetectedItem) + +
    +
    + +

    Creates an ENGAGE task when there are human friendlies airborne near the targets.

    + +

    Parameter

    + +

    Return values

    +
      +
    1. + +

      Set#SET_UNIT: +TargetSetUnit: The target set of units.

      + +
      2. +
    2. + +

      #nil: +If there are no targets to be set.

      + +
      3. +
    +
    +
    +
    +
    + + +TASK_A2A_DISPATCHER:EvaluateINTERCEPT(DetectedItem) + +
    +
    + +

    Creates an INTERCEPT task when there are targets for it.

    + +

    Parameter

    + +

    Return values

    +
      +
    1. + +

      Set#SET_UNIT: +TargetSetUnit: The target set of units.

      + +
      2. +
    2. + +

      #nil: +If there are no targets to be set.

      + +
      3. +
    +
    +
    +
    +
    + + +TASK_A2A_DISPATCHER:EvaluateRemoveTask(Mission, Task, Detection, DetectedItemID, DetectedItemChange, DetectedItem, DetectedItemChanged) + +
    +
    + +

    Evaluates the removal of the Task from the Mission.

    + + +

    Can only occur when the DetectedItem is Changed AND the state of the Task is "Planned".

    + +

    Parameters

    + +

    Return value

    + +

    Tasking.Task#TASK:

    + + +
    +
    +
    +
    + + +TASK_A2A_DISPATCHER:GetFriendliesNearBy(DetectedItem) + +
    +
    + +

    Calculates which friendlies are nearby the area

    + +

    Parameter

    +
      +
    • + +

      DetectedItem :

      + +
      • +
    +

    Return value

    + +

    #number, Core.CommandCenter#REPORT:

    + + +
    +
    +
    +
    + + +TASK_A2A_DISPATCHER:GetPlayerFriendliesNearBy(DetectedItem) + +
    +
    + +

    Calculates which HUMAN friendlies are nearby the area

    + +

    Parameter

    +
      +
    • + +

      DetectedItem :

      + +
      • +
    +

    Return value

    + +

    #number, Core.CommandCenter#REPORT:

    + + +
    +
    +
    +
    + + Tasking.Mission#MISSION + +TASK_A2A_DISPATCHER.Mission + +
    +
    + + + +
    +
    +
    +
    + + +TASK_A2A_DISPATCHER:New(Mission, SetGroup, Detection) + +
    +
    + +

    TASKA2ADISPATCHER constructor.

    + +

    Parameters

    + +

    Return value

    + +

    #TASKA2ADISPATCHER: +self

    + +
    +
    +
    +
    + + +TASK_A2A_DISPATCHER:OnAfterAssign(From, Event, To, Task, TaskUnit, PlayerName) + +
    +
    + +

    OnAfter Transition Handler for Event Assign.

    + +

    Parameters

    +
      +
    • + +

      #string From : +The From State string.

      + +
      • +
    • + +

      #string Event : +The Event string.

      + +
      • +
    • + +

      #string To : +The To State string.

      + +
      • +
    • + +

      Tasking.TaskA2A#TASKA2A Task :

      + +
      • +
    • + +

      Wrapper.Unit#UNIT TaskUnit :

      + +
      • +
    • + +

      #string PlayerName :

      + +
      • +
    +
    +
    +
    +
    + + +TASK_A2A_DISPATCHER:ProcessDetected(Detection) + +
    +
    + +

    Assigns tasks in relation to the detected items to the Set#SET_GROUP.

    + +

    Parameter

    + +

    Return value

    + +

    #boolean: +Return true if you want the task assigning to continue... false will cancel the loop.

    + +
    +
    +
    +
    + + Set#SET_GROUP + +TASK_A2A_DISPATCHER.SetGroup + +
    +
    + +

    The groups to which the FAC will report to.

    + +
    +
    +
    +
    + + + +TASK_A2A_DISPATCHER.Tasks + +
    +
    + + + +
    +
    + +
    + +
    + + diff --git a/docs/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html index 82710dd9f..78390c8c1 100644 --- a/docs/Documentation/Task_A2G.html +++ b/docs/Documentation/Task_A2G.html @@ -75,6 +75,7 @@
  • Scoring
  • Sead
  • Set
    • +
  • Settings
  • Smoke
  • Spawn
  • SpawnStatic
    • @@ -82,6 +83,8 @@
  • Static
  • StaticObject
  • Task
    • +
  • Task_A2A
    • +
  • Task_A2A_Dispatcher
  • Task_A2G
  • Task_A2G_Dispatcher
  • Task_Cargo
    • @@ -218,7 +221,7 @@ The TASK_A2G is implemented using a Stat - TASK_A2G:GetRendezVousPointVec2(TaskUnit) + TASK_A2G:GetRendezVousCoordinate(TaskUnit) @@ -230,7 +233,7 @@ The TASK_A2G is implemented using a Stat - TASK_A2G:GetTargetPointVec2(TaskUnit) + TASK_A2G:GetTargetCoordinate(TaskUnit) @@ -254,7 +257,7 @@ The TASK_A2G is implemented using a Stat - TASK_A2G:SetRendezVousPointVec2(RendezVousPointVec2, RendezVousRange, TaskUnit) + TASK_A2G:SetRendezVousCoordinate(RendezVousCoordinate, RendezVousRange, TaskUnit) @@ -278,7 +281,7 @@ The TASK_A2G is implemented using a Stat - TASK_A2G:SetTargetPointVec2(TargetPointVec2, TaskUnit) + TASK_A2G:SetTargetCoordinate(TargetCoordinate, TaskUnit) @@ -459,8 +462,8 @@ The TASK_A2G is implemented using a Stat
    - -TASK_A2G:GetRendezVousPointVec2(TaskUnit) + +TASK_A2G:GetRendezVousCoordinate(TaskUnit)
    @@ -479,8 +482,8 @@ The TASK_A2G is implemented using a Stat
    1. -

      Core.Point#POINT_VEC2: -The PointVec2 object referencing to the 2D point where the RendezVous point is located on the map.

      +

      Core.Point#COORDINATE: +The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.

    2. @@ -521,8 +524,8 @@ The Zone object where the RendezVous is located on the map.

      - -TASK_A2G:GetTargetPointVec2(TaskUnit) + +TASK_A2G:GetTargetCoordinate(TaskUnit)
      @@ -539,8 +542,8 @@ The Zone object where the RendezVous is located on the map.

      Return value

      -

      Core.Point#POINT_VEC2: -The PointVec2 object where the Target is located on the map.

      +

      Core.Point#COORDINATE: +The Coordinate object where the Target is located on the map.

      @@ -682,8 +685,8 @@ The penalty in points.

      - -TASK_A2G:SetRendezVousPointVec2(RendezVousPointVec2, RendezVousRange, TaskUnit) + +TASK_A2G:SetRendezVousCoordinate(RendezVousCoordinate, RendezVousRange, TaskUnit)
      @@ -694,8 +697,8 @@ The penalty in points.