Merge branch 'develop' into FF/Ops

.appveyor/appveyor.yml

@@ -26,24 +26,25 @@ init:
 #  - ps: iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
  
 install:
+  - cmd:
 # Outcomment if lua environment invalidates and needs to be reinstalled, otherwise all will run from the cache.
-#  - call choco install 7zip.commandline
+      call choco install 7zip.commandline
-#  - call choco install lua51
+      call choco install lua51
-#  - call choco install luarocks
+      call choco install luarocks
-#  - call refreshenv
+      call refreshenv
-#  - call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat"
+      call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat"
-#  - cmd: PATH = %PATH%;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\bin
+      cmd: PATH = %PATH%;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\bin
-#  - cmd: set LUA_PATH = %LUA_PATH%;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\share\lua\5.1\?.lua;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\share\lua\5.1\?\init.lua
+      cmd: set LUA_PATH = %LUA_PATH%;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\share\lua\5.1\?.lua;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\share\lua\5.1\?\init.lua
-#  - cmd: set LUA_CPATH = %LUA_CPATH%;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\lib\lua\5.1\?.dll 
+      cmd: set LUA_CPATH = %LUA_CPATH%;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\lib\lua\5.1\?.dll 
-#  - call luarocks install luasrcdiet
+      call luarocks install luasrcdiet
-#  - call luarocks install checks
+      call luarocks install checks
-#  - call luarocks install luadocumentor
+      call luarocks install luadocumentor
-#  - call luarocks install luacheck
+      call luarocks install luacheck
 
 
-#cache:
+cache:
-#  - C:\ProgramData\chocolatey\lib
+C:\ProgramData\chocolatey\lib
-#  - C:\ProgramData\chocolatey\bin
+C:\ProgramData\chocolatey\bin
   
 
 
