diff --git a/Moose Development/Moose/Functional/AirbasePolice.lua b/Moose Development/Moose/Functional/AirbasePolice.lua index f416c2516..3e95d65ec 100644 --- a/Moose Development/Moose/Functional/AirbasePolice.lua +++ b/Moose Development/Moose/Functional/AirbasePolice.lua @@ -1,67 +1,21 @@ ---- **Functional** -- This module monitors airbases traffic. +--- **Functional** -- The AIRBASEPOLICE classes monitor airbase traffic and regulate speed while taxiing. -- -- === -- --- 1) @{AirbasePolice#AIRBASEPOLICE_BASE} class, extends @{Base#BASE} --- ================================================================== --- The @{AirbasePolice#AIRBASEPOLICE_BASE} class provides the main methods to monitor CLIENT behaviour at airbases. --- CLIENTS should not be allowed to: --- --- * Don't taxi faster than 40 km/h. --- * Don't take-off on taxiways. --- * Avoid to hit other planes on the airbase. --- * Obey ground control orders. --- --- 2) @{AirbasePolice#AIRBASEPOLICE_CAUCASUS} class, extends @{AirbasePolice#AIRBASEPOLICE_BASE} --- ============================================================================================= --- All the airbases on the caucasus map can be monitored using this class. --- If you want to monitor specific airbases, you need to use the @{#AIRBASEPOLICE_BASE.Monitor}() method, which takes a table or airbase names. --- The following names can be given: --- * AnapaVityazevo --- * Batumi --- * Beslan --- * Gelendzhik --- * Gudauta --- * Kobuleti --- * KrasnodarCenter --- * KrasnodarPashkovsky --- * Krymsk --- * Kutaisi --- * MaykopKhanskaya --- * MineralnyeVody --- * Mozdok --- * Nalchik --- * Novorossiysk --- * SenakiKolkhi --- * SochiAdler --- * Soganlug --- * SukhumiBabushara --- * TbilisiLochini --- * Vaziani --- --- 3) @{AirbasePolice#AIRBASEPOLICE_NEVADA} class, extends @{AirbasePolice#AIRBASEPOLICE_BASE} --- ============================================================================================= --- All the airbases on the NEVADA map can be monitored using this class. --- If you want to monitor specific airbases, you need to use the @{#AIRBASEPOLICE_BASE.Monitor}() method, which takes a table or airbase names. --- The following names can be given: --- * Nellis --- * McCarran --- * Creech --- * Groom Lake --- -- ### Contributions: Dutch Baron - Concept & Testing -- ### Author: FlightControl - Framework Design & Programming -- +-- === +-- -- @module AirbasePolice - - - --- @type AIRBASEPOLICE_BASE -- @field Core.Set#SET_CLIENT SetClient -- @extends Core.Base#BASE +--- Base class for AIRBASEPOLICE implementations. +-- @field #AIRBASEPOLICE_BASE AIRBASEPOLICE_BASE = { ClassName = "AIRBASEPOLICE_BASE", SetClient = nil, @@ -224,9 +178,82 @@ end --- @type AIRBASEPOLICE_CAUCASUS --- @field Core.Set#SET_CLIENT SetClient -- @extends #AIRBASEPOLICE_BASE +--- # AIRBASEPOLICE_CAUCASUS, extends @{#AIRBASEPOLICE_BASE} +-- +-- ![Banner Image](..\Presentations\AIRBASEPOLICE\Dia1.JPG) +-- +-- The AIRBASEPOLICE_CAUCASUS class monitors the speed of the airplanes at the airbase during taxi. +-- The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned. +-- +-- The maximum speed for the airbases at Caucasus is **50 km/h**. +-- +-- The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving +-- faster than the maximum allowed speed, the pilot will be kicked. +-- +-- Different airbases have different maximum speeds, according safety regulations. +-- +-- # Airbases monitored +-- +-- The following airbases are monitored at the Caucasus region: +-- +-- * Anapa Vityazevo +-- * Batumi +-- * Beslan +-- * Gelendzhik +-- * Gudauta +-- * Kobuleti +-- * Krasnodar Center +-- * Krasnodar Pashkovsky +-- * Krymsk +-- * Kutaisi +-- * Maykop Khanskaya +-- * Mineralnye Vody +-- * Mozdok +-- * Nalchik +-- * Novorossiysk +-- * Senaki Kolkhi +-- * Sochi Adler +-- * Soganlug +-- * Sukhumi Babushara +-- * Tbilisi Lochini +-- * Vaziani +-- +-- +-- # Installation +-- +-- ## In Single Player Missions +-- +-- AIRBASEPOLICE is fully functional in single player. +-- +-- ## In Multi Player Missions +-- +-- AIRBASEPOLICE is NOT functional in multi player, for client machines connecting to the server, running the mission. +-- Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player. +-- To work around this problem, a much better solution has been made, using the slot blocker script designed +-- by Ciribob. With the help of __Ciribob__, this script has been extended to also kick client players while in flight. +-- AIRBASEPOLICE is communicating with this modified script to kick players! +-- +-- Install the file **SimpleSlotBlockGameGUI.lua** on the server, following the installation instructions described by Ciribob. +-- +-- [Simple Slot Blocker from Ciribob & FlightControl](https://github.com/ciribob/DCS-SimpleSlotBlock) +-- +-- # Script it! +-- +-- ## 1. AIRBASEPOLICE_CAUCASUS Constructor +-- +-- Creates a new AIRBASEPOLICE_CAUCASUS object that will monitor pilots taxiing behaviour. +-- +-- -- This creates a new AIRBASEPOLICE_CAUCASUS object. +-- +-- -- Create a set of all clients in the mission. +-- AllClientsSet = SET_CLIENT:New():FilterStart() +-- +-- -- Monitor for these clients the airbases. +-- AirbasePoliceCaucasus = AIRBASEPOLICE_CAUCASUS:New( AllClientsSet ) +-- +-- @field #AIRBASEPOLICE_CAUCASUS AIRBASEPOLICE_CAUCASUS = { ClassName = "AIRBASEPOLICE_CAUCASUS", Airbases = { @@ -966,6 +993,63 @@ end --- @type AIRBASEPOLICE_NEVADA -- @extends Functional.AirbasePolice#AIRBASEPOLICE_BASE + + +--- # AIRBASEPOLICE_NEVADA, extends @{#AIRBASEPOLICE_BASE} +-- +-- ![Banner Image](..\Presentations\AIRBASEPOLICE\Dia1.JPG) +-- +-- The AIRBASEPOLICE_NEVADA class monitors the speed of the airplanes at the airbase during taxi. +-- The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned. +-- +-- The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving +-- faster than the maximum allowed speed, the pilot will be kicked. +-- +-- Different airbases have different maximum speeds, according safety regulations. +-- +-- # Airbases monitored +-- +-- The following airbases are monitored at the Caucasus region: +-- +-- * Nellis +-- * McCarran +-- * Creech +-- * GroomLake +-- +-- +-- # Installation +-- +-- ## In Single Player Missions +-- +-- AIRBASEPOLICE is fully functional in single player. +-- +-- ## In Multi Player Missions +-- +-- AIRBASEPOLICE is NOT functional in multi player, for client machines connecting to the server, running the mission. +-- Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player. +-- To work around this problem, a much better solution has been made, using the slot blocker script designed +-- by Ciribob. With the help of Ciribob, this script has been extended to also kick client players while in flight. +-- AIRBASEPOLICE is communicating with this modified script to kick players! +-- +-- Install the file **SimpleSlotBlockGameGUI.lua** on the server, following the installation instructions described by Ciribob. +-- +-- [Simple Slot Blocker from Ciribob & FlightControl](https://github.com/ciribob/DCS-SimpleSlotBlock) +-- +-- # Script it! +-- +-- ## 1. AIRBASEPOLICE_NEVADA Constructor +-- +-- Creates a new AIRBASEPOLICE_NEVADA object that will monitor pilots taxiing behaviour. +-- +-- -- This creates a new AIRBASEPOLICE_NEVADA object. +-- +-- -- Create a set of all clients in the mission. +-- AllClientsSet = SET_CLIENT:New():FilterStart() +-- +-- -- Monitor for these clients the airbases. +-- AirbasePoliceCaucasus = AIRBASEPOLICE_NEVADA:New( AllClientsSet ) +-- +-- @field #AIRBASEPOLICE_NEVADA AIRBASEPOLICE_NEVADA = { ClassName = "AIRBASEPOLICE_NEVADA", Airbases = { diff --git a/docs/Documentation/AI_A2A.html b/docs/Documentation/AI_A2A.html index 38af29dd8..67ca9d37e 100644 --- a/docs/Documentation/AI_A2A.html +++ b/docs/Documentation/AI_A2A.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AI_A2A_Cap.html b/docs/Documentation/AI_A2A_Cap.html index 34916a9e4..f39859ed3 100644 --- a/docs/Documentation/AI_A2A_Cap.html +++ b/docs/Documentation/AI_A2A_Cap.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AI_A2A_Dispatcher.html b/docs/Documentation/AI_A2A_Dispatcher.html index 20765a7f1..4984b80ca 100644 --- a/docs/Documentation/AI_A2A_Dispatcher.html +++ b/docs/Documentation/AI_A2A_Dispatcher.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AI_A2A_GCI.html b/docs/Documentation/AI_A2A_GCI.html index a7a22fbbc..bd7536ac2 100644 --- a/docs/Documentation/AI_A2A_GCI.html +++ b/docs/Documentation/AI_A2A_GCI.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AI_A2A_Patrol.html b/docs/Documentation/AI_A2A_Patrol.html index 067902aa6..6490fccd9 100644 --- a/docs/Documentation/AI_A2A_Patrol.html +++ b/docs/Documentation/AI_A2A_Patrol.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AI_BAI.html b/docs/Documentation/AI_BAI.html index 7d6770c96..01a1b0410 100644 --- a/docs/Documentation/AI_BAI.html +++ b/docs/Documentation/AI_BAI.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html index a0699856c..6e766adbc 100644 --- a/docs/Documentation/AI_Balancer.html +++ b/docs/Documentation/AI_Balancer.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -436,7 +437,7 @@ A SET_CLIENT object that will contain the CLIENT objects to be monitored if they
  • -

    Functional.Spawn#SPAWN SpawnAI : +

    Core.Spawn#SPAWN SpawnAI : The default Spawn object to spawn new AI Groups when needed.

  • @@ -543,7 +544,7 @@ The SET of Set#SET_AIRBASEs to evaluate wh
    - Functional.Spawn#SPAWN + Core.Spawn#SPAWN AI_BALANCER.SpawnAI diff --git a/docs/Documentation/AI_Cap.html b/docs/Documentation/AI_Cap.html index 3098a0ad8..bb3f18ad7 100644 --- a/docs/Documentation/AI_Cap.html +++ b/docs/Documentation/AI_Cap.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AI_Cas.html b/docs/Documentation/AI_Cas.html index 8a068de4d..f0bc40f5e 100644 --- a/docs/Documentation/AI_Cas.html +++ b/docs/Documentation/AI_Cas.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AI_Formation.html b/docs/Documentation/AI_Formation.html index 0977b5c5f..22c39b461 100644 --- a/docs/Documentation/AI_Formation.html +++ b/docs/Documentation/AI_Formation.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index 7e797ee06..7946f7c5e 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -830,7 +831,7 @@ Use the method AIPATROLZONE.M
    - Functional.Spawn#SPAWN + Core.Spawn#SPAWN AI_PATROL_ZONE.CoordTest diff --git a/docs/Documentation/Account.html b/docs/Documentation/Account.html index af42ac79d..3edae38f1 100644 --- a/docs/Documentation/Account.html +++ b/docs/Documentation/Account.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Airbase.html b/docs/Documentation/Airbase.html index f3d96bf01..c80bfd735 100644 --- a/docs/Documentation/Airbase.html +++ b/docs/Documentation/Airbase.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/AirbasePolice.html b/docs/Documentation/AirbasePolice.html index a79055079..81a4fe47e 100644 --- a/docs/Documentation/AirbasePolice.html +++ b/docs/Documentation/AirbasePolice.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -114,79 +115,49 @@

    Module AirbasePolice

    -

    Functional -- This module monitors airbases traffic.

    +

    Functional -- The AIRBASEPOLICE classes monitor airbase traffic and regulate speed while taxiing.


    -

    1) AirbasePolice#AIRBASEPOLICE_BASE class, extends Base#BASE

    -

    The AirbasePolice#AIRBASEPOLICE_BASE class provides the main methods to monitor CLIENT behaviour at airbases. -CLIENTS should not be allowed to:

    - -
      -
    • Don't taxi faster than 40 km/h.
    • -
    • Don't take-off on taxiways.
    • -
    • Avoid to hit other planes on the airbase.
    • -
    • Obey ground control orders.
    • -
    - -

    2) AirbasePolice#AIRBASEPOLICE_CAUCASUS class, extends AirbasePolice#AIRBASEPOLICE_BASE

    -

    All the airbases on the caucasus map can be monitored using this class. -If you want to monitor specific airbases, you need to use the AIRBASEPOLICE_BASE.Monitor() method, which takes a table or airbase names. -The following names can be given: - * AnapaVityazevo - * Batumi - * Beslan - * Gelendzhik - * Gudauta - * Kobuleti - * KrasnodarCenter - * KrasnodarPashkovsky - * Krymsk - * Kutaisi - * MaykopKhanskaya - * MineralnyeVody - * Mozdok - * Nalchik - * Novorossiysk - * SenakiKolkhi - * SochiAdler - * Soganlug - * SukhumiBabushara - * TbilisiLochini - * Vaziani

    - -

    3) AirbasePolice#AIRBASEPOLICE_NEVADA class, extends AirbasePolice#AIRBASEPOLICE_BASE

    -

    All the airbases on the NEVADA map can be monitored using this class. -If you want to monitor specific airbases, you need to use the AIRBASEPOLICE_BASE.Monitor() method, which takes a table or airbase names. -The following names can be given: - * Nellis - * McCarran - * Creech - * Groom Lake

    -

    Contributions: Dutch Baron - Concept & Testing

    Author: FlightControl - Framework Design & Programming

    +
    +

    Global(s)

    + + + + @@ -197,12 +168,30 @@ The following names can be given: + + + + + + + + + + + +
    AIRBASEPOLICE_BASE - +

    Base class for AIRBASEPOLICE implementations.

    AIRBASEPOLICE_CAUCASUS +

    AIRBASEPOLICE_CAUCASUS, extends #AIRBASEPOLICE_BASE

    +

    Banner Image

    + +

    The AIRBASEPOLICE_CAUCASUS class monitors the speed of the airplanes at the airbase during taxi.

    AIRBASEPOLICE_NEVADA +

    AIRBASEPOLICE_NEVADA, extends #AIRBASEPOLICE_BASE

    + +

    Banner Image

    + +

    The AIRBASEPOLICE_NEVADA class monitors the speed of the airplanes at the airbase during taxi.

    +
    SSB
    AIRBASEPOLICE_BASE.AirbaseNames +
    AIRBASEPOLICE_BASE:Monitor(AirbaseNames) +

    Monitor a table of airbase names.

    +
    AIRBASEPOLICE_BASE:New(SetClient, Airbases) +

    Creates a new AIRBASEPOLICE_BASE object.

    AIRBASEPOLICE_BASE.SetClient +
    AIRBASEPOLICE_BASE:_AirbaseMonitor() +
    @@ -210,9 +199,9 @@ The following names can be given:

    Type AIRBASEPOLICE_CAUCASUS

    - +
    AIRBASEPOLICE_CAUCASUS.SetClientAIRBASEPOLICE_CAUCASUS:New(SetClient) - +

    Creates a new AIRBASEPOLICE_CAUCASUS object.

    @@ -220,18 +209,6 @@ The following names can be given:

    Type AIRBASEPOLICE_NEVADA

    - - - - - - - - + + + + @@ -194,7 +203,7 @@ @@ -542,6 +551,46 @@ + +
    AIRBASEPOLICE_NEVADA.Airbases - -
    AIRBASEPOLICE_NEVADA.ClassName - -
    AIRBASEPOLICE_NEVADA:New(SetClient)

    Creates a new AIRBASEPOLICE_NEVADA object.

    @@ -243,27 +220,104 @@ The following names can be given:
    - + #AIRBASEPOLICE_BASE AIRBASEPOLICE_BASE
    - +

    Base class for AIRBASEPOLICE implementations.

    - + #AIRBASEPOLICE_CAUCASUS AIRBASEPOLICE_CAUCASUS
    +

    AIRBASEPOLICE_CAUCASUS, extends #AIRBASEPOLICE_BASE

    + +

    Banner Image

    + +

    The AIRBASEPOLICE_CAUCASUS class monitors the speed of the airplanes at the airbase during taxi.

    + + +

    The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.

    + +

    The maximum speed for the airbases at Caucasus is 50 km/h.

    + +

    The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving +faster than the maximum allowed speed, the pilot will be kicked.

    + +

    Different airbases have different maximum speeds, according safety regulations.

    + +

    Airbases monitored

    + +

    The following airbases are monitored at the Caucasus region:

    + +
      +
    • Anapa Vityazevo
    • +
    • Batumi
    • +
    • Beslan
    • +
    • Gelendzhik
    • +
    • Gudauta
    • +
    • Kobuleti
    • +
    • Krasnodar Center
    • +
    • Krasnodar Pashkovsky
    • +
    • Krymsk
    • +
    • Kutaisi
    • +
    • Maykop Khanskaya
    • +
    • Mineralnye Vody
    • +
    • Mozdok
    • +
    • Nalchik
    • +
    • Novorossiysk
    • +
    • Senaki Kolkhi
    • +
    • Sochi Adler
    • +
    • Soganlug
    • +
    • Sukhumi Babushara
    • +
    • Tbilisi Lochini
    • +
    • Vaziani
    • +
    + + +

    Installation

    + +

    In Single Player Missions

    + +

    AIRBASEPOLICE is fully functional in single player.

    + +

    In Multi Player Missions

    + +

    AIRBASEPOLICE is NOT functional in multi player, for client machines connecting to the server, running the mission. +Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player. +To work around this problem, a much better solution has been made, using the slot blocker script designed +by Ciribob. With the help of Ciribob, this script has been extended to also kick client players while in flight. +AIRBASEPOLICE is communicating with this modified script to kick players!

    + +

    Install the file SimpleSlotBlockGameGUI.lua on the server, following the installation instructions described by Ciribob.

    + +

    Simple Slot Blocker from Ciribob & FlightControl

    + +

    Script it!

    + +

    1. AIRBASEPOLICE_CAUCASUS Constructor

    + +

    Creates a new AIRBASEPOLICE_CAUCASUS object that will monitor pilots taxiing behaviour.

    + +
    -- This creates a new AIRBASEPOLICE_CAUCASUS object.
    +
    +-- Create a set of all clients in the mission.
    +AllClientsSet = SET_CLIENT:New():FilterStart()
    +
    +-- Monitor for these clients the airbases.
    +AirbasePoliceCaucasus = AIRBASEPOLICE_CAUCASUS:New( AllClientsSet )
    +
    @@ -278,7 +332,82 @@ The following names can be given:
    +

    AIRBASEPOLICE_NEVADA, extends #AIRBASEPOLICE_BASE

    +

    Banner Image

    + +

    The AIRBASEPOLICE_NEVADA class monitors the speed of the airplanes at the airbase during taxi.

    + + +

    The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.

    + +

    The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving +faster than the maximum allowed speed, the pilot will be kicked.

    + +

    Different airbases have different maximum speeds, according safety regulations.

    + +

    Airbases monitored

    + +

    The following airbases are monitored at the Caucasus region:

    + +
      +
    • Nellis
    • +
    • McCarran
    • +
    • Creech
    • +
    • GroomLake
    • +
    + + +

    Installation

    + +

    In Single Player Missions

    + +

    AIRBASEPOLICE is fully functional in single player.

    + +

    In Multi Player Missions

    + +

    AIRBASEPOLICE is NOT functional in multi player, for client machines connecting to the server, running the mission. +Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player. +To work around this problem, a much better solution has been made, using the slot blocker script designed +by Ciribob. With the help of Ciribob, this script has been extended to also kick client players while in flight. +AIRBASEPOLICE is communicating with this modified script to kick players!

    + +

    Install the file SimpleSlotBlockGameGUI.lua on the server, following the installation instructions described by Ciribob.

    + +

    Simple Slot Blocker from Ciribob & FlightControl

    + +

    Script it!

    + +

    1. AIRBASEPOLICE_NEVADA Constructor

    + +

    Creates a new AIRBASEPOLICE_NEVADA object that will monitor pilots taxiing behaviour.

    + +
    -- This creates a new AIRBASEPOLICE_NEVADA object.
    +
    +-- Create a set of all clients in the mission.
    +AllClientsSet = SET_CLIENT:New():FilterStart()
    +
    +-- Monitor for these clients the airbases.
    +AirbasePoliceCaucasus = AIRBASEPOLICE_NEVADA:New( AllClientsSet )
    +
    + + +
    +
    +
    +
    + + + +SSB + +
    +
    + + + + +

    This is simple slot blocker is used on the server.

    @@ -298,6 +427,66 @@ The following names can be given: + + +
    +
    + + +AIRBASEPOLICE_BASE:Monitor(AirbaseNames) + +
    +
    + +

    Monitor a table of airbase names.

    + +

    Parameter

    +
      +
    • + +

      #AIRBASEPOLICE_BASE.AirbaseNames AirbaseNames : +A list of AirbaseNames to monitor. If this parameters is nil, then all airbases will be monitored.

      + +
    • +
    +

    Return value

    + +

    #AIRBASEPOLICE_BASE: +self

    + +
    +
    +
    +
    + + +AIRBASEPOLICE_BASE:New(SetClient, Airbases) + +
    +
    + +

    Creates a new AIRBASEPOLICE_BASE object.

    + +

    Parameters

    +
      +
    • + +

      SetClient : +A SET_CLIENT object that will contain the CLIENT objects to be monitored if they follow the rules of the airbase.

      + +
    • +
    • + +

      Airbases : +A table of Airbase Names.

      + +
    • +
    +

    Return value

    + +

    #AIRBASEPOLICE_BASE: +self

    +
    @@ -312,6 +501,19 @@ The following names can be given: + +
    +
    +
    + + +AIRBASEPOLICE_BASE:_AirbaseMonitor() + +
    +
    + + +
    @@ -322,14 +524,27 @@ The following names can be given:
    - Core.Set#SET_CLIENT - -AIRBASEPOLICE_CAUCASUS.SetClient + +AIRBASEPOLICE_CAUCASUS:New(SetClient)
    +

    Creates a new AIRBASEPOLICE_CAUCASUS object.

    +

    Parameter

    +
      +
    • + +

      SetClient : +A SET_CLIENT object that will contain the CLIENT objects to be monitored if they follow the rules of the airbase.

      + +
    • +
    +

    Return value

    + +

    #AIRBASEPOLICE_CAUCASUS: +self

    @@ -339,34 +554,6 @@ The following names can be given:
    - - -AIRBASEPOLICE_NEVADA.Airbases - -
    -
    - - - -
    -
    -
    -
    - - #string - -AIRBASEPOLICE_NEVADA.ClassName - -
    -
    - - - -
    -
    -
    -
    - AIRBASEPOLICE_NEVADA:New(SetClient) diff --git a/docs/Documentation/Assign.html b/docs/Documentation/Assign.html index 71af3b872..a3e44f47d 100644 --- a/docs/Documentation/Assign.html +++ b/docs/Documentation/Assign.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Base.html b/docs/Documentation/Base.html index 0592e3e73..2a96f397b 100644 --- a/docs/Documentation/Base.html +++ b/docs/Documentation/Base.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index 95619eed8..ea6e33cb9 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -169,6 +170,14 @@
    CARGOS +
    CARGO_CRATE +

    CARGO_CRATE class, extends #CARGO_REPRESENTABLE

    + +

    The CARGO_CRATE class defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.

    CARGO_REPRESENTABLE - +

    Models CARGO that is representable by a Unit.

    CARGO:__UnLoad(DelaySeconds, ToPointVec2)

    UnLoads the cargo to a Carrier.

    +
    + +

    Type CARGO_CRATE

    + + + + + + + + + + + + + + + + + + + + + + + +
    CARGO_CRATE.CargoCarrier + +
    CARGO_CRATE.CargoObject + +
    CARGO_CRATE:New(CrateName, Type, Name, Weight, ReportRadius, NearRadius, CargoCrateName) +

    CARGO_CRATE Constructor.

    +
    CARGO_CRATE.OnUnLoadedCallBack + +
    CARGO_CRATE:onenterLoaded(Event, From, To, CargoCarrier) +

    Loaded State.

    +
    CARGO_CRATE:onenterUnLoaded(Event, From, To, Core, ToPointVec2) +

    Enter UnLoaded State.

    @@ -771,6 +820,12 @@

    Type CARGO_REPRESENTABLE

    + + + + - - - - @@ -957,6 +1006,28 @@ There are 2 moments when state transition methods will be called by the state ma + + +
    +
    + + #CARGO_CRATE + +CARGO_CRATE + +
    +
    + +

    CARGO_CRATE class, extends #CARGO_REPRESENTABLE

    + +

    The CARGO_CRATE class defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.

    + + +

    Use the event functions as described above to Load, UnLoad, Board, UnBoard the CARGO_CRATE objects to and from carriers.

    + +
    + +
    @@ -1017,7 +1088,7 @@ There are 2 moments when state transition methods will be called by the state ma
    - +

    Models CARGO that is representable by a Unit.

    @@ -2190,6 +2261,188 @@ The amount of seconds to delay the action.

    Type CARGO.CargoObjects

    +

    Type CARGO_CRATE

    + +

    Models the behaviour of cargo crates, which can be slingloaded and boarded on helicopters using the DCS menus.

    + +

    Field(s)

    +
    +
    + + +CARGO_CRATE.CargoCarrier + +
    +
    + + + +
    +
    +
    +
    + + + +CARGO_CRATE.CargoObject + +
    +
    + + + +
    +
    +
    +
    + + +CARGO_CRATE:New(CrateName, Type, Name, Weight, ReportRadius, NearRadius, CargoCrateName) + +
    +
    + +

    CARGO_CRATE Constructor.

    + +

    Parameters

    +
      +
    • + +

      #string CrateName :

      + +
    • +
    • + +

      #string Type :

      + +
    • +
    • + +

      #string Name :

      + +
    • +
    • + +

      #number Weight :

      + +
    • +
    • + +

      #number ReportRadius : +(optional)

      + +
    • +
    • + +

      #number NearRadius : +(optional)

      + +
    • +
    • + +

      CargoCrateName :

      + +
    • +
    +

    Return value

    + +

    #CARGO_CRATE:

    + + +
    +
    +
    +
    + + +CARGO_CRATE.OnUnLoadedCallBack + +
    +
    + + + +
    +
    +
    +
    + + +CARGO_CRATE:onenterLoaded(Event, From, To, CargoCarrier) + +
    +
    + +

    Loaded State.

    + +

    Parameters

    +
      +
    • + +

      #string Event :

      + +
    • +
    • + +

      #string From :

      + +
    • +
    • + +

      #string To :

      + +
    • +
    • + +

      Wrapper.Unit#UNIT CargoCarrier :

      + +
    • +
    +
    +
    +
    +
    + + +CARGO_CRATE:onenterUnLoaded(Event, From, To, Core, ToPointVec2) + +
    +
    + +

    Enter UnLoaded State.

    + +

    Parameters

    +
      +
    • + +

      #string Event :

      + +
    • +
    • + +

      #string From :

      + +
    • +
    • + +

      #string To :

      + +
    • +
    • + +

      Core : +Point#POINT_VEC2

      + +
    • +
    • + +

      ToPointVec2 :

      + +
    • +
    +
    +
    +

    Type CARGO_GROUP

    Field(s)

    @@ -3323,6 +3576,24 @@ The range till cargo will board.

    + +CARGO_REPRESENTABLE:Destroy() + +
    +
    + +

    CARGO_REPRESENTABLE Destructor.

    + +

    Return value

    + +

    #CARGO_REPRESENTABLE:

    + + +
    +
    +
    +
    + CARGO_REPRESENTABLE:New(Type, Name, Weight, ReportRadius, NearRadius, CargoObject) @@ -3420,7 +3691,7 @@ The range till cargo will board.

    Type CARGO_UNIT

    -

    Hello

    +

    Models CARGO in the form of units, which can be boarded, unboarded, loaded, unloaded.

    Field(s)

    @@ -3462,24 +3733,6 @@ The range till cargo will board.

    - -
    -
    -
    - - -CARGO_UNIT:Destroy() - -
    -
    - -

    CARGO_UNIT Destructor.

    - -

    Return value

    - -

    #CARGO_UNIT:

    - -
    diff --git a/docs/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html index 45478a336..d71241c29 100644 --- a/docs/Documentation/CleanUp.html +++ b/docs/Documentation/CleanUp.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Client.html b/docs/Documentation/Client.html index 648d6e81c..31983dfb8 100644 --- a/docs/Documentation/Client.html +++ b/docs/Documentation/Client.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html index e8d4e3fb2..a99621a6c 100644 --- a/docs/Documentation/CommandCenter.html +++ b/docs/Documentation/CommandCenter.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html index 9ea63b683..1a81d568f 100644 --- a/docs/Documentation/Controllable.html +++ b/docs/Documentation/Controllable.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSAirbase.html b/docs/Documentation/DCSAirbase.html index ca640897c..b7bb4bb46 100644 --- a/docs/Documentation/DCSAirbase.html +++ b/docs/Documentation/DCSAirbase.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSCoalitionObject.html b/docs/Documentation/DCSCoalitionObject.html index 1eee6c4cb..cf4dfd653 100644 --- a/docs/Documentation/DCSCoalitionObject.html +++ b/docs/Documentation/DCSCoalitionObject.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSCommand.html b/docs/Documentation/DCSCommand.html index 3677dd7b7..be18b704d 100644 --- a/docs/Documentation/DCSCommand.html +++ b/docs/Documentation/DCSCommand.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSController.html b/docs/Documentation/DCSController.html index 3439daa17..ffe035b06 100644 --- a/docs/Documentation/DCSController.html +++ b/docs/Documentation/DCSController.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSGroup.html b/docs/Documentation/DCSGroup.html index 6ff1afbee..9af43a594 100644 --- a/docs/Documentation/DCSGroup.html +++ b/docs/Documentation/DCSGroup.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSObject.html b/docs/Documentation/DCSObject.html index 7eceacd31..471315d7d 100644 --- a/docs/Documentation/DCSObject.html +++ b/docs/Documentation/DCSObject.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSTask.html b/docs/Documentation/DCSTask.html index 51395ba5f..9a37b51bd 100644 --- a/docs/Documentation/DCSTask.html +++ b/docs/Documentation/DCSTask.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSTypes.html b/docs/Documentation/DCSTypes.html index 059dc039f..1c2cadc66 100644 --- a/docs/Documentation/DCSTypes.html +++ b/docs/Documentation/DCSTypes.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSUnit.html b/docs/Documentation/DCSUnit.html index 7d9c60004..b286a5a8e 100644 --- a/docs/Documentation/DCSUnit.html +++ b/docs/Documentation/DCSUnit.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSVec3.html b/docs/Documentation/DCSVec3.html index e5403e169..b5aebb5a2 100644 --- a/docs/Documentation/DCSVec3.html +++ b/docs/Documentation/DCSVec3.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSWorld.html b/docs/Documentation/DCSWorld.html index 6337356dc..aaa798b22 100644 --- a/docs/Documentation/DCSWorld.html +++ b/docs/Documentation/DCSWorld.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCSZone.html b/docs/Documentation/DCSZone.html index e84e9495c..442ed36f2 100644 --- a/docs/Documentation/DCSZone.html +++ b/docs/Documentation/DCSZone.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCScountry.html b/docs/Documentation/DCScountry.html index e32c737df..1bf08dc46 100644 --- a/docs/Documentation/DCScountry.html +++ b/docs/Documentation/DCScountry.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCStimer.html b/docs/Documentation/DCStimer.html index 2488e8315..8f91702af 100644 --- a/docs/Documentation/DCStimer.html +++ b/docs/Documentation/DCStimer.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/DCStrigger.html b/docs/Documentation/DCStrigger.html index ee0ae54f3..2f5cb2fa5 100644 --- a/docs/Documentation/DCStrigger.html +++ b/docs/Documentation/DCStrigger.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html index 6c758c57b..4629160d2 100644 --- a/docs/Documentation/Database.html +++ b/docs/Documentation/Database.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index 0a4ea910b..acd819583 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -1105,7 +1106,7 @@ function below will use the range 1-7 just in case

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

    + DESIGNATE.LaserCodes diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index 34245c128..477b2312e 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -4060,7 +4061,7 @@ Return false to cancel Transition.

    - + #number DETECTION_BASE.RefreshTimeInterval diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html index e81587d9c..d03d6d579 100644 --- a/docs/Documentation/DetectionManager.html +++ b/docs/Documentation/DetectionManager.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Escort.html b/docs/Documentation/Escort.html index fe815825a..6b331253c 100644 --- a/docs/Documentation/Escort.html +++ b/docs/Documentation/Escort.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Event.html b/docs/Documentation/Event.html index e307356f7..78be7f4c5 100644 --- a/docs/Documentation/Event.html +++ b/docs/Documentation/Event.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index c93ca5781..2dc168b7d 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Goal.html b/docs/Documentation/Goal.html index 027a67c19..3d4e32f4d 100644 --- a/docs/Documentation/Goal.html +++ b/docs/Documentation/Goal.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html index 16ba101d1..412fd6b3f 100644 --- a/docs/Documentation/Group.html +++ b/docs/Documentation/Group.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html index dd7d66ad6..20b85c948 100644 --- a/docs/Documentation/Identifiable.html +++ b/docs/Documentation/Identifiable.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html index 76097e757..72c7f2fe1 100644 --- a/docs/Documentation/Menu.html +++ b/docs/Documentation/Menu.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Message.html b/docs/Documentation/Message.html index 719909bc6..556adb28c 100644 --- a/docs/Documentation/Message.html +++ b/docs/Documentation/Message.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html index 669dae432..b37a093e7 100644 --- a/docs/Documentation/MissileTrainer.html +++ b/docs/Documentation/MissileTrainer.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html index ce7feec59..037069a01 100644 --- a/docs/Documentation/Mission.html +++ b/docs/Documentation/Mission.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index 6cdb0d829..3d57bc058 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Object.html b/docs/Documentation/Object.html index 4b5d22319..458382e42 100644 --- a/docs/Documentation/Object.html +++ b/docs/Documentation/Object.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index bee612e3b..fbdfecd9e 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index 8bc4135fe..0cddcefeb 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -1982,7 +1983,6 @@ The height in meters to add to the altitude of the positionable.

    - Core.Spot#SPOT POSITIONABLE.Spot diff --git a/docs/Documentation/Process_JTAC.html b/docs/Documentation/Process_JTAC.html index c22bde4df..cf84a9508 100644 --- a/docs/Documentation/Process_JTAC.html +++ b/docs/Documentation/Process_JTAC.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Process_Pickup.html b/docs/Documentation/Process_Pickup.html index c6ce210a1..8e98c8715 100644 --- a/docs/Documentation/Process_Pickup.html +++ b/docs/Documentation/Process_Pickup.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Protect.html b/docs/Documentation/Protect.html index 77de9c119..753a1bda6 100644 --- a/docs/Documentation/Protect.html +++ b/docs/Documentation/Protect.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html index c467e6b9f..186d75cf5 100644 --- a/docs/Documentation/Radio.html +++ b/docs/Documentation/Radio.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Rat.html b/docs/Documentation/Rat.html index 484006a12..17df9e9b1 100644 --- a/docs/Documentation/Rat.html +++ b/docs/Documentation/Rat.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Route.html b/docs/Documentation/Route.html index e7b16df03..634031bae 100644 --- a/docs/Documentation/Route.html +++ b/docs/Documentation/Route.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Scenery.html b/docs/Documentation/Scenery.html index 12782991d..ae65cd9d9 100644 --- a/docs/Documentation/Scenery.html +++ b/docs/Documentation/Scenery.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/ScheduleDispatcher.html b/docs/Documentation/ScheduleDispatcher.html index 3c81b5daf..a029bd0da 100644 --- a/docs/Documentation/ScheduleDispatcher.html +++ b/docs/Documentation/ScheduleDispatcher.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html index ebd4e0669..f4b48332f 100644 --- a/docs/Documentation/Scheduler.html +++ b/docs/Documentation/Scheduler.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Scoring.html b/docs/Documentation/Scoring.html index e81fc5f57..2420002c3 100644 --- a/docs/Documentation/Scoring.html +++ b/docs/Documentation/Scoring.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Sead.html b/docs/Documentation/Sead.html index e824ce99c..92ef00631 100644 --- a/docs/Documentation/Sead.html +++ b/docs/Documentation/Sead.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html index ea5420bda..e7f92fb7a 100644 --- a/docs/Documentation/Set.html +++ b/docs/Documentation/Set.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 6dafa540b..200c0b2e4 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -1249,7 +1250,7 @@ true if metric.

    - + #boolean SETTINGS.Metric diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html index 7a8f47cfe..11171008f 100644 --- a/docs/Documentation/Smoke.html +++ b/docs/Documentation/Smoke.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 664917ca9..a681b4c38 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -114,7 +115,7 @@

    Module Spawn

    -

    Functional -- Spawn dynamically new GROUPs in your missions.

    +

    Core -- SPAWN class dynamically spawns new groups of units in your missions.

    @@ -165,6 +166,10 @@

    @@ -327,6 +332,18 @@ and any spaces before and after the resulting name are removed.

    + + + + + + + + @@ -831,6 +848,12 @@ and any spaces before and after the resulting name are removed.

    + + + +
    CARGO_REPRESENTABLE:Destroy() +

    CARGO_REPRESENTABLE Destructor.

    +
    CARGO_REPRESENTABLE:New(Type, Name, Weight, ReportRadius, NearRadius, CargoObject)

    CARGO_REPRESENTABLE Constructor.

    @@ -808,12 +863,6 @@
    CARGO_UNIT.CargoObject -
    CARGO_UNIT:Destroy() -

    CARGO_UNIT Destructor.

    SPAWN class, extends Base#BASE

    +

    -- Banner Image

    + +
    +

    The SPAWN class allows to spawn dynamically new groups.

    SPAWN:InitRandomizeTemplate(SpawnTemplatePrefixTable)

    This method is rather complicated to understand.

    +
    SPAWN:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes) +

    Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.

    +
    SPAWN:InitRandomizeTemplateSet(SpawnTemplateSet) +

    Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.

    SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) +
    SPAWN.uncontrolled +
    @@ -848,10 +871,14 @@ and any spaces before and after the resulting name are removed.

    SPAWN class, extends Base#BASE

    +

    -- Banner Image

    + +
    +

    The SPAWN class allows to spawn dynamically new groups.

    -

    Each SPAWN object needs to be have a related template group setup in the Mission Editor (ME), +

    Each SPAWN object needs to be have related template groups setup in the Mission Editor (ME), which is a normal group with the Late Activation flag set. This template group will never be activated in your mission.
    SPAWN uses that template group to reference to all the characteristics @@ -1825,6 +1852,99 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150

    + +SPAWN:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes) + +
    +
    + +

    Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.

    + + +

    This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, +but they will all follow the same Template route and have the same prefix name. +In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

    + +

    Parameter

    +
      +
    • + +

      #string SpawnTemplatePrefixes : +A string or a list of string that contains the prefixes of the groups that are possible unit representatives of the group to be spawned.

      + +
    • +
    +

    Return value

    + +

    #SPAWN:

    + + +

    Usage:

    +
    -- NATO Tank Platoons invading Gori.
    +
    +-- Choose between different 'US Tank Platoon Templates' configurations to be spawned for the 
    +-- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.
    +
    +-- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and 
    +-- with a limit set of maximum 12 Units alive simulteneously  and 150 Groups to be spawned during the whole mission.
    +
    +Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
    +Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
    +Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
    + +
    +
    +
    +
    + + +SPAWN:InitRandomizeTemplateSet(SpawnTemplateSet) + +
    +
    + +

    Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.

    + + +

    This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, +but they will all follow the same Template route and have the same prefix name. +In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

    + +

    Parameter

    +
      +
    • + +

      Core.Set#SET_GROUP SpawnTemplateSet : +A SET_GROUP object set, that contains the groups that are possible unit representatives of the group to be spawned.

      + +
    • +
    +

    Return value

    + +

    #SPAWN:

    + + +

    Usage:

    +
    -- NATO Tank Platoons invading Gori.
    +
    +-- Choose between different 'US Tank Platoon Template' configurations to be spawned for the 
    +-- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.
    +
    +-- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and 
    +-- with a limit set of maximum 12 Units alive simulteneously  and 150 Groups to be spawned during the whole mission.
    +
    +Spawn_US_PlatoonSet = SET_GROUP:New():FilterPrefixes( "US Tank Platoon Templates" ):FilterOnce()
    +
    +--- Now use the Spawn_US_PlatoonSet to define the templates using InitRandomizeTemplateSet.
    +Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
    +Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
    +Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
    + +
    +
    +
    +
    + SPAWN:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius) @@ -3165,7 +3285,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
    - #boolean + SPAWN.SpawnUnControlled @@ -3189,7 +3309,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.

    @@ -3769,6 +3889,20 @@ True = Continue Scheduler

    + +
    +
    +
    + + + +SPAWN.uncontrolled + +
    +
    + + +
    diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index c56956b2f..c23cc7a49 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html index 2264ce42f..50b44013c 100644 --- a/docs/Documentation/Spot.html +++ b/docs/Documentation/Spot.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html index e909ef5dd..d55c5547c 100644 --- a/docs/Documentation/Static.html +++ b/docs/Documentation/Static.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -156,6 +157,12 @@ STATIC:GetThreatLevel() + + + + STATIC:ReSpawn(Coordinate, Heading) + +

    Respawn the Unit using a (tweaked) template of the parent Group.

    @@ -284,6 +291,34 @@ Raise an error if not found.

    + +
    +
    +
    + + +STATIC:ReSpawn(Coordinate, Heading) + +
    +
    + +

    Respawn the Unit using a (tweaked) template of the parent Group.

    + +

    Parameters

    +
      +
    • + +

      Core.Point#COORDINATE Coordinate : +The coordinate where to spawn the new Static.

      + +
    • +
    • + +

      #number Heading : +The heading of the unit respawn.

      + +
    • +
    @@ -322,6 +357,8 @@ Raise an error if not found.

    +

    Type UNIT

    + diff --git a/docs/Documentation/StaticObject.html b/docs/Documentation/StaticObject.html index ac871f1ab..edaaceef9 100644 --- a/docs/Documentation/StaticObject.html +++ b/docs/Documentation/StaticObject.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html index cf075e8a0..ad89915ac 100644 --- a/docs/Documentation/Task.html +++ b/docs/Documentation/Task.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/TaskZoneCapture.html b/docs/Documentation/TaskZoneCapture.html index db21fd694..07610d9ca 100644 --- a/docs/Documentation/TaskZoneCapture.html +++ b/docs/Documentation/TaskZoneCapture.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Task_A2A.html b/docs/Documentation/Task_A2A.html index 7d4a0884f..e1ede0801 100644 --- a/docs/Documentation/Task_A2A.html +++ b/docs/Documentation/Task_A2A.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Task_A2A_Dispatcher.html b/docs/Documentation/Task_A2A_Dispatcher.html index 5570cb0af..bcaa0f453 100644 --- a/docs/Documentation/Task_A2A_Dispatcher.html +++ b/docs/Documentation/Task_A2A_Dispatcher.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html index bad43ad15..1f22797fb 100644 --- a/docs/Documentation/Task_A2G.html +++ b/docs/Documentation/Task_A2G.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Task_A2G_Dispatcher.html b/docs/Documentation/Task_A2G_Dispatcher.html index ab6e7a762..fcf0e0d6d 100644 --- a/docs/Documentation/Task_A2G_Dispatcher.html +++ b/docs/Documentation/Task_A2G_Dispatcher.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 7e6aa0acd..40b927b18 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -575,6 +576,7 @@ based on the tasking capabilities defined in Task#TA
    + FSM_PROCESS.DeployZone @@ -639,7 +641,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 79f2d5cf5..481dedc9f 100644 --- a/docs/Documentation/Task_PICKUP.html +++ b/docs/Documentation/Task_PICKUP.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Unit.html b/docs/Documentation/Unit.html index ce18f49cc..c3e4be0f3 100644 --- a/docs/Documentation/Unit.html +++ b/docs/Documentation/Unit.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -152,6 +153,12 @@

    Type UNIT

    + + + + @@ -616,7 +617,7 @@ and creates a CSV file logging the scoring events and results for use at team or @@ -732,6 +733,12 @@ which are excellent tools to be reused in an OO environment!.

    + + + + diff --git a/docs/Documentation/land.html b/docs/Documentation/land.html index 0df69e015..edb13ac44 100644 --- a/docs/Documentation/land.html +++ b/docs/Documentation/land.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/routines.html b/docs/Documentation/routines.html index e5e6fbc2e..22f0e9cea 100644 --- a/docs/Documentation/routines.html +++ b/docs/Documentation/routines.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • UNIT:Destroy() +

    Destroys the UNIT.

    +
    UNIT:Find(DCSUnit)

    Finds a UNIT from the _DATABASE using a DCSUnit object.

    @@ -498,6 +505,24 @@ If you want to obtain the complete 3D position including ori�
    + +UNIT:Destroy() + +
    +
    + +

    Destroys the UNIT.

    + +

    Return value

    + +

    #nil: +The DCS Unit is not existing or alive.

    + +
    +
    +
    +
    + UNIT:Find(DCSUnit) diff --git a/docs/Documentation/UserFlag.html b/docs/Documentation/UserFlag.html index 032664ca1..f6d9f1f3f 100644 --- a/docs/Documentation/UserFlag.html +++ b/docs/Documentation/UserFlag.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -143,6 +144,12 @@

    Type USERFLAG

    + + + + + + + +
    USERFLAG:Get(Number) +

    Get the userflag Number.

    +
    USERFLAG:Is(Number)

    Check if the userflag has a value of Number.

    @@ -201,6 +208,37 @@
    + +USERFLAG:Get(Number) + +
    +
    + +

    Get the userflag Number.

    + +

    Parameter

    +
      +
    • + +

      Number :

      + +
    • +
    +

    Return value

    + +

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

    + +

    Usage:

    +
      local BlueVictory = USERFLAG:New( "VictoryBlue" )
    +  local BlueVictoryValue = BlueVictory:Get() -- Get the UserFlag VictoryBlue value.
    +  
    + +
    +
    +
    +
    + USERFLAG:Is(Number) diff --git a/docs/Documentation/UserSound.html b/docs/Documentation/UserSound.html index a4254e451..9d2cfbecd 100644 --- a/docs/Documentation/UserSound.html +++ b/docs/Documentation/UserSound.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html index 231da148a..c04656808 100644 --- a/docs/Documentation/Utils.html +++ b/docs/Documentation/Utils.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html index 3d3024456..10096ce01 100644 --- a/docs/Documentation/Zone.html +++ b/docs/Documentation/Zone.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -431,7 +432,13 @@
    ZONE_POLYGON:New(ZoneName, ZoneGroup) -

    Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the Group#GROUP defined within the Mission Editor.

    +

    Constructor to create a ZONE_POLYGON instance, taking the zone name and the Group#GROUP defined within the Mission Editor.

    +
    ZONE_POLYGON:NewFromGroupName(ZoneName, GroupName) +

    Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the Group#GROUP defined within the Mission Editor.

    @@ -1676,7 +1683,7 @@ self

    -

    Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the Group#GROUP defined within the Mission Editor.

    +

    Constructor to create a ZONE_POLYGON instance, taking the zone name and the Group#GROUP defined within the Mission Editor.

    The Group#GROUP waypoints define the polygon corners. The first and the last point are automatically connected by ZONE_POLYGON.

    @@ -1701,6 +1708,42 @@ The GROUP waypoints as defined within the Mission Editor define the polygon shap

    #ZONE_POLYGON: self

    +
    +
    +
    +
    + + +ZONE_POLYGON:NewFromGroupName(ZoneName, GroupName) + +
    +
    + +

    Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the Group#GROUP defined within the Mission Editor.

    + + +

    The Group#GROUP waypoints define the polygon corners. The first and the last point are automatically connected by ZONE_POLYGON.

    + +

    Parameters

    +
      +
    • + +

      #string ZoneName : +Name of the zone.

      + +
    • +
    • + +

      #string GroupName : +The group name of the GROUP defining the waypoints within the Mission Editor to define the polygon shape.

      + +
    • +
    +

    Return value

    + +

    #ZONE_POLYGON: +self

    +
    diff --git a/docs/Documentation/ZoneCaptureCoalition.html b/docs/Documentation/ZoneCaptureCoalition.html index bd1319037..e41e17814 100644 --- a/docs/Documentation/ZoneCaptureCoalition.html +++ b/docs/Documentation/ZoneCaptureCoalition.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/ZoneGoal.html b/docs/Documentation/ZoneGoal.html index 10026f42f..854e07ffe 100644 --- a/docs/Documentation/ZoneGoal.html +++ b/docs/Documentation/ZoneGoal.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -488,6 +489,7 @@ The name of the player.

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

    + +

    self.SmokeColor = nil

    +
    diff --git a/docs/Documentation/ZoneGoalCoalition.html b/docs/Documentation/ZoneGoalCoalition.html index b1964b864..84a90c12d 100644 --- a/docs/Documentation/ZoneGoalCoalition.html +++ b/docs/Documentation/ZoneGoalCoalition.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/env.html b/docs/Documentation/env.html index 0e1265037..a8e2e77c2 100644 --- a/docs/Documentation/env.html +++ b/docs/Documentation/env.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html index c61e305dc..59b168ce2 100644 --- a/docs/Documentation/index.html +++ b/docs/Documentation/index.html @@ -105,6 +105,7 @@
  • Zone
  • ZoneCaptureCoalition
  • ZoneGoal
  • +
  • ZoneGoalCargo
  • ZoneGoalCoalition
  • env
  • land
  • @@ -275,7 +276,7 @@ even when there are hardly any players in the mission.

    AirbasePolice -

    Functional -- This module monitors airbases traffic.

    +

    Functional -- The AIRBASEPOLICE classes monitor airbase traffic and regulate speed while taxiing.

    Spawn -

    Functional -- Spawn dynamically new GROUPs in your missions.

    +

    Core -- SPAWN class dynamically spawns new groups of units in your missions.

    ZoneGoal

    Functional (WIP) -- Base class that models processes to achieve goals involving a Zone.

    +
    ZoneGoalCargo +

    Functional (WIP) -- Base class that models processes to achieve goals involving a Zone and Cargo.