diff --git a/Moose Mission Setup/Moose.lua b/Moose Mission Setup/Moose.lua index a1ae2c475..2b0c46928 100644 --- a/Moose Mission Setup/Moose.lua +++ b/Moose Mission Setup/Moose.lua @@ -1,5 +1,5 @@ env.info( '*** MOOSE DYNAMIC INCLUDE START *** ' ) -env.info( 'Moose Generation Timestamp: 20171009_1446' ) +env.info( 'Moose Generation Timestamp: 20171010_1107' ) local base = _G @@ -24,6 +24,8 @@ __Moose.Includes = {} __Moose.Include( 'Utilities/Routines.lua' ) __Moose.Include( 'Utilities/Utils.lua' ) __Moose.Include( 'Core/Base.lua' ) +__Moose.Include( 'Core/UserFlag.lua' ) +__Moose.Include( 'Core/UserSound.lua' ) __Moose.Include( 'Core/Report.lua' ) __Moose.Include( 'Core/Scheduler.lua' ) __Moose.Include( 'Core/ScheduleDispatcher.lua' ) diff --git a/Moose Mission Setup/Moose_.lua b/Moose Mission Setup/Moose_.lua index 92d010362..3facc6990 100644 --- a/Moose Mission Setup/Moose_.lua +++ b/Moose Mission Setup/Moose_.lua @@ -1,5 +1,5 @@ env.info('*** MOOSE DYNAMIC INCLUDE START *** ') -env.info('Moose Generation Timestamp: 20171009_1446') +env.info('Moose Generation Timestamp: 20171010_1107') local base=_G __Moose={} __Moose.Include=function(IncludeFile) @@ -19,6 +19,8 @@ __Moose.Includes={} __Moose.Include('Utilities/Routines.lua') __Moose.Include('Utilities/Utils.lua') __Moose.Include('Core/Base.lua') +__Moose.Include('Core/UserFlag.lua') +__Moose.Include('Core/UserSound.lua') __Moose.Include('Core/Report.lua') __Moose.Include('Core/Scheduler.lua') __Moose.Include('Core/ScheduleDispatcher.lua') diff --git a/docs/Documentation/AI_A2A.html b/docs/Documentation/AI_A2A.html index 090470fc4..38af29dd8 100644 --- a/docs/Documentation/AI_A2A.html +++ b/docs/Documentation/AI_A2A.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_A2A_Cap.html b/docs/Documentation/AI_A2A_Cap.html index 1c0934009..34916a9e4 100644 --- a/docs/Documentation/AI_A2A_Cap.html +++ b/docs/Documentation/AI_A2A_Cap.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_A2A_Dispatcher.html b/docs/Documentation/AI_A2A_Dispatcher.html index e07abcdb2..20765a7f1 100644 --- a/docs/Documentation/AI_A2A_Dispatcher.html +++ b/docs/Documentation/AI_A2A_Dispatcher.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_A2A_GCI.html b/docs/Documentation/AI_A2A_GCI.html index d7aac5ea3..a7a22fbbc 100644 --- a/docs/Documentation/AI_A2A_GCI.html +++ b/docs/Documentation/AI_A2A_GCI.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_A2A_Patrol.html b/docs/Documentation/AI_A2A_Patrol.html index 12384fad2..067902aa6 100644 --- a/docs/Documentation/AI_A2A_Patrol.html +++ b/docs/Documentation/AI_A2A_Patrol.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_BAI.html b/docs/Documentation/AI_BAI.html index eec16df40..7d6770c96 100644 --- a/docs/Documentation/AI_BAI.html +++ b/docs/Documentation/AI_BAI.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html index 7220aec89..a0699856c 100644 --- a/docs/Documentation/AI_Balancer.html +++ b/docs/Documentation/AI_Balancer.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_Cap.html b/docs/Documentation/AI_Cap.html index b3f3e51b9..3098a0ad8 100644 --- a/docs/Documentation/AI_Cap.html +++ b/docs/Documentation/AI_Cap.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_Cas.html b/docs/Documentation/AI_Cas.html index a5f0c1ead..8a068de4d 100644 --- a/docs/Documentation/AI_Cas.html +++ b/docs/Documentation/AI_Cas.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_Formation.html b/docs/Documentation/AI_Formation.html index 8d1d65a54..0977b5c5f 100644 --- a/docs/Documentation/AI_Formation.html +++ b/docs/Documentation/AI_Formation.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index b0f19451b..7e797ee06 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -933,6 +935,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 527b5033c..af42ac79d 100644 --- a/docs/Documentation/Account.html +++ b/docs/Documentation/Account.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Airbase.html b/docs/Documentation/Airbase.html index 674de623e..f3d96bf01 100644 --- a/docs/Documentation/Airbase.html +++ b/docs/Documentation/Airbase.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/AirbasePolice.html b/docs/Documentation/AirbasePolice.html index 8ff5c6988..a79055079 100644 --- a/docs/Documentation/AirbasePolice.html +++ b/docs/Documentation/AirbasePolice.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Assign.html b/docs/Documentation/Assign.html index 1929bba26..71af3b872 100644 --- a/docs/Documentation/Assign.html +++ b/docs/Documentation/Assign.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Base.html b/docs/Documentation/Base.html index 592c22cf0..0592e3e73 100644 --- a/docs/Documentation/Base.html +++ b/docs/Documentation/Base.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index d98186019..95619eed8 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -3424,7 +3426,6 @@ The range till cargo will board.

    - CARGO_UNIT.CargoCarrier @@ -3550,6 +3551,7 @@ The range till cargo will board.

    + #number CARGO_UNIT.RunCount diff --git a/docs/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html index 75c7a78a0..45478a336 100644 --- a/docs/Documentation/CleanUp.html +++ b/docs/Documentation/CleanUp.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Client.html b/docs/Documentation/Client.html index 8f048a4e1..648d6e81c 100644 --- a/docs/Documentation/Client.html +++ b/docs/Documentation/Client.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html index 59957f107..e8d4e3fb2 100644 --- a/docs/Documentation/CommandCenter.html +++ b/docs/Documentation/CommandCenter.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html index e9b65e4ac..9ea63b683 100644 --- a/docs/Documentation/Controllable.html +++ b/docs/Documentation/Controllable.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSAirbase.html b/docs/Documentation/DCSAirbase.html index 495771991..ca640897c 100644 --- a/docs/Documentation/DCSAirbase.html +++ b/docs/Documentation/DCSAirbase.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSCoalitionObject.html b/docs/Documentation/DCSCoalitionObject.html index 84278d39e..1eee6c4cb 100644 --- a/docs/Documentation/DCSCoalitionObject.html +++ b/docs/Documentation/DCSCoalitionObject.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSCommand.html b/docs/Documentation/DCSCommand.html index 24586b5b4..3677dd7b7 100644 --- a/docs/Documentation/DCSCommand.html +++ b/docs/Documentation/DCSCommand.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSController.html b/docs/Documentation/DCSController.html index 255245afb..3439daa17 100644 --- a/docs/Documentation/DCSController.html +++ b/docs/Documentation/DCSController.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSGroup.html b/docs/Documentation/DCSGroup.html index f71d07fea..6ff1afbee 100644 --- a/docs/Documentation/DCSGroup.html +++ b/docs/Documentation/DCSGroup.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSObject.html b/docs/Documentation/DCSObject.html index 39ebc862e..7eceacd31 100644 --- a/docs/Documentation/DCSObject.html +++ b/docs/Documentation/DCSObject.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSTask.html b/docs/Documentation/DCSTask.html index 54f519426..51395ba5f 100644 --- a/docs/Documentation/DCSTask.html +++ b/docs/Documentation/DCSTask.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSTypes.html b/docs/Documentation/DCSTypes.html index 0c503127b..059dc039f 100644 --- a/docs/Documentation/DCSTypes.html +++ b/docs/Documentation/DCSTypes.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSUnit.html b/docs/Documentation/DCSUnit.html index 2af906b20..7d9c60004 100644 --- a/docs/Documentation/DCSUnit.html +++ b/docs/Documentation/DCSUnit.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSVec3.html b/docs/Documentation/DCSVec3.html index 35586cf3d..e5403e169 100644 --- a/docs/Documentation/DCSVec3.html +++ b/docs/Documentation/DCSVec3.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSWorld.html b/docs/Documentation/DCSWorld.html index 15f8813c6..6337356dc 100644 --- a/docs/Documentation/DCSWorld.html +++ b/docs/Documentation/DCSWorld.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCSZone.html b/docs/Documentation/DCSZone.html index ad7a092d0..e84e9495c 100644 --- a/docs/Documentation/DCSZone.html +++ b/docs/Documentation/DCSZone.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCScountry.html b/docs/Documentation/DCScountry.html index 127e37595..e32c737df 100644 --- a/docs/Documentation/DCScountry.html +++ b/docs/Documentation/DCScountry.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCStimer.html b/docs/Documentation/DCStimer.html index 28e5ae110..2488e8315 100644 --- a/docs/Documentation/DCStimer.html +++ b/docs/Documentation/DCStimer.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/DCStrigger.html b/docs/Documentation/DCStrigger.html index 737cf0a04..ee0ae54f3 100644 --- a/docs/Documentation/DCStrigger.html +++ b/docs/Documentation/DCStrigger.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html index bc7fdd980..6c758c57b 100644 --- a/docs/Documentation/Database.html +++ b/docs/Documentation/Database.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index 9372fa3d2..0a4ea910b 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -1103,7 +1105,7 @@ function below will use the range 1-7 just in case

    - #number + DESIGNATE.LaseDuration @@ -1157,7 +1159,6 @@ function below will use the range 1-7 just in case

    - DESIGNATE.LaserCodes diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index 0d3d2f122..34245c128 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -4058,7 +4060,7 @@ Return false to cancel Transition.

    - #number + DETECTION_BASE.RefreshTimeInterval diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html index a8497d2f1..e81587d9c 100644 --- a/docs/Documentation/DetectionManager.html +++ b/docs/Documentation/DetectionManager.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Escort.html b/docs/Documentation/Escort.html index 624908b68..fe815825a 100644 --- a/docs/Documentation/Escort.html +++ b/docs/Documentation/Escort.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Event.html b/docs/Documentation/Event.html index 237e7b036..e307356f7 100644 --- a/docs/Documentation/Event.html +++ b/docs/Documentation/Event.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index a613fca6a..c93ca5781 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -1605,7 +1607,7 @@ A string defining the start state.

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

    + FSM.current diff --git a/docs/Documentation/Goal.html b/docs/Documentation/Goal.html index 81c2aea93..027a67c19 100644 --- a/docs/Documentation/Goal.html +++ b/docs/Documentation/Goal.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html index 8b71f7b62..16ba101d1 100644 --- a/docs/Documentation/Group.html +++ b/docs/Documentation/Group.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html index ee45da3f0..dd7d66ad6 100644 --- a/docs/Documentation/Identifiable.html +++ b/docs/Documentation/Identifiable.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html index 96f8d2d81..76097e757 100644 --- a/docs/Documentation/Menu.html +++ b/docs/Documentation/Menu.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Message.html b/docs/Documentation/Message.html index 574ed46bb..719909bc6 100644 --- a/docs/Documentation/Message.html +++ b/docs/Documentation/Message.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html index 3c30ef6df..669dae432 100644 --- a/docs/Documentation/MissileTrainer.html +++ b/docs/Documentation/MissileTrainer.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html index 1e6c12d45..ce7feec59 100644 --- a/docs/Documentation/Mission.html +++ b/docs/Documentation/Mission.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index 7e0421af2..6cdb0d829 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -234,7 +236,6 @@ on defined intervals (currently every minute).

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

    - -

    Contains the counter how many units are currently alive

    -
    diff --git a/docs/Documentation/Object.html b/docs/Documentation/Object.html index d4bdeee2f..4b5d22319 100644 --- a/docs/Documentation/Object.html +++ b/docs/Documentation/Object.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index 6237a6e0d..bee612e3b 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index ed5897722..8bc4135fe 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Process_JTAC.html b/docs/Documentation/Process_JTAC.html index e7e60d127..c22bde4df 100644 --- a/docs/Documentation/Process_JTAC.html +++ b/docs/Documentation/Process_JTAC.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Process_Pickup.html b/docs/Documentation/Process_Pickup.html index 229b8a94b..c6ce210a1 100644 --- a/docs/Documentation/Process_Pickup.html +++ b/docs/Documentation/Process_Pickup.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Protect.html b/docs/Documentation/Protect.html index 368e20320..77de9c119 100644 --- a/docs/Documentation/Protect.html +++ b/docs/Documentation/Protect.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html index 39e53f7cf..c467e6b9f 100644 --- a/docs/Documentation/Radio.html +++ b/docs/Documentation/Radio.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Rat.html b/docs/Documentation/Rat.html index 07724fc38..484006a12 100644 --- a/docs/Documentation/Rat.html +++ b/docs/Documentation/Rat.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -327,18 +329,18 @@ RAT:SetCoalition(friendly)

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

    - - - - RAT:SetCoalition2(id) - -

    Set country of RAT group.

    RAT:SetCoalitionAircraft(color)

    Set coalition of RAT group.

    + + + + RAT:SetCountry(id) + +

    Set country of RAT group.

    @@ -351,6 +353,12 @@ RAT:SetDeparture(names)

    Set possible departure ports.

    + + + + RAT:SetDeparturesFromZone(zone) + +

    Include all airports which lie in a zone as possible destinations.

    @@ -363,6 +371,12 @@ RAT:SetDestination(names)

    Set name of destination airport for the AI aircraft.

    + + + + RAT:SetDestinationsFromZone(zone) + +

    Include all airports which lie in a zone as possible destinations.

    @@ -597,6 +611,12 @@ RAT:_FLmax(alpha, beta, d, phi, h0)

    Calculate the max flight level for a given distance and fixed climb and descent rates.

    + + + + RAT:_GetAirportsInZone(zone) + +

    Find airports within a zone.

    @@ -861,6 +881,12 @@ RAT.debug

    Turn debug messages on or off.

    + + + + RAT.departure_Azone + +

    Zone containing the departure airports.

    @@ -873,6 +899,12 @@ RAT.departure_zones

    Array containing the names of the departure zones.

    + + + + RAT.destination_Azone + +

    Zone containing the destination airports.

    @@ -884,7 +916,7 @@ RAT.excluded_ports - +

    Array containing the names of explicitly excluded airports.

    @@ -1704,31 +1736,6 @@ Default is "same", so aircraft will use airports of the coalition their spawn te
    - -RAT:SetCoalition2(id) - -
    -
    - -

    Set country of RAT group.

    - - -

    This overrules the coalition settings.

    - -

    Parameter

    -
      -
    • - -

      #number id : -DCS country enumerator ID. For example country.id.USA or country.id.RUSSIA.

      - -
      • -
    -
    -
    -
    -
    - RAT:SetCoalitionAircraft(color) @@ -1754,6 +1761,31 @@ Color of coalition, i.e. "red" or blue".

    + +RAT:SetCountry(id) + +
    +
    + +

    Set country of RAT group.

    + + +

    This overrules the coalition settings.

    + +

    Parameter

    +
      +
    • + +

      #number id : +DCS country enumerator ID. For example country.id.USA or country.id.RUSSIA.

      + +
      • +
    +
    +
    +
    +
    + RAT:SetCruiseAltitude(alt) @@ -1811,6 +1843,28 @@ Name or table of names of departure airports or zones.

    + +RAT:SetDeparturesFromZone(zone) + +
    +
    + +

    Include all airports which lie in a zone as possible destinations.

    + +

    Parameter

    + +
    +
    +
    +
    + RAT:SetDescentAngle(angle) @@ -1864,6 +1918,28 @@ Name of the destination airport or table of destination airports.

    + +RAT:SetDestinationsFromZone(zone) + +
    +
    + +

    Include all airports which lie in a zone as possible destinations.

    + +

    Parameter

    + +
    +
    +
    +
    + RAT:SetFL(height) @@ -2804,6 +2880,32 @@ Maximal flight level in meters.

    + +RAT:_GetAirportsInZone(zone) + +
    +
    + +

    Find airports within a zone.

    + +

    Parameter

    + +

    Return value

    + +

    #list: +Table with airport names that lie within the zone.

    + +
    +
    +
    +
    + RAT:_GetAirportsOfCoalition() @@ -3929,6 +4031,20 @@ Waypoints for DCS task route or spawn template.

    Turn debug messages on or off.

    + +
    +
    +
    + + Core.Zone#ZONE + +RAT.departure_Azone + +
    +
    + +

    Zone containing the departure airports.

    +
    @@ -3957,6 +4073,20 @@ Waypoints for DCS task route or spawn template.

    Array containing the names of the departure zones.

    + +
    +
    +
    + + Core.Zone#ZONE + +RAT.destination_Azone + +
    +
    + +

    Zone containing the destination airports.

    +
    @@ -3976,14 +4106,14 @@ Waypoints for DCS task route or spawn template.

    - + #table RAT.excluded_ports
    - +

    Array containing the names of explicitly excluded airports.

    diff --git a/docs/Documentation/Route.html b/docs/Documentation/Route.html index 41222bef8..e7b16df03 100644 --- a/docs/Documentation/Route.html +++ b/docs/Documentation/Route.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Scenery.html b/docs/Documentation/Scenery.html index 2da5eda56..12782991d 100644 --- a/docs/Documentation/Scenery.html +++ b/docs/Documentation/Scenery.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/ScheduleDispatcher.html b/docs/Documentation/ScheduleDispatcher.html index 8bb0af947..3c81b5daf 100644 --- a/docs/Documentation/ScheduleDispatcher.html +++ b/docs/Documentation/ScheduleDispatcher.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html index 8e01ae1ab..ebd4e0669 100644 --- a/docs/Documentation/Scheduler.html +++ b/docs/Documentation/Scheduler.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Scoring.html b/docs/Documentation/Scoring.html index 160a840b8..e81fc5f57 100644 --- a/docs/Documentation/Scoring.html +++ b/docs/Documentation/Scoring.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -375,6 +377,12 @@ Various methods exist to configure:

    SCORING:AddGoalScore(PlayerUnit, GoalTag, Text, Score)

    Add a goal score for a player.

    + + + + SCORING:AddGoalScorePlayer(PlayerName, GoalTag, Text, Score) + +

    Add a goal score for a player.

    @@ -870,6 +878,52 @@ The score can be both positive or negative ( Penalty ).

    + +SCORING:AddGoalScorePlayer(PlayerName, GoalTag, Text, Score) + +
    +
    + +

    Add a goal score for a player.

    + + +

    The method takes the Player name for which the Goal score needs to be set. +The GoalTag is a string or identifier that is taken into the CSV file scoring log to identify the goal. +A free text can be given that is shown to the players. +The Score can be both positive and negative.

    + +

    Parameters

    +
      +
    • + +

      #string PlayerName : +The name of the Player.

      + +
      • +
    • + +

      #string GoalTag : +The string or identifier that is used in the CSV file to identify the goal (sort or group later in Excel).

      + +
      • +
    • + +

      #string Text : +A free text that is shown to the players.

      + +
      • +
    • + +

      #number Score : +The score can be both positive or negative ( Penalty ).

      + +
      • +
    +
    +
    +
    +
    + SCORING:AddScoreGroup(ScoreGroup, Score) diff --git a/docs/Documentation/Sead.html b/docs/Documentation/Sead.html index 3c6e56173..e824ce99c 100644 --- a/docs/Documentation/Sead.html +++ b/docs/Documentation/Sead.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html index bf497968c..ea5420bda 100644 --- a/docs/Documentation/Set.html +++ b/docs/Documentation/Set.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -458,6 +460,18 @@ SET_BASE:GetSet()

    Gets the Set.

    + + + + SET_BASE:GetSetNames() + +

    Gets a list of the Names of the Objects in the Set.

    + + + + SET_BASE:GetSetObjects() + +

    Gets a list of the Objects in the Set.

    @@ -2595,6 +2609,42 @@ self

    + +SET_BASE:GetSetNames() + +
    +
    + +

    Gets a list of the Names of the Objects in the Set.

    + +

    Return value

    + +

    #SET_BASE: +self

    + +
    +
    +
    +
    + + +SET_BASE:GetSetObjects() + +
    +
    + +

    Gets a list of the Objects in the Set.

    + +

    Return value

    + +

    #SET_BASE: +self

    + +
    +
    +
    +
    + SET_BASE:IsIncludeObject(Object) diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 89d8bfd34..6dafa540b 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html index ddc5f021c..7a8f47cfe 100644 --- a/docs/Documentation/Smoke.html +++ b/docs/Documentation/Smoke.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 18708aea5..664917ca9 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -2192,9 +2194,6 @@ The group that was spawned. You can use this group for further actions.

    - -

    Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

    -
    @@ -2769,9 +2768,6 @@ when nothing was spawned.

    - -

    Overwrite unit names by default with group name.

    -
    @@ -2786,6 +2782,9 @@ when nothing was spawned.

    + +

    By default, no InitLimit

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

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

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

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

    +

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

    diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index 3304a02fb..c56956b2f 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -175,6 +177,12 @@ SPAWNSTATIC:NewFromType(SpawnTypeName, SpawnShapeName, SpawnCategory, CountryID)

    Creates the main object to spawn a Static based on a type name.

    + + + + SPAWNSTATIC:Spawn(Heading, (, NewName) + +

    Creates a new Static at the original position.

    @@ -350,6 +358,44 @@ is the name of the type.

    #SPAWNSTATIC:

    + +
    +
    +
    + + +SPAWNSTATIC:Spawn(Heading, (, NewName) + +
    +
    + +

    Creates a new Static at the original position.

    + +

    Parameters

    +
      +
    • + +

      #number Heading : +The heading of the static, which is a number in degrees from 0 to 360.

      + +
      • +
    • + +

      #string ( : +ptional) The name of the new static.

      + +
      • +
    • + +

      NewName :

      + +
      • +
    +

    Return value

    + +

    #SPAWNSTATIC:

    + +
    diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index 25eba3ad1..2264ce42f 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html index 2d8f1ccfb..e909ef5dd 100644 --- a/docs/Documentation/Static.html +++ b/docs/Documentation/Static.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/StaticObject.html b/docs/Documentation/StaticObject.html index 5c2e035a1..ac871f1ab 100644 --- a/docs/Documentation/StaticObject.html +++ b/docs/Documentation/StaticObject.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html index ea4232815..cf075e8a0 100644 --- a/docs/Documentation/Task.html +++ b/docs/Documentation/Task.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/TaskZoneCapture.html b/docs/Documentation/TaskZoneCapture.html index 897ea4c63..db21fd694 100644 --- a/docs/Documentation/TaskZoneCapture.html +++ b/docs/Documentation/TaskZoneCapture.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Task_A2A.html b/docs/Documentation/Task_A2A.html index c9afabb62..7d4a0884f 100644 --- a/docs/Documentation/Task_A2A.html +++ b/docs/Documentation/Task_A2A.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Task_A2A_Dispatcher.html b/docs/Documentation/Task_A2A_Dispatcher.html index 127db2f84..5570cb0af 100644 --- a/docs/Documentation/Task_A2A_Dispatcher.html +++ b/docs/Documentation/Task_A2A_Dispatcher.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html index d055e51b6..bad43ad15 100644 --- a/docs/Documentation/Task_A2G.html +++ b/docs/Documentation/Task_A2G.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Task_A2G_Dispatcher.html b/docs/Documentation/Task_A2G_Dispatcher.html index fcc1f967d..ab6e7a762 100644 --- a/docs/Documentation/Task_A2G_Dispatcher.html +++ b/docs/Documentation/Task_A2G_Dispatcher.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index a6892ac63..7e6aa0acd 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -573,7 +575,6 @@ based on the tasking capabilities defined in Task#TA
    - FSM_PROCESS.DeployZone @@ -638,7 +639,7 @@ based on the tasking capabilities defined in Task#TA
    - #number + TASK_CARGO.CargoLimit diff --git a/docs/Documentation/Task_PICKUP.html b/docs/Documentation/Task_PICKUP.html index 4ef412939..79f2d5cf5 100644 --- a/docs/Documentation/Task_PICKUP.html +++ b/docs/Documentation/Task_PICKUP.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Unit.html b/docs/Documentation/Unit.html index 488725a32..ce18f49cc 100644 --- a/docs/Documentation/Unit.html +++ b/docs/Documentation/Unit.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/UserFlag.html b/docs/Documentation/UserFlag.html new file mode 100644 index 000000000..032664ca1 --- /dev/null +++ b/docs/Documentation/UserFlag.html @@ -0,0 +1,312 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module UserFlag

    + +

    Core (WIP) -- Manage user flags.

    + + + +
    + +

    Management of DCS User Flags.

    + +
    + +

    Author: Sven Van de Velde (FlightControl)

    + +
    + + +

    Global(s)

    + + + + + +
    USERFLAG +

    USERFLAG class, extends Base#BASE

    + +

    Management of DCS User Flags.

    +
    +

    Type USERFLAG

    + + + + + + + + + + + + + + + + + +
    USERFLAG:Is(Number) +

    Check if the userflag has a value of Number.

    +
    USERFLAG:New(UserFlagName) +

    USERFLAG Constructor.

    +
    USERFLAG:Set(Number) +

    Set the userflag to a given Number.

    +
    USERFLAG.UserFlagName + +
    + +

    Global(s)

    +
    +
    + + #USERFLAG + +USERFLAG + +
    +
    + +

    USERFLAG class, extends Base#BASE

    + +

    Management of DCS User Flags.

    + + + +

    1. USERFLAG constructor

    + + + + +
    +
    +

    Type UserFlag

    + +

    Type USERFLAG

    +

    Field(s)

    +
    +
    + + +USERFLAG:Is(Number) + +
    +
    + +

    Check if the userflag has a value of Number.

    + +

    Parameter

    +
      +
    • + +

      #number Number : +The number value to be checked if it is the same as the userflag.

      + +
      • +
    +

    Return value

    + +

    #boolean: +true if the Number is the value of the userflag.

    + +

    Usage:

    + 
      local BlueVictory = USERFLAG:New( "VictoryBlue" )
+  if BlueVictory:Is( 1 ) then
+    return "Blue has won"
+  end
    + +
    +
    +
    +
    + + +USERFLAG:New(UserFlagName) + +
    +
    + +

    USERFLAG Constructor.

    + +

    Parameter

    +
      +
    • + +

      #string UserFlagName : +The name of the userflag, which is a free text string.

      + +
      • +
    +

    Return value

    + +

    #USERFLAG:

    + + +
    +
    +
    +
    + + +USERFLAG:Set(Number) + +
    +
    + +

    Set the userflag to a given Number.

    + +

    Parameter

    +
      +
    • + +

      #number Number : +The number value to be checked if it is the same as the userflag.

      + +
      • +
    +

    Return value

    + +

    #USERFLAG: +The userflag instance.

    + +

    Usage:

    + 
      local BlueVictory = USERFLAG:New( "VictoryBlue" )
+  BlueVictory:Set( 100 ) -- Set the UserFlag VictoryBlue to 100.
+
    + +
    +
    +
    +
    + + + +USERFLAG.UserFlagName + +
    +
    + + + +
    +
    + +
    + +
    + + diff --git a/docs/Documentation/UserSound.html b/docs/Documentation/UserSound.html new file mode 100644 index 000000000..a4254e451 --- /dev/null +++ b/docs/Documentation/UserSound.html @@ -0,0 +1,417 @@ + + + + + + +
    +
    + +
    +
    +
    +
    + +
    +

    Module UserSound

    + +

    Core (WIP) -- Manage user sound.

    + + + +
    + +

    Management of DCS User Sound.

    + +
    + +

    Author: Sven Van de Velde (FlightControl)

    + +
    + + +

    Global(s)

    + + + + + +
    USERSOUND +

    USERSOUND class, extends Base#BASE

    + +

    Management of DCS User Sound.

    +
    +

    Type USERSOUND

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    USERSOUND:New(UserSoundFileName) +

    USERSOUND Constructor.

    +
    USERSOUND:SetFileName(UserSoundFileName) +

    Set usersound filename.

    +
    USERSOUND:ToAll() +

    Play the usersound to all players.

    +
    USERSOUND:ToCoalition(Coalition) +

    Play the usersound to the given coalition.

    +
    USERSOUND:ToCountry(Country) +

    Play the usersound to the given country.

    +
    USERSOUND:ToGroup(Group) +

    Play the usersound to the given Group.

    +
    USERSOUND.UserSoundFileName + +
    + +

    Global(s)

    +
    +
    + + #USERSOUND + +USERSOUND + +
    +
    + +

    USERSOUND class, extends Base#BASE

    + +

    Management of DCS User Sound.

    + + + +

    1. USERSOUND constructor

    + + + + +
    +
    +

    Type UserSound

    + +

    Type USERSOUND

    +

    Field(s)

    +
    +
    + + +USERSOUND:New(UserSoundFileName) + +
    +
    + +

    USERSOUND Constructor.

    + +

    Parameter

    +
      +
    • + +

      #string UserSoundFileName : +The filename of the usersound.

      + +
      • +
    +

    Return value

    + +

    #USERSOUND:

    + + +
    +
    +
    +
    + + +USERSOUND:SetFileName(UserSoundFileName) + +
    +
    + +

    Set usersound filename.

    + +

    Parameter

    +
      +
    • + +

      #string UserSoundFileName : +The filename of the usersound.

      + +
      • +
    +

    Return value

    + +

    #USERSOUND: +The usersound instance.

    + +

    Usage:

    + 
      local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  BlueVictory:SetFileName( "BlueVictoryLoud.ogg" ) -- Set the BlueVictory to change the file name to play a louder sound.
+
    + +
    +
    +
    +
    + + +USERSOUND:ToAll() + +
    +
    + +

    Play the usersound to all players.

    + +

    Return value

    + +

    #USERSOUND: +The usersound instance.

    + +

    Usage:

    + 
      local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  BlueVictory:ToAll() -- Play the sound that Blue has won.
+
    + +
    +
    +
    +
    + + +USERSOUND:ToCoalition(Coalition) + +
    +
    + +

    Play the usersound to the given coalition.

    + +

    Parameter

    + +

    Return value

    + +

    #USERSOUND: +The usersound instance.

    + +

    Usage:

    + 
      local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  BlueVictory:ToCoalition( coalition.side.BLUE ) -- Play the sound that Blue has won to the blue coalition.
+
    + +
    +
    +
    +
    + + +USERSOUND:ToCountry(Country) + +
    +
    + +

    Play the usersound to the given country.

    + +

    Parameter

    + +

    Return value

    + +

    #USERSOUND: +The usersound instance.

    + +

    Usage:

    + 
      local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  BlueVictory:ToCountry( country.id.USA ) -- Play the sound that Blue has won to the USA country.
+
    + +
    +
    +
    +
    + + +USERSOUND:ToGroup(Group) + +
    +
    + +

    Play the usersound to the given Group.

    + +

    Parameter

    + +

    Return value

    + +

    #USERSOUND: +The usersound instance.

    + +

    Usage:

    + 
      local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  local PlayerGroup = GROUP:FindByName( "PlayerGroup" ) -- Search for the active group named "PlayerGroup", that contains a human player.
+  BlueVictory:ToGroup( PlayerGroup ) -- Play the sound that Blue has won to the player group.
+
    + +
    +
    +
    +
    + + + +USERSOUND.UserSoundFileName + +
    +
    + + + +
    +
    + +
    + +
    + + diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html index 2733c9330..231da148a 100644 --- a/docs/Documentation/Utils.html +++ b/docs/Documentation/Utils.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html index 672e10322..3d3024456 100644 --- a/docs/Documentation/Zone.html +++ b/docs/Documentation/Zone.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -513,13 +515,7 @@ - ZONE_RADIUS.Coalitions - - - - - - ZONE_RADIUS:CountCoalitions() + ZONE_RADIUS:CountScannedCoalitions() @@ -528,12 +524,6 @@ ZONE_RADIUS:FlareZone(FlareColor, Points, Azimuth)

    Flares the zone boundaries in a color.

    - - - - ZONE_RADIUS:GetCoalition() - -

    Get the Zone Coalitions.

    @@ -564,6 +554,24 @@ ZONE_RADIUS:GetRandomVec2(inner, outer)

    Returns a random Vec2 location within the zone.

    + + + + ZONE_RADIUS:GetScannedCoalition(Coalition) + +

    Get Coalitions of the units in the Zone, or Check if there are units of the given Coalition in the Zone.

    + + + + ZONE_RADIUS:GetScannedScenery() + + + + + + ZONE_RADIUS:GetScannedSceneryType(SceneryType) + + @@ -633,13 +641,19 @@ - ZONE_RADIUS:Scan(Coalition) + ZONE_RADIUS:Scan(ObjectCategories, Coalition)

    Scan the zone

    - ZONE_RADIUS:SearchZone(EvaluateFunction) + ZONE_RADIUS.ScanData + + + + + + ZONE_RADIUS:SearchZone(ObjectCategories, EvaluateFunction)

    Searches the zone

    @@ -1992,22 +2006,8 @@ self

    - - -ZONE_RADIUS.Coalitions - -
    -
    - - - -
    -
    -
    -
    - - -ZONE_RADIUS:CountCoalitions() + +ZONE_RADIUS:CountScannedCoalitions()
    @@ -2058,27 +2058,6 @@ self

    - -ZONE_RADIUS:GetCoalition() - -
    -
    - -

    Get the Zone Coalitions.

    - - -

    Returns nil if there are none ot two coalitions in the zone!

    - -

    Return value

    - - -

    Coalitions

    - -
    -
    -
    -
    - ZONE_RADIUS:GetRadius() @@ -2229,6 +2208,71 @@ The random location within the zone.

    + +ZONE_RADIUS:GetScannedCoalition(Coalition) + +
    +
    + +

    Get Coalitions of the units in the Zone, or Check if there are units of the given Coalition in the Zone.

    + + +

    Returns nil if there are none ot two Coalitions in the zone! +Returns one Coalition if there are only Units of one Coalition in the Zone. +Returns the Coalition for the given Coalition if there are units of the Coalition in the Zone

    + +

    Parameter

    +
      +
    • + +

      Coalition :

      + +
      • +
    +

    Return value

    + +

    #table:

    + + +
    +
    +
    +
    + + +ZONE_RADIUS:GetScannedScenery() + +
    +
    + + + +
    +
    +
    +
    + + +ZONE_RADIUS:GetScannedSceneryType(SceneryType) + +
    +
    + + + +

    Parameter

    +
      +
    • + +

      SceneryType :

      + +
      • +
    +
    +
    +
    +
    + ZONE_RADIUS:GetVec2() @@ -2504,38 +2548,63 @@ self

    -ZONE_RADIUS:Scan(Coalition) +ZONE_RADIUS:Scan(ObjectCategories, Coalition)

    Scan the zone

    -

    Parameter

    +

    Parameters

    • +

      ObjectCategories :

      + +
      • +
    • +

      Coalition :

    +
    +
    +
    +
    + + + +ZONE_RADIUS.ScanData + +
    +
    + + +
    -ZONE_RADIUS:SearchZone(EvaluateFunction) +ZONE_RADIUS:SearchZone(ObjectCategories, EvaluateFunction)

    Searches the zone

    -

    Parameter

    +

    Parameters

    • +

      ObjectCategories : +A list of categories, which are members of Object.Category

      + +
      • +
    • +

      EvaluateFunction :

      • diff --git a/docs/Documentation/ZoneCaptureCoalition.html b/docs/Documentation/ZoneCaptureCoalition.html index 0936ef338..bd1319037 100644 --- a/docs/Documentation/ZoneCaptureCoalition.html +++ b/docs/Documentation/ZoneCaptureCoalition.html @@ -99,6 +99,8 @@
    • Task_Cargo
    • Task_PICKUP
    • Unit
      • +
    • UserFlag
      • +
    • UserSound
    • Utils
    • Zone
    • ZoneCaptureCoalition
      • diff --git a/docs/Documentation/ZoneGoal.html b/docs/Documentation/ZoneGoal.html index 6478a6afc..10026f42f 100644 --- a/docs/Documentation/ZoneGoal.html +++ b/docs/Documentation/ZoneGoal.html @@ -99,6 +99,8 @@
    • Task_Cargo
    • Task_PICKUP
    • Unit
      • +
    • UserFlag
      • +
    • UserSound
    • Utils
    • Zone
    • ZoneCaptureCoalition
      • @@ -486,7 +488,6 @@ The name of the player.

      - ZONE_GOAL.SmokeTime @@ -495,9 +496,6 @@ The name of the player.

      - -

      self.SmokeColor = nil

      -
    diff --git a/docs/Documentation/ZoneGoalCoalition.html b/docs/Documentation/ZoneGoalCoalition.html index ff2b36f4b..b1964b864 100644 --- a/docs/Documentation/ZoneGoalCoalition.html +++ b/docs/Documentation/ZoneGoalCoalition.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/env.html b/docs/Documentation/env.html index 21f208d56..0e1265037 100644 --- a/docs/Documentation/env.html +++ b/docs/Documentation/env.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html index 025287124..c61e305dc 100644 --- a/docs/Documentation/index.html +++ b/docs/Documentation/index.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • @@ -693,6 +695,18 @@ and creates a CSV file logging the scoring events and results for use at team or Unit

    Wrapper - UNIT is a wrapper class for the DCS Class Unit.

    + + + + UserFlag + +

    Core (WIP) -- Manage user flags.

    + + + + UserSound + +

    Core (WIP) -- Manage user sound.

    diff --git a/docs/Documentation/land.html b/docs/Documentation/land.html index 9b94e02ea..0df69e015 100644 --- a/docs/Documentation/land.html +++ b/docs/Documentation/land.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition
    • diff --git a/docs/Documentation/routines.html b/docs/Documentation/routines.html index 934850b4e..e5e6fbc2e 100644 --- a/docs/Documentation/routines.html +++ b/docs/Documentation/routines.html @@ -99,6 +99,8 @@
  • Task_Cargo
  • Task_PICKUP
  • Unit
    • +
  • UserFlag
    • +
  • UserSound
  • Utils
  • Zone
  • ZoneCaptureCoalition