@@ -51,8 +52,9 @@ build_script:
    - ps: | 
        if( $env:appveyor_repo_branch -eq 'master' -or $env:appveyor_repo_branch -eq 'develop' )     
        {
+         echo "Hello World!"
          $apiUrl = 'https://ci.appveyor.com/api'
-         $token = 'qts80b5kpq0ooj4x6vvw'
+         $token = 'v2.6hcv3ige78kg3yvg4ge8'
          $headers = @{
            "Authorization" = "Bearer $token"
            "Content-type" = "application/json"
@@ -65,7 +67,7 @@ build_script:
        if( $env:appveyor_repo_branch -eq 'master' -or $env:appveyor_repo_branch -eq 'develop' )     
        {
          $apiUrl = 'https://ci.appveyor.com/api'
-         $token = 'qts80b5kpq0ooj4x6vvw'
+         $token = 'v2.6hcv3ige78kg3yvg4ge8'
          $headers = @{
            "Authorization" = "Bearer $token"
            "Content-type" = "application/json"

.gitignore

@@ -18,6 +18,8 @@ local.properties
 # External tool builders
 .externalToolBuilders/
 
+# AppVeyor
+.appveyor/
 
 # CDT-specific
 .cproject

.luacheckrc

@@ -0,0 +1,54 @@
+ignore = {
+    "011", -- A syntax error.
+    "021", -- An invalid inline option.
+    "022", -- An unpaired inline push directive.
+    "023", -- An unpaired inline pop directive.
+    "111", -- Setting an undefined global variable.
+    "112", -- Mutating an undefined global variable.
+    "113", -- Accessing an undefined global variable.
+    "121", -- Setting a read-only global variable.
+    "122", -- Setting a read-only field of a global variable.
+    "131", -- Unused implicitly defined global variable.
+    "142", -- Setting an undefined field of a global variable.
+    "143", -- Accessing an undefined field of a global variable.
+    "211", -- Unused local variable.
+    "212", -- Unused argument.
+    "213", -- Unused loop variable.
+    "221", -- Local variable is accessed but never set.
+    "231", -- Local variable is set but never accessed.
+    "232", -- An argument is set but never accessed.
+    "233", -- Loop variable is set but never accessed.
+    "241", -- Local variable is mutated but never accessed.
+    "311", -- Value assigned to a local variable is unused.
+    "312", -- Value of an argument is unused.
+    "313", -- Value of a loop variable is unused.
+    "314", -- Value of a field in a table literal is unused.
+    "321", -- Accessing uninitialized local variable.
+    "331", -- Value assigned to a local variable is mutated but never accessed.
+    "341", -- Mutating uninitialized local variable.
+    "411", -- Redefining a local variable.
+    "412", -- Redefining an argument.
+    "413", -- Redefining a loop variable.
+    "421", -- Shadowing a local variable.
+    "422", -- Shadowing an argument.
+    "423", -- Shadowing a loop variable.
+    "431", -- Shadowing an upvalue.
+    "432", -- Shadowing an upvalue argument.
+    "433", -- Shadowing an upvalue loop variable.
+    "511", -- Unreachable code.
+    "512", -- Loop can be executed at most once.
+    "521", -- Unused label.
+    "531", -- Left-hand side of an assignment is too short.
+    "532", -- Left-hand side of an assignment is too long.
+    "541", -- An empty do end block.
+    "542", -- An empty if branch.
+    "551", -- An empty statement.
+    "561", -- Cyclomatic complexity of a function is too high.
+    "571", -- A numeric for loop goes from #(expr) down to 1 or less without negative step.
+    "611", -- A line consists of nothing but whitespace.
+    "612", -- A line contains trailing whitespace.
+    "613", -- Trailing whitespace in a string.
+    "614", -- Trailing whitespace in a comment.
+    "621", -- Inconsistent indentation (SPACE followed by TAB).
+    "631", -- Line is too long.
+}

Moose Development/Moose/Actions/Act_Route.lua

@@ -190,7 +190,7 @@ do -- ACT_ROUTE
           self:F( { ZoneName = ZoneName } )
           local Zone = Zone -- Core.Zone#ZONE
           local ZoneCoord = Zone:GetCoordinate()
-          local ZoneDistance = ZoneCoord:Get2DDistance( self.Coordinate )
+          local ZoneDistance = ZoneCoord:Get2DDistance( Coordinate )
           self:F( { ShortestDistance, ShortestReferenceName } )
           if ShortestDistance == 0 or ZoneDistance < ShortestDistance then
             ShortestDistance = ZoneDistance

Moose Development/Moose/Core/Event.lua

@@ -254,7 +254,7 @@ EVENTS = {
 -- Note that at the beginning of each field description, there is an indication which field will be populated depending on the object type involved in the Event:
 --   
 --   * A (Object.Category.)UNIT : A UNIT object type is involved in the Event.
---   * A (Object.Category.)STATIC : A STATIC object type is involved in the Event.µ
+--   * A (Object.Category.)STATIC : A STATIC object type is involved in the Event.
 --   
 -- @type EVENTDATA
 -- @field #number id The identifier of the event.

Moose Development/Moose/DCS.lua

@@ -1242,7 +1242,7 @@ do -- Group
   -- @param #Group self 
   -- @return #number
   
-  --- Returns initial size of the group. If some of the units will be destroyed, initial size of the group will not be changed. Initial size limits the unitNumber parameter for Group.getUnit() function.
+  --- Returns initial size of the group. If some of the units will be destroyed, initial size of the group will not be changed; Initial size limits the unitNumber parameter for Group.getUnit() function.
   -- @function [parent=#Group] getInitialSize
   -- @param #Group self 
   -- @return #number

Moose Development/Moose/Ops/ATIS.lua

@@ -580,6 +580,8 @@ ATIS.version="0.9.1"
 -- DONE: Metric units.
 -- DONE: Set UTC correction.
 -- DONE: Set magnetic variation.
+-- DONE: New DCS 2.7 weather presets.
+-- DONE: whatever
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- Constructor

Moose Development/Moose/Ops/Airboss.lua

@@ -17930,7 +17930,7 @@ function AIRBOSS:onbeforeSave(From, Event, To, path, filename)
 
   -- Check default path.
   if path==nil and not lfs then
-    self:E(self.lid.."WARNING: lfs not desanitized. Results will be saved in DCS installation root directory rather than your \"Saved Games\DCS\" folder.")
+    self:E(self.lid.."WARNING: lfs not desanitized. Results will be saved in DCS installation root directory rather than your \"Saved Games\\DCS\" folder.")
   end
 
   return true
@@ -18037,7 +18037,7 @@ function AIRBOSS:onbeforeLoad(From, Event, To, path, filename)
 
   -- Check default path.
   if path==nil and not lfs then
-    self:E(self.lid.."WARNING: lfs not desanitized. Results will be saved in DCS installation root directory rather than your \"Saved Games\DCS\" folder.")
+    self:E(self.lid.."WARNING: lfs not desanitized. Results will be saved in DCS installation root directory rather than your \"Saved Games\\DCS\" folder.")
   end
 
   -- Set path or default.

Moose Development/Moose/Utilities/Utils.lua

@@ -6,7 +6,7 @@
 --
 -- ### Contributions:
 --
---   * FlightControl : Rework to OO framework
+--   * FlightControl : Rework to OO framework.
 --
 -- @module Utils
 -- @image MOOSE.JPG

Moose Development/Moose/Wrapper/Airbase.lua

@@ -362,6 +362,14 @@ AIRBASE.TheChannel = {
 -- * AIRBASE.Syria.Beirut_Rafic_Hariri
 -- * AIRBASE.Syria.An_Nasiriyah
 -- * AIRBASE.Syria.Abu_al_Duhur
+-- * AIRBASE.Syria.H4
+-- * AIRBASE.Syria.Gaziantep
+-- * AIRBASE.Syria.Rosh_Pina
+-- * AIRBASE.Syria.Sayqal
+-- * AIRBASE.Syria.Shayrat
+-- * AIRBASE.Syria.Tiyas
+-- * AIRBASE.Syria.Tha_lah
+-- * AIRBASE.Syria.Naqoura
 --
 -- @field Syria
 AIRBASE.Syria={
@@ -398,6 +406,14 @@ AIRBASE.Syria={
   ["Beirut_Rafic_Hariri"]="Beirut-Rafic Hariri",
   ["An_Nasiriyah"]="An Nasiriyah",
   ["Abu_al_Duhur"]="Abu al-Duhur",
+  ["H4"]="H4",
+  ["Gaziantep"]="Gaziantep",
+  ["Rosh_Pina"]="Rosh Pina",
+  ["Sayqal"]="Sayqal",
+  ["Shayrat"]="Shayrat",
+  ["Tiyas"]="Tiyas",
+  ["Tha_lah"]="Tha'lah",
+  ["Naqoura"]="Naqoura",
 }
 
 

Moose Development/Moose/Wrapper/Controllable.lua

@@ -1429,7 +1429,7 @@ end
 -- @param #number AmmoCount (optional) Quantity of ammunition to expand (omit to fire until ammunition is depleted).
 -- @param #number WeaponType (optional) Enum for weapon type ID. This value is only required if you want the group firing to use a specific weapon, for instance using the task on a ship to force it to fire guided missiles at targets within cannon range. See http://wiki.hoggit.us/view/DCS_enum_weapon_flag
 -- @param #number Altitude (Optional) Altitude in meters.
--- @param #number ASL Altitude is above mean sea level. Default is above ground level. 
+-- @param #number ASL Altitude is above mean sea level. Default is above ground level.
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:TaskFireAtPoint( Vec2, Radius, AmmoCount, WeaponType, Altitude, ASL )
 
@@ -1451,7 +1451,7 @@ function CONTROLLABLE:TaskFireAtPoint( Vec2, Radius, AmmoCount, WeaponType, Alti
     DCSTask.params.expendQty = AmmoCount
     DCSTask.params.expendQtyEnabled = true
   end
-  
+
   if Altitude then
     DCSTask.params.altitude=Altitude
   end
@@ -1459,7 +1459,7 @@ function CONTROLLABLE:TaskFireAtPoint( Vec2, Radius, AmmoCount, WeaponType, Alti
   if WeaponType then
     DCSTask.params.weaponType=WeaponType
   end
-  
+
   self:I(DCSTask)
 
   return DCSTask
@@ -2908,7 +2908,7 @@ end
 --- Set option for Rules of Engagement (ROE).
 -- @param Wrapper.Controllable#CONTROLLABLE self
 -- @param #number ROEvalue ROE value. See ENUMS.ROE.
--- @return Wrapper.Controllable#CONTROLLABLE self
+-- @return #CONTROLLABLE self
 function CONTROLLABLE:OptionROE(ROEvalue)
 
   local DCSControllable = self:GetDCSObject()
@@ -2950,8 +2950,8 @@ function CONTROLLABLE:OptionROEHoldFirePossible()
 end
 
 --- Weapons Hold: AI will hold fire under all circumstances.
--- @param Wrapper.Controllable#CONTROLLABLE self
+-- @param #CONTROLLABLE self
--- @return Wrapper.Controllable#CONTROLLABLE self
+-- @return #CONTROLLABLE self
 function CONTROLLABLE:OptionROEHoldFire()
   self:F2( { self.ControllableName } )
 
@@ -3549,7 +3549,7 @@ end
 -- Note that when WayPointInitialize is called, the Mission of the controllable is RESTARTED!
 -- @param #CONTROLLABLE self
 -- @param #table WayPoints If WayPoints is given, then use the route.
--- @return #CONTROLLABLE
+-- @return #CONTROLLABLE self
 function CONTROLLABLE:WayPointInitialize( WayPoints )
   self:F( { WayPoints } )
 
@@ -3580,7 +3580,7 @@ end
 -- @param #number WayPoint The waypoint number. Note that the start waypoint on the route is WayPoint 1!
 -- @param #number WayPointIndex When defining multiple WayPoint functions for one WayPoint, use WayPointIndex to set the sequence of actions.
 -- @param #function WayPointFunction The waypoint function to be called when the controllable moves over the waypoint. The waypoint function takes variable parameters.
--- @return #CONTROLLABLE
+-- @return #CONTROLLABLE self
 function CONTROLLABLE:WayPointFunction( WayPoint, WayPointIndex, WayPointFunction, ... )
   self:F2( { WayPoint, WayPointIndex, WayPointFunction } )
 
@@ -3596,7 +3596,7 @@ end
 -- @param #CONTROLLABLE self
 -- @param #number WayPoint The WayPoint from where to execute the mission.
 -- @param #number WaitTime The amount seconds to wait before initiating the mission.
--- @return #CONTROLLABLE
+-- @return #CONTROLLABLE self
 function CONTROLLABLE:WayPointExecute( WayPoint, WaitTime )
   self:F( { WayPoint, WaitTime } )
 
@@ -3679,7 +3679,9 @@ end
 
 --- Sets Controllable Option for A2A attack range for AIR FIGHTER units.
 -- @param #CONTROLLABLE self
--- @param #number Defines the range: MAX_RANGE = 0, NEZ_RANGE = 1, HALF_WAY_RMAX_NEZ = 2, TARGET_THREAT_EST = 3, RANDOM_RANGE = 4. Defaults to 3. See: https://wiki.hoggitworld.com/view/DCS_option_missileAttack
+-- @param #number range Defines the range
+-- @return #CONTROLLABLE self
+-- @usage Range can be one of MAX_RANGE = 0, NEZ_RANGE = 1, HALF_WAY_RMAX_NEZ = 2, TARGET_THREAT_EST = 3, RANDOM_RANGE = 4. Defaults to 3. See: https://wiki.hoggitworld.com/view/DCS_option_missileAttack
 function CONTROLLABLE:OptionAAAttackRange(range)
   self:F2( { self.ControllableName } )
   -- defaults to 3
@@ -3705,7 +3707,7 @@ end
 -- @param #number EngageRange Engage range limit in percent (a number between 0 and 100). Default 100.
 -- @return #CONTROLLABLE self
 function CONTROLLABLE:OptionEngageRange(EngageRange)
-  self:F2( { self.ControllableName } ) 
+  self:F2( { self.ControllableName } )
   -- Set default if not specified.
   EngageRange=EngageRange or 100
   if EngageRange < 0  or EngageRange > 100 then
@@ -3714,9 +3716,9 @@ function CONTROLLABLE:OptionEngageRange(EngageRange)
   local DCSControllable = self:GetDCSObject()
   if DCSControllable then
     local Controller = self:_GetController()
-    if Controller then 
+    if Controller then
      if self:IsGround() then
-        self:SetOption(AI.Option.Ground.id.AC_ENGAGEMENT_RANGE_RESTRICTION, EngageRange)     
+        self:SetOption(AI.Option.Ground.id.AC_ENGAGEMENT_RANGE_RESTRICTION, EngageRange)
      end
     end
    return self
@@ -3730,10 +3732,11 @@ end
 -- @param  #number radius Radius of the relocation zone, default 500
 -- @param  #boolean onroad If true, route on road (less problems with AI way finding), default true
 -- @param  #boolean shortcut If true and onroad is set, take a shorter route - if available - off road, default false
+-- @return #CONTROLLABLE self
 function CONTROLLABLE:RelocateGroundRandomInRadius(speed, radius, onroad, shortcut)
-  self:F2( { self.ControllableName } ) 
+  self:F2( { self.ControllableName } )
 
-    local _coord = self:GetCoordinate() 
+    local _coord = self:GetCoordinate()
     local _radius = radius or 500
     local _speed = speed or 20
     local _tocoord = _coord:GetRandomCoordinateInRadius(_radius,100)
@@ -3741,7 +3744,7 @@ function CONTROLLABLE:RelocateGroundRandomInRadius(speed, radius, onroad, shortc
     local _grptsk = {}
     local _candoroad = false
     local _shortcut = shortcut or false
-    
+
     -- create a DCS Task an push it on the group
     -- TaskGroundOnRoad(ToCoordinate,Speed,OffRoadFormation,Shortcut,FromCoordinate,WaypointFunction,WaypointFunctionArguments)
     if onroad then
@@ -3751,5 +3754,26 @@ function CONTROLLABLE:RelocateGroundRandomInRadius(speed, radius, onroad, shortc
       self:TaskRouteToVec2(_tocoord:GetVec2(),_speed,"Off Road")
     end
 
-  return self    
+  return self
+end
+
+--- Defines how long a GROUND unit/group will move to avoid an ongoing attack.
+-- @param #CONTROLLABLE self
+-- @param #number Seconds Any positive number: AI will disperse, but only for the specified time before continuing their route. 0: AI will not disperse.
+-- @return #CONTROLLABLE self
+function CONTROLLABLE:OptionDisperseOnAttack(Seconds)
+  self:F2( { self.ControllableName } )
+  -- Set default if not specified.
+  local seconds = Seconds or 0
+  local DCSControllable = self:GetDCSObject()
+  if DCSControllable then
+    local Controller = self:_GetController()
+    if Controller then
+     if self:IsGround() then
+        self:SetOption(AI.Option.GROUND.id.DISPERSE_ON_ATTACK, seconds)
+     end
+    end
+   return self
+  end
+  return nil
 end

Moose Development/Moose/Wrapper/Group.lua

@@ -2169,40 +2169,6 @@ function GROUP:GetThreatLevel()
   return threatlevelMax
 end
 
---- Get the unit in the group with the highest threat level, which is still alive.
--- @param #GROUP self
--- @return Wrapper.Unit#UNIT The most dangerous unit in the group.
--- @return #number Threat level of the unit.
-function GROUP:GetHighestThreat()
-
-  -- Get units of the group.
-  local units=self:GetUnits()
-  
-  if units then
-    
-    local threat=nil ; local maxtl=0
-    for _,_unit in pairs(units or {}) do
-      local unit=_unit --Wrapper.Unit#UNIT
-      
-      if unit and unit:IsAlive() then
-    
-        -- Threat level of group.
-        local tl=unit:GetThreatLevel()
-        
-        -- Check if greater the current threat.
-        if tl>maxtl then
-          maxtl=tl
-          threat=unit
-        end        
-      end
-    end
-        
-    return threat, maxtl    
-  end
-  
-  return nil, nil
-end
-
 
 --- Returns true if the first unit of the GROUP is in the air.
 -- @param Wrapper.Group#GROUP self

Moose Development/Moose/Wrapper/Unit.lua

@@ -154,8 +154,8 @@ function UNIT:Name()
   return self.UnitName
 end
 
-
+--- Get the DCS unit object.
---- @param #UNIT self
+-- @param #UNIT self
 -- @return DCS#Unit
 function UNIT:GetDCSObject()
 
@@ -1429,7 +1429,7 @@ function UNIT:GetTemplateFuel()
   return nil
 end
 
---- GROUND - Switch on/off radar emissions
+--- GROUND - Switch on/off radar emissions.
 -- @param #UNIT self
 -- @param #boolean switch
 function UNIT:EnableEmission(switch)

README.md

@@ -1,3 +1,5 @@
+[![Build status](https://ci.appveyor.com/api/projects/status/1y8nfmx7lwsn33tt?svg=true)](https://ci.appveyor.com/project/Applevangelist/MOOSE)
+
 # MOOSE framework
 
 MOOSE is a **M**ission **O**bject **O**riented **S**cripting **E**nvironment, and is meant for mission designers in DCS World.
@@ -50,9 +52,7 @@ This repository contains all the demonstration missions in packed format (*.miz)
 
 This repository contains all the demonstration missions in unpacked format. That means that there is no .miz file included, but all the .miz contents are unpacked.
 
-  
+
-  
-  
 ##  [MOOSE Web Site](https://flightcontrol-master.github.io/MOOSE_DOCS/)
 
 Documentation on the MOOSE class hierarchy, usage guides and background information can be found here for normal users, beta testers and contributors.