simple support module

   1.
      Overwiew
   2.

   3.
      The approach for Simple Support Module is to have an easy-to-use module, which provides various support types in game, from the abstract HQ/Papa Bear source. Module is Single player and Multiplayer compatible. As bug-free as possible.
   4.

   5.
          * Air Support
   6.
                o Drop Ammunition Box
   7.
                o Drop Units
   8.

   9.
          * Airstrike
  10.
                o by coordinates
  11.
                o with Laser Designator
  12.

  13.
          * Artillery Support
  14.
                o Mortar
  15.
                o Artillery
  16.

  17.
      [edit] Quick Start
  18.

  19.
      Once the Logic is placed in the editor, every player get the Support Module Communication Interface in the radio.
  20.
      The player can request by pressing space, communication, and then selecting the type of Support he wants to have.
  21.
      The player is pointing with the cursor to the position of the request, in 3D as well as on map.
  22.
      [edit] Details
  23.

  24.
      All functionality of the module can be highly customized thru the global variables, conditions, expressions, and the variables stored in the objects.
  25.
      Air support planes/choppers spawn at a random position outside of every player's View (and hear) distance, and once their mission completed, disappear outside of View Distance.
  26.
      The module has only optional arguments. (And synchronization to artillery or mortar battery's would be also optional, but it is not implemented yet.)
  27.
      Every Feature of the Modul can optionally disabled, but by default all features are enabled.
  28.
      The module behaves like a singleton, only one instance is created.
  29.
      The module is independent from all other modules.
  30.
      [edit] Mission designers reference
  31.
      [edit] Variables
  32.

  33.
      // ALL variables stored in missionnamespace
  34.

  35.
      // number, default 10
  36.
      BIS_SSM_MAXGROUPSIZE
  37.

  38.
      // number in meters, default 2000
  39.
      BIS_SSM_VIEWDISTANCE
  40.

  41.
      // number in meters, default 3000
  42.
      BIS_SSM_SPAWNDISTANCE
  43.

  44.
      // number in meters, default 100 or 150
  45.
      BIS_SSM_FLYINHEIGHT
  46.

  47.
      // number in seconds, default 20
  48.
      BIS_SSM_Mortar_DELAY
  49.

  50.
      // number in seconds, default 30
  51.
      BIS_SSM_Artillery_DELAY
  52.

  53.
      // Bool value, indicateing the use of detailed group call signs in the radio chatter.
  54.
      // By default group call signs are disabled. (false)
  55.
      BIS_SSM_CallSignsEnabled
  56.

  57.
      // Fallback definition for undefined callsign, when BIS_SSM_CallSignsEnabled is true. Default is ["bravo","charlie","one"]
  58.
      // Use with caution, this array needs to have exactly 3 string elements, each from a valid speech class.
  59.
      // If the Group ID cannot be evaluated at least partially to some acceptable value, this will be used.
  60.
      // For example: group player setGroupID [""]; .. will force the use of this fallback callsign.
  61.
      BIS_SSM_undefinedCallSign
  62.

  63.
      // bool values, default true
  64.
      // if changed with publicVariable, will update all clients Menu's
  65.
      // if changed on client call BIS_SSM_fnc_updateMenu
  66.
      BIS_SSM_AmmoDrop_ENABLED_WEST
  67.
      BIS_SSM_UnitsDrop_ENABLED_WEST
  68.
      BIS_SSM_Airstrike_ENABLED_WEST
  69.
      BIS_SSM_Mortar_ENABLED_WEST
  70.
      BIS_SSM_Artillery_ENABLED_WEST
  71.
      BIS_SSM_CeaseFire_ENABLED_WEST
  72.

  73.
      BIS_SSM_AmmoDrop_ENABLED_EAST
  74.
      BIS_SSM_UnitsDrop_ENABLED_EAST
  75.
      BIS_SSM_Airstrike_ENABLED_EAST
  76.
      BIS_SSM_Mortar_ENABLED_EAST
  77.
      BIS_SSM_Artillery_ENABLED_EAST
  78.
      BIS_SSM_CeaseFire_ENABLED_EAST
  79.

  80.
      BIS_SSM_AmmoDrop_ENABLED_GUER
  81.
      BIS_SSM_UnitsDrop_ENABLED_GUER
  82.
      BIS_SSM_Airstrike_ENABLED_GUER
  83.
      BIS_SSM_Mortar_ENABLED_GUER
  84.
      BIS_SSM_Artillery_ENABLED_GUER
  85.
      BIS_SSM_CeaseFire_ENABLED_GUER
  86.

  87.
      BIS_SSM_AmmoDrop_AVAILABLE_WEST
  88.
      BIS_SSM_UnitsDrop_AVAILABLE_WEST
  89.
      BIS_SSM_Airstrike_AVAILABLE_WEST
  90.
      BIS_SSM_Mortar_AVAILABLE_WEST
  91.
      BIS_SSM_Artillery_AVAILABLE_WEST
  92.
      BIS_SSM_CeaseFire_AVAILABLE_WEST
  93.

  94.
      BIS_SSM_AmmoDrop_AVAILABLE_EAST
  95.
      BIS_SSM_UnitsDrop_AVAILABLE_EAST
  96.
      BIS_SSM_Airstrike_AVAILABLE_EAST
  97.
      BIS_SSM_Mortar_AVAILABLE_EAST
  98.
      BIS_SSM_Artillery_AVAILABLE_EAST
  99.
      BIS_SSM_CeaseFire_AVAILABLE_EAST
 100.

 101.
      BIS_SSM_AmmoDrop_AVAILABLE_GUER
 102.
      BIS_SSM_UnitsDrop_AVAILABLE_GUER
 103.
      BIS_SSM_Airstrike_AVAILABLE_GUER
 104.
      BIS_SSM_Mortar_AVAILABLE_GUER
 105.
      BIS_SSM_Artillery_AVAILABLE_GUER
 106.
      BIS_SSM_CeaseFire_AVAILABLE_GUER
 107.

 108.

 109.
      //string of class, Arma 2 defaults are  "MV22", "Mi17_medevac_RU", "Mi17_medevac_Ins"
 110.
      BIS_SSM_AmmoDrop_VEHICLE_WEST
 111.
      BIS_SSM_AmmoDrop_VEHICLE_EAST
 112.
      BIS_SSM_AmmoDrop_VEHICLE_GUER
 113.
      BIS_SSM_UnitsDrop_VEHICLE_WEST
 114.
      BIS_SSM_UnitsDrop_VEHICLE_EAST
 115.
      BIS_SSM_UnitsDrop_VEHICLE_GUER
 116.

 117.
      // string of class, Arma 2 defaults are "AV8B", "Su34", "Su25_Ins"
 118.
      BIS_SSM_Airstrike_VEHICLE_WEST
 119.
      BIS_SSM_Airstrike_VEHICLE_EAST
 120.
      BIS_SSM_Airstrike_VEHICLE_GUER
 121.

 122.
      // string of class, Arma 2 defaults are "USMC_Soldier_Pilot", "RU_Soldier_Pilot", "GUE_Soldier_Pilot"
 123.
      BIS_SSM_PILOT_WEST
 124.
      BIS_SSM_PILOT_EAST
 125.
      BIS_SSM_PILOT_GUER
 126.

 127.
      //Array of class strings, ...
 128.
      BIS_SSM_AmmoDrop_BOX_WEST
 129.
      BIS_SSM_AmmoDrop_BOX_EAST
 130.
      BIS_SSM_AmmoDrop_BOX_GUER
 131.

 132.
      // string of class, default is "ARTY_Sh_81_HE"
 133.
      BIS_SSM_Mortar_SHELL_WEST
 134.
      BIS_SSM_Mortar_SHELL_EAST
 135.
      BIS_SSM_Mortar_SHELL_GUER
 136.

 137.
      // string of class, default is "ARTY_Sh_122_HE"
 138.
      BIS_SSM_Artillery_SHELL_WEST
 139.
      BIS_SSM_Artillery_SHELL_EAST
 140.
      BIS_SSM_Artillery_SHELL_GUER
 141.

 142.
      // number, radius in meters default 10
 143.
      BIS_SSM_Mortar_DISPERSION_WEST
 144.
      BIS_SSM_Mortar_DISPERSION_EAST
 145.
      BIS_SSM_Mortar_DISPERSION_GUER
 146.

 147.
      // number, radius in meters default 20
 148.
      BIS_SSM_Artillery_DISPERSION_WEST
 149.
      BIS_SSM_Artillery_DISPERSION_EAST
 150.
      BIS_SSM_Artillery_DISPERSION_GUER
 151.

 152.
      // number, default 10
 153.
      BIS_SSM_Airstrike_DISPERSION_WEST
 154.
      BIS_SSM_Airstrike_DISPERSION_EAST
 155.
      BIS_SSM_Airstrike_DISPERSION_GUER
 156.

 157.
      // number, default 80
 158.
      BIS_SSM_Mortar_ROUNDS_WEST
 159.
      BIS_SSM_Mortar_ROUNDS_EAST
 160.
      BIS_SSM_Mortar_ROUNDS_GUER
 161.

 162.
      // number, default 50
 163.
      BIS_SSM_Artillery_ROUNDS_WEST
 164.
      BIS_SSM_Artillery_ROUNDS_EAST
 165.
      BIS_SSM_Artillery_ROUNDS_GUER
 166.

 167.
      // Optional Variables in mission namespace
 168.

 169.
      // Array to override default randomization, eg. [1000,1000]
 170.
      BIS_SSM_AmmoDrop_FLYOUTPOSITION
 171.
      BIS_SSM_UnitsDrop_FLYOUTPOSITION
 172.
      BIS_SSM_Airstrike_FLYOUTPOSITION
 173.

 174.
      // Array, eg. [1000,1000]
 175.
      BIS_SSM_AmmoDrop_FLYINPOSITION
 176.
      BIS_SSM_UnitsDrop_FLYINPOSITION
 177.
      BIS_SSM_Airstrike_FLYINPOSITION
 178.

 179.

 180.
      [edit] Conditions
 181.

 182.
      // Conditions are strings that will be evaluated to bool value. (Client side)
 183.
      BIS_SSM_CeaseFire_CONDITION = " <your condition> ";
 184.
      BIS_SSM_AmmoDrop_CONDITION = " <your condition> ";
 185.
      BIS_SSM_UnitsDrop_CONDITION = " <your condition> ";
 186.
      BIS_SSM_Airstrike_CONDITION = " <your condition> ";
 187.
      BIS_SSM_Mortar_CONDITION = " <your condition> ";
 188.
      BIS_SSM_Artillery_CONDITION = " <your condition> ";
 189.

 190.
      [edit] Expressions
 191.

 192.
      // Expressions are called (Client Side), if the player is calling support and the condition has been evaluated to true.
 193.
      // _this select 0 is the position that the player called the support for.
 194.
      BIS_SSM_CeaseFire_EXPRESSION = { <your code> };
 195.
      BIS_SSM_AmmoDrop_EXPRESSION = { <your code> };
 196.
      BIS_SSM_UnitsDrop_EXPRESSION = { <your code> };
 197.
      BIS_SSM_Airstrike_EXPRESSION = { <your code> };
 198.
      BIS_SSM_Mortar_EXPRESSION = { <your code> };
 199.
      BIS_SSM_Artillery_EXPRESSION = { <your code> };
 200.

 201.

 202.
      // These are called after the vehicle has been initialized. (Server Side)
 203.
      // Available variables from the underlying scope are:
 204.
      // _vehicle, _pilot, _spawnPos, _requestPos, _caller, _act
 205.
      BIS_SSM_AmmoDrop_VEHICLEINIT = { <your code> };
 206.
      BIS_SSM_UnitsDrop_VEHICLEINIT = { <your code> };
 207.
      BIS_SSM_Airstrike_VEHICLEINIT = { <your code> };
 208.

 209.

 210.
      [edit] UnitsDrop Custom Groups
 211.

 212.
      // When calling support for Units to be parachuted, the module will drop a predefined random group, similar to the player
 213.
      // The mission designer can create custom Groups, which is an Array of Arrays with the syntax ["name-string",possibility-number,[unit class-string array]]
 214.
      // Example, add this to the init of your player. That will override the default spawning groups.
 215.

 216.
       this setvariable ["BIS_SSM_UnitRequestConfigArray",[["Custom Squad",0.5,["USMC_Soldier_SL","USMC_Soldier_TL","USMC_Soldier_AR","USMC_Soldier_LAT"]]]];
 217.

 218.

 219.
      [edit] Missions with that module
 220.

 221.
          * Sector Control