Merge remote-tracking branch 'origin/master' into develop

Weapon check for bomb runway task

.appveyor/appveyor.yml

@@ -1,87 +0,0 @@
-version: 2.4.a.{build}
-shallow_clone: true
-skip_branch_with_pr: false
-skip_commits:
-  message: /!nobuild/
-skip_tags: false
-
-environment:
-  access_token_documentation:
-    secure: JVBVVL8uJUcLXN+48eRdELEeCGOGCCaMzCqutsUqNuaZ/KblG5ZTt7+LV4UKv/0f
-  LUAROCKS_VER: 2.4.1
-  LUA_VER: 5.1.5
-  LUA: lua5.3
-  matrix:
-  - LUA_VER: 5.1.5
-
-platform:
-  - x64
-
-
-init:
-  - ps: if ($env:APPVEYOR_PULL_REQUEST_NUMBER -and $env:APPVEYOR_BUILD_NUMBER -ne ((Invoke-RestMethod `
-        https://ci.appveyor.com/api/projects/$env:APPVEYOR_ACCOUNT_NAME/$env:APPVEYOR_PROJECT_SLUG/history?recordsNumber=50).builds | `
-        Where-Object pullRequestId -eq $env:APPVEYOR_PULL_REQUEST_NUMBER)[0].buildNumber) { `
-        throw "There are newer queued builds for this pull request, failing early." }
-#  - 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 lua51
-      call choco install luarocks
-      call refreshenv
-      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: 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 
-      call luarocks install luasrcdiet
-      call luarocks install checks
-      call luarocks install luadocumentor
-      call luarocks install luacheck
-
-
-cache:
-C:\ProgramData\chocolatey\lib
-C:\ProgramData\chocolatey\bin
-  
-
-
-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 = 'v2.6hcv3ige78kg3yvg4ge8'
-         $headers = @{
-           "Authorization" = "Bearer $token"
-           "Content-type" = "application/json"
-           }
-         $RequestBody = @{ accountName = 'FlightControl-Master'; projectSlug = 'moose-include'; branch = "$env:appveyor_repo_branch"; environmentVariables = @{} } | ConvertTo-Json
-         # Generate the new version ...
-         $project = Invoke-RestMethod -method Post -Uri "$apiUrl/builds" -Headers $headers -Body $RequestBody
-       }
-   - ps: | 
-       if( $env:appveyor_repo_branch -eq 'master' -or $env:appveyor_repo_branch -eq 'develop' )     
-       {
-         $apiUrl = 'https://ci.appveyor.com/api'
-         $token = 'v2.6hcv3ige78kg3yvg4ge8'
-         $headers = @{
-           "Authorization" = "Bearer $token"
-           "Content-type" = "application/json"
-           }
-         $RequestBody = @{ accountName = 'FlightControl-Master'; projectSlug = 'moose-docs'; branch = "$env:appveyor_repo_branch"; environmentVariables = @{} } | ConvertTo-Json
-         # get project with last build details
-         $project = Invoke-RestMethod -method Post -Uri "$apiUrl/builds" -Headers $headers -Body $RequestBody
-       }
-
-
-test: off
-# test_script:
-#   - cmd: luacheck "Moose Development\Moose\moose.lua" "Moose Mission Setup\moose.lua"
-
-
-on_finish:
-#  - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))

.gitattributes

@@ -15,3 +15,7 @@
 *.PDF	 diff=astextplain
 *.rtf	 diff=astextplain
 *.RTF	 diff=astextplain
+
+# Avoid Windows line endings on shell scripts
+# Needed for dockerfile builds
+*.sh text eol=lf

.github/workflows/build-docs.yml

@@ -0,0 +1,168 @@
+name: Moose-Docs
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+    paths:
+      - 'Moose Setup/**/*.lua'
+      - 'Moose Development/**/*.lua'
+      - 'Moose Development/**/*.py'
+      - 'Moose Development/**/*.html'
+      - '.github/workflows/build-docs.yml'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  Build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Extract branch name
+        shell: bash
+        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+        id: extract_branch
+
+      - name: Build informations
+        run: |
+            echo "Triggered by:  ${{ github.event_name }}"
+            echo "Running on:    ${{ runner.os }}"
+            echo "Ref:           ${{ github.ref }}"
+            echo "Branch name:   ${{ steps.extract_branch.outputs.branch }}"
+            echo "Repository:    ${{ github.repository }}"
+            echo "Commit-Id:     ${{ github.sha }}"
+            echo "Owner:         ${{ github.repository_owner }}"
+            echo "FORCE_PUSH:    ${{ vars.FORCE_PUSH }}"
+
+      #########################################################################
+      # Prepare build environment
+      #########################################################################
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Prepare build output folders
+        run: |
+          mkdir -p build/tools
+          mkdir -p build/doc
+
+      - name: Checkout FlightControls modified luadocumentor
+        uses: actions/checkout@v4
+        with:
+          repository: Applevangelist/luadocumentor
+          path: './build/tools/luadocumentor'
+          ref: 'patch-1'
+          token: ${{ secrets.BOT_TOKEN }}
+
+      - name: Update apt-get (needed for act docker image)
+        run: |
+          sudo apt-get -qq update
+
+      - name: Install tree
+        run: |
+          sudo apt-get -qq install tree
+
+      #########################################################################
+      # Install all prerequisites for LuaDocumentor
+      #########################################################################
+      - name: Install Lua
+        run: |
+          sudo apt-get -qq install lua5.1
+
+      - name: Install LuaRocks
+        run: |
+          sudo apt-get -qq install luarocks -y
+
+      - name: Install markdown (prereq for LuaDocumentor)
+        run: |
+          sudo luarocks install markdown 0.32-2
+
+      - name: Install penlight (prereq for LuaDocumentor)
+        run: |
+          sudo luarocks install penlight 1.11.0-1
+
+      - name: Install metalua-compiler (prereq for LuaDocumentor)
+        run: |
+          sudo luarocks install metalua-compiler 0.7.3-1
+
+      - name: Install metalua-parser (prereq for LuaDocumentor)
+        run: |
+          sudo luarocks install metalua-parser 0.7.3-2
+
+      - name: Install checks (prereq for LuaDocumentor)
+        run: |
+          sudo luarocks install checks
+
+      #########################################################################
+      # Run LuaDocumentor
+      #########################################################################
+      - name: Run LuaDocumentor
+        run: |
+          lua luadocumentor.lua -d ${{ github.workspace }}/build/doc "${{ github.workspace }}/Moose Development/Moose"
+        working-directory: ${{ github.workspace }}/build/tools/luadocumentor
+
+      #########################################################################
+      # Replace <head> tag
+      #########################################################################
+      - name: Replace head tag
+        run: |
+          python3 "${{ github.workspace }}/Moose Development/docs-header.py"
+        working-directory: ${{ github.workspace }}/build/doc
+
+      - name: Check replacement of head tag
+        run: |
+          head -10 ${{ github.workspace }}/build/doc/AI.AI_A2A_Cap.html
+
+      #########################################################################
+      # Push to MOOSE_DOCS
+      #########################################################################
+      - name: Set docs repo for branch
+        shell: bash
+        id: set_doc_repo
+        run: |
+          if [[ $GITHUB_REF == 'refs/heads/master' ]]; then
+              echo "docrepo=MOOSE_DOCS" >> "$GITHUB_OUTPUT"
+          else
+              echo "docrepo=MOOSE_DOCS_DEVELOP" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Checkout ${{ steps.set_doc_repo.outputs.docrepo }} to folder MOOSE_DOCS
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.repository_owner }}/${{ steps.set_doc_repo.outputs.docrepo }}
+          path: './build/MOOSE_DOCS'
+          fetch-depth: 0
+          ref: 'master'
+          token: ${{ secrets.BOT_TOKEN }}
+
+      - name: Delete folder to remove deleted files
+        run: |
+          rm -rf ./build/MOOSE_DOCS/Documentation/
+
+      - name: Create target folder
+        run: mkdir -p build/MOOSE_DOCS/Documentation
+
+      - name: Copy build result to MOOSE_DOCS
+        run: |
+          cp ./build/doc/*.* ./build/MOOSE_DOCS/Documentation/
+
+      - name: Push result to docs repository
+        if: ${{ vars.FORCE_PUSH == 'true' }}
+        run: |
+          git config user.name "MooseBotter"
+          git config user.email "MooseBotter@users.noreply.github.com"
+          git add .
+          git commit --allow-empty -m "Auto commit by GitHub Actions Workflow"
+          git push --set-upstream origin master
+
+        working-directory: ${{ github.workspace }}/build/MOOSE_DOCS
+
+      #########################################################################
+      # Show the results
+      #########################################################################
+      - name: List files in the repository
+        run: |
+          tree ${{ github.workspace }}/build
+
+      - run: echo "This job's status is ${{ job.status }}."

.github/workflows/build-includes.yml

@@ -0,0 +1,148 @@
+name: Moose-Includes
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+    paths:
+      - 'Moose Setup/**/*.lua'
+      - 'Moose Development/**/*.lua'
+      - '.github/workflows/build-includes.yml'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  Build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Extract branch name
+        shell: bash
+        run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
+        id: extract_branch
+
+      - name: Build informations
+        run: |
+            echo "Triggered by:  ${{ github.event_name }}"
+            echo "Running on:    ${{ runner.os }}"
+            echo "Ref:           ${{ github.ref }}"
+            echo "Branch name:   ${{ steps.extract_branch.outputs.branch }}"
+            echo "Repository:    ${{ github.repository }}"
+            echo "Commit-Id:     ${{ github.sha }}"
+            echo "Owner:         ${{ github.repository_owner }}"
+            echo "FORCE_PUSH:    ${{ vars.FORCE_PUSH }}"
+
+      #########################################################################
+      # Prepare build environment
+      #########################################################################
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Prepare build output folders
+        run: |
+          mkdir -p build/result/Moose_Include_Dynamic
+          mkdir -p build/result/Moose_Include_Static
+
+      - name: Update apt-get (needed for act docker image)
+        run: |
+          sudo apt-get -qq update
+
+      - name: Install tree
+        run: |
+          sudo apt-get -qq install tree
+
+      #########################################################################
+      # Install all prerequisites
+      #########################################################################
+      - name: Install Lua 5.3
+        run: |
+          sudo apt-get -qq install lua5.3 -y
+      - name: Check Lua version
+        run: |
+          lua -v
+
+      - name: Install LuaRocks
+        run: |
+          sudo apt-get -qq install luarocks -y
+      - name: Check LuaRocks version
+        run: |
+          luarocks --version
+
+      - name: Install Lua 5.3 Dev for prerequisites for LuaSrcDiet
+        run: |
+          sudo apt-get -qq install liblua5.3-dev -y
+
+      - name: Install LuaSrcDiet
+        run: |
+          sudo luarocks install luasrcdiet
+
+      - name: Install LuaCheck
+        run: |
+          sudo luarocks install luacheck
+
+      #########################################################################
+      # Build Include files
+      #########################################################################
+      - name: Build Include Static
+        run: |
+          export COMMIT_TIME=$(git show -s --format=%cd ${{ github.sha }} --date=iso-strict)
+          lua5.3 "./Moose Setup/Moose_Create.lua" S "$COMMIT_TIME-${{ github.sha }}" "./Moose Development/Moose" "./Moose Setup" "./build/result/Moose_Include_Static"
+
+      - name: Build Includes Dynamic
+        run: |
+          export COMMIT_TIME=$(git show -s --format=%cd ${{ github.sha }} --date=iso-strict)
+          lua5.3 "./Moose Setup/Moose_Create.lua" D "$COMMIT_TIME-${{ github.sha }}" "./Moose Development/Moose" "./Moose Setup" "./build/result/Moose_Include_Dynamic"
+
+      - name: Run LuaSrcDiet
+        run: |
+          luasrcdiet --basic --opt-emptylines ./build/result/Moose_Include_Static/Moose.lua -o ./build/result/Moose_Include_Static/Moose_.lua
+
+      #########################################################################
+      # Run LuaCheck
+      #########################################################################
+      - name: Run LuaCheck
+        if: ${{ vars.SKIP_LUACHECK != true }}
+        continue-on-error: true
+        run: |
+          luacheck --std=lua51c --config=.luacheckrc -gurasqq "Moose Development/Moose"
+
+      #########################################################################
+      # Push to MOOSE_INCLUDE
+      #########################################################################
+      - name: Checkout MOOSE_INCLUDE
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.repository_owner }}/MOOSE_INCLUDE
+          path: './build/MOOSE_INCLUDE'
+          fetch-depth: 0
+          ref: ${{ steps.extract_branch.outputs.branch }}
+          token: ${{ secrets.BOT_TOKEN }}
+
+      - name: Create target folder (needed if checkout is deactivated)
+        run: mkdir -p build/MOOSE_INCLUDE
+
+      - name: Copy build reseult to MOOSE_INCLUDE
+        run: |
+          cp -r ./build/result/* ./build/MOOSE_INCLUDE/
+
+      - name: Push result to MOOSE_INCLUDE repository
+        if: ${{ vars.FORCE_PUSH == 'true' }}
+        run: |
+          git config user.name "MooseBotter"
+          git config user.email "MooseBotter@users.noreply.github.com"
+          git add .
+          git commit --allow-empty -m "Auto commit by GitHub Actions Workflow"
+          git push --set-upstream origin ${{ steps.extract_branch.outputs.branch }}
+
+        working-directory: ${{ github.workspace }}/build/MOOSE_INCLUDE
+
+      #########################################################################
+      # Show the results
+      #########################################################################
+      - name: List files in the repository
+        run: |
+          tree ${{ github.workspace }}/build
+
+      - run: echo "This job's status is ${{ job.status }}."

.github/workflows/gh-pages.yml

@@ -0,0 +1,78 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll site to Pages
+
+on:
+  push:
+    branches: ["master"]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/gh-pages.yml'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+          working-directory: docs/
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+        working-directory: docs/
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/_site/
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
+
+  check:
+    runs-on: ubuntu-latest
+    needs: deploy
+    steps:
+      - name: Setup Node
+        uses: actions/setup-node@v3
+      - run: npm install linkinator
+      - run: npx linkinator https://flightcontrol-master.github.io/MOOSE/ --verbosity error --timeout 5000 --recurse --skip "(java.com)"

.gitignore

@@ -28,6 +28,13 @@ local.properties
 .buildpath
 
 
+#####################
+## Visual Studio Code
+#####################
+*.code-workspace
+.vscode/
+
+
 #################
 ## Visual Studio
 #################
@@ -35,6 +42,8 @@ local.properties
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 
+.vscode
+
 # User-specific files
 *.suo
 *.user
@@ -220,11 +229,12 @@ pip-log.txt
 _gsdata_/
 
 #GITHUB
-.gitattributes
-.gitignore
 Moose Test Missions/MOOSE_Test_Template.miz
 Moose Development/Moose/.vscode/launch.json
 MooseCodeWS.code-workspace
-.gitignore
-.gitignore
-/.gitignore
+
+# Excludes for act (https://github.com/nektos/act)
+.secrets
+.env
+.actrc
+.vars

Moose Development/Moose/AI/AI_A2A_Cap.lua

@@ -92,6 +92,11 @@
 -- that will define when the AI will engage with the detected airborne enemy targets.
 -- Use the method @{#AI_A2A_CAP.SetEngageZone}() to define that Zone.
 --
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 --
 -- @field #AI_A2A_CAP
@@ -118,7 +123,7 @@ function AI_A2A_CAP:New2( AICap, EngageMinSpeed, EngageMaxSpeed, EngageFloorAlti
 
   -- Multiple inheritance ... :-)
   local AI_Air = AI_AIR:New( AICap )
-  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL
+  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
   local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AICap, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
   local self = BASE:Inherit( self, AI_Air_Engage ) --#AI_A2A_CAP
 

Moose Development/Moose/AI/AI_A2A_Dispatcher.lua

@@ -177,6 +177,11 @@
 --
 -- **The default grouping is 1. That means, that each spawned defender will act individually.**
 --
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 --
 -- ### Authors: **FlightControl** rework of GCICAP + introduction of new concepts (squadrons).
@@ -305,7 +310,7 @@ do -- AI_A2A_DISPATCHER
   -- Use the method @{#AI_A2A_DISPATCHER.SetEngageRadius}() to set a specific Engage Radius.
   -- **The Engage Radius is defined for ALL squadrons which are operational.**
   --
-  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-019%20-%20AI_A2A%20-%20Engage%20Range%20Test)
+  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-019%20-%20Engage%20Range%20Test)
   --
   -- In this example an Engage Radius is set to various values.
   --
@@ -328,7 +333,7 @@ do -- AI_A2A_DISPATCHER
   -- Use the method @{#AI_A2A_DISPATCHER.SetGciRadius}() to set a specific controlled ground intercept radius.
   -- **The Ground Controlled Intercept radius is defined for ALL squadrons which are operational.**
   --
-  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-013%20-%20AI_A2A%20-%20Intercept%20Test)
+  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-013%20-%20Intercept%20Test)
   --
   -- In these examples, the Gci Radius is set to various values:
   --
@@ -361,7 +366,7 @@ do -- AI_A2A_DISPATCHER
   -- it makes it easier sometimes for the mission maker to envisage where the red and blue territories roughly are.
   -- In a hot war the borders are effectively defined by the ground based radar coverage of a coalition.
   --
-  -- Demonstration Mission: [AID-009 - AI_A2A - Border Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-009 - AI_A2A - Border Test)
+  -- Demonstration Mission: [AID-009 - AI_A2A - Border Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-009%20-%20Border%20Test)
   --
   -- In this example a border is set for the CCCP A2A dispatcher:
   --
@@ -1228,7 +1233,7 @@ do -- AI_A2A_DISPATCHER
   --
   -- **Use the method @{#AI_A2A_DISPATCHER.SetEngageRadius}() to modify the default Engage Radius for ALL squadrons.**
   --
-  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-019%20-%20AI_A2A%20-%20Engage%20Range%20Test)
+  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-019%20-%20Engage%20Range%20Test)
   --
   -- @param #AI_A2A_DISPATCHER self
   -- @param #number EngageRadius (Optional, Default = 100000) The radius to report friendlies near the target.
@@ -1278,7 +1283,7 @@ do -- AI_A2A_DISPATCHER
   -- Use the method @{#AI_A2A_DISPATCHER.SetGciRadius}() to set a specific controlled ground intercept radius.
   -- **The Ground Controlled Intercept radius is defined for ALL squadrons which are operational.**
   --
-  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-013%20-%20AI_A2A%20-%20Intercept%20Test)
+  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-013%20-%20Intercept%20Test)
   --
   -- @param #AI_A2A_DISPATCHER self
   -- @param #number GciRadius (Optional, Default = 200000) The radius to ground control intercept detected targets from the nearest airbase.

Moose Development/Moose/AI/AI_A2A_Gci.lua

@@ -14,47 +14,31 @@
 
 
 --- @type AI_A2A_GCI
--- @extends AI.AI_A2A#AI_A2A
+-- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE
 
 
 --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
 --
--- ![Process](..\Presentations\AI_GCI\Dia3.JPG)
---
 -- The AI_A2A_GCI is assigned a @{Wrapper.Group} and this must be done before the AI_A2A_GCI process can be started using the **Start** event.
 --
--- ![Process](..\Presentations\AI_GCI\Dia4.JPG)
---
 -- The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits.
 -- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
 --
--- ![Process](..\Presentations\AI_GCI\Dia5.JPG)
---
 -- This cycle will continue.
 --
--- ![Process](..\Presentations\AI_GCI\Dia6.JPG)
---
 -- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
 --
--- ![Process](..\Presentations\AI_GCI\Dia9.JPG)
---
 -- When enemies are detected, the AI will automatically engage the enemy.
 --
--- ![Process](..\Presentations\AI_GCI\Dia10.JPG)
---
 -- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
 -- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 --
--- ![Process](..\Presentations\AI_GCI\Dia13.JPG)
---
 -- ## 1. AI_A2A_GCI constructor
 --
 --   * @{#AI_A2A_GCI.New}(): Creates a new AI_A2A_GCI object.
 --
 -- ## 2. AI_A2A_GCI is a FSM
 --
--- ![Process](..\Presentations\AI_GCI\Dia2.JPG)
---
 -- ### 2.1 AI_A2A_GCI States
 --
 --   * **None** ( Group ): The process is not started yet.
@@ -75,23 +59,10 @@
 --   * **@{#AI_A2A_GCI.Destroyed}**: The AI has destroyed all bogeys @{Wrapper.Unit}s assigned in the CAS task.
 --   * **Status** ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 --
--- ## 3. Set the Range of Engagement
+-- # Developer Note
 --
--- ![Range](..\Presentations\AI_GCI\Dia11.JPG)
---
--- An optional range can be set in meters,
--- that will define when the AI will engage with the detected airborne enemy targets.
--- The range can be beyond or smaller than the range of the Patrol Zone.
--- The range is applied at the position of the AI.
--- Use the method @{AI.AI_GCI#AI_A2A_GCI.SetEngageRange}() to define that range.
---
--- ## 4. Set the Zone of Engagement
---
--- ![Zone](..\Presentations\AI_GCI\Dia12.JPG)
---
--- An optional @{Core.Zone} can be set,
--- that will define when the AI will engage with the detected airborne enemy targets.
--- Use the method @{AI.AI_CAP#AI_CAP_ZONE.SetEngageZone}() to define that Zone.
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
 --
 -- ===
 --

Moose Development/Moose/AI/AI_A2A_Patrol.lua

@@ -11,7 +11,7 @@
 
 
 --- @type AI_A2A_PATROL
--- @extends AI.AI_A2A#AI_A2A
+-- @extends AI.AI_Air_Patrol#AI_AIR_PATROL
 
 --- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group}.
 -- 
@@ -111,7 +111,12 @@
 -- When the AI is damaged, it is required that a new Patrol is started. However, damage cannon be foreseen early on. 
 -- Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB).
 -- Use the method @{#AI_A2A_PATROL.ManageDamage}() to have this proces in place.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_A2A_PATROL

Moose Development/Moose/AI/AI_A2G_BAI.lua

@@ -12,10 +12,16 @@
 -- @image AI_Air_To_Ground_Engage.JPG
 
 --- @type AI_A2G_BAI
--- @extends AI.AI_A2A_Engage#AI_A2A_Engage -- TODO: Documentation. This class does not exist, unable to determine what it extends.
+-- @extends AI.AI_Air_Patrol#AI_AIR_PATROL
+-- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE
 
 --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_A2G_BAI
@@ -41,7 +47,7 @@ AI_A2G_BAI = {
 function AI_A2G_BAI:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
 
   local AI_Air = AI_AIR:New( AIGroup )
-  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL
+  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
   local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
   local self = BASE:Inherit( self, AI_Air_Engage )
 

Moose Development/Moose/AI/AI_A2G_CAS.lua

@@ -12,10 +12,16 @@
 -- @image AI_Air_To_Ground_Engage.JPG
 
 --- @type AI_A2G_CAS
--- @extends AI.AI_A2G_Patrol#AI_AIR_PATROL TODO: Documentation. This class does not exist, unable to determine what it extends.
+-- @extends AI.AI_Air_Patrol#AI_AIR_PATROL
+-- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE
 
 --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_A2G_CAS
@@ -41,7 +47,7 @@ AI_A2G_CAS = {
 function AI_A2G_CAS:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
 
   local AI_Air = AI_AIR:New( AIGroup )
-  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL
+  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
   local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
   local self = BASE:Inherit( self, AI_Air_Engage )
 

Moose Development/Moose/AI/AI_A2G_Dispatcher.lua

@@ -253,7 +253,12 @@
 -- 
 -- **The default grouping is 1. That means, that each spawned defender will act individually.**
 -- But you can specify a number between 1 and 4, so that the defenders will act as a group.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- ### Author: **FlightControl** rework of GCICAP + introduction of new concepts (squadrons).
@@ -291,8 +296,6 @@ do -- AI_A2G_DISPATCHER
   -- 
   -- ## 1. AI\_A2G\_DISPATCHER constructor:
   -- 
-  -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\AI_A2G_DISPATCHER-ME_1.JPG)
-  -- 
   -- 
   -- The @{#AI_A2G_DISPATCHER.New}() method creates a new AI_A2G_DISPATCHER instance.
   -- 
@@ -306,8 +309,6 @@ do -- AI_A2G_DISPATCHER
   -- A reconnaissance network, is used to detect enemy ground targets, 
   -- potentially group them into areas, and to understand the position, level of threat of the enemy.
   -- 
-  -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\Dia5.JPG)
-  -- 
   -- As explained in the introduction, depending on the type of mission you want to achieve, different types of units can be applied to detect ground enemy targets.
   -- Ground based units are very useful to act as a reconnaissance, but they lack sometimes the visibility to detect targets at greater range.
   -- Recce are very useful to acquire the position of enemy ground targets when spread out over the battlefield at strategic positions.
@@ -681,8 +682,6 @@ do -- AI_A2G_DISPATCHER
   -- 
   -- Use the method @{#AI_A2G_DISPATCHER.SetSquadronGrouping}() to set the grouping of aircraft when spawned in.
   -- 
-  -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\Dia12.JPG)
-  -- 
   -- In the case of **on call** engagement, the @{#AI_A2G_DISPATCHER.SetSquadronGrouping}() method has additional behaviour.
   -- When there aren't enough patrol flights airborne, a on call will be initiated for the remaining
   -- targets to be engaged. Depending on the grouping parameter, the spawned flights for on call aircraft are grouped into this setting.   
@@ -696,8 +695,6 @@ do -- AI_A2G_DISPATCHER
   -- The effectiveness can be set with the **overhead parameter**. This is a number that is used to calculate the amount of Units that dispatching command will allocate to GCI in surplus of detected amount of units.
   -- The **default value** of the overhead parameter is 1.0, which means **equal balance**.
   -- 
-  -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\Dia11.JPG)
-  -- 
   -- However, depending on the (type of) aircraft (strength and payload) in the squadron and the amount of resources available, this parameter can be changed.
   -- 
   -- The @{#AI_A2G_DISPATCHER.SetSquadronOverhead}() method can be used to tweak the defense strength,
@@ -843,8 +840,6 @@ do -- AI_A2G_DISPATCHER
   -- 
   -- For example, the following setup will set the default refuel tanker to "Tanker":
   -- 
-  -- ![Banner Image](..\Presentations\AI_A2G_DISPATCHER\AI_A2G_DISPATCHER-ME_11.JPG)
-  -- 
   --      -- Set the default tanker for refuelling to "Tanker", when the default fuel threshold has reached 90% fuel left.
   --      A2GDispatcher:SetDefaultFuelThreshold( 0.9 )
   --      A2GDispatcher:SetDefaultTanker( "Tanker" )

Moose Development/Moose/AI/AI_A2G_SEAD.lua

@@ -14,61 +14,43 @@
 
 
 --- @type AI_A2G_SEAD
--- @extends AI.AI_A2G_Patrol#AI_AIR_PATROL
+-- @extends AI.AI_Air_Patrol#AI_AIR_PATROL
+-- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE
 
 
 --- Implements the core functions to SEAD intruders. Use the Engage trigger to intercept intruders.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia3.JPG)
--- 
 -- The AI_A2G_SEAD is assigned a @{Wrapper.Group} and this must be done before the AI_A2G_SEAD process can be started using the **Start** event.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia4.JPG)
--- 
 -- The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits.
 -- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia5.JPG)
--- 
 -- This cycle will continue.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia6.JPG)
--- 
 -- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
---
--- ![Process](..\Presentations\AI_GCI\Dia9.JPG)
 -- 
 -- When enemies are detected, the AI will automatically engage the enemy.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia10.JPG)
--- 
 -- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
 -- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia13.JPG)
--- 
 -- ## 1. AI_A2G_SEAD constructor
 --   
 --   * @{#AI_A2G_SEAD.New}(): Creates a new AI_A2G_SEAD object.
 --
 -- ## 3. Set the Range of Engagement
 -- 
--- ![Range](..\Presentations\AI_GCI\Dia11.JPG)
--- 
 -- An optional range can be set in meters, 
 -- that will define when the AI will engage with the detected airborne enemy targets.
 -- The range can be beyond or smaller than the range of the Patrol Zone.
 -- The range is applied at the position of the AI.
--- Use the method @{AI.AI_GCI#AI_A2G_SEAD.SetEngageRange}() to define that range.
+-- Use the method @{#AI_AIR_PATROL.SetEngageRange}() to define that range.
 --
--- ## 4. Set the Zone of Engagement
+-- # Developer Note
 -- 
--- ![Zone](..\Presentations\AI_GCI\Dia12.JPG)
--- 
--- An optional @{Core.Zone} can be set, 
--- that will define when the AI will engage with the detected airborne enemy targets.
--- Use the method @{AI.AI_CAP#AI_CAP_ZONE.SetEngageZone}() to define that Zone. -- TODO: Documentation. Check that this is actually correct. The originally referenced class does not exist.
---  
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_A2G_SEAD
@@ -94,7 +76,7 @@ AI_A2G_SEAD = {
 function AI_A2G_SEAD:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
 
   local AI_Air = AI_AIR:New( AIGroup )
-  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL
+  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
   local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
   local self = BASE:Inherit( self, AI_Air_Engage )
 

Moose Development/Moose/AI/AI_Air.lua

@@ -46,6 +46,11 @@
 --   * **Stop**: Stop the transport process.
 --   * **Monitor**: Monitor and take action.
 --
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- @field #AI_AIR
 AI_AIR = {
   ClassName = "AI_AIR",

Moose Development/Moose/AI/AI_Air_Dispatcher.lua

@@ -292,8 +292,6 @@ do -- AI_AIR_DISPATCHER
   -- 
   -- ## 1. AI\_AIR\_DISPATCHER constructor:
   -- 
-  -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\AI_AIR_DISPATCHER-ME_1.JPG)
-  -- 
   -- 
   -- The @{#AI_AIR_DISPATCHER.New}() method creates a new AI_AIR_DISPATCHER instance.
   -- 
@@ -306,8 +304,6 @@ do -- AI_AIR_DISPATCHER
   -- A reconnaissance network, is used to detect enemy ground targets, 
   -- potentially group them into areas, and to understand the position, level of threat of the enemy.
   -- 
-  -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\Dia5.JPG)
-  -- 
   -- As explained in the introduction, depending on the type of mission you want to achieve, different types of units can be applied to detect ground enemy targets.
   -- Ground based units are very useful to act as a reconnaissance, but they lack sometimes the visibility to detect targets at greater range.
   -- Recce are very useful to acquire the position of enemy ground targets when spread out over the battlefield at strategic positions.
@@ -673,8 +669,6 @@ do -- AI_AIR_DISPATCHER
   -- 
   -- Use the method @{#AI_AIR_DISPATCHER.SetSquadronGrouping}() to set the grouping of aircraft when spawned in.
   -- 
-  -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\Dia12.JPG)
-  -- 
   -- In the case of **on call** engagement, the @{#AI_AIR_DISPATCHER.SetSquadronGrouping}() method has additional behaviour. 
   -- When there aren't enough patrol flights airborne, a on call will be initiated for the remaining
   -- targets to be engaged. Depending on the grouping parameter, the spawned flights for on call aircraft are grouped into this setting.   
@@ -688,8 +682,6 @@ do -- AI_AIR_DISPATCHER
   -- The effectiveness can be set with the **overhead parameter**. This is a number that is used to calculate the amount of Units that dispatching command will allocate to GCI in surplus of detected amount of units.
   -- The **default value** of the overhead parameter is 1.0, which means **equal balance**.
   -- 
-  -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\Dia11.JPG)
-  -- 
   -- However, depending on the (type of) aircraft (strength and payload) in the squadron and the amount of resources available, this parameter can be changed.
   -- 
   -- The @{#AI_AIR_DISPATCHER.SetSquadronOverhead}() method can be used to tweak the defense strength,
@@ -835,8 +827,6 @@ do -- AI_AIR_DISPATCHER
   -- 
   -- For example, the following setup will set the default refuel tanker to "Tanker":
   -- 
-  -- ![Banner Image](..\Presentations\AI_AIR_DISPATCHER\AI_AIR_DISPATCHER-ME_11.JPG)
-  -- 
   --      -- Define the CAP
   --      A2ADispatcher:SetSquadron( "Sochi", AIRBASE.Caucasus.Sochi_Adler, { "SQ CCCP SU-34" }, 20 )
   --      A2ADispatcher:SetSquadronCap( "Sochi", ZONE:New( "PatrolZone" ), 4000, 8000, 600, 800, 1000, 1300 )
@@ -883,6 +873,11 @@ do -- AI_AIR_DISPATCHER
   -- However, the squadron will still stay alive. Any airplane that is airborne will continue its operations until all airborne airplanes
   -- of the squadron will be destroyed. This to keep consistency of air operations not to confuse the players.
   --
+  -- # Developer Note
+  -- 
+  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+  -- Therefore, this class is considered to be deprecated
+  --
   -- @field #AI_AIR_DISPATCHER
   AI_AIR_DISPATCHER = {
     ClassName = "AI_AIR_DISPATCHER",

Moose Development/Moose/AI/AI_Air_Engage.lua

@@ -14,61 +14,45 @@
 
 
 --- @type AI_AIR_ENGAGE
--- @extends AI.AI_AIR#AI_AIR
+-- @extends AI.AI_Air#AI_AIR
 
 
 --- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia3.JPG)
--- 
 -- The AI_AIR_ENGAGE is assigned a @{Wrapper.Group} and this must be done before the AI_AIR_ENGAGE process can be started using the **Start** event.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia4.JPG)
--- 
 -- The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits.
 -- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia5.JPG)
--- 
 -- This cycle will continue.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia6.JPG)
--- 
 -- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
---
--- ![Process](..\Presentations\AI_GCI\Dia9.JPG)
 -- 
 -- When enemies are detected, the AI will automatically engage the enemy.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia10.JPG)
--- 
 -- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
 -- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
--- ![Process](..\Presentations\AI_GCI\Dia13.JPG)
--- 
 -- ## 1. AI_AIR_ENGAGE constructor
 --   
 --   * @{#AI_AIR_ENGAGE.New}(): Creates a new AI_AIR_ENGAGE object.
 --
--- ## 3. Set the Range of Engagement
--- 
--- ![Range](..\Presentations\AI_GCI\Dia11.JPG)
--- 
--- An optional range can be set in meters, 
--- that will define when the AI will engage with the detected airborne enemy targets.
--- The range can be beyond or smaller than the range of the Patrol Zone.
--- The range is applied at the position of the AI.
--- Use the method @{AI.AI_GCI#AI_AIR_ENGAGE.SetEngageRange}() to define that range.
+-- ## 2. Set the Zone of Engagement
 --
--- ## 4. Set the Zone of Engagement
--- 
--- ![Zone](..\Presentations\AI_GCI\Dia12.JPG)
--- 
--- An optional @{Core.Zone} can be set, 
+-- An optional @{Core.Zone} can be set,
 -- that will define when the AI will engage with the detected airborne enemy targets.
 -- Use the method @{AI.AI_CAP#AI_AIR_ENGAGE.SetEngageZone}() to define that Zone.
---  
+  --
+  -- # Developer Note
+  -- 
+  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+  -- Therefore, this class is considered to be deprecated
+  --
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_AIR_ENGAGE
@@ -451,12 +435,12 @@ function AI_AIR_ENGAGE:onafterEngageRoute( DefenderGroup, From, Event, To, Attac
       -- TODO: A factor of * 3 is way too close. This causes the AI not to engange until merged sometimes!
       if TargetDistance <= EngageDistance * 9 then
 
-        self:I(string.format("AI_AIR_ENGAGE onafterEngageRoute ==> __Engage - target distance = %.1f km", TargetDistance/1000))
+        --self:I(string.format("AI_AIR_ENGAGE onafterEngageRoute ==> __Engage - target distance = %.1f km", TargetDistance/1000))
         self:__Engage( 0.1, AttackSetUnit )
 
       else
       
-        self:I(string.format("FF AI_AIR_ENGAGE onafterEngageRoute ==> Routing - target distance = %.1f km", TargetDistance/1000))
+        --self:I(string.format("FF AI_AIR_ENGAGE onafterEngageRoute ==> Routing - target distance = %.1f km", TargetDistance/1000))
 
         local EngageRoute = {}
         local AttackTasks = {}

Moose Development/Moose/AI/AI_Air_Patrol.lua

@@ -79,16 +79,13 @@
 -- that will define when the AI will engage with the detected airborne enemy targets.
 -- The range can be beyond or smaller than the range of the Patrol Zone.
 -- The range is applied at the position of the AI.
--- Use the method @{AI.AI_CAP#AI_AIR_PATROL.SetEngageRange}() to define that range.
+-- Use the method @{#AI_AIR_PATROL.SetEngageRange}() to define that range.
 --
--- ## 4. Set the Zone of Engagement
+-- # Developer Note
 -- 
--- ![Zone](..\Presentations\AI_CAP\Dia12.JPG)
--- 
--- An optional @{Core.Zone} can be set, 
--- that will define when the AI will engage with the detected airborne enemy targets.
--- Use the method @{AI.AI_CAP#AI_AIR_PATROL.SetEngageZone}() to define that Zone.
---  
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_AIR_PATROL

Moose Development/Moose/AI/AI_Air_Squadron.lua

@@ -18,7 +18,12 @@
 
 
 --- Implements the core functions modeling squadrons for airplanes and helicopters.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_AIR_SQUADRON

Moose Development/Moose/AI/AI_BAI.lua

@@ -22,7 +22,7 @@
 -- ### Author: **FlightControl**
 -- ### Contributions: 
 -- 
---   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
+--   * **Gunterlund**: Test case revision.
 -- 
 -- ===
 --
@@ -130,7 +130,12 @@
 --      AIBAIZone:SearchOff()
 -- 
 -- Searching can be switched back on with the method @{#AI_BAI_ZONE.SearchOn}(). Use the method @{#AI_BAI_ZONE.SearchOnOff}() to flexibily switch searching on or off.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_BAI_ZONE

Moose Development/Moose/AI/AI_Balancer.lua

@@ -20,7 +20,7 @@
 -- ### Author: **FlightControl**
 -- ### Contributions: 
 -- 
---   * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)
+--   * **Dutch_Baron**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)
 -- 
 -- ===
 -- 
@@ -40,7 +40,7 @@
 -- 
 -- The parent class @{Core.Fsm#FSM_SET} manages the functionality to control the Finite State Machine (FSM). 
 -- The mission designer can tailor the behaviour of the AI_BALANCER, by defining event and state transition methods.
--- An explanation about state and event transition methods can be found in the @{FSM} module documentation.
+-- An explanation about state and event transition methods can be found in the @{Core.Fsm} module documentation.
 -- 
 -- The mission designer can tailor the AI_BALANCER behaviour, by implementing a state or event handling method for the following:
 -- 
@@ -52,7 +52,7 @@
 -- 
 -- ## 2. AI_BALANCER is a FSM
 -- 
--- ![Process](..\Presentations\AI_Balancer\Dia13.JPG)
+-- ![Process](..\Presentations\AI_BALANCER\Dia13.JPG)
 -- 
 -- ### 2.1. AI_BALANCER States
 -- 
@@ -85,7 +85,12 @@
 -- 
 -- Note that when AI returns to an airbase, the AI_BALANCER will trigger the **Return** event and the AI will return, 
 -- otherwise the AI_BALANCER will trigger a **Destroy** event, and the AI will be destroyed.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- @field #AI_BALANCER
 AI_BALANCER = {
   ClassName = "AI_BALANCER",

Moose Development/Moose/AI/AI_CAP.lua

@@ -20,11 +20,11 @@
 -- ### Author: **FlightControl**
 -- ### Contributions:
 --
---   * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing.
---   * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing.
---   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
---   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing.
---   * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing.
+--   * **Quax**: Concept, Advice & Testing.
+--   * **Pikey**: Concept, Advice & Testing.
+--   * **Gunterlund**: Test case revision.
+--   * **Whisper**: Testing.
+--   * **Delta99**: Testing.
 -- 
 -- ===       
 --
@@ -112,7 +112,12 @@
 -- An optional @{Core.Zone} can be set, 
 -- that will define when the AI will engage with the detected airborne enemy targets.
 -- Use the method @{#AI_CAP_ZONE.SetEngageZone}() to define that Zone.
---  
+--
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_CAP_ZONE

Moose Development/Moose/AI/AI_CAS.lua

@@ -22,9 +22,9 @@
 -- ### Author: **FlightControl**
 -- ### Contributions: 
 --
---   * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing.
---   * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing.
---   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
+--   * **Quax**: Concept, Advice & Testing.
+--   * **Pikey**: Concept, Advice & Testing.
+--   * **Gunterlund**: Test case revision.
 --
 -- ===
 --
@@ -118,7 +118,12 @@
 --   * **@{#AI_CAS_ZONE.Destroy}**: The AI has destroyed a target @{Wrapper.Unit}.
 --   * **@{#AI_CAS_ZONE.Destroyed}**: The AI has destroyed all target @{Wrapper.Unit}s assigned in the CAS task.
 --   * **Status**: The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_CAS_ZONE

Moose Development/Moose/AI/AI_Cargo.lua

@@ -25,7 +25,12 @@
 --    * @{AI.AI_Cargo_APC} - Cargo transportation using APCs and other vehicles between zones.
 --    * @{AI.AI_Cargo_Helicopter} - Cargo transportation using helicopters between zones.
 --    * @{AI.AI_Cargo_Airplane} - Cargo transportation using airplanes to and from airbases.
---    
+--
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+-- 
 -- @field #AI_CARGO
 AI_CARGO = {
   ClassName = "AI_CARGO",

Moose Development/Moose/AI/AI_Cargo_APC.lua

@@ -75,7 +75,12 @@
 -- Using the @{#AI_CARGO_APC.Pickup}() method, you are able to direct the APCs towards a point on the battlefield to board/load the cargo at the specific coordinate. 
 -- The APCs will follow nearby roads as much as possible, to ensure fast and clean cargo transportation between the objects and villages in the simulation environment.
 -- 
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- 
 -- @field #AI_CARGO_APC
 AI_CARGO_APC = {

Moose Development/Moose/AI/AI_Cargo_Airplane.lua

@@ -41,7 +41,12 @@
 -- marginal impact on the overall battlefield simulation. Fortunately, the firing strength of infantry is limited, and thus, respacing healthy infantry every
 -- time is not so much of an issue ... 
 -- 
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- @field #AI_CARGO_AIRPLANE
 AI_CARGO_AIRPLANE = {
   ClassName = "AI_CARGO_AIRPLANE",

Moose Development/Moose/AI/AI_Cargo_Dispatcher.lua

@@ -100,7 +100,12 @@
 -- 
 -- Yes, please ensure that the zones are declared using the @{Core.Zone} classes.
 -- Possible zones that function at the moment are ZONE, ZONE_GROUP, ZONE_UNIT, ZONE_POLYGON.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- ### Author: **FlightControl**

Moose Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua

@@ -137,7 +137,12 @@
 -- Use @{#AI_CARGO_DISPATCHER_APC.SetHomeZone}() to specify the home zone.
 -- 
 -- If no home zone is specified, the APCs will wait near the deploy zone for a new pickup command.   
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_CARGO_DISPATCHER_APC

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua

@@ -108,7 +108,12 @@
 -- 
 -- **There are a lot of templates available that allows you to quickly setup an event handler for a specific event type!**
 -- 
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- 
 -- @field #AI_CARGO_DISPATCHER_AIRPLANE
 AI_CARGO_DISPATCHER_AIRPLANE = {

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua

@@ -140,7 +140,12 @@
 -- Use @{#AI_CARGO_DISPATCHER_HELICOPTER.SetHomeZone}() to specify the home zone.
 -- 
 -- If no home zone is specified, the helicopters will wait near the deploy zone for a new pickup command.   
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_CARGO_DISPATCHER_HELICOPTER

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Ship.lua

@@ -130,7 +130,12 @@
 -- Use @{#AI_CARGO_DISPATCHER_SHIP.SetHomeZone}() to specify the home zone.
 -- 
 -- If no home zone is specified, the Ship will wait near the deploy zone for a new pickup command.   
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_CARGO_DISPATCHER_SHIP

Moose Development/Moose/AI/AI_Cargo_Helicopter.lua

@@ -41,7 +41,12 @@
 -- marginal impact on the overall battlefield simulation. Fortunately, the firing strength of infantry is limited, and thus, respacing healthy infantry every
 -- time is not so much of an issue ... 
 -- 
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_CARGO_HELICOPTER

Moose Development/Moose/AI/AI_Cargo_Ship.lua

@@ -55,6 +55,11 @@
 -- coordinate. The Ship will follow the Shipping Lane to ensure consistent cargo transportation within the simulation environment.
 --
 --
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- @field #AI_CARGO_SHIP
 AI_CARGO_SHIP = {
     ClassName = "AI_CARGO_SHIP",

Moose Development/Moose/AI/AI_Escort.lua

@@ -174,8 +174,12 @@
 -- EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
 -- EscortPlanes:MenusAirplanes() -- create menus for airplanes
 -- EscortPlanes:__Start(2)
+--
+-- # Developer Note
 -- 
--- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- @field #AI_ESCORT
 AI_ESCORT = {
   ClassName = "AI_ESCORT",
@@ -195,13 +199,6 @@ AI_ESCORT = {
 -- @field Functional.Detection#DETECTION_AREAS
 AI_ESCORT.Detection = nil
 
---- MENUPARAM type
--- @type MENUPARAM
--- @field #AI_ESCORT ParamSelf
--- @field #Distance ParamDistance
--- @field #function ParamFunction
--- @field #string ParamMessage
-
 --- AI_ESCORT class constructor for an AI group
 -- @param #AI_ESCORT self
 -- @param Wrapper.Client#CLIENT EscortUnit The client escorted by the EscortGroup.
@@ -264,7 +261,7 @@ function AI_ESCORT:New( EscortUnit, EscortGroupSet, EscortName, EscortBriefing )
 
 
   EscortGroupSet:ForEachGroup(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       -- Set EscortGroup known at EscortUnit.
       if not self.PlayerUnit._EscortGroups then
@@ -346,7 +343,7 @@ function AI_ESCORT:onafterStart( EscortGroupSet )
   self:F()
 
   EscortGroupSet:ForEachGroup(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       EscortGroup:WayPointInitialize()
     
@@ -384,7 +381,7 @@ function AI_ESCORT:onafterStart( EscortGroupSet )
   self:_InitFlightMenus()
   
   self.EscortGroupSet:ForSomeGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
 
       self:_InitEscortMenus( EscortGroup )
@@ -415,7 +412,7 @@ function AI_ESCORT:onafterStop( EscortGroupSet )
   self:F()
 
   EscortGroupSet:ForEachGroup(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       EscortGroup:WayPointInitialize()
     
@@ -564,7 +561,7 @@ function AI_ESCORT:SetFlightMenuFormation( Formation )
     local MenuFlightFormationID = MENU_GROUP_COMMAND:New( self.PlayerGroup, Formation, FlightMenuFormation, 
       function ( self, Formation, ... )
         self.EscortGroupSet:ForSomeGroupAlive(
-          -- @param Core.Group#GROUP EscortGroup
+          -- @param Wrapper.Group#GROUP EscortGroup
           function( EscortGroup, self, Formation, Arguments )
             if EscortGroup:IsAir() then
               self:E({FormationID=FormationID})
@@ -1245,7 +1242,7 @@ function AI_ESCORT:MenuAssistedAttack()
   self:F()
 
   self.EscortGroupSet:ForSomeGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       if not EscortGroup:IsAir() then
         -- Request assistance from other escorts.
@@ -1442,7 +1439,7 @@ function AI_ESCORT:_FlightHoldPosition( OrbitGroup, OrbitHeight, OrbitSeconds )
   local EscortUnit = self.PlayerUnit
 
   self.EscortGroupSet:ForEachGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup, OrbitGroup )
       if EscortGroup:IsAir() then
         if OrbitGroup == nil then
@@ -1470,7 +1467,7 @@ end
 function AI_ESCORT:_FlightJoinUp()
 
   self.EscortGroupSet:ForEachGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       if EscortGroup:IsAir() then
         self:_JoinUp( EscortGroup )
@@ -1497,7 +1494,7 @@ end
 function AI_ESCORT:_FlightFormationTrail( XStart, XSpace, YStart )
 
   self.EscortGroupSet:ForEachGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       if EscortGroup:IsAir() then
         self:_EscortFormationTrail( EscortGroup, XStart, XSpace, YStart )
@@ -1524,7 +1521,7 @@ end
 function AI_ESCORT:_FlightFormationStack( XStart, XSpace, YStart, YSpace )
 
   self.EscortGroupSet:ForEachGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       if EscortGroup:IsAir() then
         self:_EscortFormationStack( EscortGroup, XStart, XSpace, YStart, YSpace )
@@ -1547,7 +1544,7 @@ end
 function AI_ESCORT:_FlightFlare( Color, Message )
 
   self.EscortGroupSet:ForEachGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       if EscortGroup:IsAir() then
         self:_Flare( EscortGroup, Color, Message )
@@ -1570,7 +1567,7 @@ end
 function AI_ESCORT:_FlightSmoke( Color, Message )
 
   self.EscortGroupSet:ForEachGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       if EscortGroup:IsAir() then
         self:_Smoke( EscortGroup, Color, Message )
@@ -1601,7 +1598,7 @@ end
 function AI_ESCORT:_FlightSwitchReportNearbyTargets( ReportTargets )
 
   self.EscortGroupSet:ForEachGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       if EscortGroup:IsAir() then
         self:_EscortSwitchReportNearbyTargets( EscortGroup, ReportTargets )
@@ -1809,7 +1806,7 @@ end
 function AI_ESCORT:_FlightAttackTarget( DetectedItem )
 
   self.EscortGroupSet:ForEachGroupAlive(
-    -- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup, DetectedItem )
       if EscortGroup:IsAir() then
         self:_AttackTarget( EscortGroup, DetectedItem )

Moose Development/Moose/AI/AI_Escort_Dispatcher.lua

@@ -20,7 +20,12 @@
 
 
 --- Models the automatic assignment of AI escorts to player flights.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 --   
 -- @field #AI_ESCORT_DISPATCHER

Moose Development/Moose/AI/AI_Escort_Dispatcher_Request.lua

@@ -20,7 +20,12 @@
 
 
 --- Models the assignment of AI escorts to player flights upon request using the radio menu.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 --   
 -- @field #AI_ESCORT_DISPATCHER_REQUEST

Moose Development/Moose/AI/AI_Escort_Request.lua

@@ -137,6 +137,11 @@
 -- Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
 -- Note that this is really fantastic, as you now have the dynamic of taking control of the escort groups, and allowing them to resume their path or mission.
 --
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- ### Authors: **FlightControl** 
@@ -292,7 +297,7 @@ function AI_ESCORT_REQUEST:onafterStop( EscortGroupSet )
   self:F()
   
   EscortGroupSet:ForEachGroup(
-    --- @param Core.Group#GROUP EscortGroup
+    --- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       EscortGroup:WayPointInitialize()
     

Moose Development/Moose/AI/AI_Formation.lua

@@ -8,7 +8,7 @@
 -- 
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/FOR%20-%20Formation)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/FOR%20-%20AI%20Group%20Formation)
 -- 
 -- ===
 -- 
@@ -31,11 +31,11 @@
 -- @field Core.Set#SET_GROUP FollowGroupSet
 -- @field #string FollowName
 -- @field #AI_FORMATION.MODE FollowMode The mode the escort is in.
--- @field Scheduler#SCHEDULER FollowScheduler The instance of the SCHEDULER class.
+-- @field Core.Scheduler#SCHEDULER FollowScheduler The instance of the SCHEDULER class.
 -- @field #number FollowDistance The current follow distance.
 -- @field #boolean ReportTargets If true, nearby targets are reported.
--- @Field DCSTypes#AI.Option.Air.val.ROE OptionROE Which ROE is set to the FollowGroup.
--- @field DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT OptionReactionOnThreat Which REACTION_ON_THREAT is set to the FollowGroup.
+-- @field DCS#AI.Option.Air.val.ROE OptionROE Which ROE is set to the FollowGroup.
+-- @field DCS#AI.Option.Air.val.REACTION_ON_THREAT OptionReactionOnThreat Which REACTION_ON_THREAT is set to the FollowGroup.
 -- @field #number dtFollow Time step between position updates.
 
 
@@ -92,7 +92,12 @@
 -- local LargeFormation = AI_FORMATION:New( LeaderUnit, FollowGroupSet, "Center Wing Formation", "Briefing" )
 -- LargeFormation:FormationCenterWing( 500, 50, 0, 250, 250 )
 -- LargeFormation:__Start( 1 )
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- @field #AI_FORMATION 
 AI_FORMATION = {
   ClassName = "AI_FORMATION",
@@ -159,15 +164,6 @@ AI_FORMATION.__Enum.ReportType = {
   Ground = "G",
 }
 
-
-
---- MENUPARAM type
--- @type MENUPARAM
--- @field #AI_FORMATION ParamSelf
--- @field #number ParamDistance
--- @field #function ParamFunction
--- @field #string ParamMessage
-
 --- AI_FORMATION class constructor for an AI group
 -- @param #AI_FORMATION self
 -- @param Wrapper.Unit#UNIT FollowUnit The UNIT leading the FolllowGroupSet.
@@ -1000,7 +996,7 @@ function AI_FORMATION:SetFlightModeMission( FollowGroup )
     FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Mission )
   else
     self.FollowGroupSet:ForSomeGroupAlive(
-      --- @param Core.Group#GROUP EscortGroup
+      --- @param Wrapper.Group#GROUP EscortGroup
       function( FollowGroup )
         FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
         FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Mission )
@@ -1024,7 +1020,7 @@ function AI_FORMATION:SetFlightModeAttack( FollowGroup )
     FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Attack )
   else
     self.FollowGroupSet:ForSomeGroupAlive(
-      --- @param Core.Group#GROUP EscortGroup
+      --- @param Wrapper.Group#GROUP EscortGroup
       function( FollowGroup )
         FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
         FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Attack )
@@ -1048,7 +1044,7 @@ function AI_FORMATION:SetFlightModeFormation( FollowGroup )
     FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Formation )
   else
     self.FollowGroupSet:ForSomeGroupAlive(
-      --- @param Core.Group#GROUP EscortGroup
+      --- @param Wrapper.Group#GROUP EscortGroup
       function( FollowGroup )
         FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
         FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Formation )

Moose Development/Moose/AI/AI_Patrol.lua

@@ -27,8 +27,8 @@
 -- ### Author: **FlightControl**
 -- ### Contributions: 
 -- 
---   * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)
---   * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Testing and API concept review.
+--   * **Dutch_Baron**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)
+--   * **Pikey**: Testing and API concept review.
 -- 
 -- ===
 -- 
@@ -144,7 +144,12 @@
 -- When the AI is damaged, it is required that a new AIControllable is started. However, damage cannon be foreseen early on. 
 -- Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB).
 -- Use the method @{#AI_PATROL_ZONE.ManageDamage}() to have this process in place.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- @field #AI_PATROL_ZONE

Moose Development/Moose/Actions/Act_Account.lua

@@ -54,6 +54,11 @@ do -- ACT_ACCOUNT
   --     The state transition method needs to start with the name **OnAfter + the name of the state**.
   --     These state transition methods need to provide a return value, which is specified at the function description.
   --
+  -- # Developer Note
+  -- 
+  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+  -- Therefore, this class is considered to be deprecated
+  --
   -- @type ACT_ACCOUNT
   -- @field Core.Set#SET_UNIT TargetSetUnit
   -- @extends Core.Fsm#FSM_PROCESS
@@ -137,7 +142,7 @@ end -- ACT_ACCOUNT
 
 do -- ACT_ACCOUNT_DEADS
 
-  --- # @{#ACT_ACCOUNT_DEADS} FSM class, extends @{Core.Fsm.Account#ACT_ACCOUNT}
+  --- # @{#ACT_ACCOUNT_DEADS} FSM class, extends @{#ACT_ACCOUNT}
   --
   -- The ACT_ACCOUNT_DEADS class accounts (detects, counts and reports) successful kills of DCS units.
   -- The process is given a @{Core.Set} of units that will be tracked upon successful destruction.

Moose Development/Moose/Actions/Act_Assign.lua

@@ -52,9 +52,14 @@
 --     The state transition method needs to start with the name **OnAfter + the name of the state**.
 --     These state transition methods need to provide a return value, which is specified at the function description.
 --
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 --
--- # 1) @{#ACT_ASSIGN_ACCEPT} class, extends @{Core.Fsm.Assign#ACT_ASSIGN}
+-- # 1) @{#ACT_ASSIGN_ACCEPT} class, extends @{Core.Fsm#ACT_ASSIGN}
 --
 -- The ACT_ASSIGN_ACCEPT class accepts by default a task for a player. No player intervention is allowed to reject the task.
 --
@@ -64,7 +69,7 @@
 --
 -- ===
 --
--- # 2) @{#ACT_ASSIGN_MENU_ACCEPT} class, extends @{Core.Fsm.Assign#ACT_ASSIGN}
+-- # 2) @{#ACT_ASSIGN_MENU_ACCEPT} class, extends @{Core.Fsm#ACT_ASSIGN}
 --
 -- The ACT_ASSIGN_MENU_ACCEPT class accepts a task when the player accepts the task through an added menu option.
 -- This assignment type is useful to conditionally allow the player to choose whether or not he would accept the task.

Moose Development/Moose/Actions/Act_Assist.lua

@@ -48,7 +48,7 @@
 --
 -- ===
 --
--- # 1) @{#ACT_ASSIST_SMOKE_TARGETS_ZONE} class, extends @{Core.Fsm.Route#ACT_ASSIST}
+-- # 1) @{#ACT_ASSIST_SMOKE_TARGETS_ZONE} class, extends @{#ACT_ASSIST}
 --
 -- The ACT_ASSIST_SMOKE_TARGETS_ZONE class implements the core functions to smoke targets in a @{Core.Zone}.
 -- The targets are smoked within a certain range around each target, simulating a realistic smoking behaviour.
@@ -58,6 +58,11 @@
 --
 --   * @{#ACT_ASSIST_SMOKE_TARGETS_ZONE.New}(): Creates a new ACT_ASSIST_SMOKE_TARGETS_ZONE object.
 --
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 --
 -- @module Actions.Act_Assist

Moose Development/Moose/Actions/Act_Route.lua

@@ -60,7 +60,7 @@
 --
 -- ===
 --
--- # 1) @{#ACT_ROUTE_ZONE} class, extends @{Core.Fsm.Route#ACT_ROUTE}
+-- # 1) @{#ACT_ROUTE_ZONE} class, extends @{#ACT_ROUTE}
 --
 -- The ACT_ROUTE_ZONE class implements the core functions to route an AIR @{Wrapper.Controllable} player @{Wrapper.Unit} to a @{Core.Zone}.
 -- The player receives on perioding times messages with the coordinates of the route to follow.
@@ -70,6 +70,11 @@
 --
 --   * @{#ACT_ROUTE_ZONE.New}(): Creates a new ACT_ROUTE_ZONE object.
 --
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 --
 -- @module Actions.Act_Route

Moose Development/Moose/Cargo/Cargo.lua

@@ -86,7 +86,7 @@
 -- There are also dispatchers that make AI work together to transport cargo automatically!!!
 --   
 --   - @{AI.AI_Cargo_Dispatcher_APC} derived classes will create for your dynamic cargo handlers controlled by AI ground vehicle groups (APCs) to transport cargo between sites.
---   - @{AI.AI_Cargo_Dispatcher_Helicopters} derived classes will create for your dynamic cargo handlers controlled by AI helicopter groups to transport cargo between sites.
+--   - @{AI.AI_Cargo_Dispatcher_Helicopter} derived classes will create for your dynamic cargo handlers controlled by AI helicopter groups to transport cargo between sites.
 -- 
 -- ## 3.3) Cargo transportation tasking.
 --   
@@ -233,7 +233,12 @@
 --      Note that this option is optional, so can be omitted. The default value of the RR is 250 meters.
 --    * **NR=** Provide the maximum range in meters when the cargo units will be boarded within the carrier during boarding.
 --      Note that this option is optional, so can be omitted. The default value of the RR is 10 meters.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- ### Author: **FlightControl**
@@ -393,7 +398,7 @@ do -- CARGO
   -- 
   --   * AI Armoured Personnel Carriers to transport cargo and engage in battles, using the @{AI.AI_Cargo_APC#AI_CARGO_APC} class.
   --   * AI Helicopters to transport cargo, using the @{AI.AI_Cargo_Helicopter#AI_CARGO_HELICOPTER} class.
-  --   * AI Planes to transport cargo, using the @{AI.AI_Cargo_Plane#AI_CARGO_PLANE} class.
+  --   * AI Planes to transport cargo, using the @{AI.AI_Cargo_Airplane#AI_CARGO_AIRPLANE} class.
   --   * AI Ships is planned.
   -- 
   -- The above cargo classes are also used by the TASK\_CARGO\_ classes to allow human players to transport cargo as part of a tasking:
@@ -975,7 +980,7 @@ do -- CARGO
 
   --- Report to a Carrier Group with a Flaring signal.
   -- @param #CARGO self
-  -- @param Utils#UTILS.FlareColor FlareColor the color of the flare.
+  -- @param Utilities.Utils#UTILS.FlareColor FlareColor the color of the flare.
   -- @return #CARGO
   function CARGO:ReportFlare( FlareColor )
 
@@ -984,7 +989,7 @@ do -- CARGO
 
   --- Report to a Carrier Group with a Smoking signal.
   -- @param #CARGO self
-  -- @param Utils#UTILS.SmokeColor SmokeColor the color of the smoke.
+  -- @param Utilities.Utils#UTILS.SmokeColor SmokeColor the color of the smoke.
   -- @return #CARGO
   function CARGO:ReportSmoke( SmokeColor )
 

Moose Development/Moose/Cargo/CargoCrate.lua

@@ -36,7 +36,12 @@ do -- CARGO_CRATE
   -- 
   --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} to transport cargo by human players.
   --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR} to transport downed pilots by human players.
+  --
+  -- # Developer Note
   -- 
+  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+  -- Therefore, this class is considered to be deprecated
+  --
   -- ===
   -- 
   -- @field #CARGO_CRATE

Moose Development/Moose/Cargo/CargoGroup.lua

@@ -38,7 +38,12 @@ do -- CARGO_GROUP
   -- 
   --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} to transport cargo by human players.
   --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR} to transport downed pilots by human players.
+  --
+  -- # Developer Note
   -- 
+  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+  -- Therefore, this class is considered to be deprecated
+  --
   -- @field #CARGO_GROUP CARGO_GROUP
   -- 
   CARGO_GROUP = {

Moose Development/Moose/Cargo/CargoSlingload.lua

@@ -29,7 +29,12 @@ do -- CARGO_SLINGLOAD
   -- 
   --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} to transport cargo by human players.
   --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR} to transport downed pilots by human players.
+  --
+  -- # Developer Note
   -- 
+  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+  -- Therefore, this class is considered to be deprecated
+  --
   -- ===
   -- 
   -- @field #CARGO_SLINGLOAD

Moose Development/Moose/Cargo/CargoUnit.lua

@@ -27,7 +27,12 @@ do -- CARGO_UNIT
   -- Note that ground forces behave in a group, and thus, act in formation, regardless if one unit is commanded to move.
   -- 
   -- This class is used in CARGO_GROUP, and is not meant to be used by mission designers individually.
+  --
+  -- # Developer Note
   -- 
+  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+  -- Therefore, this class is considered to be deprecated
+  --
   -- ===
   -- 
   -- @field #CARGO_UNIT CARGO_UNIT

Moose Development/Moose/Core/Astar.lua

@@ -112,7 +112,7 @@
 -- 
 -- # Calculate the Path
 -- 
--- Finally, we have to calculate the path. This is done by the @{ASTAR.GetPath}(*ExcludeStart, ExcludeEnd*) function. This function returns a table of nodes, which
+-- Finally, we have to calculate the path. This is done by the @{#GetPath}(*ExcludeStart, ExcludeEnd*) function. This function returns a table of nodes, which
 -- describe the optimal path from the start node to the end node.
 -- 
 -- By default, the start and end node are include in the table that is returned.

Moose Development/Moose/Core/Base.lua

@@ -34,7 +34,8 @@ local _TraceClassMethod = {}
 
 local _ClassID = 0
 
---- @type BASE
+---
+-- @type BASE
 -- @field ClassName The name of the class.
 -- @field ClassID The ID number of the class.
 -- @field ClassNameAndID The name of the class concatenated with the ID number of the class.
@@ -201,10 +202,10 @@ BASE = {
   Scheduler = nil,
 }
 
---- @field #BASE.__
+-- @field #BASE.__
 BASE.__ = {}
 
---- @field #BASE._
+-- @field #BASE._
 BASE._ = {
   Schedules = {}, --- Contains the Schedulers Active
 }
@@ -229,7 +230,7 @@ FORMATION = {
 -- @param #BASE self
 -- @return #BASE
 function BASE:New()
-  --local self = routines.utils.deepCopy( self ) -- Create a new self instance
+  --local self = UTILS.DeepCopy( self ) -- Create a new self instance
   local self = UTILS.DeepCopy(self)
 
   _ClassID = _ClassID + 1
@@ -252,7 +253,7 @@ end
 function BASE:Inherit( Child, Parent )
 
   -- Create child.
-  local Child = routines.utils.deepCopy( Child )
+  local Child = UTILS.DeepCopy( Child )
 
   if Child ~= nil then
 
@@ -1167,7 +1168,7 @@ function BASE:_F( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
       if DebugInfoFrom then
         LineFrom = DebugInfoFrom.currentline
       end
-      env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "F", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+      env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "F", self.ClassName, self.ClassID, Function, UTILS.BasicSerialize( Arguments ) ) )
     end
   end
 end
@@ -1241,7 +1242,7 @@ function BASE:_T( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
       if DebugInfoFrom then
         LineFrom = DebugInfoFrom.currentline
       end
-      env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s", LineCurrent, LineFrom, "T", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
+      env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s", LineCurrent, LineFrom, "T", self.ClassName, self.ClassID, UTILS.BasicSerialize( Arguments ) ) )
     end
   end
 end
@@ -1311,9 +1312,9 @@ function BASE:E( Arguments )
       LineFrom = DebugInfoFrom.currentline
     end
 
-    env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, UTILS.BasicSerialize( Arguments ) ) )
   else
-    env.info( string.format( "%1s:%30s%05d(%s)", "E", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%1s:%30s%05d(%s)", "E", self.ClassName, self.ClassID, UTILS.BasicSerialize( Arguments ) ) )
   end
 
 end
@@ -1338,9 +1339,9 @@ function BASE:I( Arguments )
       LineFrom = DebugInfoFrom.currentline
     end
 
-    env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "I", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "I", self.ClassName, self.ClassID, Function, UTILS.BasicSerialize( Arguments ) ) )
   else
-    env.info( string.format( "%1s:%30s%05d(%s)", "I", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%1s:%30s%05d(%s)", "I", self.ClassName, self.ClassID, UTILS.BasicSerialize( Arguments ) ) )
   end
 
 end

Moose Development/Moose/Core/ClientMenu.lua

@@ -0,0 +1,882 @@
+--- **Core** - Client Menu Management.
+--
+-- **Main Features:**
+--
+--    * For complex, non-static menu structures
+--    * Lightweigt implementation as alternative to MENU
+--    * Separation of menu tree creation from menu on the clients's side
+--    * Works with a SET_CLIENT set of clients
+--    * Allow manipulation of the shadow tree in various ways
+--    * Push to all or only one client
+--    * Change entries' menu text
+--    * Option to make an entry usable once only across all clients
+--    * Auto appends GROUP and CLIENT objects to menu calls
+--
+-- ===
+--
+-- ### Author: **applevangelist**
+-- 
+-- ===
+-- 
+-- @module Core.ClientMenu
+-- @image Core_Menu.JPG
+-- last change: Oct 2023
+
+-- TODO
+----------------------------------------------------------------------------------------------------------------
+--
+-- CLIENTMENU
+--
+----------------------------------------------------------------------------------------------------------------
+
+---
+-- @type CLIENTMENU
+-- @field #string ClassName Class Name
+-- @field #string lid Lid for log entries
+-- @field #string version Version string
+-- @field #string name Name
+-- @field #string groupname Group name
+-- @field #table path
+-- @field #table parentpath
+-- @field #CLIENTMENU Parent
+-- @field Wrapper.Client#CLIENT client
+-- @field #number GroupID Group ID
+-- @field #number ID Entry ID
+-- @field Wrapper.Group#GROUP group
+-- @field #string UUID Unique ID based on path+name
+-- @field #string Function
+-- @field #table Functionargs
+-- @field #table Children
+-- @field #boolean Once
+-- @field #boolean Generic
+-- @field #boolean debug
+-- @field #CLIENTMENUMANAGER Controller
+-- @extends Core.Base#BASE
+
+---
+-- @field #CLIENTMENU
+CLIENTMENU = {
+  ClassName = "CLIENTMENUE",
+  lid = "",
+  version = "0.1.1",
+  name = nil,
+  path = nil,
+  group = nil,
+  client = nil,
+  GroupID = nil,
+  Children = {},
+  Once = false,
+  Generic = false,
+  debug = false,
+  Controller = nil,
+  groupname = nil,
+}
+
+---
+-- @field #CLIENTMENU_ID
+CLIENTMENU_ID = 0
+
+--- Create an new CLIENTMENU object.
+-- @param #CLIENTMENU self
+-- @param Wrapper.Client#CLIENT Client The client for whom this entry is.
+-- @param #string Text Text of the F10 menu entry.
+-- @param #CLIENTMENU Parent The parent menu entry.
+-- @param #string Function (optional) Function to call when the entry is used.
+-- @param ... (optional) Arguments for the Function, comma separated
+-- @return #CLIENTMENU self 
+function CLIENTMENU:NewEntry(Client,Text,Parent,Function,...)
+  -- Inherit everything from BASE class.
+  local self=BASE:Inherit(self, BASE:New()) -- #CLIENTMENU
+  CLIENTMENU_ID = CLIENTMENU_ID + 1
+  self.ID = CLIENTMENU_ID
+  if Client then
+    self.group = Client:GetGroup()
+    self.client = Client
+    self.GroupID = self.group:GetID()
+    self.groupname = self.group:GetName() or "Unknown Groupname"
+  else
+    self.Generic = true
+  end
+  self.name = Text or "unknown entry"
+  if Parent then
+    if Parent:IsInstanceOf("MENU_BASE") then
+      self.parentpath = Parent.MenuPath
+    else
+      self.parentpath = Parent:GetPath()
+      Parent:AddChild(self)
+    end
+  end
+  self.Parent = Parent
+  self.Function = Function
+  self.Functionargs = arg or {}
+  table.insert(self.Functionargs,self.group)
+  table.insert(self.Functionargs,self.client)
+  if self.Functionargs and self.debug then
+    self:T({"Functionargs",self.Functionargs})
+  end
+  if not self.Generic then
+    if Function ~= nil then
+      local ErrorHandler = function( errmsg )
+        env.info( "MOOSE Error in CLIENTMENU COMMAND function: " .. errmsg )
+        if BASE.Debug ~= nil then
+          env.info( BASE.Debug.traceback() )
+        end
+        return errmsg
+      end
+      self.CallHandler = function()
+      local function MenuFunction() 
+        return self.Function( unpack( self.Functionargs ) )
+      end
+        local Status, Result = xpcall( MenuFunction, ErrorHandler)
+        if self.Once == true then
+          self:Clear()
+        end
+      end
+      self.path = missionCommands.addCommandForGroup(self.GroupID,Text,self.parentpath, self.CallHandler)
+    else
+      self.path = missionCommands.addSubMenuForGroup(self.GroupID,Text,self.parentpath)
+    end
+  else
+    if self.parentpath then
+      self.path = UTILS.DeepCopy(self.parentpath)
+    else
+      self.path = {}
+    end
+    self.path[#self.path+1] = Text
+  end
+  self.UUID = table.concat(self.path,";")
+  self:T({self.UUID})
+  self.Once = false
+  -- Log id.
+  self.lid=string.format("CLIENTMENU %s | %s | ", self.ID, self.name)
+  self:T(self.lid.."Created")
+  return self
+end
+
+--- Create a UUID
+-- @param #CLIENTMENU self
+-- @param #CLIENTMENU Parent The parent object if any
+-- @param #string Text The menu entry text
+-- @return #string UUID
+function CLIENTMENU:CreateUUID(Parent,Text)
+  local path = {}
+  if Parent and Parent.path then
+    path = Parent.path
+  end
+  path[#path+1] = Text
+  local UUID = table.concat(path,";")
+  return UUID
+end
+
+--- Set the CLIENTMENUMANAGER for this entry.
+-- @param #CLIENTMENU self
+-- @param #CLIENTMENUMANAGER Controller The controlling object.
+-- @return #CLIENTMENU self 
+function CLIENTMENU:SetController(Controller)
+  self.Controller = Controller
+  return self
+end
+
+--- The entry will be deleted after being used used - for menu entries with functions only.
+-- @param #CLIENTMENU self
+-- @return #CLIENTMENU self 
+function CLIENTMENU:SetOnce()
+  self:T(self.lid.."SetOnce")
+  self.Once = true
+  return self
+end
+
+--- Remove the entry from the F10 menu.
+-- @param #CLIENTMENU self
+-- @return #CLIENTMENU self 
+function CLIENTMENU:RemoveF10()
+  self:T(self.lid.."RemoveF10")
+  if self.GroupID then
+    --self:I(self.lid.."Removing "..table.concat(self.path,";"))
+    local function RemoveFunction()
+      return missionCommands.removeItemForGroup(self.GroupID , self.path )
+    end
+    local status, err = pcall(RemoveFunction)
+    if not status then
+      self:I(string.format("**** Error Removing Menu Entry %s for %s!",tostring(self.name),self.groupname))
+    end
+  end
+  return self
+end
+
+--- Get the menu path table.
+-- @param #CLIENTMENU self
+-- @return #table Path
+function CLIENTMENU:GetPath()
+  self:T(self.lid.."GetPath")
+  return self.path 
+end
+
+--- Get the UUID.
+-- @param #CLIENTMENU self
+-- @return #string UUID
+function CLIENTMENU:GetUUID()
+  self:T(self.lid.."GetUUID")
+  return self.UUID
+end
+
+--- Link a child entry.
+-- @param #CLIENTMENU self
+-- @param #CLIENTMENU Child The entry to link as a child.
+-- @return #CLIENTMENU self
+function CLIENTMENU:AddChild(Child)
+  self:T(self.lid.."AddChild "..Child.ID)
+  table.insert(self.Children,Child.ID,Child)
+  return self
+end
+
+--- Remove a child entry.
+-- @param #CLIENTMENU self
+-- @param #CLIENTMENU Child The entry to remove from the children.
+-- @return #CLIENTMENU self
+function CLIENTMENU:RemoveChild(Child)
+  self:T(self.lid.."RemoveChild "..Child.ID)
+  table.remove(self.Children,Child.ID)
+  return self
+end
+
+--- Remove all subentries (children) from this entry.
+-- @param #CLIENTMENU self
+-- @return #CLIENTMENU self
+function CLIENTMENU:RemoveSubEntries()
+  self:T(self.lid.."RemoveSubEntries")
+  self:T({self.Children})
+  for _id,_entry in pairs(self.Children) do
+    self:T("Removing ".._id)
+    if _entry then
+      _entry:RemoveSubEntries()
+      _entry:RemoveF10()
+      if _entry.Parent then
+        _entry.Parent:RemoveChild(self)
+      end
+      --if self.Controller then
+        --self.Controller:_RemoveByID(_entry.ID)
+      --end
+      --_entry = nil
+    end
+  end
+  return self
+end
+
+--- Remove this entry and all subentries (children) from this entry.
+-- @param #CLIENTMENU self
+-- @return #CLIENTMENU self
+function CLIENTMENU:Clear()
+  self:T(self.lid.."Clear")
+  for _id,_entry in pairs(self.Children) do
+    if _entry then
+      _entry:RemoveSubEntries()
+      _entry = nil
+    end
+  end
+  self:RemoveF10()
+  if self.Parent then
+    self.Parent:RemoveChild(self)
+  end
+  --if self.Controller then
+    --self.Controller:_RemoveByID(self.ID)
+  --end
+  return self
+end
+
+-- TODO
+----------------------------------------------------------------------------------------------------------------
+--
+-- CLIENTMENUMANAGER
+--
+----------------------------------------------------------------------------------------------------------------
+
+
+--- Class CLIENTMENUMANAGER              
+-- @type CLIENTMENUMANAGER
+-- @field #string ClassName Class Name
+-- @field #string lid Lid for log entries
+-- @field #string version Version string
+-- @field #string name Name
+-- @field Core.Set#SET_CLIENT clientset The set of clients this menu manager is for
+-- @field #table flattree
+-- @field #table rootentries
+-- @field #table menutree
+-- @field #number entrycount
+-- @field #boolean debug
+-- @field #table PlayerMenu
+-- @field #number Coalition
+-- @extends Core.Base#BASE
+
+--- *As a child my family's menu consisted of two choices: take it, or leave it.*
+--
+-- ===
+--
+-- ## CLIENTMENU and CLIENTMENUMANAGER
+-- 
+-- Manage menu structures for a SET_CLIENT of clients.
+-- 
+-- ## Concept
+-- 
+-- Separate creation of a menu tree structure from pushing it to each client. Create a shadow "reference" menu structure tree for your client pilot's in a mission. 
+-- This can then be propagated to all clients. Manipulate the entries in the structure with removing, clearing or changing single entries, create replacement sub-structures 
+-- for entries etc, push to one or all clients.
+-- 
+-- Many functions can either change the tree for one client or for all clients.
+-- 
+-- ## Create a base reference tree and send to all clients
+-- 
+--            local clientset = SET_CLIENT:New():FilterStart()
+--            
+--            local menumgr = CLIENTMENUMANAGER:New(clientset,"Dayshift")
+--            local mymenu = menumgr:NewEntry("Top")
+--            local mymenu_lv1a = menumgr:NewEntry("Level 1 a",mymenu)
+--            local mymenu_lv1b = menumgr:NewEntry("Level 1 b",mymenu)
+--            -- next one is a command menu entry, which can only be used once
+--            local mymenu_lv1c = menumgr:NewEntry("Action Level 1 c",mymenu, testfunction, "testtext"):SetOnce()
+--            
+--            local mymenu_lv2a = menumgr:NewEntry("Go here",mymenu_lv1a)
+--            local mymenu_lv2b = menumgr:NewEntry("Level 2 ab",mymenu_lv1a)
+--            local mymenu_lv2c = menumgr:NewEntry("Level 2 ac",mymenu_lv1a)
+--            
+--            local mymenu_lv2ba = menumgr:NewEntry("Level 2 ba",mymenu_lv1b)
+--            local mymenu_lv2bb = menumgr:NewEntry("Level 2 bb",mymenu_lv1b)
+--            local mymenu_lv2bc = menumgr:NewEntry("Level 2 bc",mymenu_lv1b)
+--            
+--            local mymenu_lv3a = menumgr:NewEntry("Level 3 aaa",mymenu_lv2a)
+--            local mymenu_lv3b = menumgr:NewEntry("Level 3 aab",mymenu_lv2a)
+--            local mymenu_lv3c = menumgr:NewEntry("Level 3 aac",mymenu_lv2a)
+--            
+--            menumgr:Propagate() -- propagate **once** to all clients in the SET_CLIENT
+--            
+-- ## Remove a single entry's subtree
+-- 
+--            menumgr:RemoveSubEntries(mymenu_lv3a)
+--            
+ -- ## Remove a single entry and also it's subtree
+-- 
+--            menumgr:DeleteEntry(mymenu_lv3a)
+-- 
+-- ## Add a single entry
+-- 
+--            local baimenu = menumgr:NewEntry("BAI",mymenu_lv1b)
+--            
+--            menumgr:AddEntry(baimenu)  
+--            
+-- ## Add an entry with a function 
+-- 
+--            local baimenu = menumgr:NewEntry("Task Action", mymenu_lv1b, TestFunction, Argument1, Argument1)
+--            
+--  Now, the class will **automatically append the call with GROUP and CLIENT objects**, as this is can only be done when pushing the entry to the clients. So, the actual function implementation needs to look like this:
+--  
+--            function TestFunction( Argument1, Argument2, Group, Client)
+--            
+--  **Caveat is**, that you need to ensure your arguments are not **nil** or **false**, as LUA will optimize those away. You would end up having Group and Client in wrong places in the function call. Hence,
+--  if you need/ want to send **nil** or **false**, send a place holder instead and ensure your function can handle this, e.g.
+--  
+--            local baimenu = menumgr:NewEntry("Task Action", mymenu_lv1b, TestFunction, "nil", Argument1)
+--     
+-- ## Change the text of a leaf entry in the menu tree          
+--            
+--            menumgr:ChangeEntryTextForAll(mymenu_lv1b,"Attack")
+--            
+-- ## Reset a single clients menu tree
+-- 
+--            menumgr:ResetMenu(client)
+--            
+-- ## Reset all and clear the reference tree
+-- 
+--            menumgr:ResetMenuComplete()
+--            
+-- ## Set to auto-propagate for CLIENTs joining the SET_CLIENT **after** the script is loaded - handy if you have a single menu tree.
+-- 
+--            menumgr:InitAutoPropagation()
+--
+-- @field #CLIENTMENUMANAGER
+CLIENTMENUMANAGER = {
+  ClassName = "CLIENTMENUMANAGER",
+  lid = "",
+  version = "0.1.3",
+  name = nil,
+  clientset = nil,
+  menutree = {},
+  flattree = {},
+  playertree = {},
+  entrycount = 0,
+  rootentries = {},
+  debug = true,
+  PlayerMenu = {},
+  Coalition = nil,
+}
+
+--- Create a new ClientManager instance.
+-- @param #CLIENTMENUMANAGER self
+-- @param Core.Set#SET_CLIENT ClientSet The set of clients to manage.
+-- @param #string Alias The name of this manager.
+-- @param #number Coalition (Optional) Coalition of this Manager, defaults to coalition.side.BLUE
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:New(ClientSet, Alias, Coalition)
+  -- Inherit everything from FSM class.
+  local self=BASE:Inherit(self, BASE:New()) -- #CLIENTMENUMANAGER
+  self.clientset = ClientSet
+  self.PlayerMenu = {}
+  self.name = Alias or "Nightshift"
+  self.Coalition = Coalition or coalition.side.BLUE
+    -- Log id.
+  self.lid=string.format("CLIENTMENUMANAGER %s | %s | ", self.version, self.name)
+  if self.debug then
+    self:I(self.lid.."Created")
+  end
+  return self
+end
+
+--- [Internal] Event handling
+-- @param #CLIENTMENUMANAGER self
+-- @param Core.Event#EVENTDATA EventData
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:_EventHandler(EventData)
+  self:T(self.lid.."_EventHandler: "..EventData.id)
+  --self:I(self.lid.."_EventHandler: "..tostring(EventData.IniPlayerName))
+  if EventData.id == EVENTS.PlayerLeaveUnit or EventData.id == EVENTS.Ejection or EventData.id == EVENTS.Crash or EventData.id == EVENTS.PilotDead then
+    self:T(self.lid.."Leave event for player: "..tostring(EventData.IniPlayerName)) 
+    local Client = _DATABASE:FindClient( EventData.IniPlayerName )
+    if Client then
+      self:ResetMenu(Client)
+    end
+  elseif (EventData.id == EVENTS.PlayerEnterAircraft) and EventData.IniCoalition == self.Coalition then
+    if EventData.IniPlayerName and EventData.IniGroup then
+      if (not self.clientset:IsIncludeObject(_DATABASE:FindClient( EventData.IniPlayerName ))) then
+        self:T(self.lid.."Client not in SET: "..EventData.IniPlayerName)
+        return self
+      end
+      --self:I(self.lid.."Join event for player: "..EventData.IniPlayerName)
+      local player = _DATABASE:FindClient( EventData.IniPlayerName )
+      self:Propagate(player)
+    end
+  elseif EventData.id == EVENTS.PlayerEnterUnit then
+    -- special for CA slots
+    local grp = GROUP:FindByName(EventData.IniGroupName)
+    if grp:IsGround() then
+      self:T(string.format("Player %s entered GROUND unit %s!",EventData.IniPlayerName,EventData.IniUnitName))
+      local IsPlayer = EventData.IniDCSUnit:getPlayerName()
+      if IsPlayer then
+        
+        local client=_DATABASE.CLIENTS[EventData.IniDCSUnitName] --Wrapper.Client#CLIENT
+        
+        -- Add client in case it does not exist already.
+        if not client then
+          
+          -- Debug info.
+          self:I(string.format("Player '%s' joined ground unit '%s' of group '%s'", tostring(EventData.IniPlayerName), tostring(EventData.IniDCSUnitName), tostring(EventData.IniDCSGroupName)))
+        
+          client=_DATABASE:AddClient(EventData.IniDCSUnitName)
+            
+          -- Add player.
+          client:AddPlayer(EventData.IniPlayerName)
+          
+          -- Add player.
+          if not _DATABASE.PLAYERS[EventData.IniPlayerName] then
+            _DATABASE:AddPlayer( EventData.IniUnitName, EventData.IniPlayerName )
+          end
+          
+          -- Player settings.
+          local Settings = SETTINGS:Set( EventData.IniPlayerName )
+          Settings:SetPlayerMenu(EventData.IniUnit)
+        end
+        --local player = _DATABASE:FindClient( EventData.IniPlayerName )
+        self:Propagate(client)
+      end
+    end
+  end
+  
+  return self
+end
+
+--- Set this Client Manager to auto-propagate menus to newly joined players. Useful if you have **one** menu structure only.
+-- @param #CLIENTMENUMANAGER self
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:InitAutoPropagation()
+  -- Player Events
+  self:HandleEvent(EVENTS.PlayerLeaveUnit, self._EventHandler)
+  self:HandleEvent(EVENTS.Ejection, self._EventHandler)
+  self:HandleEvent(EVENTS.Crash, self._EventHandler)
+  self:HandleEvent(EVENTS.PilotDead, self._EventHandler)
+  self:HandleEvent(EVENTS.PlayerEnterAircraft, self._EventHandler)
+  self:HandleEvent(EVENTS.PlayerEnterUnit, self._EventHandler)
+  self:SetEventPriority(5) 
+  return self 
+end
+
+--- Create a new entry in the generic structure.
+-- @param #CLIENTMENUMANAGER self
+-- @param #string Text Text of the F10 menu entry.
+-- @param #CLIENTMENU Parent The parent menu entry.
+-- @param #string Function (optional) Function to call when the entry is used.
+-- @param ... (optional) Arguments for the Function, comma separated.
+-- @return #CLIENTMENU Entry
+function CLIENTMENUMANAGER:NewEntry(Text,Parent,Function,...)
+  self:T(self.lid.."NewEntry "..Text or "None")
+  self.entrycount = self.entrycount + 1
+  local entry = CLIENTMENU:NewEntry(nil,Text,Parent,Function,unpack(arg))
+  if not Parent then
+    self.rootentries[self.entrycount] = entry
+  end
+  local depth = #entry.path
+  if not self.menutree[depth] then self.menutree[depth] = {} end
+  table.insert(self.menutree[depth],entry.UUID)
+  self.flattree[entry.UUID] = entry
+  return entry
+end
+
+--- Check matching entry in the generic structure by UUID.
+-- @param #CLIENTMENUMANAGER self
+-- @param #string UUID UUID of the menu entry.
+-- @return #boolean Exists
+function CLIENTMENUMANAGER:EntryUUIDExists(UUID)
+  local exists = self.flattree[UUID] and true or false
+  return exists
+end
+
+--- Find matching entry in the generic structure by UUID.
+-- @param #CLIENTMENUMANAGER self
+-- @param #string UUID UUID of the menu entry.
+-- @return #CLIENTMENU Entry The #CLIENTMENU object found or nil.
+function CLIENTMENUMANAGER:FindEntryByUUID(UUID)
+  self:T(self.lid.."FindEntryByUUID "..UUID or "None")
+  local entry = nil
+  for _gid,_entry in pairs(self.flattree) do
+    local Entry = _entry -- #CLIENTMENU
+    if Entry and Entry.UUID == UUID then
+      entry = Entry
+    end
+  end
+  return entry
+end
+
+--- Find matching entries by text in the generic structure by UUID.
+-- @param #CLIENTMENUMANAGER self
+-- @param #string Text Text or partial text of the menu entry to find.
+-- @param #CLIENTMENU Parent (Optional) Only find entries under this parent entry.
+-- @return #table Table of matching UUIDs of #CLIENTMENU objects
+-- @return #table Table of matching #CLIENTMENU objects
+-- @return #number Number of matches
+function CLIENTMENUMANAGER:FindUUIDsByText(Text,Parent)
+  self:T(self.lid.."FindUUIDsByText "..Text or "None")
+  local matches = {}
+  local entries = {}
+  local n = 0
+  for _uuid,_entry in pairs(self.flattree) do
+    local Entry = _entry -- #CLIENTMENU
+    if Parent then
+      if Entry and string.find(Entry.name,Text,1,true) and string.find(Entry.UUID,Parent.UUID,1,true) then
+        table.insert(matches,_uuid)
+        table.insert(entries,Entry )
+        n=n+1
+      end
+    else
+      if Entry and string.find(Entry.name,Text,1,true) then
+        table.insert(matches,_uuid)
+        table.insert(entries,Entry )
+        n=n+1
+      end
+    end
+  end
+  return matches, entries, n
+end
+
+--- Find matching entries in the generic structure by the menu text.
+-- @param #CLIENTMENUMANAGER self
+-- @param #string Text Text or partial text of the F10 menu entry.
+-- @param #CLIENTMENU Parent (Optional) Only find entries under this parent entry.
+-- @return #table Table of matching #CLIENTMENU objects.
+-- @return #number Number of matches
+function CLIENTMENUMANAGER:FindEntriesByText(Text,Parent)
+  self:T(self.lid.."FindEntriesByText "..Text or "None")
+  local matches, objects, number = self:FindUUIDsByText(Text, Parent)
+  return objects, number
+end
+
+--- Find matching entries under a parent in the generic structure by UUID.
+-- @param #CLIENTMENUMANAGER self
+-- @param #CLIENTMENU Parent Find entries under this parent entry.
+-- @return #table Table of matching UUIDs of #CLIENTMENU objects
+-- @return #table Table of matching #CLIENTMENU objects
+-- @return #number Number of matches
+function CLIENTMENUMANAGER:FindUUIDsByParent(Parent)
+  self:T(self.lid.."FindUUIDsByParent")
+  local matches = {}
+  local entries = {}
+  local n = 0
+  for _uuid,_entry in pairs(self.flattree) do
+    local Entry = _entry -- #CLIENTMENU
+    if Parent then
+      if Entry and string.find(Entry.UUID,Parent.UUID,1,true) then
+        table.insert(matches,_uuid)
+        table.insert(entries,Entry )
+        n=n+1
+      end
+    end
+  end
+  return matches, entries, n
+end
+
+--- Find matching entries in the generic structure under a parent.
+-- @param #CLIENTMENUMANAGER self
+-- @param #CLIENTMENU Parent Find entries under this parent entry.
+-- @return #table Table of matching #CLIENTMENU objects.
+-- @return #number Number of matches
+function CLIENTMENUMANAGER:FindEntriesByParent(Parent)
+  self:T(self.lid.."FindEntriesByParent")
+  local matches, objects, number = self:FindUUIDsByParent(Parent)
+  return objects, number
+end
+
+--- Alter the text of a leaf entry in the generic structure and push to one specific client's F10 menu.
+-- @param #CLIENTMENUMANAGER self
+-- @param #CLIENTMENU Entry The menu entry.
+-- @param #string Text New Text of the F10 menu entry.
+-- @param Wrapper.Client#CLIENT Client (optional) The client for whom to alter the entry, if nil done for all clients.
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:ChangeEntryText(Entry, Text, Client)
+  self:T(self.lid.."ChangeEntryText "..Text or "None")
+  local newentry = CLIENTMENU:NewEntry(nil,Text,Entry.Parent,Entry.Function,unpack(Entry.Functionargs))
+  self:DeleteF10Entry(Entry,Client)
+  self:DeleteGenericEntry(Entry)
+  if not Entry.Parent then
+    self.rootentries[self.entrycount] = newentry
+  end
+  local depth = #newentry.path
+  if not self.menutree[depth] then self.menutree[depth] = {} end
+  table.insert(self.menutree[depth],newentry.UUID)
+  self.flattree[newentry.UUID] = newentry
+  self:AddEntry(newentry,Client)
+  return self
+end
+
+--- Push the complete menu structure to each of the clients in the set - refresh the menu tree of the clients.
+-- @param #CLIENTMENUMANAGER self
+-- @param Wrapper.Client#CLIENT Client (optional) If given, propagate only for this client.
+-- @return #CLIENTMENU Entry
+function CLIENTMENUMANAGER:Propagate(Client)
+  self:T(self.lid.."Propagate")
+  --self:I(UTILS.PrintTableToLog(Client,1))
+  local Set = self.clientset.Set
+  if Client then
+    Set = {Client}
+  end
+  self:ResetMenu(Client)
+  for _,_client in pairs(Set) do
+    local client = _client -- Wrapper.Client#CLIENT
+    if client and client:IsAlive() then
+      local playername = client:GetPlayerName()
+        if not self.playertree[playername] then
+          self.playertree[playername] = {}
+        end
+        for level,branch in pairs (self.menutree) do
+          self:T("Building branch:" .. level)
+          for _,leaf in pairs(branch) do
+            self:T("Building leaf:" .. leaf)
+            local entry = self:FindEntryByUUID(leaf)
+            if entry then
+              self:T("Found generic entry:" .. entry.UUID)
+              local parent = nil
+              if entry.Parent and entry.Parent.UUID then
+                parent = self.playertree[playername][entry.Parent.UUID] or self:FindEntryByUUID(entry.Parent.UUID)
+              end
+              self.playertree[playername][entry.UUID] = CLIENTMENU:NewEntry(client,entry.name,parent,entry.Function,unpack(entry.Functionargs))
+              self.playertree[playername][entry.UUID].Once = entry.Once
+            else
+              self:T("NO generic entry for:" .. leaf)
+            end  
+          end
+        end
+    end
+  end
+  return self
+end
+
+--- Push a single previously created entry into the menu structure of all clients.
+-- @param #CLIENTMENUMANAGER self
+-- @param #CLIENTMENU Entry The entry to add.
+-- @param Wrapper.Client#CLIENT Client (optional) If given, make this change only for this client. 
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:AddEntry(Entry,Client)
+  self:T(self.lid.."AddEntry")
+  local Set = self.clientset.Set
+  if Client then
+    Set = {Client}
+  end
+  for _,_client in pairs(Set) do
+    local client = _client -- Wrapper.Client#CLIENT
+    if client and client:IsAlive() then
+      local playername = client:GetPlayerName()
+      if Entry then
+        self:T("Adding generic entry:" .. Entry.UUID)
+        local parent = nil
+        if not self.playertree[playername] then
+          self.playertree[playername] = {}
+        end
+        if Entry.Parent and Entry.Parent.UUID then
+          parent = self.playertree[playername][Entry.Parent.UUID] or self:FindEntryByUUID(Entry.Parent.UUID)
+        end
+        self.playertree[playername][Entry.UUID] = CLIENTMENU:NewEntry(client,Entry.name,parent,Entry.Function,unpack(Entry.Functionargs))
+        self.playertree[playername][Entry.UUID].Once = Entry.Once
+      else
+        self:T("NO generic entry given")
+      end 
+    end
+  end
+  return self
+end
+
+--- Blank out the menu - remove **all root entries** and all entries below from the client's F10 menus, leaving the generic structure untouched.
+-- @param #CLIENTMENUMANAGER self
+-- @param Wrapper.Client#CLIENT Client (optional) If given, remove only for this client.
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:ResetMenu(Client)
+  self:T(self.lid.."ResetMenu")
+  for _,_entry in pairs(self.rootentries) do
+    --local RootEntry = self.structure.generic[_entry]
+    if _entry then
+      self:DeleteF10Entry(_entry,Client)
+    end
+  end
+  return self
+end
+
+--- Blank out the menu - remove **all root entries** and all entries below from all clients' F10 menus, and **delete** the generic structure.
+-- @param #CLIENTMENUMANAGER self
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:ResetMenuComplete()
+  self:T(self.lid.."ResetMenuComplete")
+  for _,_entry in pairs(self.rootentries) do
+    --local RootEntry = self.structure.generic[_entry]
+    if _entry then
+      self:DeleteF10Entry(_entry)
+    end
+  end
+  self.playertree = nil
+  self.playertree = {}
+  self.rootentries = nil
+  self.rootentries = {}
+  self.menutree = nil
+  self.menutree = {}
+  return self
+end
+
+--- Remove the entry and all entries below the given entry from the client's F10 menus.
+-- @param #CLIENTMENUMANAGER self
+-- @param #CLIENTMENU Entry The entry to remove
+-- @param Wrapper.Client#CLIENT Client (optional) If given, make this change only for this client. 
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:DeleteF10Entry(Entry,Client)
+  self:T(self.lid.."DeleteF10Entry")
+  local Set = self.clientset.Set
+  if Client then
+    Set = {Client}
+  end
+  for _,_client in pairs(Set) do
+    if _client and _client:IsAlive() then
+      local playername = _client:GetPlayerName()
+      if self.playertree[playername] then
+        local centry = self.playertree[playername][Entry.UUID] -- #CLIENTMENU
+        if centry then
+          --self:I("Match for "..Entry.UUID)
+          centry:Clear()
+        end
+      end
+    end
+  end
+  return self
+end
+
+--- Remove the entry and all entries below the given entry from the generic tree.
+-- @param #CLIENTMENUMANAGER self
+-- @param #CLIENTMENU Entry The entry to remove
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:DeleteGenericEntry(Entry)
+  self:T(self.lid.."DeleteGenericEntry")
+  
+  if Entry.Children and #Entry.Children > 0 then
+    self:RemoveGenericSubEntries(Entry)
+  end
+  
+  local depth = #Entry.path
+  local uuid = Entry.UUID
+  
+  local tbl = UTILS.DeepCopy(self.menutree)
+  
+  if tbl[depth] then
+    for i=depth,#tbl do
+      --self:I("Level = "..i)
+      for _id,_uuid in pairs(tbl[i]) do
+        self:T(_uuid)
+        if string.find(_uuid,uuid,1,true) or _uuid == uuid then
+          --self:I("Match for ".._uuid)
+          self.menutree[i][_id] = nil
+          self.flattree[_uuid] = nil
+        end  
+      end 
+    end
+  end
+  
+  return self
+end
+
+--- Remove all entries below the given entry from the generic tree.
+-- @param #CLIENTMENUMANAGER self
+-- @param #CLIENTMENU Entry The entry where to start. This entry stays.
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:RemoveGenericSubEntries(Entry)
+  self:T(self.lid.."RemoveGenericSubEntries")
+  
+  local depth = #Entry.path + 1
+  local uuid = Entry.UUID
+  
+  local tbl = UTILS.DeepCopy(self.menutree)
+  
+  if tbl[depth] then
+    for i=depth,#tbl do
+      self:T("Level = "..i)
+      for _id,_uuid in pairs(tbl[i]) do
+        self:T(_uuid)
+        if string.find(_uuid,uuid,1,true) then
+          self:T("Match for ".._uuid)
+          self.menutree[i][_id] = nil
+          self.flattree[_uuid] = nil
+        end  
+      end 
+    end
+  end  
+  return self
+end
+
+
+--- Remove all entries below the given entry from the client's F10 menus.
+-- @param #CLIENTMENUMANAGER self
+-- @param #CLIENTMENU Entry The entry where to start. This entry stays.
+-- @param Wrapper.Client#CLIENT Client (optional) If given, make this change only for this client. In this case the generic structure will not be touched.
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:RemoveF10SubEntries(Entry,Client)
+  self:T(self.lid.."RemoveSubEntries")
+  local Set = self.clientset.Set
+  if Client then
+    Set = {Client}
+  end
+  for _,_client in pairs(Set) do
+    if _client and _client:IsAlive() then
+      local playername = _client:GetPlayerName()
+      if self.playertree[playername] then
+        local centry = self.playertree[playername][Entry.UUID] -- #CLIENTMENU
+        centry:RemoveSubEntries()
+      end
+    end
+  end
+  return self
+end
+
+----------------------------------------------------------------------------------------------------------------
+--
+-- End ClientMenu
+--
+----------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Core/Condition.lua

@@ -9,7 +9,7 @@
 --
 -- ## Example Missions:
 --
--- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/OPS%20-%20Operation).
+-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Core/Condition).
 --
 -- ===
 --

Moose Development/Moose/Core/Database.lua

@@ -31,8 +31,7 @@
 -- @module Core.Database
 -- @image Core_Database.JPG
 
-
---- DATABASE class.
+---
 -- @type DATABASE
 -- @field #string ClassName Name of the class.
 -- @field #table Templates Templates: Units, Groups, Statics, ClientsByName, ClientsByID.
@@ -127,6 +126,8 @@ function DATABASE:New()
   self:SetEventPriority( 1 )
 
   self:HandleEvent( EVENTS.Birth, self._EventOnBirth )
+  -- DCS 2.9 fixed CA event for players -- TODO: reset unit when leaving
+  self:HandleEvent( EVENTS.PlayerEnterUnit, self._EventOnPlayerEnterUnit )
   self:HandleEvent( EVENTS.Dead, self._EventOnDeadOrCrash )
   self:HandleEvent( EVENTS.Crash, self._EventOnDeadOrCrash )
   self:HandleEvent( EVENTS.RemoveUnit, self._EventOnDeadOrCrash )
@@ -681,7 +682,7 @@ do -- cargo
   --- Finds an CARGO based on the CargoName.
   -- @param #DATABASE self
   -- @param #string CargoName
-  -- @return Wrapper.Cargo#CARGO The found CARGO.
+  -- @return Cargo.Cargo#CARGO The found CARGO.
   function DATABASE:FindCargo( CargoName )
 
     local CargoFound = self.CARGOS[CargoName]
@@ -811,6 +812,7 @@ function DATABASE:AddPlayer( UnitName, PlayerName )
     self.PLAYERUNITS[PlayerName] = self:FindUnit( UnitName )
     self.PLAYERSJOINED[PlayerName] = PlayerName
   end
+  
 end
 
 --- Deletes a player from the DATABASE based on the Player Name.
@@ -1369,7 +1371,7 @@ function DATABASE:_EventOnBirth( Event )
       if PlayerName then
 
         -- Debug info.
-        self:I(string.format("Player '%s' joint unit '%s' of group '%s'", tostring(PlayerName), tostring(Event.IniDCSUnitName), tostring(Event.IniDCSGroupName)))
+        self:I(string.format("Player '%s' joined unit '%s' of group '%s'", tostring(PlayerName), tostring(Event.IniDCSUnitName), tostring(Event.IniDCSGroupName)))
 
         -- Add client in case it does not exist already.
         if not client then
@@ -1471,39 +1473,43 @@ function DATABASE:_EventOnDeadOrCrash( Event )
 end
 
 
---- Handles the OnPlayerEnterUnit event to fill the active players table (with the unit filter applied).
+--- Handles the OnPlayerEnterUnit event to fill the active players table for CA units (with the unit filter applied).
 -- @param #DATABASE self
 -- @param Core.Event#EVENTDATA Event
 function DATABASE:_EventOnPlayerEnterUnit( Event )
   self:F2( { Event } )
 
   if Event.IniDCSUnit then
-    if Event.IniObjectCategory == 1 then
+    -- Player entering a CA slot
+    if Event.IniObjectCategory == 1 and Event.IniGroup and Event.IniGroup:IsGround() then
+        
+      local IsPlayer = Event.IniDCSUnit:getPlayerName()
+      if IsPlayer then
 
-      -- Add unit.
-      self:AddUnit( Event.IniDCSUnitName )
+        -- Debug info.
+        self:I(string.format("Player '%s' joined GROUND unit '%s' of group '%s'", tostring(Event.IniPlayerName), tostring(Event.IniDCSUnitName), tostring(Event.IniDCSGroupName)))
+        
+        local client= self.CLIENTS[Event.IniDCSUnitName] --Wrapper.Client#CLIENT
+        
+        -- Add client in case it does not exist already.
+        if not client then
+          client=self:AddClient(Event.IniDCSUnitName)
+        end
+              
+        -- Add player.
+        client:AddPlayer(Event.IniPlayerName)
 
-      -- Ini unit.
-      Event.IniUnit = self:FindUnit( Event.IniDCSUnitName )
-
-      -- Add group.
-      self:AddGroup( Event.IniDCSGroupName )
-
-      -- Get player unit.
-      local PlayerName = Event.IniDCSUnit:getPlayerName()
-
-      if PlayerName then
-
-        if not self.PLAYERS[PlayerName] then
-          self:AddPlayer( Event.IniDCSUnitName, PlayerName )
+        -- Add player.
+        if not self.PLAYERS[Event.IniPlayerName] then
+          self:AddPlayer( Event.IniUnitName, Event.IniPlayerName )
         end
 
-        local Settings = SETTINGS:Set( PlayerName )
-        Settings:SetPlayerMenu( Event.IniUnit )
+        -- Player settings.
+        local Settings = SETTINGS:Set( Event.IniPlayerName )
+        Settings:SetPlayerMenu(Event.IniUnit)
 
-      else
-        self:E("ERROR: getPlayerName() returned nil for event PlayerEnterUnit")
       end
+
     end
   end
 end
@@ -1514,15 +1520,26 @@ end
 -- @param Core.Event#EVENTDATA Event
 function DATABASE:_EventOnPlayerLeaveUnit( Event )
   self:F2( { Event } )
-
+  
+  local function FindPlayerName(UnitName)
+    local playername = nil
+    for _name,_unitname in pairs(self.PLAYERS) do
+      if _unitname == UnitName then
+        playername = _name
+        break
+      end
+    end
+    return playername
+  end
+  
   if Event.IniUnit then
 
     if Event.IniObjectCategory == 1 then
 
       -- Try to get the player name. This can be buggy for multicrew aircraft!
-      local PlayerName = Event.IniUnit:GetPlayerName()
-
-      if PlayerName then --and self.PLAYERS[PlayerName] then
+      local PlayerName = Event.IniUnit:GetPlayerName() or FindPlayerName(Event.IniUnitName)
+          
+      if PlayerName then
 
         -- Debug info.
         self:I(string.format("Player '%s' left unit %s", tostring(PlayerName), tostring(Event.IniUnitName)))
@@ -1849,13 +1866,13 @@ function DATABASE:GetFlightControl(airbasename)
   return self.FLIGHTCONTROLS[airbasename]
 end
 
---- @param #DATABASE self
+-- @param #DATABASE self
 function DATABASE:_RegisterTemplates()
   self:F2()
 
   self.Navpoints = {}
   self.UNITS = {}
-  --Build routines.db.units and self.Navpoints
+  --Build self.Navpoints
   for CoalitionName, coa_data in pairs(env.mission.coalition) do
     self:T({CoalitionName=CoalitionName})
 
@@ -1877,7 +1894,7 @@ function DATABASE:_RegisterTemplates()
         for nav_ind, nav_data in pairs(coa_data.nav_points) do
 
           if type(nav_data) == 'table' then
-            self.Navpoints[CoalitionName][nav_ind] = routines.utils.deepCopy(nav_data)
+            self.Navpoints[CoalitionName][nav_ind] = UTILS.DeepCopy(nav_data)
 
             self.Navpoints[CoalitionName][nav_ind]['name'] = nav_data.callsignStr  -- name is a little bit more self-explanatory.
             self.Navpoints[CoalitionName][nav_ind]['point'] = {}  -- point is used by SSE, support it.
@@ -2006,8 +2023,6 @@ end
       TargetPlayerName = Event.IniPlayerName
 
       TargetCoalition = Event.IniCoalition
-      --TargetCategory = TargetUnit:getCategory()
-      --TargetCategory = TargetUnit:getDesc().category  -- Workaround
       TargetCategory = Event.IniCategory
       TargetType = Event.IniTypeName
 

Moose Development/Moose/Core/Event.lua

@@ -173,7 +173,8 @@
 -- @image Core_Event.JPG
 
 
---- @type EVENT
+---
+-- @type EVENT
 -- @field #EVENT.Events Events
 -- @extends Core.Base#BASE
 
@@ -282,6 +283,7 @@ EVENTS = {
 -- @field Wrapper.Group#GROUP IniGroup (UNIT) The initiating MOOSE wrapper @{Wrapper.Group#GROUP} of the initiator Group object.
 -- @field #string IniGroupName UNIT) The initiating GROUP name (same as IniDCSGroupName).
 -- @field #string IniPlayerName (UNIT) The name of the initiating player in case the Unit is a client or player slot.
+-- @field #string IniPlayerUCID (UNIT) The UCID of the initiating player in case the Unit is a client or player slot and on a multi-player server.
 -- @field DCS#coalition.side IniCoalition (UNIT) The coalition of the initiator.
 -- @field DCS#Unit.Category IniCategory (UNIT) The category of the initiator.
 -- @field #string IniTypeName (UNIT) The type name of the initiator.
@@ -297,6 +299,7 @@ EVENTS = {
 -- @field Wrapper.Group#GROUP TgtGroup (UNIT) The target MOOSE wrapper @{Wrapper.Group#GROUP} of the target Group object.
 -- @field #string TgtGroupName (UNIT) The target GROUP name (same as TgtDCSGroupName).
 -- @field #string TgtPlayerName (UNIT) The name of the target player in case the Unit is a client or player slot.
+-- @field #string TgtPlayerUCID (UNIT) The UCID of the target player in case the Unit is a client or player slot and on a multi-player server.
 -- @field DCS#coalition.side TgtCoalition (UNIT) The coalition of the target.
 -- @field DCS#Unit.Category TgtCategory (UNIT) The category of the target.
 -- @field #string TgtTypeName (UNIT) The type name of the target.
@@ -313,7 +316,7 @@ EVENTS = {
 -- @field Cargo.Cargo#CARGO Cargo The cargo object.
 -- @field #string CargoName The name of the cargo object.
 --
--- @field Core.ZONE#ZONE Zone The zone object.
+-- @field Core.Zone#ZONE Zone The zone object.
 -- @field #string ZoneName The name of the zone.
 
 
@@ -988,7 +991,7 @@ do -- Event Creation
 
   --- Creation of a New ZoneGoal Event.
   -- @param #EVENT self
-  -- @param Core.Functional#ZONE_GOAL ZoneGoal The ZoneGoal created.
+  -- @param Functional.ZoneGoal#ZONE_GOAL ZoneGoal The ZoneGoal created.
   function EVENT:CreateEventNewZoneGoal( ZoneGoal )
     self:F( { ZoneGoal } )
 
@@ -1080,9 +1083,9 @@ function EVENT:onEvent( Event )
 
       if Event.initiator then
 
-        Event.IniObjectCategory = Event.initiator:getCategory()
+        Event.IniObjectCategory = Object.getCategory(Event.initiator)
         
-       if Event.IniObjectCategory == Object.Category.STATIC then
+        if Event.IniObjectCategory == Object.Category.STATIC then
           ---
           -- Static
           ---          
@@ -1118,10 +1121,9 @@ function EVENT:onEvent( Event )
           local Unit=UNIT:FindByName(Event.IniDCSUnitName)
           if Unit then
             Event.IniObjectCategory = Object.Category.UNIT
-          end
-        end        
+          end       
 
-        if Event.IniObjectCategory == Object.Category.UNIT then
+        elseif Event.IniObjectCategory == Object.Category.UNIT then
           ---
           -- Unit
           ---        
@@ -1144,12 +1146,19 @@ function EVENT:onEvent( Event )
           end
           
           Event.IniPlayerName = Event.IniDCSUnit:getPlayerName()
+          if Event.IniPlayerName then
+            -- get UUCID
+            local PID = NET.GetPlayerIDByName(nil,Event.IniPlayerName)
+            if PID then
+              Event.IniPlayerUCID = net.get_player_info(tonumber(PID), 'ucid')
+              --env.info("Event.IniPlayerUCID="..tostring(Event.IniPlayerUCID),false)
+            end
+          end
           Event.IniCoalition = Event.IniDCSUnit:getCoalition()
           Event.IniTypeName = Event.IniDCSUnit:getTypeName()
           Event.IniCategory = Event.IniDCSUnit:getDesc().category  
-        end
 
-        if Event.IniObjectCategory == Object.Category.CARGO then
+        elseif Event.IniObjectCategory == Object.Category.CARGO then
           ---
           -- Cargo
           ---
@@ -1160,9 +1169,8 @@ function EVENT:onEvent( Event )
           Event.IniCoalition = Event.IniDCSUnit:getCoalition()
           Event.IniCategory = Event.IniDCSUnit:getDesc().category
           Event.IniTypeName = Event.IniDCSUnit:getTypeName()
-        end
 
-        if Event.IniObjectCategory == Object.Category.SCENERY then
+        elseif Event.IniObjectCategory == Object.Category.SCENERY then
           ---
           -- Scenery
           ---          
@@ -1172,9 +1180,8 @@ function EVENT:onEvent( Event )
           Event.IniUnit = SCENERY:Register( Event.IniDCSUnitName, Event.initiator )
           Event.IniCategory = Event.IniDCSUnit:getDesc().category
           Event.IniTypeName = Event.initiator:isExist() and Event.IniDCSUnit:getTypeName() or "SCENERY"
-        end
 
-        if Event.IniObjectCategory == Object.Category.BASE then
+        elseif Event.IniObjectCategory == Object.Category.BASE then
           ---
           -- Base Object
           ---
@@ -1201,9 +1208,12 @@ function EVENT:onEvent( Event )
         ---
 
         -- Target category.
-        Event.TgtObjectCategory = Event.target:getCategory()
+        Event.TgtObjectCategory = Object.getCategory(Event.target)
 
         if Event.TgtObjectCategory == Object.Category.UNIT then
+          ---
+          -- UNIT
+          ---
           Event.TgtDCSUnit = Event.target
           Event.TgtDCSGroup = Event.TgtDCSUnit:getGroup()
           Event.TgtDCSUnitName = Event.TgtDCSUnit:getName()
@@ -1216,13 +1226,22 @@ function EVENT:onEvent( Event )
             Event.TgtGroupName = Event.TgtDCSGroupName
           end
           Event.TgtPlayerName = Event.TgtDCSUnit:getPlayerName()
+          if Event.TgtPlayerName  then
+            -- get UUCID
+            local PID = NET.GetPlayerIDByName(nil,Event.TgtPlayerName)
+            if PID then
+              Event.TgtPlayerUCID = net.get_player_info(tonumber(PID), 'ucid')
+              --env.info("Event.TgtPlayerUCID="..tostring(Event.TgtPlayerUCID),false)
+            end
+          end
           Event.TgtCoalition = Event.TgtDCSUnit:getCoalition()
           Event.TgtCategory = Event.TgtDCSUnit:getDesc().category
           Event.TgtTypeName = Event.TgtDCSUnit:getTypeName()
-        end
 
-        if Event.TgtObjectCategory == Object.Category.STATIC then
-          -- get base data
+        elseif Event.TgtObjectCategory == Object.Category.STATIC then
+          ---
+          -- STATIC
+          ---
           Event.TgtDCSUnit = Event.target
           if Event.target:isExist() and Event.id ~= 33 then -- leave out ejected seat object
             Event.TgtDCSUnitName = Event.TgtDCSUnit:getName()
@@ -1249,9 +1268,11 @@ function EVENT:onEvent( Event )
               Event.TgtTypeName = "Static"
             end
           end
-        end
 
-        if Event.TgtObjectCategory == Object.Category.SCENERY then
+        elseif Event.TgtObjectCategory == Object.Category.SCENERY then
+          ---
+          -- SCENERY
+          ---
           Event.TgtDCSUnit = Event.target
           Event.TgtDCSUnitName = Event.TgtDCSUnit:getName()
           Event.TgtUnitName = Event.TgtDCSUnitName
@@ -1281,7 +1302,7 @@ function EVENT:onEvent( Event )
           -- However, this is not a big thing, as the aircraft the pilot ejected from is usually long crashed before the ejected pilot touches the ground.
           --Event.Place=UNIT:Find(Event.place)
         else  
-          if Event.place:isExist() and Event.place:getCategory() ~= Object.Category.SCENERY then
+          if Event.place:isExist() and Object.getCategory(Event.place) ~= Object.Category.SCENERY then
             Event.Place=AIRBASE:Find(Event.place)
             Event.PlaceName=Event.Place:GetName()
           end

Moose Development/Moose/Core/Fsm.lua

@@ -249,7 +249,7 @@ do -- FSM
   --
   -- ### Linear Transition Example
   --
-  -- This example is fully implemented in the MOOSE test mission on GITHUB: [FSM-100 - Transition Explanation](https://github.com/FlightControl-Master/MOOSE/blob/master/Moose%20Test%20Missions/FSM%20-%20Finite%20State%20Machine/FSM-100%20-%20Transition%20Explanation/FSM-100%20-%20Transition%20Explanation.lua)
+  -- This example is fully implemented in the MOOSE test mission on GITHUB: [FSM-100 - Transition Explanation](https://github.com/FlightControl-Master/MOOSE_MISSIONS/blob/master/FSM%20-%20Finite%20State%20Machine/FSM-100%20-%20Transition%20Explanation/FSM-100%20-%20Transition%20Explanation.lua)
   --
   -- It models a unit standing still near Batumi, and flaring every 5 seconds while switching between a Green flare and a Red flare.
   -- The purpose of this example is not to show how exciting flaring is, but it demonstrates how a Linear Transition FSM can be build.
@@ -1260,7 +1260,7 @@ do -- FSM_PROCESS
 
   --- Assign the process to a @{Wrapper.Unit} and activate the process.
   -- @param #FSM_PROCESS self
-  -- @param Task.Tasking#TASK Task
+  -- @param Tasking.Task#TASK Task
   -- @param Wrapper.Unit#UNIT ProcessUnit
   -- @return #FSM_PROCESS self
   function FSM_PROCESS:Assign( ProcessUnit, Task )

Moose Development/Moose/Core/Menu.lua

@@ -513,7 +513,7 @@ do -- MENU_COALITION
   --- @type MENU_COALITION
   -- @extends Core.Menu#MENU_BASE
   
-  --- Manages the main menus for @{DCS.coalition}s.  
+  --- Manages the main menus for DCS.coalition.
   -- 
   -- You can add menus with the @{#MENU_COALITION.New} method, which constructs a MENU_COALITION object and returns you the object reference.
   -- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_COALITION.Remove}.

Moose Development/Moose/Core/Message.lua

@@ -52,7 +52,7 @@
 -- ===
 --
 -- ### Author: **FlightControl**
--- ### Contributions:
+-- ### Contributions: **Applevangelist**
 --
 -- ===
 --
@@ -73,7 +73,7 @@ MESSAGE.Type = {
   Detailed = "Detailed Report",
 }
 
---- Creates a new MESSAGE object. Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions @{ToClient} or @{ToCoalition} or @{ToAll} to send these Messages to the respective recipients.
+--- Creates a new MESSAGE object. Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions @{#MESSAGE.ToClient} or @{#MESSAGE.ToCoalition} or @{#MESSAGE.ToAll} to send these Messages to the respective recipients.
 -- @param self
 -- @param #string MessageText is the text of the Message.
 -- @param #number MessageDuration is a number in seconds of how long the MESSAGE should be shown on the display panel.
@@ -127,7 +127,7 @@ end
 
 --- Creates a new MESSAGE object of a certain type.
 -- Note that these MESSAGE objects are not yet displayed on the display panel.
--- You must use the functions @{ToClient} or @{ToCoalition} or @{ToAll} to send these Messages to the respective recipients.
+-- You must use the functions @{Core.Message#ToClient} or @{Core.Message#ToCoalition} or @{Core.Message#ToAll} to send these Messages to the respective recipients.
 -- The message display times are automatically defined based on the timing settings in the @{Core.Settings} menu.
 -- @param self
 -- @param #string MessageText is the text of the Message.
@@ -343,7 +343,7 @@ end
 
 --- Sends a MESSAGE to a Coalition.
 -- @param #MESSAGE self
--- @param #DCS.coalition.side CoalitionSide @{#DCS.coalition.side} to which the message is displayed.
+-- @param DCS#coalition.side CoalitionSide @{#DCS.coalition.side} to which the message is displayed.
 -- @param Core.Settings#SETTINGS Settings (Optional) Settings for message display.
 -- @return #MESSAGE Message object.
 -- @usage
@@ -371,13 +371,15 @@ function MESSAGE:ToCoalition( CoalitionSide, Settings )
       trigger.action.outTextForCoalition( CoalitionSide, self.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ), self.MessageDuration, self.ClearScreen )
     end
   end
-
+  
+  self.CoalitionSide = CoalitionSide
+  
   return self
 end
 
 --- Sends a MESSAGE to a Coalition if the given Condition is true.
 -- @param #MESSAGE self
--- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}.
+-- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{#DCS.coalition.side}.
 -- @param #boolean Condition Sends the message only if the condition is true.
 -- @return #MESSAGE self
 function MESSAGE:ToCoalitionIf( CoalitionSide, Condition )
@@ -454,3 +456,163 @@ function MESSAGE:ToLogIf( Condition )
   end
   return self
 end
+
+_MESSAGESRS = {}
+
+--- Set up MESSAGE generally to allow Text-To-Speech via SRS and TTS functions.
+-- @param #string PathToSRS Path to SRS Folder, defaults to "C:\\\\Program Files\\\\DCS-SimpleRadio-Standalone".
+-- @param #number Port Port number of SRS, defaults to 5002.
+-- @param #string PathToCredentials (optional) Path to credentials file for e.g. Google.
+-- @param #number Frequency Frequency in MHz. Can also be given as a #table of frequencies.
+-- @param #number Modulation Modulation, i.e. radio.modulation.AM  or radio.modulation.FM. Can also be given as a #table of modulations.
+-- @param #string Gender (optional) Gender, i.e. "male" or "female", defaults to "female".
+-- @param #string Culture (optional) Culture, e.g. "en-US", defaults to "en-GB"
+-- @param #string Voice (optional) Voice. Will override gender and culture settings, e.g. MSRS.Voices.Microsoft.Hazel or MSRS.Voices.Google.Standard.de_DE_Standard_D. Hint on Microsoft voices - working voices are limited to Hedda, Hazel, David, Zira and Hortense. **Must** be installed on your Desktop or Server!
+-- @param #number Coalition (optional) Coalition, can be coalition.side.RED, coalition.side.BLUE or coalition.side.NEUTRAL. Defaults to coalition.side.NEUTRAL.
+-- @param #number Volume (optional) Volume, can be between 0.0 and 1.0 (loudest).
+-- @param #string Label (optional) Label, defaults to "MESSAGE" or the Message Category set.
+-- @param Core.Point#COORDINATE Coordinate (optional) Coordinate this messages originates from.
+-- @usage
+--          -- Mind the dot here, not using the colon this time around!
+--          -- Needed once only
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
+--          -- later on in your code
+--          MESSAGE:New("Test message!",15,"SPAWN"):ToSRS()
+--          
+function MESSAGE.SetMSRS(PathToSRS,Port,PathToCredentials,Frequency,Modulation,Gender,Culture,Voice,Coalition,Volume,Label,Coordinate)
+  _MESSAGESRS.MSRS = MSRS:New(PathToSRS,Frequency or 243,Modulation or radio.modulation.AM,Volume)
+  
+  _MESSAGESRS.frequency = Frequency
+  _MESSAGESRS.modulation = Modulation or radio.modulation.AM
+  
+  _MESSAGESRS.MSRS:SetCoalition(Coalition or coalition.side.NEUTRAL)
+  _MESSAGESRS.coalition = Coalition or coalition.side.NEUTRAL
+  
+  _MESSAGESRS.coordinate = Coordinate
+  _MESSAGESRS.MSRS:SetCoordinate(Coordinate)
+  
+  _MESSAGESRS.MSRS:SetCulture(Culture)
+  _MESSAGESRS.Culture = Culture or "en-GB"
+
+  _MESSAGESRS.MSRS:SetGender(Gender)
+  _MESSAGESRS.Gender = Gender or "female"
+
+  _MESSAGESRS.MSRS:SetGoogle(PathToCredentials)
+  _MESSAGESRS.google = PathToCredentials
+
+  _MESSAGESRS.MSRS:SetLabel(Label or "MESSAGE")
+  _MESSAGESRS.label = Label or "MESSAGE"
+
+  _MESSAGESRS.MSRS:SetPort(Port or 5002)
+  _MESSAGESRS.port = Port or 5002
+  
+  _MESSAGESRS.volume = Volume or 1
+  _MESSAGESRS.MSRS:SetVolume(_MESSAGESRS.volume)
+  
+  if Voice then _MESSAGESRS.MSRS:SetVoice(Voice) end
+  
+  _MESSAGESRS.voice = Voice --or MSRS.Voices.Microsoft.Hedda
+  --if _MESSAGESRS.google and not Voice then _MESSAGESRS.Voice = MSRS.Voices.Google.Standard.en_GB_Standard_A end
+  --_MESSAGESRS.MSRS:SetVoice(Voice or _MESSAGESRS.voice)
+  
+  _MESSAGESRS.SRSQ = MSRSQUEUE:New(Label or "MESSAGE")
+end
+
+--- Sends a message via SRS.
+-- @param #MESSAGE self
+-- @param #number frequency (optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with `MESSAGE.SetMSRS()` for this one setting.
+-- @param #number modulation (optional) Modulation, i.e. radio.modulation.AM  or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with `MESSAGE.SetMSRS()` for this one setting.
+-- @param #string gender (optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #string culture (optional) Culture, e.g. "en-US". Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #string voice (optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #number coalition (optional) Coalition, can be coalition.side.RED, coalition.side.BLUE or coalition.side.NEUTRAL. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #number volume (optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param Core.Point#COORDINATE coordinate (optional) Coordinate this messages originates from. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @return #MESSAGE self
+-- @usage
+--          -- Mind the dot here, not using the colon this time around!
+--          -- Needed once only
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
+--          -- later on in your code
+--          MESSAGE:New("Test message!",15,"SPAWN"):ToSRS()
+--          
+function MESSAGE:ToSRS(frequency,modulation,gender,culture,voice,coalition,volume,coordinate)
+  local tgender = gender or _MESSAGESRS.Gender
+  if _MESSAGESRS.SRSQ then
+      if voice then
+        _MESSAGESRS.MSRS:SetVoice(voice or _MESSAGESRS.voice)
+      end
+      if coordinate then
+        _MESSAGESRS.MSRS:SetCoordinate(coordinate)  
+      end
+      local category = string.gsub(self.MessageCategory,":","")
+      _MESSAGESRS.SRSQ:NewTransmission(self.MessageText,nil,_MESSAGESRS.MSRS,nil,nil,nil,nil,nil,frequency or _MESSAGESRS.frequency,modulation or _MESSAGESRS.modulation, gender or _MESSAGESRS.Gender,culture or _MESSAGESRS.Culture,nil,volume or _MESSAGESRS.volume,category,coordinate or _MESSAGESRS.coordinate)
+  end
+  return self
+end
+
+--- Sends a message via SRS on the blue coalition side.
+-- @param #MESSAGE self
+-- @param #number frequency (optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with `MESSAGE.SetMSRS()` for this one setting.
+-- @param #number modulation (optional) Modulation, i.e. radio.modulation.AM  or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with `MESSAGE.SetMSRS()` for this one setting.
+-- @param #string gender (optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #string culture (optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #string voice (optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #number volume (optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param Core.Point#COORDINATE coordinate (optional) Coordinate this messages originates from. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @return #MESSAGE self
+-- @usage
+--          -- Mind the dot here, not using the colon this time around!
+--          -- Needed once only
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
+--          -- later on in your code
+--          MESSAGE:New("Test message!",15,"SPAWN"):ToSRSBlue()
+--          
+function MESSAGE:ToSRSBlue(frequency,modulation,gender,culture,voice,volume,coordinate)
+  self:ToSRS(frequency,modulation,gender,culture,voice,coalition.side.BLUE,volume,coordinate)
+  return self
+end
+
+--- Sends a message via SRS on the red coalition side.
+-- @param #MESSAGE self
+-- @param #number frequency (optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with `MESSAGE.SetMSRS()` for this one setting.
+-- @param #number modulation (optional) Modulation, i.e. radio.modulation.AM  or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with `MESSAGE.SetMSRS()` for this one setting.
+-- @param #string gender (optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #string culture (optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #string voice (optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #number volume (optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param Core.Point#COORDINATE coordinate (optional) Coordinate this messages originates from. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @return #MESSAGE self
+-- @usage
+--          -- Mind the dot here, not using the colon this time around!
+--          -- Needed once only
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.RED)
+--          -- later on in your code
+--          MESSAGE:New("Test message!",15,"SPAWN"):ToSRSRed()
+--          
+function MESSAGE:ToSRSRed(frequency,modulation,gender,culture,voice,volume,coordinate)
+  self:ToSRS(frequency,modulation,gender,culture,voice,coalition.side.RED,volume,coordinate)
+  return self
+end
+
+--- Sends a message via SRS to all - via the neutral coalition side.
+-- @param #MESSAGE self
+-- @param #number frequency (optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with `MESSAGE.SetMSRS()` for this one setting.
+-- @param #number modulation (optional) Modulation, i.e. radio.modulation.AM  or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with `MESSAGE.SetMSRS()` for this one setting.
+-- @param #string gender (optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #string culture (optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #string voice (optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param #number volume (optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @param Core.Point#COORDINATE coordinate (optional) Coordinate this messages originates from. Only needed if you want to change defaults set with `MESSAGE.SetMSRS()`.
+-- @return #MESSAGE self
+-- @usage
+--          -- Mind the dot here, not using the colon this time around!
+--          -- Needed once only
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.NEUTRAL)
+--          -- later on in your code
+--          MESSAGE:New("Test message!",15,"SPAWN"):ToSRSAll()
+--          
+function MESSAGE:ToSRSAll(frequency,modulation,gender,culture,voice,volume,coordinate)
+  self:ToSRS(frequency,modulation,gender,culture,voice,coalition.side.NEUTRAL,volume,coordinate)
+  return self
+end

Moose Development/Moose/Core/Pathline.lua

@@ -199,7 +199,7 @@ end
 
 --- Get points of pathline. Not that points are tables, that contain more information as just the 2D or 3D position but also the surface type etc.
 -- @param #PATHLINE self
--- @return <#PATHLINE.Point> List of points.
+-- @return #list <#PATHLINE.Point> List of points.
 function PATHLINE:GetPoints()  
   return self.points
 end

Moose Development/Moose/Core/Point.lua

@@ -544,7 +544,7 @@ do -- COORDINATE
       if ZoneObject then
 
         -- Get category of scanned object.
-        local ObjectCategory = ZoneObject:getCategory()
+        local ObjectCategory = Object.getCategory(ZoneObject)
 
         -- Check for unit or static objects
         if ObjectCategory==Object.Category.UNIT and ZoneObject:isExist() then

Moose Development/Moose/Core/Scheduler.lua

@@ -52,7 +52,7 @@
 --
 -- A SCHEDULER can manage **multiple** (repeating) schedules. Each planned or executing schedule has a unique **ScheduleID**.
 -- The ScheduleID is returned when the method @{#SCHEDULER.Schedule}() is called.
--- It is recommended to store the ScheduleID in a variable, as it is used in the methods @{SCHEDULER.Start}() and @{SCHEDULER.Stop}(),
+-- It is recommended to store the ScheduleID in a variable, as it is used in the methods @{#SCHEDULER.Start}() and @{#SCHEDULER.Stop}(),
 -- which can start and stop specific repeating schedules respectively within a SCHEDULER object.
 --
 -- ## SCHEDULER constructor
@@ -208,7 +208,7 @@ SCHEDULER = {
 -- @param #number RandomizeFactor Specifies a randomization factor between 0 and 1 to randomize the Repeat.
 -- @param #number Stop Specifies the amount of seconds when the scheduler will be stopped.
 -- @return #SCHEDULER self.
--- @return #table The ScheduleID of the planned schedule.
+-- @return #string The ScheduleID of the planned schedule.
 function SCHEDULER:New( MasterObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop )
 
   local self = BASE:Inherit( self, BASE:New() ) -- #SCHEDULER

Moose Development/Moose/Core/Set.lua

@@ -35,6 +35,13 @@
 --   * Validate the presence of objects in the SET.
 --   * Trigger events when objects in the SET change a zone presence.
 --
+-- ## Notes on `FilterPrefixes()`:  
+-- 
+-- This filter always looks for a **partial match** somewhere in the given field. LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+-- Have a read through the following to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching).  
+-- For example, setting a filter like so `FilterPrefixes("Huey")` is perfectly all right, whilst `FilterPrefixes("UH-1H Al-Assad")` might not be due to the minus signs. A quick fix here is to use a dot (.) 
+-- in place of the special character, or escape it with a percentage sign (%), i.e. either `FilterPrefixes("UH.1H Al.Assad")` or `FilterPrefixes("UH%-1H Al%-Assad")` will give you the expected results.
+--
 -- ===
 --
 -- ### Author: **FlightControl**
@@ -432,7 +439,7 @@ do -- SET_BASE
   function SET_BASE:SetDatabase( BaseSet )
 
     -- Copy the filter criteria of the BaseSet
-    local OtherFilter = routines.utils.deepCopy( BaseSet.Filter )
+    local OtherFilter = UTILS.DeepCopy( BaseSet.Filter )
     self.Filter = OtherFilter
 
     -- Now base the new Set on the BaseSet
@@ -853,8 +860,10 @@ do -- SET_BASE
     self:F3( Object )
     local outcome = false
     local name = Object:GetName()
+    --self:I("SET_BASE: Objectname = "..name)
     self:ForEach(
       function(object)
+        --self:I("SET_BASE: In set objectname = "..object:GetName())
         if object:GetName() == name then
           outcome = true
         end
@@ -940,7 +949,8 @@ do
   --    * @{#SET_GROUP.FilterCoalitions}: Builds the SET_GROUP with the groups belonging to the coalition(s).
   --    * @{#SET_GROUP.FilterCategories}: Builds the SET_GROUP with the groups belonging to the category(ies).
   --    * @{#SET_GROUP.FilterCountries}: Builds the SET_GROUP with the groups belonging to the country(ies).
-  --    * @{#SET_GROUP.FilterPrefixes}: Builds the SET_GROUP with the groups *containing* the given string in the group name. **Attention!** Bad naming convention, as this not really filtering *prefixes*.
+  --    * @{#SET_GROUP.FilterPrefixes}: Builds the SET_GROUP with the groups *containing* the given string in the group name. **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --    * @{#SET_GROUP.FilterActive}: Builds the SET_GROUP with the groups that are only active. Groups that are inactive (late activation) won't be included in the set!
   --
   -- For the Category Filter, extra methods have been added:
@@ -2052,7 +2062,8 @@ do -- SET_UNIT
   --    * @{#SET_UNIT.FilterCategories}: Builds the SET_UNIT with the units belonging to the category(ies).
   --    * @{#SET_UNIT.FilterTypes}: Builds the SET_UNIT with the units belonging to the unit type(s).
   --    * @{#SET_UNIT.FilterCountries}: Builds the SET_UNIT with the units belonging to the country(ies).
-  --    * @{#SET_UNIT.FilterPrefixes}: Builds the SET_UNIT with the units sharing the same string(s) in their name. **ATTENTION!** Bad naming convention as this *does not* only filter *prefixes*.
+  --    * @{#SET_UNIT.FilterPrefixes}: Builds the SET_UNIT with the units sharing the same string(s) in their name. **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --    * @{#SET_UNIT.FilterActive}: Builds the SET_UNIT with the units that are only active. Units that are inactive (late activation) won't be included in the set!
   --    * @{#SET_UNIT.FilterZones}: Builds the SET_UNIT with the units within a @{Core.Zone#ZONE}.
   --    
@@ -3231,7 +3242,8 @@ do -- SET_STATIC
   --    * @{#SET_STATIC.FilterCategories}: Builds the SET_STATIC with the units belonging to the category(ies).
   --    * @{#SET_STATIC.FilterTypes}: Builds the SET_STATIC with the units belonging to the unit type(s).
   --    * @{#SET_STATIC.FilterCountries}: Builds the SET_STATIC with the units belonging to the country(ies).
-  --    * @{#SET_STATIC.FilterPrefixes}: Builds the SET_STATIC with the units containing the same string(s) in their name. **ATTENTION** bad naming convention as this *does not** only filter *prefixes*.
+  --    * @{#SET_STATIC.FilterPrefixes}: Builds the SET_STATIC with the units containing the same string(s) in their name. **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --    * @{#SET_STATIC.FilterZones}: Builds the SET_STATIC with the units within a @{Core.Zone#ZONE}.
   --    
   -- Once the filter criteria have been set for the SET_STATIC, you can start filtering using:
@@ -3988,7 +4000,8 @@ do -- SET_CLIENT
   --    * @{#SET_CLIENT.FilterCategories}: Builds the SET_CLIENT with the clients belonging to the category(ies).
   --    * @{#SET_CLIENT.FilterTypes}: Builds the SET_CLIENT with the clients belonging to the client type(s).
   --    * @{#SET_CLIENT.FilterCountries}: Builds the SET_CLIENT with the clients belonging to the country(ies).
-  --    * @{#SET_CLIENT.FilterPrefixes}: Builds the SET_CLIENT with the clients containing the same string(s) in their unit/pilot name. **ATTENTION!** Bad naming convention as this *does not* only filter *prefixes*.
+  --    * @{#SET_CLIENT.FilterPrefixes}: Builds the SET_CLIENT with the clients containing the same string(s) in their unit/pilot name. **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --    * @{#SET_CLIENT.FilterActive}: Builds the SET_CLIENT with the units that are only active. Units that are inactive (late activation) won't be included in the set!
   --    * @{#SET_CLIENT.FilterZones}: Builds the SET_CLIENT with the clients within a @{Core.Zone#ZONE}.
   --    
@@ -4017,8 +4030,8 @@ do -- SET_CLIENT
       Countries = nil,
       ClientPrefixes = nil,
       Zones = nil,
-  	  Playernames = nil,
-  	  Callsigns = nil,
+      Playernames = nil,
+      Callsigns = nil,
     },
     FilterMeta = {
       Coalitions = {
@@ -4319,7 +4332,6 @@ do -- SET_CLIENT
   function SET_CLIENT:FilterStart()
 
     if _DATABASE then
-      self:_FilterStart()
       self:HandleEvent( EVENTS.Birth, self._EventOnBirth )
       self:HandleEvent( EVENTS.Dead, self._EventOnDeadOrCrash )
       self:HandleEvent( EVENTS.Crash, self._EventOnDeadOrCrash )
@@ -4328,6 +4340,7 @@ do -- SET_CLIENT
         local timing = self.ZoneTimerInterval or 30
         self.ZoneTimer:Start(timing,timing)
       end
+      self:_FilterStart()
     end
 
     return self
@@ -4535,45 +4548,45 @@ do -- SET_CLIENT
         MClientInclude = MClientInclude and MClientPrefix
       end
 
-		if self.Filter.Zones then
-		  local MClientZone = false
-		  for ZoneName, Zone in pairs( self.Filter.Zones ) do
-			self:T3( "Zone:", ZoneName )
-			local unit = MClient:GetClientGroupUnit()
-			if unit and unit:IsInZone(Zone) then
-			  MClientZone = true
-			end
-		  end
-		  MClientInclude = MClientInclude and MClientZone
-		end
-		
-		if self.Filter.Playernames then
-			local MClientPlayername = false
-			local playername = MClient:GetPlayerName() or "Unknown"
-			--self:T(playername)
-			for _,_Playername in pairs(self.Filter.Playernames) do
-				if playername and string.find(playername,_Playername) then
-					MClientPlayername = true
-				end
-			end
-			self:T( { "Evaluated Playername", MClientPlayername } )
-			MClientInclude = MClientInclude and MClientPlayername
-		end
-		
-		if self.Filter.Callsigns then
-			local MClientCallsigns = false
-			local callsign = MClient:GetCallsign()
-			--self:T(callsign)
-			for _,_Callsign in pairs(self.Filter.Callsigns) do
-				if callsign and string.find(callsign,_Callsign) then
-					MClientCallsigns = true
-				end
-			end
-			self:T( { "Evaluated Callsign", MClientCallsigns } )
-			MClientInclude = MClientInclude and MClientCallsigns
-		end
-		
-	end
+    if self.Filter.Zones then
+      local MClientZone = false
+      for ZoneName, Zone in pairs( self.Filter.Zones ) do
+      self:T3( "Zone:", ZoneName )
+      local unit = MClient:GetClientGroupUnit()
+      if unit and unit:IsInZone(Zone) then
+        MClientZone = true
+      end
+      end
+      MClientInclude = MClientInclude and MClientZone
+    end
+    
+    if self.Filter.Playernames then
+      local MClientPlayername = false
+      local playername = MClient:GetPlayerName() or "Unknown"
+      --self:T(playername)
+      for _,_Playername in pairs(self.Filter.Playernames) do
+        if playername and string.find(playername,_Playername) then
+          MClientPlayername = true
+        end
+      end
+      self:T( { "Evaluated Playername", MClientPlayername } )
+      MClientInclude = MClientInclude and MClientPlayername
+    end
+    
+    if self.Filter.Callsigns then
+      local MClientCallsigns = false
+      local callsign = MClient:GetCallsign()
+      --self:I(callsign)
+      for _,_Callsign in pairs(self.Filter.Callsigns) do
+        if callsign and string.find(callsign,_Callsign,1,true) then
+          MClientCallsigns = true
+        end
+      end
+      self:T( { "Evaluated Callsign", MClientCallsigns } )
+      MClientInclude = MClientInclude and MClientCallsigns
+    end
+    
+  end
     self:T2( MClientInclude )
     return MClientInclude
   end
@@ -4603,7 +4616,8 @@ do -- SET_PLAYER
   --    * @{#SET_PLAYER.FilterCategories}: Builds the SET_PLAYER with the clients belonging to the category(ies).
   --    * @{#SET_PLAYER.FilterTypes}: Builds the SET_PLAYER with the clients belonging to the client type(s).
   --    * @{#SET_PLAYER.FilterCountries}: Builds the SET_PLAYER with the clients belonging to the country(ies).
-  --    * @{#SET_PLAYER.FilterPrefixes}: Builds the SET_PLAYER with the clients sharing the same string(s) in their unit/pilot name. **ATTENTION** Bad naming convention as this *does not* only filter prefixes.
+  --    * @{#SET_PLAYER.FilterPrefixes}: Builds the SET_PLAYER with the clients sharing the same string(s) in their unit/pilot name. **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --
   -- Once the filter criteria have been set for the SET_PLAYER, you can start filtering using:
   --
@@ -5380,7 +5394,8 @@ do -- SET_CARGO
   -- Filter criteria are defined by:
   --
   --    * @{#SET_CARGO.FilterCoalitions}: Builds the SET_CARGO with the cargos belonging to the coalition(s).
-  --    * @{#SET_CARGO.FilterPrefixes}: Builds the SET_CARGO with the cargos containing the same string(s). **ATTENTION** Bad naming convention as this *does not* only filter *prefixes*.
+  --    * @{#SET_CARGO.FilterPrefixes}: Builds the SET_CARGO with the cargos containing the same string(s). **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --    * @{#SET_CARGO.FilterTypes}: Builds the SET_CARGO with the cargos belonging to the cargo type(s).
   --    * @{#SET_CARGO.FilterCountries}: Builds the SET_CARGO with the cargos belonging to the country(ies).
   --
@@ -5456,7 +5471,7 @@ do -- SET_CARGO
 
   --- (R2.1) Remove CARGOs from SET_CARGO.
   -- @param Core.Set#SET_CARGO self
-  -- @param Wrapper.Cargo#CARGO RemoveCargoNames A single name or an array of CARGO names.
+  -- @param Cargo.Cargo#CARGO RemoveCargoNames A single name or an array of CARGO names.
   -- @return Core.Set#SET_CARGO self
   function SET_CARGO:RemoveCargosByName( RemoveCargoNames ) -- R2.1
 
@@ -5472,7 +5487,7 @@ do -- SET_CARGO
   --- (R2.1) Finds a Cargo based on the Cargo Name.
   -- @param #SET_CARGO self
   -- @param #string CargoName
-  -- @return Wrapper.Cargo#CARGO The found Cargo.
+  -- @return Cargo.Cargo#CARGO The found Cargo.
   function SET_CARGO:FindCargo( CargoName ) -- R2.1
 
     local CargoFound = self.Set[CargoName]
@@ -5615,7 +5630,7 @@ do -- SET_CARGO
   --- (R2.1) Iterate the SET_CARGO while identifying the nearest @{Cargo.Cargo#CARGO} from a @{Core.Point#POINT_VEC2}.
   -- @param #SET_CARGO self
   -- @param Core.Point#POINT_VEC2 PointVec2 A @{Core.Point#POINT_VEC2} object from where to evaluate the closest @{Cargo.Cargo#CARGO}.
-  -- @return Wrapper.Cargo#CARGO The closest @{Cargo.Cargo#CARGO}.
+  -- @return Cargo.Cargo#CARGO The closest @{Cargo.Cargo#CARGO}.
   function SET_CARGO:FindNearestCargoFromPointVec2( PointVec2 ) -- R2.1
     self:F2( PointVec2 )
 
@@ -5802,7 +5817,8 @@ do -- SET_ZONE
   -- You can set filter criteria to build the collection of zones in SET_ZONE.
   -- Filter criteria are defined by:
   --
-  --    * @{#SET_ZONE.FilterPrefixes}: Builds the SET_ZONE with the zones having a certain text pattern in their name. **ATTENTION!** Bad naming convention as this *does not* only filter *prefixes*.
+  --    * @{#SET_ZONE.FilterPrefixes}: Builds the SET_ZONE with the zones having a certain text pattern in their name. **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --
   -- Once the filter criteria have been set for the SET_ZONE, you can start filtering using:
   --
@@ -5826,6 +5842,7 @@ do -- SET_ZONE
     },
       FilterMeta = {
     },
+    Checktime = 5,
   }
 
   --- Creates a new SET_ZONE object, building a set of zones.
@@ -6036,7 +6053,29 @@ do -- SET_ZONE
 
     return self
   end
-
+  
+  --- Get the average aggregated coordinate of this set of zones.
+  -- @param #SET_ZONE self
+  -- @return Core.Point#COORDINATE
+  function SET_ZONE:GetAverageCoordinate()
+    local x,y,z = 0,0,0
+    local count = 0
+    for _,_zone in pairs(self.Set) do
+      local zone=_zone --Core.Zone#ZONE
+      local vec3 = zone:GetVec3()
+      x = x + vec3.x
+      y = y + vec3.y
+      z = z + vec3.z
+      count = count + 1
+    end
+    if count > 1 then
+      x = x/count
+      y = y/count
+      z = z/count
+    end
+    local coord = COORDINATE:New(x,y,z)
+    return coord
+  end
 
   --- Private function.
   -- @param #SET_ZONE self
@@ -6144,7 +6183,170 @@ do -- SET_ZONE
 
     return zmin, dmin
   end  
-
+  
+  --- Set the check time for SET_ZONE:Trigger()
+  -- @param #SET_ZONE self
+  -- @param #number seconds Check every seconds for objects entering or leaving the zone. Defaults to 5 secs.
+  -- @return #SET_ZONE self
+  function SET_ZONE:SetCheckTime(seconds)
+    self.Checktime = seconds or 5
+    return self
+  end
+  
+  --- Start watching if the Object or Objects move into or out of our set of zones.
+  -- @param #SET_ZONE self
+  -- @param Wrapper.Controllable#CONTROLLABLE Objects Object or Objects to watch, can be of type UNIT, GROUP, CLIENT, or SET\_UNIT, SET\_GROUP, SET\_CLIENT
+  -- @return #SET_ZONE self
+  -- @usage
+  --          -- Create a SET_GROUP and a SET_ZONE for this:
+  -- 
+  --          local groupset = SET_GROUP:New():FilterPrefixes("Aerial"):FilterStart()
+  --          
+  --          -- Trigger will check each zone of the SET_ZONE every 5 secs for objects entering or leaving from the groupset
+  --          local zoneset = SET_ZONE:New():FilterPrefixes("Target Zone"):FilterOnce():Trigger(groupset)
+  --          
+  --          -- Draw zones on map so we see what's going on
+  --          zoneset:ForEachZone(
+  --            function(zone)
+  --              zone:DrawZone(-1, {0,1,0}, Alpha, FillColor, FillAlpha, 4, ReadOnly)
+  --            end 
+  --          )
+  --          
+  --          -- This FSM function will be called for entering objects
+  --          function zoneset:OnAfterEnteredZone(From,Event,To,Controllable,Zone)
+  --            MESSAGE:New("Group "..Controllable:GetName() .. " entered zone "..Zone:GetName(),10,"Set Trigger"):ToAll()
+  --          end
+  --          
+  --          -- This FSM function will be called for leaving objects
+  --          function zoneset:OnAfterLeftZone(From,Event,To,Controllable,Zone)
+  --            MESSAGE:New("Group "..Controllable:GetName() .. " left zone "..Zone:GetName(),10,"Set Trigger"):ToAll()
+  --          end
+  --          
+  --          -- Stop watching after 1 hour
+  --          zoneset:__TriggerStop(3600)
+  function SET_ZONE:Trigger(Objects)
+    --self:I("Added Set_Zone Trigger")
+    self:AddTransition("*","TriggerStart","TriggerRunning")
+    self:AddTransition("*","EnteredZone","*")
+    self:AddTransition("*","LeftZone","*")
+    self:AddTransition("*","TriggerRunCheck","*")
+    self:AddTransition("*","TriggerStop","TriggerStopped")
+    self:TriggerStart()
+    self.checkobjects = Objects
+    if UTILS.IsInstanceOf(Objects,"SET_BASE") then
+      self.objectset = Objects.Set
+    else
+      self.objectset = {Objects}
+    end
+    self:_TriggerCheck(true)
+    self:__TriggerRunCheck(self.Checktime)
+    return self
+    
+    ------------------------
+    --- Pseudo Functions ---
+    ------------------------
+    
+    --- Triggers the FSM event "TriggerStop". Stops the SET_ZONE Trigger.
+    -- @function [parent=#SET_ZONE] TriggerStop
+    -- @param #SET_ZONE self
+  
+    --- Triggers the FSM event "TriggerStop" after a delay. 
+    -- @function [parent=#SET_ZONE] __TriggerStop
+    -- @param #SET_ZONE self
+    -- @param #number delay Delay in seconds.
+    
+    --- On After "EnteredZone" event. An observed object has entered the zone.
+    -- @function [parent=#SET_ZONE] OnAfterEnteredZone
+    -- @param #SET_ZONE self
+    -- @param #string From From state.
+    -- @param #string Event Event.
+    -- @param #string To To state.
+    -- @param Wrapper.Controllable#CONTROLLABLE Controllable The controllable entering the zone.
+    -- @param Core.Zone#ZONE_BASE Zone The zone entered.
+  
+    --- On After "LeftZone" event. An observed object has left the zone.
+    -- @function [parent=#SET_ZONE] OnAfterLeftZone
+    -- @param #SET_ZONE self
+    -- @param #string From From state.
+    -- @param #string Event Event.
+    -- @param #string To To state.
+    -- @param Wrapper.Controllable#CONTROLLABLE Controllable The controllable leaving the zone.
+    -- @param Core.Zone#ZONE_BASE Zone The zone left.
+  end
+  
+  --- (Internal) Check the assigned objects for being in/out of the zone
+  -- @param #SET_ZONE self
+  -- @param #boolean fromstart If true, do the init of the objects
+  -- @return #SET_ZONE self
+  function SET_ZONE:_TriggerCheck(fromstart)
+    --self:I("_TriggerCheck | FromStart = "..tostring(fromstart))
+    if fromstart then
+      for _,_object in pairs(self.objectset) do
+        local obj = _object -- Wrapper.Controllable#CONTROLLABLE
+        if obj and obj:IsAlive() then
+          for _,_zone in pairs(self.Set) do
+            if not obj.TriggerInZone then obj.TriggerInZone = {} end
+            if _zone:IsCoordinateInZone(obj:GetCoordinate()) then
+              obj.TriggerInZone[_zone.ZoneName] = true
+            else
+              obj.TriggerInZone[_zone.ZoneName] = false
+            end
+            --self:I("Object "..obj:GetName().." is in zone = "..tostring(obj.TriggerInZone[_zone.ZoneName]))
+          end
+        end
+      end
+    else
+      for _,_object in pairs(self.objectset) do
+        local obj = _object -- Wrapper.Controllable#CONTROLLABLE
+        if obj and obj:IsAlive() then
+          for _,_zone in pairs(self.Set) do
+            -- Check for pop-up objects
+            if not obj.TriggerInZone then
+              -- has not been tagged previously - wasn't in set! 
+              obj.TriggerInZone = {}
+            end
+            if not obj.TriggerInZone[_zone.ZoneName] then
+              -- has not been tagged previously - wasn't in set! 
+              obj.TriggerInZone[_zone.ZoneName] = false 
+            end
+            -- is obj in zone?
+            local inzone = _zone:IsCoordinateInZone(obj:GetCoordinate())
+            --self:I("Object "..obj:GetName().." is in zone: "..tostring(inzone))
+            if inzone and not obj.TriggerInZone[_zone.ZoneName] then
+              -- wasn't in zone before
+              --self:I("Newly entered")
+              self:__EnteredZone(0.5,obj,_zone)
+              obj.TriggerInZone[_zone.ZoneName] = true
+            elseif (not inzone) and obj.TriggerInZone[_zone.ZoneName] then
+              -- has left the zone
+              --self:I("Newly left")
+              self:__LeftZone(0.5,obj,_zone)
+              obj.TriggerInZone[_zone.ZoneName] = false
+            else
+              --self:I("Not left or not entered, or something went wrong!")
+            end
+          end
+        end
+      end
+    end 
+    return self
+  end
+  
+  --- (Internal) Check the assigned objects for being in/out of the zone
+  -- @param #SET_ZONE self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string to
+  -- @return #SET_ZONE self
+  function SET_ZONE:onafterTriggerRunCheck(From,Event,To)
+    --self:I("onafterTriggerRunCheck")
+    --self:I({From, Event, To})  
+    if self:GetState() ~= "TriggerStopped" then
+      self:_TriggerCheck()
+      self:__TriggerRunCheck(self.Checktime)
+    end
+    return self
+  end
 end
 
 do -- SET_ZONE_GOAL
@@ -6171,7 +6373,8 @@ do -- SET_ZONE_GOAL
   -- You can set filter criteria to build the collection of zones in SET_ZONE_GOAL.
   -- Filter criteria are defined by:
   --
-  --    * @{#SET_ZONE_GOAL.FilterPrefixes}: Builds the SET_ZONE_GOAL with the zones having a certain text pattern in their name. **ATTENTION!** Bad naming convention as this *does not* only filter *prefixes*.
+  --    * @{#SET_ZONE_GOAL.FilterPrefixes}: Builds the SET_ZONE_GOAL with the zones having a certain text pattern in their name. **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --
   -- Once the filter criteria have been set for the SET_ZONE_GOAL, you can start filtering using:
   --
@@ -6483,7 +6686,8 @@ do -- SET_OPSZONE
   -- You can set filter criteria to build the collection of zones in SET_OPSZONE.
   -- Filter criteria are defined by:
   --
-  --    * @{#SET_OPSZONE.FilterPrefixes}: Builds the SET_OPSZONE with the zones having a certain text pattern in their name. **ATTENTION!** Bad naming convention as this *does not* only filter *prefixes*.
+  --    * @{#SET_OPSZONE.FilterPrefixes}: Builds the SET_OPSZONE with the zones having a certain text pattern in their name. **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --
   -- Once the filter criteria have been set for the SET_OPSZONE, you can start filtering using:
   --
@@ -6949,7 +7153,8 @@ do -- SET_OPSGROUP
   --    * @{#SET_OPSGROUP.FilterCoalitions}: Builds the SET_OPSGROUP with the groups belonging to the coalition(s).
   --    * @{#SET_OPSGROUP.FilterCategories}: Builds the SET_OPSGROUP with the groups belonging to the category(ies).
   --    * @{#SET_OPSGROUP.FilterCountries}: Builds the SET_OPSGROUP with the groups belonging to the country(ies).
-  --    * @{#SET_OPSGROUP.FilterPrefixes}: Builds the SET_OPSGROUP with the groups *containing* the given string in the group name. **Attention!** Bad naming convention, as this not really filtering *prefixes*.
+  --    * @{#SET_OPSGROUP.FilterPrefixes}: Builds the SET_OPSGROUP with the groups *containing* the given string in the group name. **Attention!** LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. 
+  -- Have a read through here to understand the application of regular expressions: [LUA regular expressions](https://riptutorial.com/lua/example/20315/lua-pattern-matching)
   --    * @{#SET_OPSGROUP.FilterActive}: Builds the SET_OPSGROUP with the groups that are only active. Groups that are inactive (late activation) won't be included in the set!
   --
   -- For the Category Filter, extra methods have been added:

Moose Development/Moose/Core/Settings.lua

@@ -91,7 +91,7 @@
 --
 -- Will customize which display format is used to indicate A2G coordinates in text as part of the Command Center communications.
 --
---   - A2G BR: [Bearing Range](https://en.wikipedia.org/wiki/Bearing_(navigation)).
+--   - A2G BR: [Bearing Range](https://en.wikipedia.org/wiki/Bearing_\(navigation\)).
 --   - A2G MGRS: The [Military Grid Reference System](https://en.wikipedia.org/wiki/Military_Grid_Reference_System). The accuracy can also be adapted.
 --   - A2G LL DMS: Latitude Longitude [Degrees Minutes Seconds](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion). The accuracy can also be adapted.
 --   - A2G LL DDM: Latitude Longitude [Decimal Degrees Minutes](https://en.wikipedia.org/wiki/Decimal_degrees). The accuracy can also be adapted.
@@ -105,9 +105,9 @@
 -- There are different methods that can be used to change the **System settings** using the \_SETTINGS object.
 --
 --   - @{#SETTINGS.SetA2G_BR}(): Enable the BR display formatting by default.
---   - @{#SETTINGS.SetA2G_MGRS}(): Enable the MGRS display formatting by default. Use @{SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting.
---   - @{#SETTINGS.SetA2G_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
---   - @{#SETTINGS.SetA2G_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
+--   - @{#SETTINGS.SetA2G_MGRS}(): Enable the MGRS display formatting by default. Use @{#SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting.
+--   - @{#SETTINGS.SetA2G_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{#SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
+--   - @{#SETTINGS.SetA2G_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{#SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
 --
 -- ### 3.1.4) A2G coordinates setting - additional notes
 --
@@ -120,7 +120,7 @@
 --
 -- Will customize which display format is used to indicate A2A coordinates in text as part of the Command Center communications.
 --
---   - A2A BRAA: [Bearing Range Altitude Aspect](https://en.wikipedia.org/wiki/Bearing_(navigation)).
+--   - A2A BRAA: [Bearing Range Altitude Aspect](https://en.wikipedia.org/wiki/Bearing_\(navigation\)).
 --   - A2A MGRS: The [Military Grid Reference System](https://en.wikipedia.org/wiki/Military_Grid_Reference_System). The accuracy can also be adapted.
 --   - A2A LL DMS: Lattitude Longitude [Degrees Minutes Seconds](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion). The accuracy can also be adapted.
 --   - A2A LL DDM: Lattitude Longitude [Decimal Degrees and Minutes](https://en.wikipedia.org/wiki/Decimal_degrees). The accuracy can also be adapted.
@@ -135,9 +135,9 @@
 -- There are different methods that can be used to change the **System settings** using the \_SETTINGS object.
 --
 --   - @{#SETTINGS.SetA2A_BRAA}(): Enable the BR display formatting by default.
---   - @{#SETTINGS.SetA2A_MGRS}(): Enable the MGRS display formatting by default. Use @{SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting.
---   - @{#SETTINGS.SetA2A_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
---   - @{#SETTINGS.SetA2A_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
+--   - @{#SETTINGS.SetA2A_MGRS}(): Enable the MGRS display formatting by default. Use @{#SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting.
+--   - @{#SETTINGS.SetA2A_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{#SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
+--   - @{#SETTINGS.SetA2A_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{#SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
 --   - @{#SETTINGS.SetA2A_BULLS}(): Enable the BULLSeye display formatting by default.
 --
 -- ### 3.2.4) A2A coordinates settings - additional notes
@@ -190,8 +190,8 @@
 --
 -- There are different methods that can be used to change the **System settings** using the \_SETTINGS object.
 --
---   - @{#SETTINGS.SetMessageTime}(): Define for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds.
---   - @{#SETTINGS.GetMessageTime}(): Retrieves for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds.
+--   - @{#SETTINGS.SetMessageTime}(): Define for a specific @{Core.Message#MESSAGE.MessageType} the duration to be displayed in seconds.
+--   - @{#SETTINGS.GetMessageTime}(): Retrieves for a specific @{Core.Message#MESSAGE.MessageType} the duration to be displayed in seconds.
 --
 -- ## 3.5) **Era** of the battle
 --
@@ -283,21 +283,21 @@ do -- SETTINGS
   function SETTINGS:SetMetric()
     self.Metric = true
   end
-  
+
   --- Sets the SETTINGS default text locale.
   -- @param #SETTINGS self
   -- @param #string Locale
   function SETTINGS:SetLocale(Locale)
     self.Locale = Locale or "en"
   end
-  
+
   --- Gets the SETTINGS text locale.
   -- @param #SETTINGS self
   -- @return #string
   function SETTINGS:GetLocale()
     return self.Locale or _SETTINGS:GetLocale()
   end
-  
+
   --- Gets if the SETTINGS is metric.
   -- @param #SETTINGS self
   -- @return #boolean true if metric.
@@ -744,7 +744,7 @@ do -- SETTINGS
 
       self.PlayerMenu = PlayerMenu
 
-      self:I( string.format( "Setting menu for player %s", tostring( PlayerName ) ) )
+      self:T( string.format( "Setting menu for player %s", tostring( PlayerName ) ) )
 
       local submenu = MENU_GROUP:New( PlayerGroup, "LL Accuracy", PlayerMenu )
       MENU_GROUP_COMMAND:New( PlayerGroup, "LL 0 Decimals", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 0 )
@@ -989,7 +989,7 @@ do -- SETTINGS
   do
     --- @param #SETTINGS self
     function SETTINGS:MenuGroupA2GSystem( PlayerUnit, PlayerGroup, PlayerName, A2GSystem )
-      BASE:E( { self, PlayerUnit:GetName(), A2GSystem } )
+      --BASE:E( {PlayerUnit:GetName(), A2GSystem } )
       self.A2GSystem = A2GSystem
       MESSAGE:New( string.format( "Settings: A2G format set to %s for player %s.", A2GSystem, PlayerName ), 5 ):ToGroup( PlayerGroup )
       if _SETTINGS.MenuStatic == false then

Moose Development/Moose/Core/Spawn.lua

@@ -58,7 +58,7 @@
 -- @field #SPAWN.SpawnZoneTable SpawnZoneTable
 -- @extends Core.Base#BASE
 
---- Allows to spawn dynamically new @{Core.Group}s.
+--- Allows to spawn dynamically new @{Wrapper.Group}s.
 --
 -- 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.
@@ -286,6 +286,7 @@ SPAWN.Takeoff = {
   Cold = 4,
 }
 
+---
 -- @type SPAWN.SpawnZoneTable
 -- @list <Core.Zone#ZONE_BASE> SpawnZone
 
@@ -327,6 +328,8 @@ function SPAWN:New( SpawnTemplatePrefix )
     self.SpawnInitModu = nil -- No special modulation.
     self.SpawnInitRadio = nil -- No radio comms setting.
     self.SpawnInitModex = nil
+    self.SpawnInitModexPrefix = nil
+    self.SpawnInitModexPostfix = nil
     self.SpawnInitAirbase = nil
     self.TweakedTemplate = false -- Check if the user is using self made template.
 
@@ -381,6 +384,8 @@ function SPAWN:NewWithAlias( SpawnTemplatePrefix, SpawnAliasPrefix )
     self.SpawnInitModu = nil -- No special modulation.
     self.SpawnInitRadio = nil -- No radio communication setting.
     self.SpawnInitModex = nil
+    self.SpawnInitModexPrefix = nil
+    self.SpawnInitModexPostfix = nil
     self.SpawnInitAirbase = nil
     self.TweakedTemplate = false -- Check if the user is using self made template.
 
@@ -540,6 +545,8 @@ function SPAWN:NewFromTemplate( SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPr
     self.SpawnInitModu = nil -- No special modulation.
     self.SpawnInitRadio = nil -- No radio communication setting.
     self.SpawnInitModex = nil
+    self.SpawnInitModexPrefix = nil
+    self.SpawnInitModexPostfix = nil
     self.SpawnInitAirbase = nil
     self.TweakedTemplate = true -- Check if the user is using self made template.
     self.MooseNameing  = true
@@ -811,12 +818,17 @@ end
 --- Sets the modex of the first unit of the group. If more units are in the group, the number is increased by one with every unit.
 -- @param #SPAWN self
 -- @param #number modex Modex of the first unit.
+-- @param #string prefix (optional) String to prefix to modex, e.g. for French AdA Modex, eg. -L-102 then "-L-" would be the prefix.
+-- @param #string postfix (optional) String to postfix to modex, example tbd.
 -- @return #SPAWN self
-function SPAWN:InitModex( modex )
+function SPAWN:InitModex( modex, prefix, postfix )
 
   if modex then
     self.SpawnInitModex = tonumber( modex )
   end
+  
+  self.SpawnInitModexPrefix = prefix
+  self.SpawnInitModexPostfix = postfix
 
   return self
 end
@@ -1202,7 +1214,6 @@ function SPAWN:InitCleanUp( SpawnCleanUpInterval )
   local SpawnGroup, SpawnCursor = self:GetFirstAliveGroup()
   self:T( { "CleanUp Scheduler:", SpawnGroup } )
 
-  -- self.CleanUpFunction = routines.scheduleFunction( self._SpawnCleanUpScheduler, { self }, timer.getTime() + 1, SpawnCleanUpInterval )
   self.CleanUpScheduler = SCHEDULER:New( self, self._SpawnCleanUpScheduler, {}, 1, SpawnCleanUpInterval, 0.2 )
   return self
 end
@@ -1320,7 +1331,7 @@ do -- Delay methods
     return self
   end
 
-  --- Turns the Delay On for the @{Wrapper.Group} when spawning with @{SpawnScheduled}(). In effect then the 1st group will only be spawned
+  --- Turns the Delay On for the @{Wrapper.Group} when spawning with @{#SpawnScheduled}(). In effect then the 1st group will only be spawned
   -- after the number of seconds given in SpawnScheduled as arguments, and not immediately.
   -- @param #SPAWN self
   -- @return #SPAWN The SPAWN object
@@ -1571,7 +1582,10 @@ function SPAWN:SpawnWithIndex( SpawnIndex, NoBirth )
         -- Set tail number.
         if self.SpawnInitModex then
           for UnitID = 1, #SpawnTemplate.units do
-            SpawnTemplate.units[UnitID].onboard_num = string.format( "%03d", self.SpawnInitModex + (UnitID - 1) )
+            local modexnumber = string.format( "%03d", self.SpawnInitModex + (UnitID - 1) )
+            if self.SpawnInitModexPrefix then modexnumber = self.SpawnInitModexPrefix..modexnumber end
+            if self.SpawnInitModexPostfix then modexnumber = modexnumber..self.SpawnInitModexPostfix end
+            SpawnTemplate.units[UnitID].onboard_num = modexnumber
           end
         end
 
@@ -1655,7 +1669,7 @@ end
 -- @param #number SpawnTimeVariation The variation to be applied on the defined time interval between each new spawn.
 -- The variation is a number between 0 and 1, representing the % of variation to be applied on the time interval.
 -- @param #boolean WithDelay Do not spawn the **first** group immediately, but delay the spawn as per the calculation below.
--- Effectively the same as @{InitDelayOn}().
+-- Effectively the same as @{#InitDelayOn}().
 -- @return #SPAWN self
 -- @usage
 -- -- NATO helicopters engaging in the battle field.
@@ -2178,14 +2192,18 @@ end
 -- @param #table Spots Table of parking spot IDs. Note that these in general are different from the numbering in the mission editor!
 -- @param #SPAWN.Takeoff Takeoff (Optional) Takeoff type, i.e. either SPAWN.Takeoff.Cold or SPAWN.Takeoff.Hot. Default is Hot.
 -- @return Wrapper.Group#GROUP The group that was spawned or nil when nothing was spawned.
-function SPAWN:SpawnAtParkingSpot( Airbase, Spots, Takeoff ) -- R2.5
+function SPAWN:SpawnAtParkingSpot( Airbase, Spots, Takeoff )
   self:F( { Airbase = Airbase, Spots = Spots, Takeoff = Takeoff } )
-
+  
   -- Ensure that Spots parameter is a table.
   if type( Spots ) ~= "table" then
     Spots = { Spots }
   end
-
+  
+  if type(Airbase) == "string" then
+    Airbase = AIRBASE:FindByName(Airbase)
+  end
+  
   -- Get template group.
   local group = GROUP:FindByName( self.SpawnTemplatePrefix )
 
@@ -3604,7 +3622,7 @@ function SPAWN:_OnLand( EventData )
 end
 
 --- Will detect AIR Units shutting down their engines ...
--- When the event takes place, and the method @{RepeatOnEngineShutDown} was called, the spawned Group will Re-SPAWN.
+-- When the event takes place, and the method @{#InitRepeatOnEngineShutDown} was called, the spawned Group will Re-SPAWN.
 -- But only when the Unit was registered to have landed.
 -- @param #SPAWN self
 -- @param Core.Event#EVENTDATA EventData

Moose Development/Moose/Core/Spot.lua

@@ -21,9 +21,9 @@
 -- ### Author: **FlightControl**
 -- ### Contributions: 
 -- 
---   * [**Ciribob**](https://forums.eagle.ru/member.php?u=112175): Showing the way how to lase targets + how laser codes work!!! Explained the autolase script.
---   * [**EasyEB**](https://forums.eagle.ru/member.php?u=112055): Ideas and Beta Testing
---   * [**Wingthor**](https://forums.eagle.ru/member.php?u=123698): Beta Testing
+--   * **Ciribob**: Showing the way how to lase targets + how laser codes work!!! Explained the autolase script.
+--   * **EasyEB**: Ideas and Beta Testing
+--   * **Wingthor**: Beta Testing
 -- 
 -- ===
 -- 

Moose Development/Moose/Core/Zone.lua

@@ -53,7 +53,8 @@
 -- @module Core.Zone
 -- @image Core_Zones.JPG
 
---- @type ZONE_BASE
+---
+-- @type ZONE_BASE
 -- @field #string ZoneName Name of the zone.
 -- @field #number ZoneProbability A value between 0 and 1. 0 = 0% and 1 = 100% probability.
 -- @field #number DrawID Unique ID of the drawn zone on the F10 map.
@@ -63,6 +64,7 @@
 -- @field #number ZoneID ID of zone. Only zones defined in the ME have an ID!
 -- @field #table Table of any trigger zone properties from the ME. The key is the Name of the property, and the value is the property's Value.
 -- @field #number Surface Type of surface. Only determined at the center of the zone!
+-- @field #number Checktime Check every Checktime seconds, used for ZONE:Trigger()
 -- @extends Core.Fsm#FSM
 
 
@@ -121,6 +123,7 @@ ZONE_BASE = {
   ZoneID=nil,
   Properties={},
   Surface=nil,
+  Checktime = 5,
 }
 
 --- The ZONE_BASE.BoundingSquare
@@ -189,13 +192,14 @@ end
 -- @param Core.Point#COORDINATE Coordinate The coordinate to test.
 -- @return #boolean true if the coordinate is within the zone.
 function ZONE_BASE:IsCoordinateInZone( Coordinate )
+  if not Coordinate then return false end
   local InZone = self:IsVec2InZone( Coordinate:GetVec2() )
   return InZone
 end
 
 --- Returns if a PointVec2 is within the zone. (Name is misleading, actually takes a #COORDINATE)
 -- @param #ZONE_BASE self
--- @param Core.Point#COORDINATE PointVec2 The coordinate to test.
+-- @param Core.Point#COORDINATE Coordinate The coordinate to test.
 -- @return #boolean true if the PointVec2 is within the zone.
 function ZONE_BASE:IsPointVec2InZone( Coordinate )
   local InZone = self:IsVec2InZone( Coordinate:GetVec2() )
@@ -555,6 +559,154 @@ function ZONE_BASE:GetZoneMaybe()
   end
 end
 
+--- Set the check time for ZONE:Trigger()
+-- @param #ZONE_BASE self
+-- @param #number seconds Check every seconds for objects entering or leaving the zone. Defaults to 5 secs.
+-- @return #ZONE_BASE self
+function ZONE_BASE:SetCheckTime(seconds)
+  self.Checktime = seconds or 5
+  return self
+end
+
+--- Start watching if the Object or Objects move into or out of a zone.
+-- @param #ZONE_BASE self
+-- @param Wrapper.Controllable#CONTROLLABLE Objects Object or Objects to watch, can be of type UNIT, GROUP, CLIENT, or SET\_UNIT, SET\_GROUP, SET\_CLIENT
+-- @return #ZONE_BASE self
+-- @usage
+--            -- Create a new zone and start watching it every 5 secs for a defined GROUP entering or leaving
+--            local triggerzone = ZONE:New("ZonetoWatch"):Trigger(GROUP:FindByName("Aerial-1"))
+--            
+--            -- This FSM function will be called when the group enters the zone
+--            function triggerzone:OnAfterEnteredZone(From,Event,To,Group)
+--              MESSAGE:New("Group has entered zone!",15):ToAll()
+--            end
+--            
+--            -- This FSM function will be called when the group leaves the zone
+--            function triggerzone:OnAfterLeftZone(From,Event,To,Group)
+--              MESSAGE:New("Group has left zone!",15):ToAll()
+--            end
+--            
+--            -- Stop watching the zone after 1 hour
+--           triggerzone:__TriggerStop(3600)
+function ZONE_BASE:Trigger(Objects)
+  --self:I("Added Zone Trigger")
+  self:SetStartState("TriggerStopped")
+  self:AddTransition("TriggerStopped","TriggerStart","TriggerRunning")
+  self:AddTransition("*","EnteredZone","*")
+  self:AddTransition("*","LeftZone","*")
+  self:AddTransition("*","TriggerRunCheck","*")
+  self:AddTransition("*","TriggerStop","TriggerStopped")
+  self:TriggerStart()
+  self.checkobjects = Objects
+  if UTILS.IsInstanceOf(Objects,"SET_BASE") then
+    self.objectset = Objects.Set
+  else
+    self.objectset = {Objects}
+  end
+  self:_TriggerCheck(true)
+  self:__TriggerRunCheck(self.Checktime)
+  return self
+  
+  ------------------------
+  --- Pseudo Functions ---
+  ------------------------
+  
+  --- Triggers the FSM event "TriggerStop". Stops the ZONE_BASE Trigger.
+  -- @function [parent=#ZONE_BASE] TriggerStop
+  -- @param #ZONE_BASE self
+
+  --- Triggers the FSM event "TriggerStop" after a delay. 
+  -- @function [parent=#ZONE_BASE] __TriggerStop
+  -- @param #ZONE_BASE self
+  -- @param #number delay Delay in seconds.
+  
+  --- On After "EnteredZone" event. An observed object has entered the zone.
+  -- @function [parent=#ZONE_BASE] OnAfterEnteredZone
+  -- @param #ZONE_BASE self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param Wrapper.Controllable#CONTROLLABLE Controllable The controllable entering the zone.
+
+  --- On After "LeftZone" event. An observed object has left the zone.
+  -- @function [parent=#ZONE_BASE] OnAfterLeftZone
+  -- @param #ZONE_BASE self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param Wrapper.Controllable#CONTROLLABLE Controllable The controllable leaving the zone.
+end
+
+--- (Internal) Check the assigned objects for being in/out of the zone
+-- @param #ZONE_BASE self
+-- @param #boolean fromstart If true, do the init of the objects
+-- @return #ZONE_BASE self
+function ZONE_BASE:_TriggerCheck(fromstart)
+  --self:I("_TriggerCheck | FromStart = "..tostring(fromstart))
+  local objectset = self.objectset or {}
+  if fromstart then
+    -- just earmark everyone in/out
+    for _,_object in pairs(objectset) do
+      local obj = _object -- Wrapper.Controllable#CONTROLLABLE
+      if not obj.TriggerInZone then obj.TriggerInZone = {} end
+      if obj and obj:IsAlive() and self:IsCoordinateInZone(obj:GetCoordinate()) then
+        obj.TriggerInZone[self.ZoneName] = true
+      else
+        obj.TriggerInZone[self.ZoneName] = false
+      end
+      --self:I("Object "..obj:GetName().." is in zone = "..tostring(obj.TriggerInZone[self.ZoneName]))
+    end
+  else
+    -- Check for changes
+    for _,_object in pairs(objectset) do
+      local obj = _object -- Wrapper.Controllable#CONTROLLABLE
+      if obj and obj:IsAlive() then
+        if not obj.TriggerInZone then
+          -- has not been tagged previously - wasn't in set! 
+          obj.TriggerInZone = {}
+        end
+        if not obj.TriggerInZone[self.ZoneName] then
+          -- has not been tagged previously - wasn't in set! 
+          obj.TriggerInZone[self.ZoneName] = false 
+        end
+        -- is obj in zone?
+        local inzone = self:IsCoordinateInZone(obj:GetCoordinate())
+        --self:I("Object "..obj:GetName().." is in zone: "..tostring(inzone))
+        if inzone and not obj.TriggerInZone[self.ZoneName] then
+          -- wasn't in zone before
+          --self:I("Newly entered")
+          self:__EnteredZone(0.5,obj)
+          obj.TriggerInZone[self.ZoneName] = true
+        elseif (not inzone) and obj.TriggerInZone[self.ZoneName] then
+          -- has left the zone
+          --self:I("Newly left")
+          self:__LeftZone(0.5,obj)
+          obj.TriggerInZone[self.ZoneName] = false
+        else
+          --self:I("Not left or not entered, or something went wrong!")
+        end
+      end
+    end
+  end  
+  return self
+end
+
+--- (Internal) Check the assigned objects for being in/out of the zone
+-- @param #ZONE_BASE self
+-- @param #string From
+-- @param #string Event
+-- @param #string to
+-- @return #ZONE_BASE self
+function ZONE_BASE:onafterTriggerRunCheck(From,Event,To)
+  if self:GetState() ~= "TriggerStopped" then
+    self:_TriggerCheck()
+    self:__TriggerRunCheck(self.Checktime)
+  end
+  return self
+end
+
+
+
 --- Returns the Value of the zone with the given PropertyName, or nil if no matching property exists.
 -- @param #ZONE_BASE self
 -- @param #string PropertyName The name of a the TriggerZone Property to be retrieved.
@@ -905,11 +1057,11 @@ end
 --- Scan the zone for the presence of units of the given ObjectCategories.
 -- Note that **only after** a zone has been scanned, the zone can be evaluated by:
 --
---   * @{ZONE_RADIUS.IsAllInZoneOfCoalition}(): Scan the presence of units in the zone of a coalition.
---   * @{ZONE_RADIUS.IsAllInZoneOfOtherCoalition}(): Scan the presence of units in the zone of an other coalition.
---   * @{ZONE_RADIUS.IsSomeInZoneOfCoalition}(): Scan if there is some presence of units in the zone of the given coalition.
---   * @{ZONE_RADIUS.IsNoneInZoneOfCoalition}(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.
---   * @{ZONE_RADIUS.IsNoneInZone}(): Scan if the zone is empty.
+--   * @{Core.Zone#ZONE_RADIUS.IsAllInZoneOfCoalition}(): Scan the presence of units in the zone of a coalition.
+--   * @{Core.Zone#ZONE_RADIUS.IsAllInZoneOfOtherCoalition}(): Scan the presence of units in the zone of an other coalition.
+--   * @{Core.Zone#ZONE_RADIUS.IsSomeInZoneOfCoalition}(): Scan if there is some presence of units in the zone of the given coalition.
+--   * @{Core.Zone#ZONE_RADIUS.IsNoneInZoneOfCoalition}(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.
+--   * @{Core.Zone#ZONE_RADIUS.IsNoneInZone}(): Scan if the zone is empty.
 -- @param #ZONE_RADIUS self
 -- @param ObjectCategories An array of categories of the objects to find in the zone. E.g. `{Object.Category.UNIT}`
 -- @param UnitCategories An array of unit categories of the objects to find in the zone. E.g. `{Unit.Category.GROUND_UNIT,Unit.Category.SHIP}`
@@ -941,11 +1093,8 @@ function ZONE_RADIUS:Scan( ObjectCategories, UnitCategories )
     --if ZoneObject:isExist() then --FF: isExist always returns false for SCENERY objects since DCS 2.2 and still in DCS 2.5
     if ZoneObject then
 
-      local ObjectCategory = ZoneObject:getCategory()
-
-      --local name=ZoneObject:getName()
-      --env.info(string.format("Zone object %s", tostring(name)))
-      --self:E(ZoneObject)
+      -- Get object category.
+      local ObjectCategory = Object.getCategory(ZoneObject)
 
       if ( ObjectCategory == Object.Category.UNIT and ZoneObject:isExist() and ZoneObject:isActive() ) or (ObjectCategory == Object.Category.STATIC and ZoneObject:isExist()) then
 
@@ -953,7 +1102,7 @@ function ZONE_RADIUS:Scan( ObjectCategories, UnitCategories )
 
         local Include = false
         if not UnitCategories then
-          -- Anythink found is included.
+          -- Anything found is included.
           Include = true
         else
           -- Check if found object is in specified categories.
@@ -984,9 +1133,9 @@ function ZONE_RADIUS:Scan( ObjectCategories, UnitCategories )
       if ObjectCategory == Object.Category.SCENERY then
         local SceneryType = ZoneObject:getTypeName()
         local SceneryName = ZoneObject:getName()
-        --BASE:I("SceneryType "..SceneryType.."SceneryName"..SceneryName)
+        --BASE:I("SceneryType "..SceneryType.." SceneryName "..tostring(SceneryName))
         self.ScanData.Scenery[SceneryType] = self.ScanData.Scenery[SceneryType] or {}
-        self.ScanData.Scenery[SceneryType][SceneryName] = SCENERY:Register( SceneryName, ZoneObject )
+        self.ScanData.Scenery[SceneryType][SceneryName] = SCENERY:Register( tostring(SceneryName), ZoneObject)
         table.insert(self.ScanData.SceneryTable,self.ScanData.Scenery[SceneryType][SceneryName] )
         self:T( { SCENERY =  self.ScanData.Scenery[SceneryType][SceneryName] } )
       end
@@ -1442,8 +1591,11 @@ function ZONE_RADIUS:GetRandomCoordinateWithoutBuildings(inner,outer,distance,ma
   local T1 = timer.getTime()
 
   local buildings = {}
+  local buildingzones = {}
+  
   if self.ScanData and self.ScanData.BuildingCoordinates then
     buildings = self.ScanData.BuildingCoordinates
+    buildingzones = self.ScanData.BuildingZones
   else
     -- build table of buildings coordinates
     for _,_object in pairs (objects) do
@@ -1455,28 +1607,32 @@ function ZONE_RADIUS:GetRandomCoordinateWithoutBuildings(inner,outer,distance,ma
             MARKER:New(scenery:GetCoordinate(),"Building"):ToAll()
           end
           buildings[#buildings+1] = scenery:GetCoordinate()
+          local bradius = scenery:GetBoundingRadius() or dist
+          local bzone = ZONE_RADIUS:New("Building-"..math.random(1,100000),scenery:GetVec2(),bradius,false)
+          buildingzones[#buildingzones+1] = bzone
+          --bzone:DrawZone(-1,{1,0,0},Alpha,FillColor,FillAlpha,1,ReadOnly)
          end
       end
     end
     self.ScanData.BuildingCoordinates = buildings
+    self.ScanData.BuildingZones = buildingzones
   end
 
   -- max 1000 tries
   local rcoord = nil  
-  local found = false
+  local found = true
   local iterations = 0
 
   for i=1,1000 do
     iterations = iterations + 1
     rcoord = self:GetRandomCoordinate(inner,outer)
-    found = false
-    for _,_coord in pairs (buildings) do
-      local coord = _coord -- Core.Point#COORDINATE
+    found = true
+    for _,_coord in pairs (buildingzones) do
+      local zone = _coord -- Core.Zone#ZONE_RADIUS
       -- keep >50m dist from buildings
-      if coord:Get3DDistance(rcoord) > dist then
-        found = true
-      else
+      if zone:IsPointVec2InZone(rcoord) then
         found = false
+        break
       end
     end
     if found then 
@@ -1488,15 +1644,43 @@ function ZONE_RADIUS:GetRandomCoordinateWithoutBuildings(inner,outer,distance,ma
     end
   end
   
+  if not found then
+    -- max 1000 tries
+    local rcoord = nil  
+    local found = true
+    local iterations = 0
+  
+    for i=1,1000 do
+      iterations = iterations + 1
+      rcoord = self:GetRandomCoordinate(inner,outer)
+      found = true
+      for _,_coord in pairs (buildings) do
+        local coord = _coord -- Core.Point#COORDINATE
+        -- keep >50m dist from buildings
+        if coord:Get3DDistance(rcoord) < dist then
+          found = false
+        end
+      end
+      if found then 
+        -- we have a winner!
+        if markfinal then
+          MARKER:New(rcoord,"FREE"):ToAll()
+        end
+        break 
+      end
+    end
+  end
+  
   T1=timer.getTime()
   
-  self:T(string.format("Found a coordinate: %s | Iterations: %d | Time: %d",tostring(found),iterations,T1-T0))
+  self:T(string.format("Found a coordinate: %s | Iterations: %d | Time: %.3f",tostring(found),iterations,T1-T0))
   
   if found then return rcoord else return nil end
   
 end
 
---- @type ZONE
+---
+-- @type ZONE
 -- @extends #ZONE_RADIUS
 
 
@@ -1580,8 +1764,8 @@ function ZONE:FindByName( ZoneName )
 end
 
 
-
---- @type ZONE_UNIT
+---
+-- @type ZONE_UNIT
 -- @field Wrapper.Unit#UNIT ZoneUNIT
 -- @extends Core.Zone#ZONE_RADIUS
 
@@ -1600,7 +1784,7 @@ ZONE_UNIT = {
 -- @param #ZONE_UNIT self
 -- @param #string ZoneName Name of the zone.
 -- @param Wrapper.Unit#UNIT ZoneUNIT The unit as the center of the zone.
--- @param Dcs.DCSTypes#Distance Radius The radius of the zone.
+-- @param #number Radius The radius of the zone in meters.
 -- @param #table Offset A table specifying the offset. The offset table may have the following elements:
 --  dx The offset in X direction, +x is north.
 --  dy The offset in Y direction, +y is east.
@@ -1616,7 +1800,11 @@ function ZONE_UNIT:New( ZoneName, ZoneUNIT, Radius, Offset)
     if (Offset.dx or Offset.dy) and (Offset.rho or Offset.theta) then
       error("Cannot use (dx, dy) with (rho, theta)")
     end
+  end
 
+  local self = BASE:Inherit( self, ZONE_RADIUS:New( ZoneName, ZoneUNIT:GetVec2(), Radius, true ) )
+
+  if Offset then
     self.dy = Offset.dy or 0.0
     self.dx = Offset.dx or 0.0
     self.rho = Offset.rho or 0.0
@@ -1624,8 +1812,6 @@ function ZONE_UNIT:New( ZoneName, ZoneUNIT, Radius, Offset)
     self.relative_to_unit = Offset.relative_to_unit or false
   end
 
-  local self = BASE:Inherit( self, ZONE_RADIUS:New( ZoneName, ZoneUNIT:GetVec2(), Radius, true ) )
-
   self:F( { ZoneName, ZoneUNIT:GetVec2(), Radius } )
 
   self.ZoneUNIT = ZoneUNIT
@@ -1721,7 +1907,8 @@ function ZONE_UNIT:GetVec3( Height )
   return Vec3
 end
 
---- @type ZONE_GROUP
+---
+-- @type ZONE_GROUP
 -- @extends #ZONE_RADIUS
 
 
@@ -1807,7 +1994,8 @@ function ZONE_GROUP:GetRandomPointVec2( inner, outer )
 end
 
 
---- @type ZONE_POLYGON_BASE
+---
+-- @type ZONE_POLYGON_BASE
 -- @field #ZONE_POLYGON_BASE.ListVec2 Polygon The polygon defined by an array of @{DCS#Vec2}.
 -- @extends #ZONE_BASE
 
@@ -2456,7 +2644,8 @@ function ZONE_POLYGON_BASE:Boundary(Coalition, Color, Radius, Alpha, Segments, C
     return self
 end
 
---- @type ZONE_POLYGON
+---
+-- @type ZONE_POLYGON
 -- @extends #ZONE_POLYGON_BASE
 
 
@@ -2557,11 +2746,11 @@ end
 --- Scan the zone for the presence of units of the given ObjectCategories. Does **not** scan for scenery at the moment.
 -- Note that **only after** a zone has been scanned, the zone can be evaluated by:
 --
---   * @{ZONE_POLYGON.IsAllInZoneOfCoalition}(): Scan the presence of units in the zone of a coalition.
---   * @{ZONE_POLYGON.IsAllInZoneOfOtherCoalition}(): Scan the presence of units in the zone of an other coalition.
---   * @{ZONE_POLYGON.IsSomeInZoneOfCoalition}(): Scan if there is some presence of units in the zone of the given coalition.
---   * @{ZONE_POLYGON.IsNoneInZoneOfCoalition}(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.
---   * @{ZONE_POLYGON.IsNoneInZone}(): Scan if the zone is empty.
+--   * @{Core.Zone#ZONE_POLYGON.IsAllInZoneOfCoalition}(): Scan the presence of units in the zone of a coalition.
+--   * @{Core.Zone#ZONE_POLYGON.IsAllInZoneOfOtherCoalition}(): Scan the presence of units in the zone of an other coalition.
+--   * @{Core.Zone#ZONE_POLYGON.IsSomeInZoneOfCoalition}(): Scan if there is some presence of units in the zone of the given coalition.
+--   * @{Core.Zone#ZONE_POLYGON.IsNoneInZoneOfCoalition}(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.
+--   * @{Core.Zone#ZONE_POLYGON.IsNoneInZone}(): Scan if the zone is empty.
 -- @param #ZONE_POLYGON self
 -- @param ObjectCategories An array of categories of the objects to find in the zone. E.g. `{Object.Category.UNIT}`
 -- @param UnitCategories An array of unit categories of the objects to find in the zone. E.g. `{Unit.Category.GROUND_UNIT,Unit.Category.SHIP}`
@@ -2584,7 +2773,7 @@ function ZONE_POLYGON:Scan( ObjectCategories, UnitCategories )
   local minmarkcoord = COORDINATE:NewFromVec3(minVec3)
   local maxmarkcoord = COORDINATE:NewFromVec3(maxVec3)
   local ZoneRadius = minmarkcoord:Get2DDistance(maxmarkcoord)/2
-  
+--  self:I("Scan Radius:" ..ZoneRadius)
   local CenterVec3 = self:GetCoordinate():GetVec3()
   
  --[[ this a bit shaky in functionality it seems
@@ -2609,7 +2798,7 @@ function ZONE_POLYGON:Scan( ObjectCategories, UnitCategories )
 
     if ZoneObject then
 
-      local ObjectCategory = ZoneObject:getCategory()
+      local ObjectCategory = Object.getCategory(ZoneObject)
       
       if ( ObjectCategory == Object.Category.UNIT and ZoneObject:isExist() and ZoneObject:isActive() ) or (ObjectCategory == Object.Category.STATIC and ZoneObject:isExist()) then
 
@@ -2907,7 +3096,7 @@ end
 
 do -- ZONE_ELASTIC
 
-  --- @type ZONE_ELASTIC
+  -- @type ZONE_ELASTIC
   -- @field #table points Points in 2D.
   -- @field #table setGroups Set of GROUPs.
   -- @field #table setOpsGroups Set of OPSGROUPS.
@@ -3107,7 +3296,7 @@ end
 
 do -- ZONE_AIRBASE
 
-  --- @type ZONE_AIRBASE
+  -- @type ZONE_AIRBASE
   -- @field #boolean isShip If `true`, airbase is a ship.
   -- @field #boolean isHelipad If `true`, airbase is a helipad.
   -- @field #boolean isAirdrome If `true`, airbase is an airdrome.

Moose Development/Moose/DCS.lua

@@ -135,6 +135,22 @@ do -- env
   
 end -- env
 
+do -- radio
+
+  ---@type radio
+  -- @field #radio.modulation modulation
+  
+  ---
+  -- @type radio.modulation
+  -- @field AM
+  -- @field FM
+  
+  radio = {}
+  radio.modulation = {}
+  radio.modulation.AM = 0  
+  radio.modulation.FM = 1
+  
+end
 
 do -- timer
 
@@ -329,11 +345,11 @@ end -- country
 
 do -- Command
 
-  --- @type Command
+  -- @type Command
   -- @field #string id
   -- @field #Command.params params
   
-  --- @type Command.params
+  -- @type Command.params
 
 end -- Command
 
@@ -374,7 +390,7 @@ end -- coalition
 
 do -- Types
 
-  --- @type Desc
+  -- @type Desc
   -- @field #number speedMax0 Max speed in meters/second at zero altitude.
   -- @field #number massEmpty Empty mass in kg.
   -- @field #number tankerType Type of refueling system: 0=boom, 1=probe.
@@ -471,16 +487,16 @@ do -- Types
   -- @type AttributeNameArray 
   -- @list <#AttributeName>
 
-  --- @type Zone
+  -- @type Zone
   -- @field DCSVec3#Vec3 point
   -- @field #number radius
 
   Zone = {}
 
-  --- @type ModelTime
+  -- @type ModelTime
   -- @extends #number
   
-  --- @type Time
+  -- @type Time
   -- @extends #number
   
   --- A task descriptor (internal structure for DCS World). See [https://wiki.hoggitworld.com/view/Category:Tasks](https://wiki.hoggitworld.com/view/Category:Tasks).
@@ -489,7 +505,7 @@ do -- Types
   -- @field #string id
   -- @field #Task.param param
   
-  --- @type Task.param
+  -- @type Task.param
   
   --- List of @{#Task}
   -- @type TaskArray
@@ -536,7 +552,7 @@ do -- Object
   -- @field SCENERY
   -- @field CARGO
   
-  --- @type Object.Desc
+  -- @type Object.Desc
   -- @extends #Desc
   -- @field #number life initial life level
   -- @field #Box3 box bounding box of collision geometry
@@ -833,6 +849,12 @@ do -- Warehouse
   -- The warehouse class gives control over warehouses that exist in airbase objects. These warehouses can limit the aircraft, munitions, and fuel available to coalition aircraft.
   -- @type Warehouse
 
+  
+  --- Get a warehouse by passing its name.
+  -- @function [parent=#Warehouse] getByName
+  -- @param #string Name Name of the warehouse.
+  -- @return #Warehouse The warehouse object.
+
   --- Adds the passed amount of a given item to the warehouse.
   -- itemName is the typeName associated with the item: "weapons.missiles.AIM_54C_Mk47"
   -- A wsType table can also be used, however the last digit with wsTypes has been known to change. {4, 4, 7, 322}
@@ -961,7 +983,7 @@ do -- Spot
 end -- Spot
 
 do -- Controller
-  --- Controller is an object that performs A.I.-routines. Other words controller is an instance of A.I.. Controller stores current main task, active enroute tasks and behavior options. Controller performs commands. Please, read DCS A-10C GUI Manual EN.pdf chapter "Task Planning for Unit Groups", page 91 to understand A.I. system of DCS:A-10C. 
+  --- Controller is an object that performs A.I.-tasks. Other words controller is an instance of A.I.. Controller stores current main task, active enroute tasks and behavior options. Controller performs commands. Please, read DCS A-10C GUI Manual EN.pdf chapter "Task Planning for Unit Groups", page 91 to understand A.I. system of DCS:A-10C. 
   -- 
   -- This class has 2 types of functions:
   -- 
@@ -1079,7 +1101,7 @@ end -- Controller
 
 do -- Unit
 
-  --- @type Unit
+  -- @type Unit
   -- @extends #CoalitionObject
   -- @field ID Identifier of an unit. It assigned to an unit by the Mission Editor automatically. 
   -- @field #Unit.Category Category
@@ -1194,15 +1216,18 @@ do -- Unit
   -- @field #Distance detectionDistanceHRM detection distance for RCS=1m^2 in high-resolution mapping mode, nil if radar has no HRM
   -- @field #Unit.Radar.detectionDistanceAir detectionDistanceAir detection distance for RCS=1m^2 airborne target, nil if radar doesn't support air search
   
-  --- @type Unit.Radar.detectionDistanceAir 
+  --- A radar.
+  -- @type Unit.Radar.detectionDistanceAir 
   -- @field #Unit.Radar.detectionDistanceAir.upperHemisphere upperHemisphere
   -- @field #Unit.Radar.detectionDistanceAir.lowerHemisphere lowerHemisphere
   
-  --- @type Unit.Radar.detectionDistanceAir.upperHemisphere
+  --- A radar.
+  -- @type Unit.Radar.detectionDistanceAir.upperHemisphere
   -- @field #Distance headOn
   -- @field #Distance tailOn
   
-  --- @type Unit.Radar.detectionDistanceAir.lowerHemisphere 
+  --- A radar.
+  -- @type Unit.Radar.detectionDistanceAir.lowerHemisphere 
   -- @field #Distance headOn
   -- @field #Distance tailOn
   
@@ -1504,22 +1529,26 @@ do -- AI
   -- @field IR_POINTER
   -- @field LASER
   
-  --- @type AI.Task.WaypointType
+  ---
+  -- @type AI.Task.WaypointType
   -- @field TAKEOFF
   -- @field TAKEOFF_PARKING
   -- @field TURNING_POINT
   -- @field TAKEOFF_PARKING_HOT
   -- @field LAND
   
-  --- @type AI.Task.TurnMethod
+  ---
+  -- @type AI.Task.TurnMethod
   -- @field FLY_OVER_POINT
   -- @field FIN_POINT
   
-  --- @type AI.Task.AltitudeType
+  ---
+  -- @type AI.Task.AltitudeType
   -- @field BARO
   -- @field RADIO
   
-  --- @type AI.Task.VehicleFormation
+  ---
+  -- @type AI.Task.VehicleFormation
   -- @field OFF_ROAD
   -- @field ON_ROAD
   -- @field RANK
@@ -1529,27 +1558,30 @@ do -- AI
   -- @field ECHELON_LEFT
   -- @field ECHELON_RIGHT
   
-  --- @type AI.Option
+  ---
+  -- @type AI.Option
   -- @field #AI.Option.Air                          Air
   -- @field #AI.Option.Ground                       Ground
   -- @field #AI.Option.Naval                        Naval
   
-  --- @type AI.Option.Air
+  ---
+  -- @type AI.Option.Air
   -- @field #AI.Option.Air.id                       id
   -- @field #AI.Option.Air.val                      val
   
-  --- @type AI.Option.Ground
+  ---
+  -- @type AI.Option.Ground
   -- @field #AI.Option.Ground.id                    id
   -- @field #AI.Option.Ground.val                   val
   -- @field #AI.Option.Ground.mid                   mid
   -- @field #AI.Option.Ground.mval                  mval
   -- 
-  --- @type AI.Option.Naval
+  -- @type AI.Option.Naval
   -- @field #AI.Option.Naval.id                     id
   -- @field #AI.Option.Naval.val                    val
  
- 
-  --- @type AI.Option.Air.id
+  ---
+  -- @type AI.Option.Air.id
   -- @field NO_OPTION
   -- @field ROE
   -- @field REACTION_ON_THREAT
@@ -1571,73 +1603,61 @@ do -- AI
   -- @field OPTION_RADIO_USAGE_KILL
   -- @field JETT_TANKS_IF_EMPTY
   -- @field FORCED_ATTACK
-  
-  --- @type AI.Option.Air.id.FORMATION
-  -- @field LINE_ABREAST
-  -- @field TRAIL
-  -- @field WEDGE
-  -- @field ECHELON_RIGHT
-  -- @field ECHELON_LEFT
-  -- @field FINGER_FOUR
-  -- @field SPREAD_FOUR
-  -- @field WW2_BOMBER_ELEMENT
-  -- @field WW2_BOMBER_ELEMENT_HEIGHT
-  -- @field WW2_FIGHTER_VIC
-  -- @field HEL_WEDGE
-  -- @field HEL_ECHELON
-  -- @field HEL_FRONT
-  -- @field HEL_COLUMN
-  -- @field COMBAT_BOX
-  -- @field JAVELIN_DOWN
 
-  
-  --- @type AI.Option.Air.val
+  ---
+  -- @type AI.Option.Air.val
   -- @field #AI.Option.Air.val.ROE ROE
   -- @field #AI.Option.Air.val.REACTION_ON_THREAT REACTION_ON_THREAT
   -- @field #AI.Option.Air.val.RADAR_USING RADAR_USING
   -- @field #AI.Option.Air.val.FLARE_USING FLARE_USING
   
-  --- @type AI.Option.Air.val.ROE
+  ---
+  -- @type AI.Option.Air.val.ROE
   -- @field WEAPON_FREE
   -- @field OPEN_FIRE_WEAPON_FREE
   -- @field OPEN_FIRE
   -- @field RETURN_FIRE
   -- @field WEAPON_HOLD
-   
-  --- @type AI.Option.Air.val.REACTION_ON_THREAT
+  
+  --- 
+  -- @type AI.Option.Air.val.REACTION_ON_THREAT
   -- @field NO_REACTION
   -- @field PASSIVE_DEFENCE
   -- @field EVADE_FIRE
   -- @field BYPASS_AND_ESCAPE
   -- @field ALLOW_ABORT_MISSION
   
-  --- @type AI.Option.Air.val.RADAR_USING
+  ---
+  -- @type AI.Option.Air.val.RADAR_USING
   -- @field NEVER
   -- @field FOR_ATTACK_ONLY
   -- @field FOR_SEARCH_IF_REQUIRED
   -- @field FOR_CONTINUOUS_SEARCH
   
-  --- @type AI.Option.Air.val.FLARE_USING
+  ---
+  -- @type AI.Option.Air.val.FLARE_USING
   -- @field NEVER
   -- @field AGAINST_FIRED_MISSILE
   -- @field WHEN_FLYING_IN_SAM_WEZ
   -- @field WHEN_FLYING_NEAR_ENEMIES
-
-  --- @type AI.Option.Air.val.ECM_USING
+  
+  ---
+  -- @type AI.Option.Air.val.ECM_USING
   -- @field NEVER_USE
   -- @field USE_IF_ONLY_LOCK_BY_RADAR
   -- @field USE_IF_DETECTED_LOCK_BY_RADAR
   -- @field ALWAYS_USE
-
-  --- @type AI.Option.Air.val.MISSILE_ATTACK
+  
+  ---
+  -- @type AI.Option.Air.val.MISSILE_ATTACK
   -- @field MAX_RANGE
   -- @field NEZ_RANGE
   -- @field HALF_WAY_RMAX_NEZ
   -- @field TARGET_THREAT_EST
   -- @field RANDOM_RANGE
 
-  
-  --- @type AI.Option.Ground.id
+  ---
+  -- @type AI.Option.Ground.id
   -- @field NO_OPTION
   -- @field ROE @{#AI.Option.Ground.val.ROE}
   -- @field FORMATION
@@ -1646,42 +1666,51 @@ do -- AI
   -- @field ENGAGE_AIR_WEAPONS
   -- @field AC_ENGAGEMENT_RANGE_RESTRICTION
   
-  --- @type AI.Option.Ground.mid -- Moose added
+  ---
+  -- @type AI.Option.Ground.mid -- Moose added
   -- @field RESTRICT_AAA_MIN        27
   -- @field RESTRICT_AAA_MAX        29
   -- @field RESTRICT_TARGETS @{#AI.Option.Ground.mval.ENGAGE_TARGETS}  28
   
-  --- @type AI.Option.Ground.val
+  ---
+  -- @type AI.Option.Ground.val
   -- @field #AI.Option.Ground.val.ROE               ROE
   -- @field #AI.Option.Ground.val.ALARM_STATE       ALARM_STATE
   -- @field #AI.Option.Ground.val.ENGAGE_TARGETS    RESTRICT_TARGETS
   
-  --- @type AI.Option.Ground.val.ROE
+  ---
+  -- @type AI.Option.Ground.val.ROE
   -- @field OPEN_FIRE
   -- @field RETURN_FIRE
   -- @field WEAPON_HOLD
   
-  --- @type AI.Option.Ground.mval -- Moose added
+  ---
+  -- @type AI.Option.Ground.mval -- Moose added
   -- @field #AI.Option.Ground.mval.ENGAGE_TARGETS   ENGAGE_TARGETS
   
-  --- @type AI.Option.Ground.mval.ENGAGE_TARGETS -- Moose added
+  ---
+  -- @type AI.Option.Ground.mval.ENGAGE_TARGETS -- Moose added
   -- @field ANY_TARGET -- 0
   -- @field AIR_UNITS_ONLY -- 1
   -- @field GROUND_UNITS_ONLY -- 2
   
-  --- @type AI.Option.Ground.val.ALARM_STATE
+  ---
+  -- @type AI.Option.Ground.val.ALARM_STATE
   -- @field AUTO
   -- @field GREEN
   -- @field RED
   
-  --- @type AI.Option.Naval.id
+  ---
+  -- @type AI.Option.Naval.id
   -- @field NO_OPTION
   -- @field ROE
   
-  --- @type AI.Option.Naval.val
+  ---
+  -- @type AI.Option.Naval.val
   -- @field #AI.Option.Naval.val.ROE ROE
   
-  --- @type AI.Option.Naval.val.ROE
+  ---
+  -- @type AI.Option.Naval.val.ROE
   -- @field OPEN_FIRE
   -- @field RETURN_FIRE
   -- @field WEAPON_HOLD

Moose Development/Moose/Functional/AmmoTruck.lua

@@ -0,0 +1,806 @@
+--- **Functional** -- Send a truck to supply artillery groups.
+--
+-- ===
+--
+-- **AMMOTRUCK** - Send a truck to supply artillery groups.
+--
+-- ===
+--
+-- ## Missions:
+--
+-- ### [AmmoTruck](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AMT%20-%20AmmoTruck/AmmoTruck%20100%20-%20NTTR%20-%20Basic)
+--
+-- ===
+--
+-- ### Author : **applevangelist**
+--
+-- @module Functional.AmmoTruck
+-- @image Artillery.JPG
+--
+-- Last update: July 2023
+
+-------------------------------------------------------------------------
+--- **AMMOTRUCK** class, extends Core.FSM#FSM
+-- @type AMMOTRUCK
+-- @field #string ClassName Class Name
+-- @field #string lid Lid for log entries
+-- @field #string version Version string
+-- @field #string alias Alias name
+-- @field #boolean debug Debug flag
+-- @field #table trucklist List of (alive) #AMMOTRUCK.data trucks
+-- @field #table targetlist  List of (alive) #AMMOTRUCK.data artillery
+-- @field #number coalition Coalition this is for
+-- @field Core.Set#SET_GROUP truckset SET of trucks
+-- @field Core.Set#SET_GROUP targetset SET of artillery
+-- @field #table remunitionqueue List of (alive) #AMMOTRUCK.data artillery to be reloaded
+-- @field #table waitingtargets  List of (alive) #AMMOTRUCK.data artillery waiting
+-- @field #number ammothreshold Threshold (min) ammo before sending a truck
+-- @field #number remunidist Max distance trucks will go
+-- @field #number monitor Monitor interval in seconds
+-- @field #number unloadtime Unload time in seconds
+-- @field #number waitingtime Max waiting time in seconds
+-- @field #boolean routeonroad Route truck on road if true (default)
+-- @field #number reloads Number of reloads a single truck can do before he must return home
+-- @extends Core.FSM#FSM
+
+--- *Amateurs talk about tactics, but professionals study logistics.* - General Robert H Barrow, USMC
+--
+-- Simple Class to re-arm your artillery with trucks.
+--
+-- #AMMOTRUCK
+-- 
+-- * Controls a SET\_GROUP of trucks which will re-arm a SET\_GROUP of artillery groups when they run out of ammunition. 
+-- 
+-- ## 1 The AMMOTRUCK concept
+-- 
+-- A SET\_GROUP of trucks which will re-arm a SET\_GROUP of artillery groups when they run out of ammunition. They will be based on a
+-- homebase and drive from there to the artillery groups and then back home.
+-- Trucks are the **only known in-game mechanic** to re-arm artillery and other units in DCS. Working units are e.g.: M-939 (blue), Ural-375 and ZIL-135 (both red).
+-- 
+-- ## 2 Set-up
+--
+-- Define a set of trucks and a set of artillery:  
+-- 
+--            local truckset = SET_GROUP:New():FilterCoalitions("blue"):FilterActive(true):FilterCategoryGround():FilterPrefixes("Ammo Truck"):FilterStart()
+--            local ariset = SET_GROUP:New():FilterCoalitions("blue"):FilterActive(true):FilterCategoryGround():FilterPrefixes("Artillery"):FilterStart()
+--
+-- Create an AMMOTRUCK object to take care of the artillery using the trucks, with a homezone:  
+-- 
+--            local ammotruck = AMMOTRUCK:New(truckset,ariset,coalition.side.BLUE,"Logistics",ZONE:FindByName("HomeZone") 
+--            
+-- ## 2 Options and their default values
+-- 
+--            ammotruck.ammothreshold = 5 -- send a truck when down to this many rounds
+--            ammotruck.remunidist = 20000 -- 20km - send trucks max this far from home
+--            ammotruck.unloadtime = 600 -- 10 minutes - min time to unload ammunition
+--            ammotruck.waitingtime = 1800 -- 30 mintes - wait max this long until remunition is done
+--            ammotruck.monitor = -60 -- 1 minute - AMMOTRUCK checks run every one minute
+--            ammotruck.routeonroad = true -- Trucks will **try** to drive on roads
+--            ammotruck.usearmygroup = false -- If true, will make use of ARMYGROUP in the background (if used in DEV branch)
+--        ammotruck.reloads = 5 -- Maxn re-arms a truck can do before he needs to go home and restock. Set to -1 for unlimited
+-- 
+-- ## 3 FSM Events to shape mission
+-- 
+-- Truck has been sent off:
+-- 
+--            function ammotruck:OnAfterRouteTruck(From, Event, To, Truckdata, Aridata)
+--              ...
+--            end
+--            
+-- Truck has arrived:
+-- 
+--            function ammotruck:OnAfterTruckArrived(From, Event, To, Truckdata)
+--              ...
+--            end 
+-- 
+-- Truck is unloading:
+-- 
+--            function ammotruck:OnAfterTruckUnloading(From, Event, To, Truckdata)
+--              ...
+--            end 
+-- 
+-- Truck is returning home:
+-- 
+--            function ammotruck:OnAfterTruckReturning(From, Event, To, Truckdata)
+--              ...
+--            end  
+-- 
+-- Truck is arrived at home:
+-- 
+--            function ammotruck:OnAfterTruckHome(From, Event, To, Truckdata)
+--              ...
+--            end 
+--                        
+-- @field #AMMOTRUCK
+AMMOTRUCK = {
+  ClassName = "AMMOTRUCK",
+  lid = "",
+  version = "0.0.12",
+  alias = "",
+  debug = false,
+  trucklist = {},
+  targetlist = {},
+  coalition = nil,
+  truckset = nil,
+  targetset = nil,
+  remunitionqueue = {},
+  waitingtargets = {},
+  ammothreshold = 5,
+  remunidist = 20000,
+  monitor = -60,
+  unloadtime = 600,
+  waitingtime = 1800,
+  routeonroad = true,
+  reloads = 5,
+}
+
+---
+-- @type AMMOTRUCK.State
+AMMOTRUCK.State = {
+  IDLE = "idle",
+  DRIVING = "driving",
+  ARRIVED = "arrived",
+  UNLOADING = "unloading",
+  RETURNING = "returning",
+  WAITING = "waiting",
+  RELOADING = "reloading",
+  OUTOFAMMO = "outofammo",
+  REQUESTED = "requested",
+}
+
+---
+--@type AMMOTRUCK.data
+--@field Wrapper.Group#GROUP group
+--@field #string name
+--@field #AMMOTRUCK.State statusquo
+--@field #number timestamp
+--@field #number ammo
+--@field Core.Point#COORDINATE coordinate
+--@field #string targetname
+--@field Wrapper.Group#GROUP targetgroup
+--@field Core.Point#COORDINATE targetcoordinate
+--@field #number reloads
+
+---
+-- @param #AMMOTRUCK self
+-- @param Core.Set#SET_GROUP Truckset Set of truck groups
+-- @param Core.Set#SET_GROUP Targetset Set of artillery groups
+-- @param #number Coalition Coalition
+-- @param #string Alias Alias Name
+-- @param Core.Zone#ZONE Homezone Home, return zone for trucks 
+-- @return #AMMOTRUCK self
+-- @usage
+-- Define a set of trucks and a set of artillery:  
+--            local truckset = SET_GROUP:New():FilterCoalitions("blue"):FilterActive(true):FilterCategoryGround():FilterPrefixes("Ammo Truck"):FilterStart()
+--            local ariset = SET_GROUP:New():FilterCoalitions("blue"):FilterActive(true):FilterCategoryGround():FilterPrefixes("Artillery"):FilterStart()
+--
+-- Create an AMMOTRUCK object to take care of the artillery using the trucks, with a homezone:  
+--            local ammotruck = AMMOTRUCK:New(truckset,ariset,coalition.side.BLUE,"Logistics",ZONE:FindByName("HomeZone") 
+function AMMOTRUCK:New(Truckset,Targetset,Coalition,Alias,Homezone)
+  
+    -- Inherit everything from BASE class.
+  local self=BASE:Inherit(self, FSM:New()) -- #AMMOTRUCK
+  
+  self.truckset = Truckset -- Core.Set#SET_GROUP
+  self.targetset = Targetset -- Core.Set#SET_GROUP
+  self.coalition = Coalition -- #number
+  self.alias = Alias -- #string
+  self.debug = false
+  self.remunitionqueue = {}
+  self.trucklist = {}
+  self.targetlist = {}
+  self.ammothreshold = 5
+  self.remunidist = 20000
+  self.homezone = Homezone -- Core.Zone#ZONE
+  self.waitingtime = 1800
+  self.usearmygroup = false
+  self.hasarmygroup = false
+  
+  -- Log id.
+  self.lid=string.format("AMMOTRUCK %s | %s | ", self.version, self.alias)
+  
+  self:SetStartState("Stopped")
+  self:AddTransition("Stopped",     "Start",               "Running")
+  self:AddTransition("*",           "Monitor",             "*")
+  self:AddTransition("*",           "RouteTruck",          "*")
+  self:AddTransition("*",           "TruckArrived",        "*")
+  self:AddTransition("*",           "TruckUnloading",      "*")
+  self:AddTransition("*",           "TruckReturning",      "*")
+  self:AddTransition("*",           "TruckHome",           "*")
+  self:AddTransition("*",           "Stop",                "Stopped")
+  
+  self:__Start(math.random(5,10))
+  
+  self:I(self.lid .. "Started")
+  
+  ------------------------
+  --- Pseudo Functions ---
+  ------------------------
+
+  --- Triggers the FSM event "Stop". Stops the AMMOTRUCK and all its event handlers.
+  -- @function [parent=#AMMOTRUCK] Stop
+  -- @param #AMMOTRUCK self
+
+  --- Triggers the FSM event "Stop" after a delay. Stops the AMMOTRUCK and all its event handlers.
+  -- @function [parent=#AMMOTRUCK] __Stop
+  -- @param #AMMOTRUCK self
+  -- @param #number delay Delay in seconds.
+  
+  --- On after "RouteTruck" event.
+  -- @function [parent=#AMMOTRUCK] OnAfterRouteTruck
+  -- @param #AMMOTRUCK self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param #AMMOTRUCK.data Truck
+  -- @param #AMMOTRUCK.data Artillery
+  
+    --- On after "TruckUnloading" event.
+  -- @function [parent=#AMMOTRUCK] OnAfterTruckUnloading
+  -- @param #AMMOTRUCK self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param #AMMOTRUCK.data Truck
+  
+    --- On after "TruckReturning" event.
+  -- @function [parent=#AMMOTRUCK] OnAfterTruckReturning
+  -- @param #AMMOTRUCK self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param #AMMOTRUCK.data Truck
+  
+    --- On after "RouteTruck" event.
+  -- @function [parent=#AMMOTRUCK] OnAfterRouteTruck
+  -- @param #AMMOTRUCK self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param #AMMOTRUCK.data Truck
+  
+    --- On after "TruckHome" event.
+  -- @function [parent=#AMMOTRUCK] OnAfterTruckHome
+  -- @param #AMMOTRUCK self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param #AMMOTRUCK.data Truck
+  
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #table dataset table of #AMMOTRUCK.data entries
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:CheckDrivingTrucks(dataset)
+  self:T(self.lid .. " CheckDrivingTrucks")
+  local data = dataset 
+  for _,_data in pairs (data) do
+    local truck = _data -- #AMMOTRUCK.data
+    -- see if we arrived at destination
+    local coord = truck.group:GetCoordinate()
+    local tgtcoord = truck.targetcoordinate
+    local dist = coord:Get2DDistance(tgtcoord)
+    if dist <= 150 then
+      -- arrived
+      truck.statusquo = AMMOTRUCK.State.ARRIVED
+      truck.timestamp = timer.getAbsTime()
+      truck.coordinate = coord
+      self:__TruckArrived(1,truck)
+    end
+    -- still driving?
+    local Tnow = timer.getAbsTime()
+    if Tnow - truck.timestamp > 30 then
+      local group = truck.group
+      if self.usearmygroup then
+        group = truck.group:GetGroup()
+      end
+      local currspeed = group:GetVelocityKMH()
+      if truck.lastspeed then
+        if truck.lastspeed == 0 and currspeed == 0 then
+          self:T(truck.group:GetName().." Is not moving!")
+          -- try and move it
+          truck.timestamp = timer.getAbsTime()
+          if self.routeonroad then
+            group:RouteGroundOnRoad(truck.targetcoordinate,30,2,"Vee")
+          else
+            group:RouteGroundTo(truck.targetcoordinate,30,"Vee",2)
+          end
+        end
+        truck.lastspeed = currspeed
+      else
+        truck.lastspeed = currspeed
+        truck.timestamp = timer.getAbsTime()
+      end
+      self:I({truck=truck.group:GetName(),currspeed=currspeed,lastspeed=truck.lastspeed})
+    end
+  end
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param Wrapper.Group#GROUP Group
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:GetAmmoStatus(Group)
+  local ammotot, shells, rockets, bombs, missiles, narti = Group:GetAmmunition()
+  return rockets+missiles+narti
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #table dataset table of #AMMOTRUCK.data entries
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:CheckWaitingTargets(dataset)
+  self:T(self.lid .. " CheckWaitingTargets")
+  local data = dataset 
+  for _,_data in pairs (data) do
+    local truck = _data -- #AMMOTRUCK.data
+    -- see how long we're waiting - maybe ammo truck is dead?
+    local Tnow = timer.getAbsTime()
+    local Tdiff = Tnow - truck.timestamp
+    if Tdiff > self.waitingtime then
+      local hasammo = self:GetAmmoStatus(truck.group)
+      if hasammo <= self.ammothreshold then
+        truck.statusquo = AMMOTRUCK.State.OUTOFAMMO
+      else
+        truck.statusquo = AMMOTRUCK.State.IDLE
+      end
+    end
+  end
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #table dataset table of #AMMOTRUCK.data entries
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:CheckReturningTrucks(dataset)
+  self:T(self.lid .. " CheckReturningTrucks")
+  local data = dataset
+  local tgtcoord = self.homezone:GetCoordinate()
+  local radius = self.homezone:GetRadius()
+  for _,_data in pairs (data) do
+    local truck = _data -- #AMMOTRUCK.data
+    -- see if we arrived at destination
+    local coord = truck.group:GetCoordinate()
+    local dist = coord:Get2DDistance(tgtcoord)
+    self:T({name=truck.name,radius=radius,distance=dist})
+    if dist <= radius then
+      -- arrived
+      truck.statusquo = AMMOTRUCK.State.IDLE
+      truck.timestamp = timer.getAbsTime()
+      truck.coordinate = coord
+      truck.reloads = self.reloads or 5
+      self:__TruckHome(1,truck)
+    end
+  end
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #string name Artillery group name to find
+-- @return #AMMOTRUCK.data Data
+function AMMOTRUCK:FindTarget(name)
+  self:T(self.lid .. " FindTarget")
+  local data = nil
+  local dataset = self.targetlist
+  for _,_entry in pairs(dataset) do
+    local entry = _entry -- #AMMOTRUCK.data
+    if entry.name == name then
+      data = entry
+      break
+    end
+  end
+  return data
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #string name Truck group name to find
+-- @return #AMMOTRUCK.data Data
+function AMMOTRUCK:FindTruck(name)
+  self:T(self.lid .. " FindTruck")
+  local data = nil
+  local dataset = self.trucklist
+  for _,_entry in pairs(dataset) do
+    local entry = _entry -- #AMMOTRUCK.data
+    if entry.name == name then
+      data = entry
+      break
+    end
+  end
+  return data
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #table dataset table of #AMMOTRUCK.data entries
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:CheckArrivedTrucks(dataset)
+  self:T(self.lid .. " CheckArrivedTrucks")
+  local data = dataset 
+  for _,_data in pairs (data) do
+    -- set to unloading
+    local truck = _data -- #AMMOTRUCK.data
+    truck.statusquo = AMMOTRUCK.State.UNLOADING
+    truck.timestamp = timer.getAbsTime()
+    self:__TruckUnloading(2,truck)
+    -- set target to reloading
+    local aridata = self:FindTarget(truck.targetname) -- #AMMOTRUCK.data
+    if aridata then
+      aridata.statusquo = AMMOTRUCK.State.RELOADING
+      aridata.timestamp = timer.getAbsTime()
+    end
+  end
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #table dataset table of #AMMOTRUCK.data entries
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:CheckUnloadingTrucks(dataset)
+  self:T(self.lid .. " CheckUnloadingTrucks")
+  local data = dataset 
+  for _,_data in pairs (data) do
+    -- check timestamp
+    local truck = _data -- #AMMOTRUCK.data
+    local Tnow = timer.getAbsTime()
+    local Tpassed = Tnow - truck.timestamp
+    local hasammo = self:GetAmmoStatus(truck.targetgroup)
+    if Tpassed > self.unloadtime and hasammo > self.ammothreshold then
+      truck.statusquo = AMMOTRUCK.State.RETURNING
+      truck.timestamp = timer.getAbsTime()
+      self:__TruckReturning(2,truck)
+      -- set target to reloaded     
+      local aridata = self:FindTarget(truck.targetname) -- #AMMOTRUCK.data
+      if aridata then
+        aridata.statusquo = AMMOTRUCK.State.IDLE
+        aridata.timestamp = timer.getAbsTime()
+      end
+    end
+  end
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:CheckTargetsAlive()
+  self:T(self.lid .. " CheckTargetsAlive")
+  local arilist = self.targetlist
+  for _,_ari in pairs(arilist) do
+    local ari = _ari -- #AMMOTRUCK.data
+    if ari.group and ari.group:IsAlive() then
+      -- everything fine
+    else
+      -- ari dead
+      self.targetlist[ari.name] = nil
+    end
+  end
+  -- new arrivals?
+  local aritable = self.targetset:GetSetObjects() --#table
+  for _,_ari in pairs(aritable) do
+    local ari = _ari -- Wrapper.Group#GROUP
+    if ari and ari:IsAlive() and not self.targetlist[ari:GetName()] then
+      local name = ari:GetName()
+      local newari = {} -- #AMMOTRUCK.data
+      newari.name = name
+      newari.group = ari
+      newari.statusquo = AMMOTRUCK.State.IDLE
+      newari.timestamp = timer.getAbsTime()
+      newari.coordinate = ari:GetCoordinate()
+      local hasammo = self:GetAmmoStatus(ari)
+      --newari.ammo = ari:GetAmmunition()
+      newari.ammo = hasammo
+      self.targetlist[name] = newari
+    end 
+  end
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:CheckTrucksAlive()
+  self:T(self.lid .. " CheckTrucksAlive")
+  local trucklist = self.trucklist
+  for _,_truck in pairs(trucklist) do
+    local truck = _truck -- #AMMOTRUCK.data
+    if truck.group and truck.group:IsAlive() then
+      -- everything fine
+    else
+      -- truck dead
+      local tgtname = truck.targetname
+      local targetdata = self:FindTarget(tgtname) -- #AMMOTRUCK.data
+      if targetdata then
+        if targetdata.statusquo ~= AMMOTRUCK.State.IDLE then
+          targetdata.statusquo = AMMOTRUCK.State.IDLE
+        end
+      end
+      self.trucklist[truck.name] = nil
+    end
+  end
+  -- new arrivals?
+  local trucktable = self.truckset:GetSetObjects() --#table
+  for _,_truck in pairs(trucktable) do
+    local truck = _truck -- Wrapper.Group#GROUP
+    if truck and truck:IsAlive() and not self.trucklist[truck:GetName()] then
+      local name = truck:GetName()
+      local newtruck = {} -- #AMMOTRUCK.data
+      newtruck.name = name
+      newtruck.group = truck
+      if self.hasarmygroup then
+        -- is (not) already ARMYGROUP?
+        if truck.ClassName and truck.ClassName == "GROUP" then
+          local trucker = ARMYGROUP:New(truck)
+          trucker:Activate()
+          newtruck.group = trucker
+        end
+      end
+      newtruck.statusquo = AMMOTRUCK.State.IDLE
+      newtruck.timestamp = timer.getAbsTime()
+      newtruck.coordinate = truck:GetCoordinate()
+      newtruck.reloads = self.reloads or 5
+      self.trucklist[name] = newtruck
+    end 
+  end
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #string From
+-- @param #string Event
+-- @param #string To
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:onafterStart(From, Event, To)
+  self:T({From, Event, To})
+  if ARMYGROUP and self.usearmygroup then
+    self.hasarmygroup = true
+  else
+   self.hasarmygroup = false
+  end
+  if self.debug then
+    BASE:TraceOn()
+    BASE:TraceClass("AMMOTRUCK")
+  end
+  self:CheckTargetsAlive()
+  self:CheckTrucksAlive() 
+  self:__Monitor(-30)
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #string From
+-- @param #string Event
+-- @param #string To
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:onafterMonitor(From, Event, To)
+  self:T({From, Event, To})
+  self:CheckTargetsAlive()
+  self:CheckTrucksAlive()
+  -- update ammo state
+  local remunition = false
+  local remunitionqueue = {}
+  local waitingtargets = {}
+  for _,_ari in pairs(self.targetlist) do
+    local data = _ari -- #AMMOTRUCK.data
+    if data.group and data.group:IsAlive() then
+      data.ammo = self:GetAmmoStatus(data.group)
+      data.timestamp = timer.getAbsTime()
+      local text = string.format("Ari %s | Ammo %d | State %s",data.name,data.ammo,data.statusquo)
+      self:T(text)
+      if data.ammo <= self.ammothreshold and (data.statusquo == AMMOTRUCK.State.IDLE or data.statusquo == AMMOTRUCK.State.OUTOFAMMO) then
+        -- add to remu queue
+        data.statusquo = AMMOTRUCK.State.OUTOFAMMO
+        remunitionqueue[#remunitionqueue+1] = data
+        remunition = true
+      elseif data.statusquo == AMMOTRUCK.State.WAITING then
+        waitingtargets[#waitingtargets+1] = data
+      end
+    else
+      self.targetlist[data.name] = nil
+    end
+  end
+  -- sort trucks in buckets
+  local idletrucks = {}
+  local drivingtrucks = {}
+  local unloadingtrucks = {}
+  local arrivedtrucks = {}
+  local returningtrucks = {}
+  local found = false
+  for _,_truckdata in pairs(self.trucklist) do
+    local data = _truckdata -- #AMMOTRUCK.data
+    if data.group and data.group:IsAlive() then
+        -- check state
+        local text = string.format("Truck %s | State %s",data.name,data.statusquo)
+        self:T(text)
+        if data.statusquo == AMMOTRUCK.State.IDLE then
+          idletrucks[#idletrucks+1] = data
+          found = true
+        elseif data.statusquo == AMMOTRUCK.State.DRIVING then
+          drivingtrucks[#drivingtrucks+1] = data
+        elseif data.statusquo == AMMOTRUCK.State.ARRIVED then
+          arrivedtrucks[#arrivedtrucks+1] = data
+        elseif data.statusquo == AMMOTRUCK.State.UNLOADING then
+          unloadingtrucks[#unloadingtrucks+1] = data
+        elseif data.statusquo == AMMOTRUCK.State.RETURNING then
+          returningtrucks[#returningtrucks+1] = data
+        if data.reloads > 0 or data.reloads == -1 then
+          idletrucks[#idletrucks+1] = data
+          found = true
+        end         
+        end
+    else
+      self.truckset[data.name] = nil
+    end
+  end
+  -- see if we can/need route one
+  local n=0
+  if found and remunition then
+    -- match
+    --local match = false
+    for _,_truckdata in pairs(idletrucks) do
+      local truckdata = _truckdata -- #AMMOTRUCK.data
+      local truckcoord = truckdata.group:GetCoordinate() -- Core.Point#COORDINATE
+      for _,_aridata in pairs(remunitionqueue) do
+        local aridata = _aridata -- #AMMOTRUCK.data
+        local aricoord = aridata.coordinate
+        local distance = truckcoord:Get2DDistance(aricoord)
+        if distance <= self.remunidist and aridata.statusquo == AMMOTRUCK.State.OUTOFAMMO and n <= #idletrucks then
+          n = n + 1
+          aridata.statusquo = AMMOTRUCK.State.REQUESTED
+          self:__RouteTruck(n*5,truckdata,aridata)
+          break
+        end
+      end
+    end
+  end
+  
+  -- check driving trucks
+  if #drivingtrucks > 0 then
+    self:CheckDrivingTrucks(drivingtrucks)
+  end
+  
+  -- check arrived trucks
+  if #arrivedtrucks > 0 then
+    self:CheckArrivedTrucks(arrivedtrucks)
+  end
+  
+  -- check unloading trucks
+  if #unloadingtrucks > 0 then
+    self:CheckUnloadingTrucks(unloadingtrucks)
+  end
+  
+  -- check returningtrucks trucks
+  if #returningtrucks > 0 then
+    self:CheckReturningTrucks(returningtrucks)
+  end
+  
+  -- check waiting targets
+  if #waitingtargets > 0 then
+    self:CheckWaitingTargets(waitingtargets)
+  end
+  
+  self:__Monitor(self.monitor)
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #string From
+-- @param #string Event
+-- @param #string To
+-- @param #AMMOTRUCK.data Truckdata
+-- @param #AMMOTRUCK.data Aridata
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:onafterRouteTruck(From, Event, To, Truckdata, Aridata)
+  self:T({From, Event, To, Truckdata.name, Aridata.name})
+  local truckdata = Truckdata -- #AMMOTRUCK.data
+  local aridata = Aridata -- #AMMOTRUCK.data
+  local tgtgrp = aridata.group
+  local tgtzone = ZONE_GROUP:New(aridata.name,tgtgrp,30)
+  local tgtcoord = tgtzone:GetRandomCoordinate(15)
+  if self.hasarmygroup then
+    local mission = AUFTRAG:NewONGUARD(tgtcoord)
+    local oldmission = truckdata.group:GetMissionCurrent()
+    if oldmission then oldmission:Cancel() end
+    mission:SetTime(5)
+    mission:SetTeleport(false)
+    truckdata.group:AddMission(mission)
+  elseif self.routeonroad then
+    truckdata.group:RouteGroundOnRoad(tgtcoord,30)
+  else
+    truckdata.group:RouteGroundTo(tgtcoord,30)
+  end
+  truckdata.statusquo = AMMOTRUCK.State.DRIVING
+  truckdata.targetgroup = tgtgrp
+  truckdata.targetname = aridata.name
+  truckdata.targetcoordinate = tgtcoord
+  aridata.statusquo = AMMOTRUCK.State.WAITING
+  aridata.timestamp = timer.getAbsTime()
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #string From
+-- @param #string Event
+-- @param #string To
+-- @param #AMMOTRUCK.data Truckdata
+-- @return #AMMOTRUCK self 
+ function AMMOTRUCK:onafterTruckUnloading(From, Event, To, Truckdata)
+   local m = MESSAGE:New("Truck "..Truckdata.name.." unloading!",15,"AmmoTruck"):ToCoalitionIf(self.coalition,self.debug)
+   local truck = Truckdata -- Functional.AmmoTruck#AMMOTRUCK.data
+   local coord = truck.group:GetCoordinate()
+   local heading = truck.group:GetHeading()
+   heading = heading < 180 and (360-heading) or (heading - 180)
+   local cid = self.coalition == coalition.side.BLUE and country.id.USA or country.id.RUSSIA
+   cid = self.coalition == coalition.side.NEUTRAL and country.id.UN_PEACEKEEPERS or cid
+   
+   local ammo = {}
+   for i=1,5 do
+     ammo[i] = SPAWNSTATIC:NewFromType("ammo_cargo","Cargos",cid)
+      :InitCoordinate(coord:Translate((15+((i-1)*4)),heading))
+      :Spawn(0,"AmmoCrate-"..math.random(1,10000))
+    end
+    
+    local function destroyammo(ammo)
+      for _,_crate in pairs(ammo) do
+        _crate:Destroy(false)
+      end
+    end
+    
+    local scheduler = SCHEDULER:New(nil,destroyammo,{ammo},self.waitingtime)
+  
+  -- one reload less
+  if truck.reloads ~= -1 then
+    truck.reloads = truck.reloads - 1
+  end
+  return self
+ end 
+
+---
+-- @param #AMMOTRUCK self
+-- @param #string From
+-- @param #string Event
+-- @param #string To
+-- @param #AMMOTRUCK.data Truck
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:onafterTruckReturning(From, Event, To, Truck)
+  self:T({From, Event, To, Truck.name})
+  -- route home
+  local truckdata = Truck -- #AMMOTRUCK.data
+  local tgtzone = self.homezone
+  local tgtcoord = tgtzone:GetRandomCoordinate()
+  if self.hasarmygroup then
+    local mission = AUFTRAG:NewONGUARD(tgtcoord)
+    local oldmission = truckdata.group:GetMissionCurrent()
+    if oldmission then oldmission:Cancel() end
+    mission:SetTime(5)
+    mission:SetTeleport(false)
+    truckdata.group:AddMission(mission)
+  elseif self.routeonroad then
+    truckdata.group:RouteGroundOnRoad(tgtcoord,30,1,"Cone")
+  else
+    truckdata.group:RouteGroundTo(tgtcoord,30,"Cone",1)
+  end
+  return self
+end
+
+---
+-- @param #AMMOTRUCK self
+-- @param #string From
+-- @param #string Event
+-- @param #string To
+-- @return #AMMOTRUCK self 
+function AMMOTRUCK:onafterStop(From, Event, To)
+  self:T({From, Event, To})
+  return self
+end

Moose Development/Moose/Functional/Artillery.lua

@@ -25,9 +25,9 @@
 --
 -- ===
 --
--- ### Author: **[funkyfranky](https://forums.eagle.ru/member.php?u=115026)**
+-- ### Author: **funkyfranky**
 --
--- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536)
+-- ### Contributions: FlightControl
 --
 -- ====
 -- @module Functional.Artillery
@@ -291,14 +291,14 @@
 -- ### Illumination Shells
 --
 -- ARTY groups that possess shells can fire shells with illumination bombs. First, the group needs to be equipped with this weapon. This is done by the
--- function @{ARTY.SetIlluminationShells}(*n*, *power*), where *n* is the number of shells the group has available and *power* the illumination power in mega candela (mcd).
+-- function @{#ARTY.SetIlluminationShells}(*n*, *power*), where *n* is the number of shells the group has available and *power* the illumination power in mega candela (mcd).
 --
 -- In order to execute an engagement with illumination shells one has to use the weapon type *ARTY.WeaponType.IlluminationShells* in the
 -- @{#ARTY.AssignTargetCoord}() function.
 --
 -- In the simulation, the explosive shell that is fired is destroyed once it gets close to the target point but before it can actually impact.
 -- At this position an illumination bomb is triggered at a random altitude between 500 and 1000 meters. This interval can be set by the function
--- @{ARTY.SetIlluminationMinMaxAlt}(*minalt*, *maxalt*).
+-- @{#ARTY.SetIlluminationMinMaxAlt}(*minalt*, *maxalt*).
 --
 -- ### Smoke Shells
 --
@@ -3547,8 +3547,6 @@ end
 function ARTY:onafterRespawn(Controllable, From, Event, To)
   self:_EventFromTo("onafterRespawn", Event, From, To)
 
-  env.info("FF Respawning arty group")
-
   local group=self.Controllable --Wrapper.Group#GROUP
 
   -- Respawn group.

Moose Development/Moose/Functional/Designate.lua

@@ -167,9 +167,9 @@
 -- 
 -- ### Contributions: 
 -- 
---   * [**Ciribob**](https://forums.eagle.ru/member.php?u=112175): Showing the way how to lase targets + how laser codes work!!! Explained the autolase script.
---   * [**EasyEB**](https://forums.eagle.ru/member.php?u=112055): Ideas and Beta Testing
---   * [**Wingthor**](https://forums.eagle.ru/member.php?u=123698): Beta Testing
+--   * **Ciribob**: Showing the way how to lase targets + how laser codes work!!! Explained the autolase script.
+--   * **EasyEB**: Ideas and Beta Testing
+--   * **Wingthor**: Beta Testing
 -- 
 -- ### Authors: 
 -- 

Moose Development/Moose/Functional/Detection.lua

@@ -2452,7 +2452,7 @@ do -- DETECTION_AREAS
   -- 
   -- Retrieve the DetectedItems[].Set with the method @{Functional.Detection#DETECTION_BASE.GetDetectedSet}(). A @{Core.Set#SET_UNIT} object will be returned.
   -- 
-  -- Retrieve the formed @{Zone@ZONE_UNIT}s as a result of the grouping the detected units within the DetectionZoneRange, use the method @{Functional.Detection#DETECTION_AREAS.GetDetectionZones}().
+  -- Retrieve the formed @{Core.Zone@ZONE_UNIT}s as a result of the grouping the detected units within the DetectionZoneRange, use the method @{Functional.Detection#DETECTION_AREAS.GetDetectionZones}().
   -- To understand the amount of zones created, use the method @{Functional.Detection#DETECTION_AREAS.GetDetectionZoneCount}(). 
   -- If you want to obtain a specific zone from the DetectedZones, use the method @{Functional.Detection#DETECTION_AREAS.GetDetectionZoneByID}() with a given index.
   -- 

Moose Development/Moose/Functional/DetectionZones.lua

@@ -21,7 +21,7 @@ do -- DETECTION_ZONES
   -- 
   -- Retrieve the DetectedItems[].Set with the method @{Functional.Detection#DETECTION_BASE.GetDetectedSet}(). A @{Core.Set#SET_UNIT} object will be returned.
   -- 
-  -- Retrieve the formed @{Zone@ZONE_UNIT}s as a result of the grouping the detected units within the DetectionZoneRange, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZones}().
+  -- Retrieve the formed @{Core.Zone#ZONE_UNIT}s as a result of the grouping the detected units within the DetectionZoneRange, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZones}().
   -- To understand the amount of zones created, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZoneCount}(). 
   -- If you want to obtain a specific zone from the DetectedZones, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZone}() with a given index.
   -- 

Moose Development/Moose/Functional/Escort.lua

@@ -108,8 +108,8 @@
 -- @image Escorting.JPG
 
 
-
---- @type ESCORT
+---
+-- @type ESCORT
 -- @extends Core.Base#BASE
 -- @field Wrapper.Client#CLIENT EscortClient
 -- @field Wrapper.Group#GROUP EscortGroup
@@ -252,7 +252,7 @@ end
 --- Set a Detection method for the EscortClient to be reported upon.
 -- Detection methods are based on the derived classes from DETECTION_BASE.
 -- @param #ESCORT self
--- @param Function.Detection#DETECTION_BASE Detection
+-- @param Functional.Detection#DETECTION_BASE Detection
 function ESCORT:SetDetection( Detection )
 
   self.Detection = Detection
@@ -600,7 +600,7 @@ function ESCORT:MenuReportTargets( Seconds )
   self.EscortMenuAttackNearbyTargets = MENU_GROUP:New( self.EscortClient:GetGroup(), "Attack targets", self.EscortMenu )
 
 
-  self.ReportTargetsScheduler = SCHEDULER:New( self, self._ReportTargetsScheduler, {}, 1, Seconds )
+  self.ReportTargetsScheduler, self.ReportTargetsSchedulerID = SCHEDULER:New( self, self._ReportTargetsScheduler, {}, 1, Seconds )
 
   return self
 end
@@ -693,7 +693,7 @@ function ESCORT:MenuResumeMission()
 end
 
 
---- @param #MENUPARAM MenuParam
+-- @param #MENUPARAM MenuParam
 function ESCORT:_HoldPosition( OrbitGroup, OrbitHeight, OrbitSeconds )
 
   local EscortGroup = self.EscortGroup
@@ -733,7 +733,7 @@ function ESCORT:_HoldPosition( OrbitGroup, OrbitHeight, OrbitSeconds )
 
 end
 
---- @param #MENUPARAM MenuParam
+-- @param #MENUPARAM MenuParam
 function ESCORT:_JoinUpAndFollow( Distance )
 
   local EscortGroup = self.EscortGroup
@@ -766,7 +766,7 @@ function ESCORT:JoinUpAndFollow( EscortGroup, EscortClient, Distance )
   EscortGroup:MessageToClient( "Rejoining and Following at " .. Distance .. "!", 30, EscortClient )
 end
 
---- @param #MENUPARAM MenuParam
+-- @param #MENUPARAM MenuParam
 function ESCORT:_Flare( Color, Message )
 
   local EscortGroup = self.EscortGroup
@@ -776,7 +776,7 @@ function ESCORT:_Flare( Color, Message )
   EscortGroup:MessageToClient( Message, 10, EscortClient )
 end
 
---- @param #MENUPARAM MenuParam
+-- @param #MENUPARAM MenuParam
 function ESCORT:_Smoke( Color, Message )
 
   local EscortGroup = self.EscortGroup
@@ -787,7 +787,7 @@ function ESCORT:_Smoke( Color, Message )
 end
 
 
---- @param #MENUPARAM MenuParam
+-- @param #MENUPARAM MenuParam
 function ESCORT:_ReportNearbyTargetsNow()
 
   local EscortGroup = self.EscortGroup
@@ -809,12 +809,12 @@ function ESCORT:_SwitchReportNearbyTargets( ReportTargets )
       self.ReportTargetsScheduler:Schedule( self, self._ReportTargetsScheduler, {}, 1, 30 )
     end
   else
-    routines.removeFunction( self.ReportTargetsScheduler )
+    self.ReportTargetsScheduler:Remove(self.ReportTargetsSchedulerID)
     self.ReportTargetsScheduler = nil
   end
 end
 
---- @param #MENUPARAM MenuParam
+-- @param #MENUPARAM MenuParam
 function ESCORT:_ScanTargets( ScanDuration )
 
   local EscortGroup = self.EscortGroup -- Wrapper.Group#GROUP
@@ -844,7 +844,7 @@ function ESCORT:_ScanTargets( ScanDuration )
 
 end
 
---- @param Wrapper.Group#GROUP EscortGroup
+-- @param Wrapper.Group#GROUP EscortGroup
 function _Resume( EscortGroup )
   env.info( '_Resume' )
 
@@ -856,7 +856,7 @@ function _Resume( EscortGroup )
 
 end
 
---- @param #ESCORT self
+-- @param #ESCORT self
 -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
 function ESCORT:_AttackTarget( DetectedItem )
 
@@ -877,7 +877,7 @@ function ESCORT:_AttackTarget( DetectedItem )
     local Tasks = {}
 
     DetectedSet:ForEachUnit(
-      --- @param Wrapper.Unit#UNIT DetectedUnit
+      -- @param Wrapper.Unit#UNIT DetectedUnit
       function( DetectedUnit, Tasks )
         if DetectedUnit:IsAlive() then
           Tasks[#Tasks+1] = EscortGroup:TaskAttackUnit( DetectedUnit )
@@ -900,7 +900,7 @@ function ESCORT:_AttackTarget( DetectedItem )
     local Tasks = {}
 
     DetectedSet:ForEachUnit(
-      --- @param Wrapper.Unit#UNIT DetectedUnit
+      -- @param Wrapper.Unit#UNIT DetectedUnit
       function( DetectedUnit, Tasks )
         if DetectedUnit:IsAlive() then
           Tasks[#Tasks+1] = EscortGroup:TaskFireAtPoint( DetectedUnit:GetVec2(), 50 )
@@ -921,7 +921,7 @@ function ESCORT:_AttackTarget( DetectedItem )
 end
 
 --- 
---- @param #ESCORT self
+-- @param #ESCORT self
 -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
 function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem )
 
@@ -939,7 +939,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem )
     local Tasks = {}
 
     DetectedSet:ForEachUnit(
-      --- @param Wrapper.Unit#UNIT DetectedUnit
+      -- @param Wrapper.Unit#UNIT DetectedUnit
       function( DetectedUnit, Tasks )
         if DetectedUnit:IsAlive() then
           Tasks[#Tasks+1] = EscortGroupAttack:TaskAttackUnit( DetectedUnit )
@@ -961,7 +961,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem )
     local Tasks = {}
 
     DetectedSet:ForEachUnit(
-      --- @param Wrapper.Unit#UNIT DetectedUnit
+      -- @param Wrapper.Unit#UNIT DetectedUnit
       function( DetectedUnit, Tasks )
         if DetectedUnit:IsAlive() then
           Tasks[#Tasks+1] = EscortGroupAttack:TaskFireAtPoint( DetectedUnit:GetVec2(), 50 )
@@ -981,7 +981,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem )
 
 end
 
---- @param #MENUPARAM MenuParam
+-- @param #MENUPARAM MenuParam
 function ESCORT:_ROE( EscortROEFunction, EscortROEMessage )
 
   local EscortGroup = self.EscortGroup
@@ -991,7 +991,7 @@ function ESCORT:_ROE( EscortROEFunction, EscortROEMessage )
   EscortGroup:MessageToClient( EscortROEMessage, 10, EscortClient )
 end
 
---- @param #MENUPARAM MenuParam
+-- @param #MENUPARAM MenuParam
 function ESCORT:_ROT( EscortROTFunction, EscortROTMessage )
 
   local EscortGroup = self.EscortGroup
@@ -1001,7 +1001,7 @@ function ESCORT:_ROT( EscortROTFunction, EscortROTMessage )
   EscortGroup:MessageToClient( EscortROTMessage, 10, EscortClient )
 end
 
---- @param #MENUPARAM MenuParam
+-- @param #MENUPARAM MenuParam
 function ESCORT:_ResumeMission( WayPoint )
 
   local EscortGroup = self.EscortGroup
@@ -1036,7 +1036,7 @@ function ESCORT:RegisterRoute()
   return TaskPoints
 end
 
---- @param Functional.Escort#ESCORT self
+-- @param Functional.Escort#ESCORT self
 function ESCORT:_FollowScheduler()
   self:F( { self.FollowDistance } )
 

Moose Development/Moose/Functional/Fox.lua

@@ -58,7 +58,7 @@
 --
 -- # The FOX Concept
 -- 
--- As you probably know [Fox](https://en.wikipedia.org/wiki/Fox_(code_word)) is a NATO brevity code for launching air-to-air munition. Therefore, the class name is not 100% accurate as this
+-- As you probably know [Fox](https://en.wikipedia.org/wiki/Fox_\(code_word\)) is a NATO brevity code for launching air-to-air munition. Therefore, the class name is not 100% accurate as this
 -- script handles air-to-air but also surface-to-air missiles.
 -- 
 -- # Basic Script
@@ -113,14 +113,9 @@
 --     -- Start missile trainer.
 --     fox:Start()
 -- 
--- # Fine Tuning
--- 
--- Todo!
--- 
--- # Special Events
--- 
--- Todo!
+-- # Notes
 -- 
+-- The script needs to be running before you enter an airplane slot. If FOX is not available to you, go back to observers and then join a slot again.
 -- 
 -- @field #FOX
 FOX = {

Moose Development/Moose/Functional/Mantis.lua

@@ -22,7 +22,7 @@
 -- @module Functional.Mantis
 -- @image Functional.Mantis.jpg
 --
--- Last Update: July 2023
+-- Last Update: Oct 2023
 
 -------------------------------------------------------------------------
 --- **MANTIS** class, extends Core.Base#BASE
@@ -103,6 +103,7 @@
 -- * Roland
 -- * Silkworm (though strictly speaking this is a surface to ship missile)
 -- * SA-2, SA-3, SA-5, SA-6, SA-7, SA-8, SA-9, SA-10, SA-11, SA-13, SA-15, SA-19
+-- * From IDF mod: STUNNER IDFA, TAMIR IDFA (Note all caps!)
 -- * From HDS (see note on HDS below): SA-2, SA-3, SA-10B, SA-10C, SA-12, SA-17, SA-20A, SA-20B, SA-23, HQ-2
 -- 
 -- * From SMA: RBS98M, RBS70, RBS90, RBS90M, RBS103A, RBS103B, RBS103AM, RBS103BM, Lvkv9040M 
@@ -373,7 +374,9 @@ MANTIS.SamData = {
   ["SA-20A"] = { Range=150, Blindspot=5, Height=27, Type="Long" , Radar="S-300PMU1"},
   ["SA-20B"] = { Range=200, Blindspot=4, Height=27, Type="Long" , Radar="S-300PMU2"},
   ["HQ-2"] = { Range=50, Blindspot=6, Height=35, Type="Medium", Radar="HQ_2_Guideline_LN" },
-  ["SHORAD"] = { Range=3, Blindspot=0, Height=3, Type="Short", Radar="Igla" }
+  ["SHORAD"] = { Range=3, Blindspot=0, Height=3, Type="Short", Radar="Igla" },
+  ["TAMIR IDFA"] = { Range=20, Blindspot=0.6, Height=12.3, Type="Short", Radar="IRON_DOME_LN" },
+  ["STUNNER IDFA"] = { Range=250, Blindspot=1, Height=45, Type="Long", Radar="DAVID_SLING_LN" },  
 }
 
 --- SAM data HDS
@@ -431,22 +434,24 @@ MANTIS.SamDataCH = {
   -- units from CH (Military Assets by Currenthill)
   -- https://www.currenthill.com/
   -- group name MUST contain CHM to ID launcher type correctly!
-  ["2S38 CH"]         = { Range=8,  Blindspot=0.5,  Height=6,     Type="Short",   Radar="2S38" },
-  ["PantsirS1 CH"]      = { Range=20,   Blindspot=1.2,  Height=15,    Type="Short",   Radar="PantsirS1" },  
-  ["PantsirS2 CH"]      = { Range=30,   Blindspot=1.2,  Height=18,    Type="Medium",  Radar="PantsirS2" }, 
-  ["PGL-625 CH"]      = { Range=10,   Blindspot=0.5,  Height=5,     Type="Short",   Radar="PGL_625" }, 
-  ["HQ-17A CH"]       = { Range=20,   Blindspot=1.5,  Height=10,    Type="Short",   Radar="HQ17A" },  
-  ["M903PAC2 CH"]       = { Range=160,  Blindspot=3,  Height=24.5,  Type="Long",  Radar="MIM104_M903_PAC2" },
-  ["M903PAC3 CH"]       = { Range=120,  Blindspot=1,  Height=40,    Type="Long",  Radar="MIM104_M903_PAC3" }, 
-  ["TorM2 CH"]        = { Range=12,   Blindspot=1,  Height=10,    Type="Short",   Radar="TorM2" },
-  ["TorM2K CH"]       = { Range=12,   Blindspot=1,  Height=10,    Type="Short",   Radar="TorM2K" },
-  ["TorM2M CH"]       = { Range=16,   Blindspot=1,  Height=10,    Type="Short",   Radar="TorM2M" },   
-  ["NASAMS3-AMRAAMER CH"]   = { Range=50,   Blindspot=2,  Height=35.7,  Type="Medium",  Radar="CH_NASAMS3_LN_AMRAAM_ER" },  
-  ["NASAMS3-AIM9X2 CH"]   = { Range=20,   Blindspot=0.2,  Height=18,    Type="Short",   Radar="CH_NASAMS3_LN_AIM9X2" },
-  ["C-RAM CH"]        = { Range=2,  Blindspot=0,  Height=2,     Type="Short",   Radar="CH_Centurion_C_RAM" }, 
-  ["PGZ-09 CH"]       = { Range=4,  Blindspot=0,  Height=3,     Type="Short",   Radar="CH_PGZ09" },
-  ["S350-9M100 CH"]     = { Range=15,   Blindspot=1.5,  Height=8,     Type="Short",   Radar="CH_S350_50P6_9M100" },
-  ["S350-9M96D CH"]     = { Range=150,  Blindspot=2.5,  Height=30,    Type="Long",  Radar="CH_S350_50P6_9M96D" },       
+ ["2S38 CH"] = { Range=8, Blindspot=0.5, Height=6, Type="Short", Radar="2S38" },
+ ["PantsirS1 CH"] = { Range=20, Blindspot=1.2, Height=15, Type="Short", Radar="PantsirS1" }, 
+ ["PantsirS2 CH"] = { Range=30, Blindspot=1.2, Height=18, Type="Medium", Radar="PantsirS2" }, 
+ ["PGL-625 CH"] = { Range=10, Blindspot=0.5, Height=5, Type="Short", Radar="PGL_625" }, 
+ ["HQ-17A CH"] = { Range=20, Blindspot=1.5, Height=10, Type="Short", Radar="HQ17A" }, 
+ ["M903PAC2 CH"] = { Range=160, Blindspot=3, Height=24.5, Type="Long", Radar="MIM104_M903_PAC2" },
+ ["M903PAC3 CH"] = { Range=120, Blindspot=1, Height=40, Type="Long", Radar="MIM104_M903_PAC3" }, 
+ ["TorM2 CH"] = { Range=12, Blindspot=1, Height=10, Type="Short", Radar="TorM2" },
+ ["TorM2K CH"] = { Range=12, Blindspot=1, Height=10, Type="Short", Radar="TorM2K" },
+ ["TorM2M CH"] = { Range=16, Blindspot=1, Height=10, Type="Short", Radar="TorM2M" }, 
+ ["NASAMS3-AMRAAMER CH"] = { Range=50, Blindspot=2, Height=35.7, Type="Medium", Radar="CH_NASAMS3_LN_AMRAAM_ER" }, 
+ ["NASAMS3-AIM9X2 CH"] = { Range=20, Blindspot=0.2, Height=18, Type="Short", Radar="CH_NASAMS3_LN_AIM9X2" },
+ ["C-RAM CH"] = { Range=2, Blindspot=0, Height=2, Type="Short", Radar="CH_Centurion_C_RAM" }, 
+ ["PGZ-09 CH"] = { Range=4, Blindspot=0, Height=3, Type="Short", Radar="CH_PGZ09" },
+ ["S350-9M100 CH"] = { Range=15, Blindspot=1.5, Height=8, Type="Short", Radar="CH_S350_50P6_9M100" },
+ ["S350-9M96D CH"] = { Range=150, Blindspot=2.5, Height=30, Type="Long", Radar="CH_S350_50P6_9M96D" },
+ ["LAV-AD CH"] = { Range=8, Blindspot=0.2, Height=4.8, Type="Short", Radar="CH_LAVAD" }, 
+ ["HQ-22 CH"] = { Range=170, Blindspot=5, Height=27, Type="Long", Radar="CH_HQ22_LN" }, 
 }
 
 -----------------------------------------------------------------------
@@ -465,6 +470,7 @@ do
   --@param #string awacs Group name of your Awacs (optional)
   --@param #boolean EmOnOff Make MANTIS switch Emissions on and off instead of changing the alarm state between RED and GREEN (optional)
   --@param #number Padding For #SEAD - Extra number of seconds to add to radar switch-back-on time (optional)
+  --@param #table Zones Table of Core.Zone#ZONE Zones Consider SAM groups in this zone(s) only for this MANTIS instance, must be handed as #table of Zone objects
   --@return #MANTIS self
   --@usage Start up your MANTIS with a basic setting
   --
@@ -483,8 +489,12 @@ do
   --        mybluemantis = MANTIS:New("bluemantis","Blue SAM","Blue EWR",nil,"blue",false,"Blue Awacs")
   --        mybluemantis:Start()
   --
-  function MANTIS:New(name,samprefix,ewrprefix,hq,coalition,dynamic,awacs, EmOnOff, Padding)
-
+  function MANTIS:New(name,samprefix,ewrprefix,hq,coalition,dynamic,awacs, EmOnOff, Padding, Zones)
+    
+    
+    -- Inherit everything from BASE class.
+    local self = BASE:Inherit(self, FSM:New()) -- #MANTIS
+    
     -- DONE: Create some user functions for these
     -- DONE: Make HQ useful
     -- DONE: Set SAMs to auto if EWR dies
@@ -544,6 +554,11 @@ do
     self.maxclassic = 6
     self.autoshorad = true
     self.ShoradGroupSet = SET_GROUP:New() -- Core.Set#SET_GROUP
+    self.FilterZones = Zones
+    
+    self.SkateZones = nil
+    self.SkateNumber =  3
+    self.shootandscoot = false   
     
     self.UseEmOnOff = true
     if EmOnOff == false then
@@ -556,9 +571,6 @@ do
       self.advAwacs = false
     end
 
-    -- Inherit everything from BASE class.
-    local self = BASE:Inherit(self, FSM:New()) -- #MANTIS
-
     -- Set the string id for output to DCS.log file.
     self.lid=string.format("MANTIS %s | ", self.name)
 
@@ -593,16 +605,23 @@ do
     
     self:T({self.ewr_templates})
     
+    self.SAM_Group = SET_GROUP:New():FilterPrefixes(self.SAM_Templates_Prefix):FilterCoalitions(self.Coalition)
+    self.EWR_Group = SET_GROUP:New():FilterPrefixes(self.ewr_templates):FilterCoalitions(self.Coalition)
+    
+    if self.FilterZones then
+      self.SAM_Group:FilterZones(self.FilterZones)
+    end
+    
     if self.dynamic then
       -- Set SAM SET_GROUP
-      self.SAM_Group = SET_GROUP:New():FilterPrefixes(self.SAM_Templates_Prefix):FilterCoalitions(self.Coalition):FilterStart()
+      self.SAM_Group:FilterStart()
       -- Set EWR SET_GROUP
-      self.EWR_Group = SET_GROUP:New():FilterPrefixes(self.ewr_templates):FilterCoalitions(self.Coalition):FilterStart()
+      self.EWR_Group:FilterStart()
     else
       -- Set SAM SET_GROUP
-      self.SAM_Group = SET_GROUP:New():FilterPrefixes(self.SAM_Templates_Prefix):FilterCoalitions(self.Coalition):FilterOnce()
+      self.SAM_Group:FilterOnce()
       -- Set EWR SET_GROUP
-      self.EWR_Group = SET_GROUP:New():FilterPrefixes(self.ewr_templates):FilterCoalitions(self.Coalition):FilterOnce()
+      self.EWR_Group:FilterOnce()
     end
 
     -- set up CC
@@ -612,7 +631,7 @@ do
     
     -- TODO Version
     -- @field #string version
-    self.version="0.8.11"
+    self.version="0.8.15"
     self:I(string.format("***** Starting MANTIS Version %s *****", self.version))
 
     --- FSM Functions ---
@@ -776,6 +795,19 @@ do
     return self
   end
   
+  --- Add a SET_ZONE of zones for Shoot&Scoot - SHORAD units will move around
+  -- @param #MANTIS self
+  -- @param Core.Set#SET_ZONE ZoneSet Set of zones to be used. Units will move around to the next (random) zone between 100m and 3000m away.
+  -- @param #number Number Number of closest zones to be considered, defaults to 3.
+  -- @return #MANTIS self
+  function MANTIS:AddScootZones(ZoneSet, Number)
+    self:T(self.lid .. " AddScootZones")
+    self.SkateZones = ZoneSet
+    self.SkateNumber = Number or 3
+    self.shootandscoot = true    
+    return self
+  end
+  
   --- Function to set accept and reject zones.
   -- @param #MANTIS self
   -- @param #table AcceptZones Table of @{Core.Zone#ZONE} objects
@@ -882,7 +914,7 @@ do
 
   --- Function to get the HQ object for further use
   -- @param #MANTIS self
-  -- @return Wrapper.GROUP#GROUP The HQ #GROUP object or *nil* if it doesn't exist
+  -- @return Wrapper.Group#GROUP The HQ #GROUP object or *nil* if it doesn't exist
   function MANTIS:GetCommandCenter()
     self:T(self.lid .. "GetCommandCenter")
     if self.HQ_CC then
@@ -918,7 +950,7 @@ do
 
   --- Function to set the HQ object for further use
   -- @param #MANTIS self
-  -- @param Wrapper.GROUP#GROUP group The #GROUP object to be set as HQ
+  -- @param Wrapper.Group#GROUP group The #GROUP object to be set as HQ
   function MANTIS:SetCommandCenter(group)
     self:T(self.lid .. "SetCommandCenter")
     local group = group or nil
@@ -980,7 +1012,7 @@ do
 
   --- Set using your own #INTEL_DLINK object instead of #DETECTION
   -- @param #MANTIS self
-  -- @param Ops.Intelligence#INTEL_DLINK DLink The data link object to be used.
+  -- @param Ops.Intel#INTEL_DLINK DLink The data link object to be used.
   function MANTIS:SetUsingDLink(DLink)
     self:T(self.lid .. "SetUsingDLink")
     self.DLink = true
@@ -1775,6 +1807,10 @@ do
       self.Shorad:SetDefenseLimits(80,95)
       self.ShoradLink = true
       self.Shorad.Groupset=self.ShoradGroupSet
+      self.Shorad.debug = self.debug
+    end
+    if self.shootandscoot and self.SkateZones then
+      self.Shorad:AddScootZones(self.SkateZones,self.SkateNumber or 3)
     end
     self:__Status(-math.random(1,10))
     return self

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -50,6 +50,11 @@
 --     * **100 meter**: Destroys the missile when the distance to the aircraft is below or equal to 100 meter.
 --     * **150 meter**: Destroys the missile when the distance to the aircraft is below or equal to 150 meter.
 --     * **200 meter**: Destroys the missile when the distance to the aircraft is below or equal to 200 meter.
+--     
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE.
+-- Therefore, this class is considered to be deprecated and superseded by the [Functional.Fox](https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/Functional.Fox.html) class, which provides the same functionality.
 --
 -- ===
 --
@@ -67,8 +72,8 @@
 -- @module Functional.MissileTrainer
 -- @image Missile_Trainer.JPG
 
-
---- @type MISSILETRAINER
+---
+-- @type MISSILETRAINER
 -- @field Core.Set#SET_CLIENT DBClients
 -- @extends Core.Base#BASE
 
@@ -97,6 +102,11 @@
 --  * @{#MISSILETRAINER.InitRangeOnOff}: Sets by default the display of range information of missiles ON of OFF.
 --  * @{#MISSILETRAINER.InitBearingOnOff}: Sets by default the display of bearing information of missiles ON of OFF.
 --  * @{#MISSILETRAINER.InitMenusOnOff}: Allows to configure the options through the radio menu.
+--  
+-- # Developer Note
+-- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE.
+-- Therefore, this class is considered to be deprecated and superseded by the [Functional.Fox](https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/Functional.Fox.html) class, which provides the same functionality.
 --
 -- @field #MISSILETRAINER
 MISSILETRAINER = {
@@ -205,7 +215,7 @@ function MISSILETRAINER:New( Distance, Briefing )
 
 
 --  	self.DB:ForEachClient(
---  	 --- @param Wrapper.Client#CLIENT Client
+--  	 -- @param Wrapper.Client#CLIENT Client
 --  	 function( Client )
 --
 --        ... actions ...
@@ -555,7 +565,7 @@ function MISSILETRAINER:_AddBearing( Client, TrainerWeapon )
 
     local DirectionVector = { x = PositionMissile.x - TargetVec3.x, y = PositionMissile.y - TargetVec3.y, z = PositionMissile.z - TargetVec3.z }
     local DirectionRadians = math.atan2( DirectionVector.z, DirectionVector.x )
-    --DirectionRadians = DirectionRadians + routines.getNorthCorrection( PositionTarget )
+
     if DirectionRadians < 0 then
       DirectionRadians = DirectionRadians + 2 * math.pi
     end

Moose Development/Moose/Functional/Movement.lua

@@ -10,7 +10,8 @@
 -- @module Functional.Movement
 -- @image MOOSE.JPG
 
---- @type MOVEMENT
+---
+-- @type MOVEMENT
 -- @extends Core.Base#BASE
 
 ---
@@ -55,7 +56,6 @@ end
 --- Call this function to start the MOVEMENT scheduling.
 function MOVEMENT:ScheduleStart()
 	self:F()
-	--self.MoveFunction = routines.scheduleFunction( self._Scheduler, { self }, timer.getTime() + 1, 120 )
   self.MoveFunction = SCHEDULER:New( self, self._Scheduler, {}, 1, 120 )
 end
 

Moose Development/Moose/Functional/RAT.lua

@@ -46,9 +46,9 @@
 --
 -- ===
 --
--- ### Author: **[funkyfranky](https://forums.eagle.ru/member.php?u=115026)**
+-- ### Author: **funkyfranky**
 --
--- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536)
+-- ### Contributions: FlightControl
 --
 -- ===
 -- @module Functional.RAT
@@ -225,7 +225,7 @@
 --
 -- * Landing: When an aircraft tries to land at an airport where it does not have a valid parking spot, it is immidiately despawned the moment its wheels touch the runway, i.e.
 -- when a landing event is triggered. This leads to the loss of the RAT aircraft. On possible way to circumvent the this problem is to let another RAT aircraft spawn at landing
--- and not when it shuts down its engines. See the @{RAT.RespawnAfterLanding}() function.
+-- and not when it shuts down its engines. See the @{#RAT.RespawnAfterLanding}() function.
 -- * Spawning: When a big aircraft is dynamically spawned on a small airbase a few things can go wrong. For example, it could be spawned at a parking spot with a shelter.
 -- Or it could be damaged by a scenery object when it is taxiing out to the runway, or it could overlap with other aircraft on parking spots near by.
 --
@@ -2474,11 +2474,11 @@ end
 -- @param #RAT self
 -- @param #number takeoff Takeoff type. Could also be air start.
 -- @param #number landing Landing type. Could also be a destination in air.
--- @param Wrapper.Airport#AIRBASE _departure (Optional) Departure airbase.
--- @param Wrapper.Airport#AIRBASE _destination (Optional) Destination airbase.
+-- @param Wrapper.Airbase#AIRBASE _departure (Optional) Departure airbase.
+-- @param Wrapper.Airbase#AIRBASE _destination (Optional) Destination airbase.
 -- @param #table _waypoint Initial waypoint.
--- @return Wrapper.Airport#AIRBASE Departure airbase.
--- @return Wrapper.Airport#AIRBASE Destination airbase.
+-- @return Wrapper.Airbase#AIRBASE Departure airbase.
+-- @return Wrapper.Airbase#AIRBASE Destination airbase.
 -- @return #table Table of flight plan waypoints.
 -- @return #nil If no valid departure or destination airport could be found.
 function RAT:_SetRoute(takeoff, landing, _departure, _destination, _waypoint)
@@ -3483,7 +3483,7 @@ function RAT:Status(message, forID)
     -- Get group.
     local group=ratcraft.group  --Wrapper.Group#GROUP
 
-    if group and group:IsAlive() then
+    if group and group:IsAlive() and (group:GetCoordinate() or group:GetVec3()) then
       nalive=nalive+1
 
       -- Gather some information.
@@ -3491,8 +3491,11 @@ function RAT:Status(message, forID)
       local life=self:_GetLife(group)
       local fuel=group:GetFuel()*100.0
       local airborne=group:InAir()
-      local coords=group:GetCoordinate()
-      local alt=coords.y or 1000
+      local coords=group:GetCoordinate() or group:GetVec3()
+      local alt=1000
+      if coords then
+        alt=coords.y or 1000
+      end  
       --local vel=group:GetVelocityKMH()
       local departure=ratcraft.departure:GetName()
       local destination=ratcraft.destination:GetName()
@@ -4602,7 +4605,7 @@ function RAT:_TaskHolding(P1, Altitude, Speed, Duration)
 end
 
 --- Function which is called after passing every waypoint. Info on waypoint is given and special functions are executed.
--- @param Core.Group#GROUP group Group of aircraft.
+-- @param Wrapper.Group#GROUP group Group of aircraft.
 -- @param #RAT rat RAT object.
 -- @param #number wp Waypoint index. Running number of the waypoints. Determines the actions to be executed.
 function RAT._WaypointFunction(group, rat, wp)

Moose Development/Moose/Functional/Range.lua

@@ -4,7 +4,7 @@
 --
 -- The RANGE class enables easy set up of bombing and strafing ranges within DCS World.
 --
--- Implementation is based on the [Simple Range Script](https://forums.eagle.ru/showthread.php?t=157991) by [Ciribob](https://forums.eagle.ru/member.php?u=112175), which itself was motivated
+-- Implementation is based on the [Simple Range Script](https://forums.eagle.ru/showthread.php?t=157991) by Ciribob, which itself was motivated
 -- by a script by SNAFU [see here](https://forums.eagle.ru/showthread.php?t=109174).
 --
 -- [476th - Air Weapons Range Objects mod](http://www.476vfightergroup.com/downloads.php?do=file&id=287) is highly recommended for this class.
@@ -42,9 +42,9 @@
 --
 -- ===
 --
--- ### Author: **[funkyfranky](https://forums.eagle.ru/member.php?u=115026)**
+-- ### Author: **funkyfranky**
 --
--- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536), [Ciribob](https://forums.eagle.ru/member.php?u=112175)
+-- ### Contributions: FlightControl, Ciribob
 -- ### SRS Additions: Applevangelist
 -- 
 -- ===
@@ -105,6 +105,7 @@
 -- @field Sound.SRS#MSRSQUEUE controlsrsQ SRS queue for range controller. 
 -- @field Sound.SRS#MSRS instructmsrs SRS wrapper for range instructor.
 -- @field Sound.SRS#MSRSQUEUE instructsrsQ SRS queue for range instructor.
+-- @field #number Coalition Coalition side for the menu, if any.
 -- @extends Core.Fsm#FSM
 
 --- *Don't only practice your art, but force your way into its secrets; art deserves that, for it and knowledge can raise man to the Divine.* - Ludwig van Beethoven
@@ -355,7 +356,8 @@ RANGE = {
   targetsheet = nil,
   targetpath = nil,
   targetprefix = nil,
-}
+  Coalition = nil,
+  }
 
 --- Default range parameters.
 -- @type RANGE.Defaults
@@ -591,7 +593,7 @@ RANGE.MenuF10Root = nil
 
 --- Range script version.
 -- @field #string version
-RANGE.version = "2.7.1"
+RANGE.version = "2.7.3"
 
 -- TODO list:
 -- TODO: Verbosity level for messages.
@@ -613,8 +615,9 @@ RANGE.version = "2.7.1"
 --- RANGE contructor. Creates a new RANGE object.
 -- @param #RANGE self
 -- @param #string RangeName Name of the range. Has to be unique. Will we used to create F10 menu items etc.
+-- @param #number Coalition (optional) Coalition of the range, if any, e.g. coalition.side.BLUE.
 -- @return #RANGE RANGE object.
-function RANGE:New( RangeName )
+function RANGE:New( RangeName, Coalition )
 
   -- Inherit BASE.
   local self = BASE:Inherit( self, FSM:New() ) -- #RANGE
@@ -622,7 +625,9 @@ function RANGE:New( RangeName )
   -- Get range name.
   -- TODO: make sure that the range name is not given twice. This would lead to problems in the F10 radio menu.
   self.rangename = RangeName or "Practice Range"
-
+  
+  self.Coalition = Coalition
+  
   -- Log id.
   self.lid = string.format( "RANGE %s | ", self.rangename )
 
@@ -1745,10 +1750,16 @@ function RANGE:OnEventBirth( EventData )
 
     -- Reset current strafe status.
     self.strafeStatus[_uid] = nil
-
-    -- Add Menu commands after a delay of 0.1 seconds.
-    self:ScheduleOnce( 0.1, self._AddF10Commands, self, _unitName )
-
+    
+    if self.Coalition then
+      if EventData.IniCoalition == self.Coalition then
+        self:ScheduleOnce( 0.1, self._AddF10Commands, self, _unitName )
+      end
+    else
+      -- Add Menu commands after a delay of 0.1 seconds.
+      self:ScheduleOnce( 0.1, self._AddF10Commands, self, _unitName )
+    end
+    
     -- By default, some bomb impact points and do not flare each hit on target.
     self.PlayerSettings[_playername] = {} -- #RANGE.PlayerData
     self.PlayerSettings[_playername].smokebombimpact = self.defaultsmokebomb

Moose Development/Moose/Functional/Scoring.lua

@@ -27,7 +27,7 @@
 -- and creates a CSV file logging the scoring events and results for use at team or squadron websites.
 --
 -- SCORING automatically calculates the threat level of the objects hit and destroyed by players,
--- which can be @{Wrapper.Unit}, @{Static) and @{Scenery} objects.
+-- which can be @{Wrapper.Unit}, @{Wrapper.Static) and @{Scenery} objects.
 --
 -- Positive score points are granted when enemy or neutral targets are destroyed.
 -- Negative score points or penalties are given when a friendly target is hit or destroyed.
@@ -81,7 +81,7 @@
 --
 --   * **Wingthor (TAW)**: Testing & Advice.
 --   * **Dutch-Baron (TAW)**: Testing & Advice.
---   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing and Advice.
+--   * **Whisper**: Testing and Advice.
 --
 -- ===
 --
@@ -226,6 +226,7 @@ SCORING = {
   ClassID = 0,
   Players = {},
   AutoSave = true,
+  version = "1.17.1"
 }
 
 local _SCORINGCoalition = {
@@ -659,7 +660,7 @@ function SCORING:_AddPlayerFromUnit( UnitData )
         self.Players[PlayerName].Penalty = self.Players[PlayerName].Penalty + self.CoalitionChangePenalty or 50
         self.Players[PlayerName].PenaltyCoalition = self.Players[PlayerName].PenaltyCoalition + 1
         MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' changed coalition from " .. _SCORINGCoalition[self.Players[PlayerName].UnitCoalition] .. " to " .. _SCORINGCoalition[UnitCoalition] ..
-          "(changed " .. self.Players[PlayerName].PenaltyCoalition .. " times the coalition). ".. self.CoalitionChangePenalty .."Penalty points added.",
+          "(changed " .. self.Players[PlayerName].PenaltyCoalition .. " times the coalition). ".. self.CoalitionChangePenalty .." penalty points added.",
           MESSAGE.Type.Information
         ):ToAll()
         self:ScoreCSV( PlayerName, "", "COALITION_PENALTY",  1, -1*self.CoalitionChangePenalty, self.Players[PlayerName].UnitName, _SCORINGCoalition[self.Players[PlayerName].UnitCoalition], _SCORINGCategory[self.Players[PlayerName].UnitCategory], self.Players[PlayerName].UnitType,

Moose Development/Moose/Functional/Sead.lua

@@ -1,4 +1,4 @@
---- **Functional** - Make SAM sites execute evasive and defensive behaviour when being fired upon.
+--- **Functional** - Make SAM sites evasive and execute defensive behaviour when being fired upon.
 --
 -- ===
 --
@@ -19,7 +19,7 @@
 --
 -- ### Authors: **FlightControl**, **applevangelist**
 --
--- Last Update: Feb 2022
+-- Last Update: Oct 2023
 --
 -- ===
 --
@@ -34,7 +34,7 @@
 --
 -- This class is very easy to use. Just setup a SEAD object by using @{#SEAD.New}() and SAMs will evade and take defensive action when being fired upon.
 -- Once a HARM attack is detected, SEAD will shut down the radars of the attacked SAM site and take evasive action by moving the SAM
--- vehicles around (*if* they are drivable, that is). There's a component of randomness in detection and evasion, which is based on the
+-- vehicles around (*if* they are driveable, that is). There's a component of randomness in detection and evasion, which is based on the
 -- skill set of the SAM set (the higher the skill, the more likely). When a missile is fired from far away, the SAM will stay active for a 
 -- period of time to stay defensive, before it takes evasive actions.
 -- 
@@ -66,7 +66,6 @@ SEAD = {
   -- @field Harms
   SEAD.Harms = {
   ["AGM_88"] = "AGM_88",
-  ["AGM_45"] = "AGM_45",
   ["AGM_122"] = "AGM_122",
   ["AGM_84"] = "AGM_84",
   ["AGM_45"] = "AGM_45",
@@ -80,6 +79,7 @@ SEAD = {
   ["BGM_109"] = "BGM_109",
   ["AGM_154"] = "AGM_154",
   ["HY-2"] = "HY-2",
+  ["ADM_141A"] = "ADM_141A",
   }
 
   --- Missile enumerators - from DCS ME and Wikipedia
@@ -100,6 +100,7 @@ SEAD = {
   ["BGM_109"] = {460, 0.705}, --in-game ~465kn
   ["AGM_154"] = {130, 0.61},
   ["HY-2"] = {90,1},
+  ["ADM_141A"] = {126,0.6},
   }
 
 --- Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.
@@ -143,7 +144,7 @@ function SEAD:New( SEADGroupPrefixes, Padding )
   self:AddTransition("*",             "ManageEvasion",                "*")
   self:AddTransition("*",             "CalculateHitZone",             "*")
   
-  self:I("*** SEAD - Started Version 0.4.3")
+  self:I("*** SEAD - Started Version 0.4.5")
   return self
 end
 
@@ -203,7 +204,7 @@ function SEAD:SwitchEmissions(Switch)
   return self
 end
 
---- Add an object to call back when going evasive.
+--- Set an object to call back when going evasive.
 -- @param #SEAD self
 -- @param #table Object The object to call. Needs to have object functions as follows:
 -- `:SeadSuppressionPlanned(Group, Name, SuppressionStartTime, SuppressionEndTime)` 
@@ -348,8 +349,9 @@ end
 -- @param #string SEADWeaponName
 -- @param Wrapper.Group#GROUP SEADGroup Attacker Group
 -- @param #number timeoffset Offset for tti calc
+-- @param Wrapper.Weapon#WEAPON Weapon
 -- @return #SEAD self 
-function SEAD:onafterManageEvasion(From,Event,To,_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup,timeoffset)
+function SEAD:onafterManageEvasion(From,Event,To,_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup,timeoffset,Weapon)
   local timeoffset = timeoffset  or 0
   if _targetskill == "Random" then -- when skill is random, choose a skill
     local Skills = { "Average", "Good", "High", "Excellent" }
@@ -369,9 +371,13 @@ function SEAD:onafterManageEvasion(From,Event,To,_targetskill,_targetgroup,SEADP
       local reach = 10
       if hit then
         local wpndata = SEAD.HarmData[data]
-        reach = wpndata[1] * 1,1
+        reach = wpndata[1] * 1.1
         local mach = wpndata[2]
         wpnspeed = math.floor(mach * 340.29)
+        if Weapon then
+          wpnspeed = Weapon:GetSpeed()
+          self:T(string.format("*** SEAD - Weapon Speed from WEAPON: %f m/s",wpnspeed))
+        end
       end
       -- time to impact
       local _tti = math.floor(_distance / wpnspeed) - timeoffset -- estimated impact time
@@ -405,7 +411,7 @@ function SEAD:onafterManageEvasion(From,Event,To,_targetskill,_targetgroup,SEADP
         local function SuppressionStop(args)
           self:T(string.format("*** SEAD - %s Radar On",args[2]))
           local grp = args[1]  -- Wrapper.Group#GROUP
-          local name = args[2] -- #string Group Nam
+          local name = args[2] -- #string Group Name
           if self.UseEmissionsOnOff then
             grp:EnableEmission(true)
           end
@@ -424,7 +430,7 @@ function SEAD:onafterManageEvasion(From,Event,To,_targetskill,_targetgroup,SEADP
         if _tti > 600 then delay =  _tti - 90 end -- shot from afar, 600 is default shorad ontime
   
         local SuppressionStartTime = timer.getTime() + delay
-        local SuppressionEndTime = timer.getTime() + _tti + self.Padding
+        local SuppressionEndTime = timer.getTime() + delay + _tti + self.Padding + delay
         local _targetgroupname = _targetgroup:GetName()
         if not self.SuppressedGroups[_targetgroupname] then
           self:T(string.format("*** SEAD - %s | Parameters TTI %ds | Switch-Off in %ds",_targetgroupname,_tti,delay))
@@ -457,6 +463,9 @@ function SEAD:HandleEventShot( EventData )
   local SEADWeapon = EventData.Weapon -- Identify the weapon fired
   local SEADWeaponName = EventData.WeaponName -- return weapon type
 
+  local WeaponWrapper = WEAPON:New(EventData.Weapon)
+  --local SEADWeaponSpeed = WeaponWrapper:GetSpeed() -- mps
+  
   self:T( "*** SEAD - Missile Launched = " .. SEADWeaponName)
   --self:T({ SEADWeapon })
 
@@ -475,7 +484,7 @@ function SEAD:HandleEventShot( EventData )
       end
       return self
     end
-    local targetcat = _target:getCategory() -- Identify category
+    local targetcat = Object.getCategory(_target) -- Identify category
     local _targetUnit = nil -- Wrapper.Unit#UNIT
     local _targetgroup = nil -- Wrapper.Group#GROUP
     self:T(string.format("*** Targetcat = %d",targetcat))
@@ -513,7 +522,11 @@ function SEAD:HandleEventShot( EventData )
       end
     end
     if SEADGroupFound == true then -- yes we are being attacked
-      self:ManageEvasion(_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup)
+      if string.find(SEADWeaponName,"ADM_141",1,true) then
+        self:__ManageEvasion(2,_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup,0,WeaponWrapper)
+      else
+        self:ManageEvasion(_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup,0,WeaponWrapper)
+      end
     end
   end
   return self

Moose Development/Moose/Functional/Shorad.lua

@@ -21,6 +21,7 @@
 -- @image Functional.Shorad.jpg
 --
 -- Date: Nov 2021
+-- Last Update: Nov 2023
 
 -------------------------------------------------------------------------
 --- **SHORAD** class, extends Core.Base#BASE
@@ -39,8 +40,11 @@
 -- @field #boolean DefendHarms Default true, intercept incoming HARMS
 -- @field #boolean DefendMavs Default true, intercept incoming AG-Missiles
 -- @field #number DefenseLowProb Default 70, minimum detection limit
--- @field #number DefenseHighProb Default 90, maximim detection limit
+-- @field #number DefenseHighProb Default 90, maximum detection limit
 -- @field #boolean UseEmOnOff Decide if we are using Emission on/off (default) or AlarmState red/green.
+-- @field #boolean shootandscoot
+-- @field #number SkateNumber
+-- @field Core.Set#SET_ZONE SkateZones  
 -- @extends Core.Base#BASE
 
 
@@ -99,7 +103,10 @@ SHORAD = {
   DefendMavs = true,
   DefenseLowProb = 70,
   DefenseHighProb = 90,
-  UseEmOnOff = false,  
+  UseEmOnOff = true,
+  shootandscoot = false,
+  SkateNumber = 3,
+  SkateZones = nil,
 }
 
 -----------------------------------------------------------------------
@@ -112,7 +119,6 @@ do
   -- @field Harms
   SHORAD.Harms = {
   ["AGM_88"] = "AGM_88",
-  ["AGM_45"] = "AGM_45",
   ["AGM_122"] = "AGM_122",
   ["AGM_84"] = "AGM_84",
   ["AGM_45"] = "AGM_45",
@@ -123,6 +129,8 @@ do
   ["X_25"] = "X_25",
   ["X_31"] = "X_31",
   ["Kh25"] = "Kh25",
+  ["HY-2"] = "HY-2",
+  ["ADM_141A"] = "ADM_141A",
   }
   
   --- TODO complete list?
@@ -134,7 +142,6 @@ do
   ["Kh29"] = "Kh29",
   ["Kh31"] = "Kh31",
   ["Kh66"] = "Kh66",
-  --["BGM_109"] = "BGM_109",
   }
   
   --- Instantiates a new SHORAD object
@@ -146,7 +153,7 @@ do
   -- @param #number ActiveTimer Determines how many seconds the systems stay on red alert after wake-up call
   -- @param #string Coalition Coalition, i.e. "blue", "red", or "neutral"
   -- @param #boolean UseEmOnOff Use Emissions On/Off rather than Alarm State Red/Green (default: use Emissions switch)
-  -- @retunr #SHORAD self
+  -- @return #SHORAD self
   function SHORAD:New(Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition, UseEmOnOff) 
     local self = BASE:Inherit( self, FSM:New() )
     self:T({Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition})
@@ -165,8 +172,9 @@ do
     self.DefendMavs = true
     self.DefenseLowProb = 70 -- probability to detect a missile shot, low margin
     self.DefenseHighProb = 90  -- probability to detect a missile shot, high margin
-    self.UseEmOnOff = UseEmOnOff or false -- Decide if we are using Emission on/off (default) or AlarmState red/green
-    self:I("*** SHORAD - Started Version 0.3.1")
+    self.UseEmOnOff = true -- Decide if we are using Emission on/off (default) or AlarmState red/green
+    if UseEmOnOff == false then self.UseEmOnOff = UseEmOnOff end
+    self:I("*** SHORAD - Started Version 0.3.2")
     -- Set the string id for output to DCS.log file.
     self.lid=string.format("SHORAD %s | ", self.name)
     self:_InitState()
@@ -176,12 +184,14 @@ do
     self:SetStartState("Running")
     self:AddTransition("*",             "WakeUpShorad",                 "*")
     self:AddTransition("*",             "CalculateHitZone",             "*")
+    self:AddTransition("*",             "ShootAndScoot",                "*")
     
     return self
   end
   
   --- Initially set all groups to alarm state GREEN
   -- @param #SHORAD self
+  -- @return #SHORAD self
   function SHORAD:_InitState()
     self:T(self.lid .. " _InitState")
     local table = {}
@@ -205,21 +215,36 @@ do
     return self
   end
   
+  --- Add a SET_ZONE of zones for Shoot&Scoot
+  -- @param #SHORAD self
+  -- @param Core.Set#SET_ZONE ZoneSet Set of zones to be used. Units will move around to the next (random) zone between 100m and 3000m away.
+  -- @param #number Number Number of closest zones to be considered, defaults to 3.
+  -- @return #SHORAD self
+  function SHORAD:AddScootZones(ZoneSet, Number)
+    self:T(self.lid .. " AddScootZones")
+    self.SkateZones = ZoneSet
+    self.SkateNumber = Number or 3
+    self.shootandscoot = true    
+    return self
+  end
+  
   --- Switch debug state on
   -- @param #SHORAD self
   -- @param #boolean debug Switch debug on (true) or off (false)
+  -- @return #SHORAD self 
   function SHORAD:SwitchDebug(onoff)
     self:T( { onoff } )
     if onoff then
       self:SwitchDebugOn()
     else
-      self.SwitchDebugOff()
+      self:SwitchDebugOff()
     end
     return self
   end
   
   --- Switch debug state on
   -- @param #SHORAD self
+  -- @return #SHORAD self 
   function SHORAD:SwitchDebugOn()
      self.debug = true
      --tracing
@@ -230,6 +255,7 @@ do
   
   --- Switch debug state off
   -- @param #SHORAD self
+  -- @return #SHORAD self 
   function SHORAD:SwitchDebugOff()
     self.debug = false
     BASE:TraceOff()
@@ -239,6 +265,7 @@ do
   --- Switch defense for HARMs
   -- @param #SHORAD self
   -- @param #boolean onoff
+  -- @return #SHORAD self 
   function SHORAD:SwitchHARMDefense(onoff)
     self:T( { onoff } )
     local onoff = onoff or true
@@ -249,6 +276,7 @@ do
   --- Switch defense for AGMs
   -- @param #SHORAD self
   -- @param #boolean onoff
+  -- @return #SHORAD self 
   function SHORAD:SwitchAGMDefense(onoff)
     self:T( { onoff } )
     local onoff = onoff or true
@@ -260,6 +288,7 @@ do
   -- @param #SHORAD self
   -- @param #number low Minimum detection limit, integer 1-100
   -- @param #number high Maximum detection limit integer 1-100
+  -- @return #SHORAD self 
   function SHORAD:SetDefenseLimits(low,high)
     self:T( { low, high } )
     local low = low or 70
@@ -278,6 +307,7 @@ do
   --- Set the number of seconds a SHORAD site will stay active
   -- @param #SHORAD self
   -- @param #number seconds Number of seconds systems stay active
+  -- @return #SHORAD self 
   function SHORAD:SetActiveTimer(seconds)
     self:T(self.lid .. " SetActiveTimer")
     local timer = seconds or 600
@@ -291,6 +321,7 @@ do
   --- Set the number of meters for the SHORAD defense zone
   -- @param #SHORAD self
   -- @param #number meters Radius of the defense search zone in meters. #SHORADs in this range around a targeted group will go active 
+  -- @return #SHORAD self 
   function SHORAD:SetDefenseRadius(meters)
   self:T(self.lid .. " SetDefenseRadius")
     local radius = meters or 20000
@@ -304,6 +335,7 @@ do
   --- Set using Emission on/off instead of changing alarm state
   -- @param #SHORAD self
   -- @param #boolean switch Decide if we are changing alarm state or AI state
+  -- @return #SHORAD self 
   function SHORAD:SetUsingEmOnOff(switch)
   self:T(self.lid .. " SetUsingEmOnOff")
     self.UseEmOnOff = switch or false
@@ -375,11 +407,11 @@ do
     local shorad = self.Groupset
     local shoradset = shorad:GetAliveSet() --#table
     local returnname = false
+    --local TDiff = 1
     for _,_groups in pairs (shoradset) do
       local groupname = _groups:GetName()
       if string.find(groupname, tgtgrp, 1, true) then
         returnname = true
-        --_groups:RelocateGroundRandomInRadius(7,100,false,false) -- be a bit evasive
       end
     end
     return returnname  
@@ -426,6 +458,7 @@ do
   -- @param #number Radius Radius of the #ZONE
   -- @param #number ActiveTimer Number of seconds to stay active
   -- @param #number TargetCat (optional) Category, i.e. Object.Category.UNIT or Object.Category.STATIC
+  -- @return #SHORAD self 
   -- @usage Use this function to integrate with other systems, example   
   -- 
   -- local SamSet = SET_GROUP:New():FilterPrefixes("Blue SAM"):FilterCoalitions("blue"):FilterStart()
@@ -452,28 +485,35 @@ do
     local targetzone = ZONE_RADIUS:New("Shorad",targetvec2,Radius)  -- create a defense zone to check
     local groupset = self.Groupset --Core.Set#SET_GROUP
     local shoradset = groupset:GetAliveSet() --#table
+    
     -- local function to switch off shorad again
     local function SleepShorad(group)
-      local groupname = group:GetName()
-      self.ActiveGroups[groupname] = nil
-      if self.UseEmOnOff then
-        group:EnableEmission(false)
-        --group:SetAIOff()
-      else
-        group:OptionAlarmStateGreen()
+      if group and group:IsAlive() then
+        local groupname = group:GetName()
+        self.ActiveGroups[groupname] = nil
+        if self.UseEmOnOff then
+          group:EnableEmission(false)
+        else
+          group:OptionAlarmStateGreen()
+        end
+        local text = string.format("Sleeping SHORAD %s", group:GetName())
+        self:T(text)
+        local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
+        --Shoot and Scoot
+        if self.shootandscoot then
+          self:__ShootAndScoot(1,group)
+        end
       end
-      local text = string.format("Sleeping SHORAD %s", group:GetName())
-      self:T(text)
-      local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
     end
+    
     -- go through set and find the one(s) to activate
+    local TDiff = 4
     for _,_group in pairs (shoradset) do
       if _group:IsAnyInZone(targetzone) then
         local text = string.format("Waking up SHORAD %s", _group:GetName())
         self:T(text)
         local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
         if self.UseEmOnOff then
-          --_group:SetAIOn()
           _group:EnableEmission(true)
         end
         _group:OptionAlarmStateRed()
@@ -481,91 +521,128 @@ do
         if self.ActiveGroups[groupname] == nil then -- no timer yet for this group
           self.ActiveGroups[groupname] = { Timing = ActiveTimer }
           local endtime = timer.getTime() + (ActiveTimer * math.random(75,100) / 100 ) -- randomize wakeup a bit
-          timer.scheduleFunction(SleepShorad, _group, endtime)
+          self.ActiveGroups[groupname].Timer = TIMER:New(SleepShorad,_group):Start(endtime)
+          --Shoot and Scoot
+          if self.shootandscoot then
+            self:__ShootAndScoot(TDiff,_group)
+            TDiff=TDiff+1
+          end
         end
       end
     end
     return self
   end
   
---- (Internal) Calculate hit zone of an AGM-88
--- @param #SHORAD self
--- @param #table SEADWeapon DCS.Weapon object
--- @param Core.Point#COORDINATE pos0 Position of the plane when it fired
--- @param #number height Height when the missile was fired
--- @param Wrapper.Group#GROUP SEADGroup Attacker group
--- @return #SHORAD self 
-function SHORAD:onafterCalculateHitZone(From,Event,To,SEADWeapon,pos0,height,SEADGroup)
-  self:T("**** Calculating hit zone")
-  if SEADWeapon and SEADWeapon:isExist() then
-    --local pos = SEADWeapon:getPoint()
+  --- (Internal) Calculate hit zone of an AGM-88
+  -- @param #SHORAD self
+  -- @param #table SEADWeapon DCS.Weapon object
+  -- @param Core.Point#COORDINATE pos0 Position of the plane when it fired
+  -- @param #number height Height when the missile was fired
+  -- @param Wrapper.Group#GROUP SEADGroup Attacker group
+  -- @return #SHORAD self 
+  function SHORAD:onafterCalculateHitZone(From,Event,To,SEADWeapon,pos0,height,SEADGroup)
+    self:T("**** Calculating hit zone")
+    if SEADWeapon and SEADWeapon:isExist() then
+      --local pos = SEADWeapon:getPoint()
+      
+      -- postion and height
+      local position = SEADWeapon:getPosition()
+      local mheight = height
+      -- heading
+      local wph = math.atan2(position.x.z, position.x.x)      
+      if wph < 0 then
+        wph=wph+2*math.pi
+      end   
+      wph=math.deg(wph)
+      
+      -- velocity
+      local wpndata = SEAD.HarmData["AGM_88"]
+      local mveloc = math.floor(wpndata[2] * 340.29)
+      local c1 = (2*mheight*9.81)/(mveloc^2)
+      local c2 = (mveloc^2) / 9.81
+      local Ropt = c2 * math.sqrt(c1+1) 
+      if height <= 5000 then
+        Ropt = Ropt * 0.72
+      elseif height <= 7500 then
+        Ropt = Ropt * 0.82  
+      elseif height <= 10000 then
+        Ropt = Ropt * 0.87
+      elseif height <= 12500 then
+        Ropt = Ropt * 0.98
+      end
+      
+      -- look at a couple of zones across the trajectory
+      for n=1,3 do
+        local dist = Ropt - ((n-1)*20000)
+        local predpos= pos0:Translate(dist,wph)
+        if predpos then
     
-    -- postion and height
-    local position = SEADWeapon:getPosition()
-    local mheight = height
-    -- heading
-    local wph = math.atan2(position.x.z, position.x.x)      
-    if wph < 0 then
-      wph=wph+2*math.pi
-    end   
-    wph=math.deg(wph)
-    
-    -- velocity
-    local wpndata = SEAD.HarmData["AGM_88"]
-    local mveloc = math.floor(wpndata[2] * 340.29)
-    local c1 = (2*mheight*9.81)/(mveloc^2)
-    local c2 = (mveloc^2) / 9.81
-    local Ropt = c2 * math.sqrt(c1+1) 
-    if height <= 5000 then
-      Ropt = Ropt * 0.72
-    elseif height <= 7500 then
-      Ropt = Ropt * 0.82  
-    elseif height <= 10000 then
-      Ropt = Ropt * 0.87
-    elseif height <= 12500 then
-      Ropt = Ropt * 0.98
+          local targetzone = ZONE_RADIUS:New("Target Zone",predpos:GetVec2(),20000)
+          
+          if self.debug then
+            predpos:MarkToAll(string.format("height=%dm | heading=%d | velocity=%ddeg | Ropt=%dm",mheight,wph,mveloc,Ropt),false)
+            targetzone:DrawZone(coalition.side.BLUE,{0,0,1},0.2,nil,nil,3,true)
+          end  
+          
+          local seadset = self.Groupset
+          local tgtcoord = targetzone:GetRandomPointVec2()
+          local tgtgrp = seadset:FindNearestGroupFromPointVec2(tgtcoord)
+          local _targetgroup = nil
+          local _targetgroupname = "none"
+          local _targetskill = "Random"
+          if tgtgrp and tgtgrp:IsAlive() then
+            _targetgroup = tgtgrp
+            _targetgroupname = tgtgrp:GetName() -- group name
+            _targetskill = tgtgrp:GetUnit(1):GetSkill()
+            self:T("*** Found Target = ".. _targetgroupname)
+            self:WakeUpShorad(_targetgroupname, self.Radius, self.ActiveTimer, Object.Category.UNIT)
+          end
+        end
+      end     
     end
-    
-    -- look at a couple of zones across the trajectory
-    for n=1,3 do
-      local dist = Ropt - ((n-1)*20000)
-      local predpos= pos0:Translate(dist,wph)
-      if predpos then
+    return self
+  end
   
-        local targetzone = ZONE_RADIUS:New("Target Zone",predpos:GetVec2(),20000)
-        
-        if self.debug then
-          predpos:MarkToAll(string.format("height=%dm | heading=%d | velocity=%ddeg | Ropt=%dm",mheight,wph,mveloc,Ropt),false)
-          targetzone:DrawZone(coalition.side.BLUE,{0,0,1},0.2,nil,nil,3,true)
-        end  
-        
-        local seadset = self.Groupset
-        local tgtcoord = targetzone:GetRandomPointVec2()
-        local tgtgrp = seadset:FindNearestGroupFromPointVec2(tgtcoord)
-        local _targetgroup = nil
-        local _targetgroupname = "none"
-        local _targetskill = "Random"
-        if tgtgrp and tgtgrp:IsAlive() then
-          _targetgroup = tgtgrp
-          _targetgroupname = tgtgrp:GetName() -- group name
-          _targetskill = tgtgrp:GetUnit(1):GetSkill()
-          self:T("*** Found Target = ".. _targetgroupname)
-          self:WakeUpShorad(_targetgroupname, self.Radius, self.ActiveTimer, Object.Category.UNIT)
+  --- (Internal) Shoot and Scoot
+  -- @param #SHORAD self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Wrapper.Group#GROUP Shorad Shorad group
+  -- @return #SHORAD self 
+  function SHORAD:onafterShootAndScoot(From,Event,To,Shorad)
+    self:T( { From,Event,To } )
+    local possibleZones = {}
+    local mindist = 100
+    local maxdist = 3000
+    if Shorad and Shorad:IsAlive() then
+      local NowCoord = Shorad:GetCoordinate()
+      for _,_zone in pairs(self.SkateZones.Set) do
+        local zone = _zone -- Core.Zone#ZONE_RADIUS
+        local dist = NowCoord:Get2DDistance(zone:GetCoordinate())
+        if dist >= mindist and dist <= maxdist then
+          possibleZones[#possibleZones+1] = zone
+          if #possibleZones == self.SkateNumber then break end
         end
       end
-    end     
+      if #possibleZones > 0 and Shorad:GetVelocityKMH() < 2 then
+        local rand = math.floor(math.random(1,#possibleZones*1000)/1000+0.5)
+        if rand == 0 then rand = 1 end
+        self:T(self.lid .. " ShootAndScoot to zone "..rand)
+        local ToCoordinate = possibleZones[rand]:GetCoordinate()
+        Shorad:RouteGroundTo(ToCoordinate,20,"Cone",1)
+      end
+    end
+    return self
   end
-  return self
-end
   
   --- Main function - work on the EventData
   -- @param #SHORAD self
   -- @param Core.Event#EVENTDATA EventData The event details table data set
+  -- @return #SHORAD self 
   function SHORAD:HandleEventShot( EventData )
     self:T( { EventData } )
     self:T(self.lid .. " HandleEventShot")
-    --local ShootingUnit = EventData.IniDCSUnit
-    --local ShootingUnitName = EventData.IniDCSUnitName
     local ShootingWeapon = EventData.Weapon -- Identify the weapon fired
     local ShootingWeaponName = EventData.WeaponName -- return weapon type
     -- get firing coalition
@@ -596,27 +673,18 @@ end
           return self
         end
         
-        local targetcat = targetdata:getCategory() -- Identify category
+        local targetcat = Object.getCategory(targetdata) -- Identify category
         self:T(string.format("Target Category (3=STATIC, 1=UNIT)= %s",tostring(targetcat)))
         self:T({targetdata})
         local targetunit = nil
         if targetcat == Object.Category.UNIT then -- UNIT
           targetunit = UNIT:Find(targetdata)
         elseif targetcat == Object.Category.STATIC then  -- STATIC
-          --self:T("Static Target Data")
-          --self:T({targetdata:isExist()})
-          --self:T({targetdata:getPoint()})
           local tgtcoord = COORDINATE:NewFromVec3(targetdata:getPoint())
-          --tgtcoord:MarkToAll("Missile Target",true)
-          
-          local tgtgrp1 = self.Samset:FindNearestGroupFromPointVec2(tgtcoord)
+         local tgtgrp1 = self.Samset:FindNearestGroupFromPointVec2(tgtcoord)
           local tgtcoord1 = tgtgrp1:GetCoordinate()
-          --tgtcoord1:MarkToAll("Close target SAM",true)
-          
           local tgtgrp2 = self.Groupset:FindNearestGroupFromPointVec2(tgtcoord)
           local tgtcoord2 = tgtgrp2:GetCoordinate()
-          --tgtcoord2:MarkToAll("Close target SHORAD",true)
-          
           local dist1 = tgtcoord:Get2DDistance(tgtcoord1)
           local dist2 = tgtcoord:Get2DDistance(tgtcoord2)
           
@@ -628,10 +696,8 @@ end
             targetcat = Object.Category.UNIT
           end
         end   
-        --local targetunitname = Unit.getName(targetdata) -- Unit name
         if targetunit and targetunit:IsAlive() then
           local targetunitname = targetunit:GetName()
-          --local targetgroup = Unit.getGroup(Weapon.getTarget(ShootingWeapon)) --targeted group
           local targetgroup = nil
           local targetgroupname = "none"
           if targetcat == Object.Category.UNIT then
@@ -649,7 +715,6 @@ end
           self:T( text )
           local m = MESSAGE:New(text,10,"Info"):ToAllIf(self.debug)
           -- check if we or a SAM site are the target 
-          --local TargetGroup = EventData.TgtGroup -- Wrapper.Group#GROUP
           local shotatus = self:_CheckShotAtShorad(targetgroupname) --#boolean
           local shotatsams = self:_CheckShotAtSams(targetgroupname) --#boolean
           -- if being shot at, find closest SHORADs to activate

Moose Development/Moose/Functional/Suppression.lua

@@ -33,9 +33,9 @@
 -- 
 -- ===
 -- 
--- ### Author: **[funkyfranky](https://forums.eagle.ru/member.php?u=115026)**
+-- ### Author: **funkyfranky**
 -- 
--- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536)
+-- ### Contributions: FlightControl
 -- 
 -- ===
 -- 

Moose Development/Moose/Functional/Warehouse.lua

@@ -742,7 +742,7 @@
 --
 -- ## Save Assets
 --
--- Saving asset data to file is achieved by the @{WAREHOUSE.Save}(*path*, *filename*) function. The parameter *path* specifies the path on the file system where the
+-- Saving asset data to file is achieved by the @{#WAREHOUSE.Save}(*path*, *filename*) function. The parameter *path* specifies the path on the file system where the
 -- warehouse data is saved. If you do not specify a path, the file is saved your the DCS installation root directory.
 -- The parameter *filename* is optional and defines the name of the saved file. By default this is automatically created from the warehouse id and name, for example
 -- "Warehouse-1234_Batumi.txt".
@@ -753,13 +753,13 @@
 --
 -- ### Automatic Save at Mission End
 --
--- The assets can be saved automatically when the mission is ended via the @{WAREHOUSE.SetSaveOnMissionEnd}(*path*, *filename*) function, i.e.
+-- The assets can be saved automatically when the mission is ended via the @{#WAREHOUSE.SetSaveOnMissionEnd}(*path*, *filename*) function, i.e.
 --
 --     warehouseBatumi:SetSaveOnMissionEnd("D:\\My Warehouse Data\\")
 --
 -- ## Load Assets
 --
--- Loading assets data from file is achieved by the @{WAREHOUSE.Load}(*path*, *filename*) function. The parameter *path* specifies the path on the file system where the
+-- Loading assets data from file is achieved by the @{#WAREHOUSE.Load}(*path*, *filename*) function. The parameter *path* specifies the path on the file system where the
 -- warehouse data is loaded from. If you do not specify a path, the file is loaded from your the DCS installation root directory.
 -- The parameter *filename* is optional and defines the name of the file to load. By default this is automatically generated from the warehouse id and name, for example
 -- "Warehouse-1234_Batumi.txt".
@@ -3616,9 +3616,10 @@ function WAREHOUSE:onafterStatus(From, Event, To)
   end
 
   -- Print queue after processing requests.
-  self:_PrintQueue(self.queue, "Queue waiting")
-  self:_PrintQueue(self.pending, "Queue pending")
-
+  if self.verbosity > 2 then
+    self:_PrintQueue(self.queue, "Queue waiting")
+    self:_PrintQueue(self.pending, "Queue pending")
+  end
   -- Check fuel for all assets.
   --self:_CheckFuel()
 
@@ -4101,9 +4102,9 @@ function WAREHOUSE:_RegisterAsset(group, ngroups, forceattribute, forcecargobay,
   -- Get the size of an object.
   local function _GetObjectSize(DCSdesc)
     if DCSdesc.box then
-      local x=DCSdesc.box.max.x+math.abs(DCSdesc.box.min.x)  --length
-      local y=DCSdesc.box.max.y+math.abs(DCSdesc.box.min.y)  --height
-      local z=DCSdesc.box.max.z+math.abs(DCSdesc.box.min.z)  --width
+      local x=DCSdesc.box.max.x-DCSdesc.box.min.x  --length
+      local y=DCSdesc.box.max.y-DCSdesc.box.min.y  --height
+      local z=DCSdesc.box.max.z-DCSdesc.box.min.z  --width
       return math.max(x,z), x , y, z
     end
     return 0,0,0,0
@@ -5498,8 +5499,13 @@ function WAREHOUSE:onafterAssetDead(From, Event, To, asset, request)
       ---
   
       -- Remove dead group from cargo group set.
-      request.cargogroupset:Remove(groupname, NoTriggerEvent)
-      self:T(self.lid..string.format("Removed selfpropelled cargo %s: ncargo=%d.", groupname, request.cargogroupset:Count()))
+      if request.cargogroupset then
+        -- cargogroupset was nil for user case. Difficult to reproduce so we add a nil check.
+        request.cargogroupset:Remove(groupname, NoTriggerEvent)
+        self:T(self.lid..string.format("Removed selfpropelled cargo %s: ncargo=%d.", groupname, request.cargogroupset:Count()))
+      else
+        self:E(self.lid..string.format("ERROR: cargogroupset is nil for request ID=%s!", tostring(request.uid)))
+      end
   
     else
   
@@ -6671,7 +6677,13 @@ function WAREHOUSE:_OnEventCrashOrDead(EventData)
         self:Destroyed()
       end
       if self.airbase and self.airbasename and self.airbasename==EventData.IniUnitName then
-        self:RunwayDestroyed()      
+        if self:IsRunwayOperational() then
+          -- Trigger RunwayDestroyed event (only if it is not destroyed already)
+          self:RunwayDestroyed()
+        else
+          -- Reset the time stamp.
+          self.runwaydestroyed=timer.getAbsTime()
+        end        
       end
     end
 
@@ -6761,7 +6773,7 @@ function WAREHOUSE:_UnitDead(deadunit, deadgroup, request)
   -- Dont trigger a Remove event for the group sets.
   local NoTriggerEvent=true
 
-  if not request.transporttype==WAREHOUSE.TransportType.SELFPROPELLED then
+  if request.transporttype~=WAREHOUSE.TransportType.SELFPROPELLED then
 
     ---
     -- Complicated case: Dead unit could be:
@@ -7858,7 +7870,7 @@ function WAREHOUSE:_GetTerminal(_attribute, _category)
   -- Default terminal is "large".
   local _terminal=AIRBASE.TerminalType.OpenBig
 
-  if _attribute==WAREHOUSE.Attribute.AIR_FIGHTER then
+  if _attribute==WAREHOUSE.Attribute.AIR_FIGHTER or _attribute==WAREHOUSE.Attribute.AIR_UAV then
     -- Fighter ==> small.
     _terminal=AIRBASE.TerminalType.FighterAircraft
   elseif _attribute==WAREHOUSE.Attribute.AIR_BOMBER or _attribute==WAREHOUSE.Attribute.AIR_TRANSPORTPLANE or _attribute==WAREHOUSE.Attribute.AIR_TANKER or _attribute==WAREHOUSE.Attribute.AIR_AWACS then
@@ -8223,7 +8235,7 @@ end
 -- @return #number Request ID.
 function WAREHOUSE:_GetIDsFromGroupName(groupname)
 
-  ---@param #string text The text to analyse.
+  -- @param #string text The text to analyse.
   local function analyse(text)
 
     -- Get rid of #0001 tail from spawn.

Moose Development/Moose/Functional/ZoneCaptureCoalition.lua

@@ -363,8 +363,8 @@ do -- ZONE_CAPTURE_COALITION
 
   --- ZONE_CAPTURE_COALITION Constructor.
   -- @param #ZONE_CAPTURE_COALITION self
-  -- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved. Alternatively, can be handed as the name of late activated group describing a @{ZONE_POLYGON} with its waypoints.
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone.
+  -- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved. Alternatively, can be handed as the name of late activated group describing a @{Core.Zone#ZONE_POLYGON} with its waypoints.
+  -- @param #number Coalition The initial coalition owning the zone.
   -- @param #table UnitCategories Table of unit categories. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit). Default {Unit.Category.GROUND_UNIT}.
   -- @param #table ObjectCategories Table of unit categories. See [DCS Class Object](https://wiki.hoggitworld.com/view/DCS_Class_Object). Default {Object.Category.UNIT, Object.Category.STATIC}, i.e. all UNITS and STATICS.
   -- @return #ZONE_CAPTURE_COALITION

Moose Development/Moose/Functional/ZoneGoalCargo.lua

@@ -4,7 +4,12 @@
 -- 
 -- ZONE_GOAL_CARGO models processes that have a Goal with a defined achievement involving a Zone and Cargo.  
 -- Derived classes implement the ways how the achievements can be realized.
+--
+-- # Developer Note
 -- 
+-- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
+-- Therefore, this class is considered to be deprecated
+--
 -- ===
 -- 
 -- ### Author: **FlightControl**
@@ -56,7 +61,7 @@ do -- ZoneGoal
   --- ZONE_GOAL_CARGO Constructor.
   -- @param #ZONE_GOAL_CARGO self
   -- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved.
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone.
+  -- @param #number Coalition The initial coalition owning the zone.
   -- @return #ZONE_GOAL_CARGO
   function ZONE_GOAL_CARGO:New( Zone, Coalition )
   
@@ -254,7 +259,7 @@ do -- ZoneGoal
 
   --- Set the owning coalition of the zone.
   -- @param #ZONE_GOAL_CARGO self
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition
+  -- @param #number Coalition
   function ZONE_GOAL_CARGO:SetCoalition( Coalition )
     self.Coalition = Coalition
   end
@@ -262,7 +267,7 @@ do -- ZoneGoal
   
   --- Get the owning coalition of the zone.
   -- @param #ZONE_GOAL_CARGO self
-  -- @return DCSCoalition.DCSCoalition#coalition Coalition.
+  -- @return #number Coalition.
   function ZONE_GOAL_CARGO:GetCoalition()
     return self.Coalition
   end

Moose Development/Moose/Functional/ZoneGoalCoalition.lua

@@ -1,4 +1,4 @@
---- **Functional** - Base class that models processes to achieve goals involving a Zone for a Coalition.
+--- **Functional (WIP)** - Base class modeling processes to achieve goals involving coalition zones.
 --
 -- ===
 --
@@ -54,7 +54,7 @@ do -- ZoneGoal
   --- ZONE_GOAL_COALITION Constructor.
   -- @param #ZONE_GOAL_COALITION self
   -- @param Core.Zone#ZONE Zone A @{Core.Zone} object with the goal to be achieved.
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone. Default coalition.side.NEUTRAL.
+  -- @param #number Coalition The initial coalition owning the zone. Default coalition.side.NEUTRAL.
   -- @param #table UnitCategories Table of unit categories. See [DCS Class Unit](https://wiki.hoggitworld.com/view/DCS_Class_Unit). Default {Unit.Category.GROUND_UNIT}.
   -- @return #ZONE_GOAL_COALITION
   function ZONE_GOAL_COALITION:New( Zone, Coalition, UnitCategories )
@@ -80,7 +80,7 @@ do -- ZoneGoal
 
   --- Set the owning coalition of the zone.
   -- @param #ZONE_GOAL_COALITION self
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition The coalition ID, e.g. *coalition.side.RED*.
+  -- @param #number Coalition The coalition ID, e.g. *coalition.side.RED*.
   -- @return #ZONE_GOAL_COALITION
   function ZONE_GOAL_COALITION:SetCoalition( Coalition )
     self.PreviousCoalition = self.Coalition or Coalition
@@ -120,14 +120,14 @@ do -- ZoneGoal
 
   --- Get the owning coalition of the zone.
   -- @param #ZONE_GOAL_COALITION self
-  -- @return DCSCoalition.DCSCoalition#coalition Coalition.
+  -- @return #number Coalition.
   function ZONE_GOAL_COALITION:GetCoalition()
     return self.Coalition
   end
 
   --- Get the previous coalition, i.e. the one owning the zone before the current one. 
   -- @param #ZONE_GOAL_COALITION self
-  -- @return DCSCoalition.DCSCoalition#coalition Coalition.
+  -- @return #number Coalition.
   function ZONE_GOAL_COALITION:GetPreviousCoalition()
     return self.PreviousCoalition
   end

Moose Development/Moose/Modules.lua

@@ -1,51 +1,52 @@
 __Moose.Include( 'Scripts/Moose/Utilities/Enums.lua' )
-__Moose.Include( 'Scripts/Moose/Utilities/Routines.lua' )
-__Moose.Include( 'Scripts/Moose/Utilities/Utils.lua' )
-__Moose.Include( 'Scripts/Moose/Utilities/Profiler.lua' )
-__Moose.Include( 'Scripts/Moose/Utilities/Templates.lua' )
-__Moose.Include( 'Scripts/Moose/Utilities/STTS.lua' )
 __Moose.Include( 'Scripts/Moose/Utilities/FiFo.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/Profiler.lua' )
 __Moose.Include( 'Scripts/Moose/Utilities/Socket.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/STTS.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/Templates.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/Utils.lua' )
 
 __Moose.Include( 'Scripts/Moose/Core/Base.lua' )
+
 __Moose.Include( 'Scripts/Moose/Core/Astar.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Beacon.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Condition.lua' )
-__Moose.Include( 'Scripts/Moose/Core/UserFlag.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Report.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Scheduler.lua' )
-__Moose.Include( 'Scripts/Moose/Core/ScheduleDispatcher.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Event.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Settings.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Menu.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Zone.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Zone_Detection.lua' )
+__Moose.Include( 'Scripts/Moose/Core/ClientMenu.lua') 
 __Moose.Include( 'Scripts/Moose/Core/Database.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Set.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Point.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Velocity.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Message.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Event.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Fsm.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Goal.lua' )
+__Moose.Include( 'Scripts/Moose/Core/MarkerOps_Base.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Menu.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Message.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Point.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Report.lua' )
+__Moose.Include( 'Scripts/Moose/Core/ScheduleDispatcher.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Scheduler.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Set.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Settings.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Spawn.lua' )
 __Moose.Include( 'Scripts/Moose/Core/SpawnStatic.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Timer.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Goal.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Spot.lua' )
-__Moose.Include( 'Scripts/Moose/Core/MarkerOps_Base.lua' )
 __Moose.Include( 'Scripts/Moose/Core/TextAndSound.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Timer.lua' )
+__Moose.Include( 'Scripts/Moose/Core/UserFlag.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Velocity.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Zone_Detection.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Zone.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Pathline.lua' )
 
-__Moose.Include( 'Scripts/Moose/Wrapper/Object.lua' )
-__Moose.Include( 'Scripts/Moose/Wrapper/Identifiable.lua' )
-__Moose.Include( 'Scripts/Moose/Wrapper/Positionable.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Airbase.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Client.lua' )
 __Moose.Include( 'Scripts/Moose/Wrapper/Controllable.lua' )
 __Moose.Include( 'Scripts/Moose/Wrapper/Group.lua' )
-__Moose.Include( 'Scripts/Moose/Wrapper/Unit.lua' )
-__Moose.Include( 'Scripts/Moose/Wrapper/Client.lua' )
-__Moose.Include( 'Scripts/Moose/Wrapper/Static.lua' )
-__Moose.Include( 'Scripts/Moose/Wrapper/Airbase.lua' )
-__Moose.Include( 'Scripts/Moose/Wrapper/Scenery.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Identifiable.lua' )
 __Moose.Include( 'Scripts/Moose/Wrapper/Marker.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Object.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Positionable.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Scenery.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Static.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Unit.lua' )
 __Moose.Include( 'Scripts/Moose/Wrapper/Weapon.lua' )
 __Moose.Include( 'Scripts/Moose/Wrapper/Net.lua' )
 __Moose.Include( 'Scripts/Moose/Wrapper/Storage.lua' )
@@ -56,35 +57,64 @@ __Moose.Include( 'Scripts/Moose/Cargo/CargoSlingload.lua' )
 __Moose.Include( 'Scripts/Moose/Cargo/CargoCrate.lua' )
 __Moose.Include( 'Scripts/Moose/Cargo/CargoGroup.lua' )
 
-__Moose.Include( 'Scripts/Moose/Functional/Scoring.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/CleanUp.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/Movement.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/Sead.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/Escort.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/MissileTrainer.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/AICSAR.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/AmmoTruck.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Artillery.lua' )
 __Moose.Include( 'Scripts/Moose/Functional/ATC_Ground.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Autolase.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/CleanUp.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Designate.lua' )
 __Moose.Include( 'Scripts/Moose/Functional/Detection.lua' )
 __Moose.Include( 'Scripts/Moose/Functional/DetectionZones.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/Designate.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/RAT.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/Range.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/ZoneGoal.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/ZoneGoalCoalition.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/ZoneCaptureCoalition.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/Artillery.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/Suppression.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/PseudoATC.lua' )
-__Moose.Include( 'Scripts/Moose/Functional/Warehouse.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Escort.lua' )
 __Moose.Include( 'Scripts/Moose/Functional/Fox.lua' )
 __Moose.Include( 'Scripts/Moose/Functional/Mantis.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/MissileTrainer.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Movement.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/PseudoATC.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Range.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/RAT.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Scoring.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Sead.lua' )
 __Moose.Include( 'Scripts/Moose/Functional/Shorad.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Suppression.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Warehouse.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/ZoneCaptureCoalition.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/ZoneGoal.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/ZoneGoalCargo.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/ZoneGoalCoalition.lua' )
 
 __Moose.Include( 'Scripts/Moose/Ops/Airboss.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/AirWing.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/ArmyGroup.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/ATIS.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Auftrag.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Awacs.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Brigade.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Chief.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Cohort.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Commander.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/CSAR.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/CTLD.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Fleet.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/FlightControl.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/FlightGroup.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Flotilla.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Intelligence.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Legion.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/NavyGroup.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Operation.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/OpsGroup.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/OpsTransport.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/OpsZone.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Platoon.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/PlayerTask.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/PlayerRecce.lua' )
 __Moose.Include( 'Scripts/Moose/Ops/RecoveryTanker.lua' )
 __Moose.Include( 'Scripts/Moose/Ops/RescueHelo.lua' )
-__Moose.Include( 'Scripts/Moose/Ops/ATIS.lua' )
-__Moose.Include( 'Scripts/Moose/Ops/CTLD.lua' )
-__Moose.Include( 'Scripts/Moose/Ops/CSAR.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Squadron.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/Target.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/EasyGCICAP.lua' )
 
 __Moose.Include( 'Scripts/Moose/AI/AI_Balancer.lua' )
 __Moose.Include( 'Scripts/Moose/AI/AI_Air.lua' )
@@ -99,9 +129,9 @@ __Moose.Include( 'Scripts/Moose/AI/AI_A2G_CAS.lua' )
 __Moose.Include( 'Scripts/Moose/AI/AI_A2G_SEAD.lua' )
 __Moose.Include( 'Scripts/Moose/AI/AI_A2G_Dispatcher.lua' )
 __Moose.Include( 'Scripts/Moose/AI/AI_Patrol.lua' )
-__Moose.Include( 'Scripts/Moose/AI/AI_Cap.lua' )
-__Moose.Include( 'Scripts/Moose/AI/AI_Cas.lua' )
-__Moose.Include( 'Scripts/Moose/AI/AI_Bai.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_CAP.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_CAS.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_BAI.lua' )
 __Moose.Include( 'Scripts/Moose/AI/AI_Formation.lua' )
 __Moose.Include( 'Scripts/Moose/AI/AI_Escort.lua' )
 __Moose.Include( 'Scripts/Moose/AI/AI_Escort_Request.lua' )
@@ -123,12 +153,12 @@ __Moose.Include( 'Scripts/Moose/Actions/Act_Route.lua' )
 __Moose.Include( 'Scripts/Moose/Actions/Act_Account.lua' )
 __Moose.Include( 'Scripts/Moose/Actions/Act_Assist.lua' )
 
-__Moose.Include( 'Scripts/Moose/Sound/UserSound.lua' )
-__Moose.Include( 'Scripts/Moose/Sound/SoundOutput.lua' )
 __Moose.Include( 'Scripts/Moose/Sound/Radio.lua' )
 __Moose.Include( 'Scripts/Moose/Sound/RadioQueue.lua' )
 __Moose.Include( 'Scripts/Moose/Sound/RadioSpeech.lua' )
+__Moose.Include( 'Scripts/Moose/Sound/SoundOutput.lua' )
 __Moose.Include( 'Scripts/Moose/Sound/SRS.lua' )
+__Moose.Include( 'Scripts/Moose/Sound/UserSound.lua' )
 
 __Moose.Include( 'Scripts/Moose/Tasking/CommandCenter.lua' )
 __Moose.Include( 'Scripts/Moose/Tasking/Mission.lua' )
@@ -140,7 +170,7 @@ __Moose.Include( 'Scripts/Moose/Tasking/Task_A2G_Dispatcher.lua' )
 __Moose.Include( 'Scripts/Moose/Tasking/Task_A2G.lua' )
 __Moose.Include( 'Scripts/Moose/Tasking/Task_A2A_Dispatcher.lua' )
 __Moose.Include( 'Scripts/Moose/Tasking/Task_A2A.lua' )
-__Moose.Include( 'Scripts/Moose/Tasking/Task_Cargo.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_CARGO.lua' )
 __Moose.Include( 'Scripts/Moose/Tasking/Task_Cargo_Transport.lua' )
 __Moose.Include( 'Scripts/Moose/Tasking/Task_Cargo_CSAR.lua' )
 __Moose.Include( 'Scripts/Moose/Tasking/Task_Cargo_Dispatcher.lua' )

Moose Development/Moose/Modules_local.lua

@@ -0,0 +1,172 @@
+__Moose.Include( 'Utilities\\Enums.lua' )
+__Moose.Include( 'Utilities\\Routines.lua' )
+__Moose.Include( 'Utilities\\Utils.lua' )
+__Moose.Include( 'Utilities\\Profiler.lua' )
+__Moose.Include( 'Utilities\\Templates.lua' )
+__Moose.Include( 'Utilities\\STTS.lua' )
+__Moose.Include( 'Utilities\\FiFo.lua' )
+__Moose.Include( 'Utilities\\Socket.lua' )
+
+__Moose.Include( 'Core\\Base.lua' )
+__Moose.Include( 'Core\\Beacon.lua' )
+__Moose.Include( 'Core\\UserFlag.lua' )
+__Moose.Include( 'Core\\Report.lua' )
+__Moose.Include( 'Core\\Scheduler.lua' )
+__Moose.Include( 'Core\\ScheduleDispatcher.lua' )
+__Moose.Include( 'Core\\Event.lua' )
+__Moose.Include( 'Core\\Settings.lua' )
+__Moose.Include( 'Core\\Menu.lua' )
+__Moose.Include( 'Core\\Zone.lua' )
+__Moose.Include( 'Core\\Zone_Detection.lua' )
+__Moose.Include( 'Core\\Database.lua' )
+__Moose.Include( 'Core\\Set.lua' )
+__Moose.Include( 'Core\\Point.lua' )
+__Moose.Include( 'Core\\Velocity.lua' )
+__Moose.Include( 'Core\\Message.lua' )
+__Moose.Include( 'Core\\Fsm.lua' )
+__Moose.Include( 'Core\\Spawn.lua' )
+__Moose.Include( 'Core\\SpawnStatic.lua' )
+__Moose.Include( 'Core\\Timer.lua' )
+__Moose.Include( 'Core\\Goal.lua' )
+__Moose.Include( 'Core\\Spot.lua' )
+__Moose.Include( 'Core\\Astar.lua' )
+__Moose.Include( 'Core\\MarkerOps_Base.lua' )
+__Moose.Include( 'Core\\TextAndSound.lua' )
+__Moose.Include( 'Core\\Condition.lua' )
+__Moose.Include( 'Core\\ClientMenu.lua' )
+
+__Moose.Include( 'Wrapper\\Object.lua' )
+__Moose.Include( 'Wrapper\\Identifiable.lua' )
+__Moose.Include( 'Wrapper\\Positionable.lua' )
+__Moose.Include( 'Wrapper\\Controllable.lua' )
+__Moose.Include( 'Wrapper\\Group.lua' )
+__Moose.Include( 'Wrapper\\Unit.lua' )
+__Moose.Include( 'Wrapper\\Client.lua' )
+__Moose.Include( 'Wrapper\\Static.lua' )
+__Moose.Include( 'Wrapper\\Airbase.lua' )
+__Moose.Include( 'Wrapper\\Scenery.lua' )
+__Moose.Include( 'Wrapper\\Marker.lua' )
+
+__Moose.Include( 'Cargo\\Cargo.lua' )
+__Moose.Include( 'Cargo\\CargoUnit.lua' )
+__Moose.Include( 'Cargo\\CargoSlingload.lua' )
+__Moose.Include( 'Cargo\\CargoCrate.lua' )
+__Moose.Include( 'Cargo\\CargoGroup.lua' )
+
+__Moose.Include( 'Functional\\Scoring.lua' )
+__Moose.Include( 'Functional\\CleanUp.lua' )
+__Moose.Include( 'Functional\\Movement.lua' )
+__Moose.Include( 'Functional\\Sead.lua' )
+__Moose.Include( 'Functional\\Escort.lua' )
+__Moose.Include( 'Functional\\MissileTrainer.lua' )
+__Moose.Include( 'Functional\\ATC_Ground.lua' )
+__Moose.Include( 'Functional\\Detection.lua' )
+__Moose.Include( 'Functional\\DetectionZones.lua' )
+__Moose.Include( 'Functional\\Designate.lua' )
+__Moose.Include( 'Functional\\RAT.lua' )
+__Moose.Include( 'Functional\\Range.lua' )
+__Moose.Include( 'Functional\\ZoneGoal.lua' )
+__Moose.Include( 'Functional\\ZoneGoalCoalition.lua' )
+__Moose.Include( 'Functional\\ZoneCaptureCoalition.lua' )
+__Moose.Include( 'Functional\\Artillery.lua' )
+__Moose.Include( 'Functional\\Suppression.lua' )
+__Moose.Include( 'Functional\\PseudoATC.lua' )
+__Moose.Include( 'Functional\\Warehouse.lua' )
+__Moose.Include( 'Functional\\Fox.lua' )
+__Moose.Include( 'Functional\\Mantis.lua' )
+__Moose.Include( 'Functional\\Shorad.lua' )
+__Moose.Include( 'Functional\\Autolase.lua' )
+__Moose.Include( 'Functional\\AICSAR.lua' )
+
+__Moose.Include( 'Ops\\Airboss.lua' )
+__Moose.Include( 'Ops\\RecoveryTanker.lua' )
+__Moose.Include( 'Ops\\RescueHelo.lua' )
+__Moose.Include( 'Ops\\ATIS.lua' )
+__Moose.Include( 'Ops\\Auftrag.lua' )
+__Moose.Include( 'Ops\\Target.lua' )
+__Moose.Include( 'Ops\\OpsGroup.lua' )
+__Moose.Include( 'Ops\\FlightGroup.lua' )
+__Moose.Include( 'Ops\\NavyGroup.lua' )
+__Moose.Include( 'Ops\\ArmyGroup.lua' )
+__Moose.Include( 'Ops\\Cohort.lua' )
+__Moose.Include( 'Ops\\Squadron.lua' )
+__Moose.Include( 'Ops\\Platoon.lua' )
+__Moose.Include( 'Ops\\Legion.lua' )
+__Moose.Include( 'Ops\\AirWing.lua' )
+__Moose.Include( 'Ops\\Brigade.lua' )
+__Moose.Include( 'Ops\\Intelligence.lua' )
+__Moose.Include( 'Ops\\Commander.lua' )
+__Moose.Include( 'Ops\\OpsTransport.lua' )
+__Moose.Include( 'Ops\\CSAR.lua' )
+__Moose.Include( 'Ops\\CTLD.lua' )
+__Moose.Include( 'Ops\\OpsZone.lua' )
+__Moose.Include( 'Ops\\Chief.lua' )
+__Moose.Include( 'Ops\\Flotilla.lua' )
+__Moose.Include( 'Ops\\Fleet.lua' )
+__Moose.Include( 'Ops\\Awacs.lua' )
+__Moose.Include( 'Ops\\PlayerTask.lua' )
+__Moose.Include( 'Ops\\Operation.lua' )
+__Moose.Include( 'Ops\\FlightControl.lua' )
+
+__Moose.Include( 'AI\\AI_Balancer.lua' )
+__Moose.Include( 'AI\\AI_Air.lua' )
+__Moose.Include( 'AI\\AI_Air_Patrol.lua' )
+__Moose.Include( 'AI\\AI_Air_Engage.lua' )
+__Moose.Include( 'AI\\AI_A2A_Patrol.lua' )
+__Moose.Include( 'AI\\AI_A2A_Cap.lua' )
+__Moose.Include( 'AI\\AI_A2A_Gci.lua' )
+__Moose.Include( 'AI\\AI_A2A_Dispatcher.lua' )
+__Moose.Include( 'AI\\AI_A2G_BAI.lua' )
+__Moose.Include( 'AI\\AI_A2G_CAS.lua' )
+__Moose.Include( 'AI\\AI_A2G_SEAD.lua' )
+__Moose.Include( 'AI\\AI_A2G_Dispatcher.lua' )
+__Moose.Include( 'AI\\AI_Patrol.lua' )
+__Moose.Include( 'AI\\AI_Cap.lua' )
+__Moose.Include( 'AI\\AI_Cas.lua' )
+__Moose.Include( 'AI\\AI_Bai.lua' )
+__Moose.Include( 'AI\\AI_Formation.lua' )
+__Moose.Include( 'AI\\AI_Escort.lua' )
+__Moose.Include( 'AI\\AI_Escort_Request.lua' )
+__Moose.Include( 'AI\\AI_Escort_Dispatcher.lua' )
+__Moose.Include( 'AI\\AI_Escort_Dispatcher_Request.lua' )
+__Moose.Include( 'AI\\AI_Cargo.lua' )
+__Moose.Include( 'AI\\AI_Cargo_APC.lua' )
+__Moose.Include( 'AI\\AI_Cargo_Helicopter.lua' )
+__Moose.Include( 'AI\\AI_Cargo_Airplane.lua' )
+__Moose.Include( 'AI\\AI_Cargo_Ship.lua' )
+__Moose.Include( 'AI\\AI_Cargo_Dispatcher.lua' )
+__Moose.Include( 'AI\\AI_Cargo_Dispatcher_APC.lua' )
+__Moose.Include( 'AI\\AI_Cargo_Dispatcher_Helicopter.lua' )
+__Moose.Include( 'AI\\AI_Cargo_Dispatcher_Airplane.lua' )
+__Moose.Include( 'AI\\AI_Cargo_Dispatcher_Ship.lua' )
+
+__Moose.Include( 'Actions\\Act_Assign.lua' )
+__Moose.Include( 'Actions\\Act_Route.lua' )
+__Moose.Include( 'Actions\\Act_Account.lua' )
+__Moose.Include( 'Actions\\Act_Assist.lua' )
+
+__Moose.Include( 'Sound\\UserSound.lua' )
+__Moose.Include( 'Sound\\SoundOutput.lua' )
+__Moose.Include( 'Sound\\Radio.lua' )
+__Moose.Include( 'Sound\\RadioQueue.lua' )
+__Moose.Include( 'Sound\\RadioSpeech.lua' )
+__Moose.Include( 'Sound\\SRS.lua' )
+
+__Moose.Include( 'Tasking\\CommandCenter.lua' )
+__Moose.Include( 'Tasking\\Mission.lua' )
+__Moose.Include( 'Tasking\\Task.lua' )
+__Moose.Include( 'Tasking\\TaskInfo.lua' )
+__Moose.Include( 'Tasking\\Task_Manager.lua' )
+__Moose.Include( 'Tasking\\DetectionManager.lua' )
+__Moose.Include( 'Tasking\\Task_A2G_Dispatcher.lua' )
+__Moose.Include( 'Tasking\\Task_A2G.lua' )
+__Moose.Include( 'Tasking\\Task_A2A_Dispatcher.lua' )
+__Moose.Include( 'Tasking\\Task_A2A.lua' )
+__Moose.Include( 'Tasking\\Task_Cargo.lua' )
+__Moose.Include( 'Tasking\\Task_Cargo_Transport.lua' )
+__Moose.Include( 'Tasking\\Task_Cargo_CSAR.lua' )
+__Moose.Include( 'Tasking\\Task_Cargo_Dispatcher.lua' )
+__Moose.Include( 'Tasking\\Task_Capture_Zone.lua' )
+__Moose.Include( 'Tasking\\Task_Capture_Dispatcher.lua' )
+
+__Moose.Include( 'Globals.lua' )

Moose Development/Moose/Ops/Brigade.lua

@@ -0,0 +1,621 @@
+--- **Ops** - Brigade Warehouse.
+--
+-- **Main Features:**
+--
+--    * Manage platoons
+--    * Carry out ARTY and PATROLZONE missions (AUFTRAG)
+--    * Define rearming zones
+-- 
+-- ===
+--
+-- ## Example Missions:
+--
+-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/OPS%20-%20Brigade).
+-- 
+-- ===
+--
+-- ### Author: **funkyfranky**
+-- 
+-- ===
+-- @module Ops.Brigade
+-- @image OPS_Brigade_.png
+
+
+--- BRIGADE class.
+-- @type BRIGADE
+-- @field #string ClassName Name of the class.
+-- @field #number verbose Verbosity of output.
+-- @field #table rearmingZones Rearming zones. Each element is of type `#BRIGADE.SupplyZone`.
+-- @field #table refuellingZones Refuelling zones. Each element is of type `#BRIGADE.SupplyZone`.
+-- @field Core.Set#SET_ZONE retreatZones Retreat zone set.
+-- @extends Ops.Legion#LEGION
+
+--- *I am not afraid of an Army of lions lead by a sheep; I am afraid of sheep lead by a lion* -- Alexander the Great
+--
+-- ===
+--
+-- # The BRIGADE Concept
+--
+-- A BRIGADE consists of one or multiple PLATOONs. These platoons "live" in a WAREHOUSE that has a phyiscal struction (STATIC or UNIT) and can be captured or destroyed.
+--
+--
+-- @field #BRIGADE
+BRIGADE = {
+  ClassName       = "BRIGADE",
+  verbose         =     0,
+  rearmingZones   =    {},
+  refuellingZones =    {}, 
+}
+
+--- Supply Zone.
+-- @type BRIGADE.SupplyZone
+-- @field Core.Zone#ZONE zone The zone.
+-- @field Ops.Auftrag#AUFTRAG mission Mission assigned to supply ammo or fuel.
+-- @field #boolean markerOn If `true`, marker is on.
+-- @field Wrapper.Marker#MARKER marker F10 marker.
+
+--- BRIGADE class version.
+-- @field #string version
+BRIGADE.version="0.1.1"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- ToDo list
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+-- TODO: Spawn when hosting warehouse is a ship or oil rig or gas platform.
+-- TODO: Rearming zones.
+-- TODO: Retreat zones.
+-- DONE: Add weapon range.
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Constructor
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a new BRIGADE class object.
+-- @param #BRIGADE self
+-- @param #string WarehouseName Name of the warehouse STATIC or UNIT object representing the warehouse.
+-- @param #string BrigadeName Name of the brigade.
+-- @return #BRIGADE self
+function BRIGADE:New(WarehouseName, BrigadeName)
+
+  -- Inherit everything from LEGION class.
+  local self=BASE:Inherit(self, LEGION:New(WarehouseName, BrigadeName)) -- #BRIGADE
+
+  -- Nil check.
+  if not self then
+    BASE:E(string.format("ERROR: Could not find warehouse %s!", WarehouseName))
+    return nil
+  end
+
+  -- Set some string id for output to DCS.log file.
+  self.lid=string.format("BRIGADE %s | ", self.alias)
+  
+  -- Defaults
+  self:SetRetreatZones()
+  
+  -- Turn ship into NAVYGROUP.
+  if self:IsShip() then
+    local wh=self.warehouse --Wrapper.Unit#UNIT
+    local group=wh:GetGroup()
+    self.warehouseOpsGroup=NAVYGROUP:New(group) --Ops.NavyGroup#NAVYGROUP
+    self.warehouseOpsElement=self.warehouseOpsGroup:GetElementByName(wh:GetName())
+  end
+  
+  -- Add FSM transitions.
+  --                 From State  -->   Event         -->      To State
+  self:AddTransition("*",             "ArmyOnMission",       "*")           -- An ARMYGROUP was send on a Mission (AUFTRAG).
+
+  ------------------------
+  --- Pseudo Functions ---
+  ------------------------
+
+  --- Triggers the FSM event "Start". Starts the BRIGADE. Initializes parameters and starts event handlers.
+  -- @function [parent=#BRIGADE] Start
+  -- @param #BRIGADE self
+
+  --- Triggers the FSM event "Start" after a delay. Starts the BRIGADE. Initializes parameters and starts event handlers.
+  -- @function [parent=#BRIGADE] __Start
+  -- @param #BRIGADE self
+  -- @param #number delay Delay in seconds.
+
+
+  --- Triggers the FSM event "Stop". Stops the BRIGADE and all its event handlers.
+  -- @param #BRIGADE self
+
+  --- Triggers the FSM event "Stop" after a delay. Stops the BRIGADE and all its event handlers.
+  -- @function [parent=#BRIGADE] __Stop
+  -- @param #BRIGADE self
+  -- @param #number delay Delay in seconds.
+
+
+  --- Triggers the FSM event "ArmyOnMission".
+  -- @function [parent=#BRIGADE] ArmyOnMission
+  -- @param #BRIGADE self
+  -- @param Ops.ArmyGroup#ARMYGROUP ArmyGroup The ARMYGROUP on mission.
+  -- @param Ops.Auftrag#AUFTRAG Mission The mission.
+
+  --- Triggers the FSM event "ArmyOnMission" after a delay.
+  -- @function [parent=#BRIGADE] __ArmyOnMission
+  -- @param #BRIGADE self
+  -- @param #number delay Delay in seconds.
+  -- @param Ops.ArmyGroup#ARMYGROUP ArmyGroup The ARMYGROUP on mission.
+  -- @param Ops.Auftrag#AUFTRAG Mission The mission.
+
+  --- On after "ArmyOnMission" event.
+  -- @function [parent=#BRIGADE] OnAfterArmyOnMission
+  -- @param #BRIGADE self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param Ops.ArmyGroup#ARMYGROUP ArmyGroup The ARMYGROUP on mission.
+  -- @param Ops.Auftrag#AUFTRAG Mission The mission.
+
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- User Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Add a platoon to the brigade.
+-- @param #BRIGADE self
+-- @param Ops.Platoon#PLATOON Platoon The platoon object.
+-- @return #BRIGADE self
+function BRIGADE:AddPlatoon(Platoon)
+
+  -- Add platoon to brigade.
+  table.insert(self.cohorts, Platoon)
+
+  -- Add assets to platoon.
+  self:AddAssetToPlatoon(Platoon, Platoon.Ngroups)
+
+  -- Set brigade of platoon.
+  Platoon:SetBrigade(self)
+
+  -- Start platoon.
+  if Platoon:IsStopped() then
+    Platoon:Start()
+  end
+
+  return self
+end
+
+--- Add asset group(s) to platoon.
+-- @param #BRIGADE self
+-- @param Ops.Platoon#PLATOON Platoon The platoon object.
+-- @param #number Nassets Number of asset groups to add.
+-- @return #BRIGADE self
+function BRIGADE:AddAssetToPlatoon(Platoon, Nassets)
+
+  if Platoon then
+
+    -- Get the template group of the platoon.
+    local Group=GROUP:FindByName(Platoon.templatename)
+
+    if Group then
+
+      -- Debug text.
+      local text=string.format("Adding asset %s to platoon %s", Group:GetName(), Platoon.name)
+      self:T(self.lid..text)
+
+      -- Add assets to airwing warehouse.
+      self:AddAsset(Group, Nassets, nil, nil, nil, nil, Platoon.skill, Platoon.livery, Platoon.name)
+
+    else
+      self:E(self.lid.."ERROR: Group does not exist!")
+    end
+
+  else
+    self:E(self.lid.."ERROR: Platoon does not exit!")
+  end
+
+  return self
+end
+
+--- Define a set of retreat zones.
+-- @param #BRIGADE self
+-- @param Core.Set#SET_ZONE RetreatZoneSet Set of retreat zones.
+-- @return #BRIGADE self
+function BRIGADE:SetRetreatZones(RetreatZoneSet)
+  self.retreatZones=RetreatZoneSet or SET_ZONE:New()
+  return self
+end
+
+--- Add a retreat zone.
+-- @param #BRIGADE self
+-- @param Core.Zone#ZONE RetreatZone Retreat zone.
+-- @return #BRIGADE self
+function BRIGADE:AddRetreatZone(RetreatZone)
+  self.retreatZones:AddZone(RetreatZone)
+  return self
+end
+
+--- Get retreat zones.
+-- @param #BRIGADE self
+-- @return Core.Set#SET_ZONE Set of retreat zones.
+function BRIGADE:GetRetreatZones()
+  return self.retreatZones
+end
+
+--- Add a rearming zone.
+-- @param #BRIGADE self
+-- @param Core.Zone#ZONE RearmingZone Rearming zone.
+-- @return #BRIGADE.SupplyZone The rearming zone data.
+function BRIGADE:AddRearmingZone(RearmingZone)
+
+  local rearmingzone={} --#BRIGADE.SupplyZone
+  
+  rearmingzone.zone=RearmingZone
+  rearmingzone.mission=nil
+  rearmingzone.marker=MARKER:New(rearmingzone.zone:GetCoordinate(), "Rearming Zone"):ToCoalition(self:GetCoalition())
+
+  table.insert(self.rearmingZones, rearmingzone)
+
+  return rearmingzone
+end
+
+
+--- Add a refuelling zone.
+-- @param #BRIGADE self
+-- @param Core.Zone#ZONE RefuellingZone Refuelling zone.
+-- @return #BRIGADE.SupplyZone The refuelling zone data.
+function BRIGADE:AddRefuellingZone(RefuellingZone)
+
+  local supplyzone={} --#BRIGADE.SupplyZone
+  
+  supplyzone.zone=RefuellingZone
+  supplyzone.mission=nil
+  supplyzone.marker=MARKER:New(supplyzone.zone:GetCoordinate(), "Refuelling Zone"):ToCoalition(self:GetCoalition())
+
+  table.insert(self.refuellingZones, supplyzone)
+
+  return supplyzone
+end
+
+
+--- Get platoon by name.
+-- @param #BRIGADE self
+-- @param #string PlatoonName Name of the platoon.
+-- @return Ops.Platoon#PLATOON The Platoon object.
+function BRIGADE:GetPlatoon(PlatoonName)
+  local platoon=self:_GetCohort(PlatoonName)
+  return platoon
+end
+
+--- Get platoon of an asset.
+-- @param #BRIGADE self
+-- @param Functional.Warehouse#WAREHOUSE.Assetitem Asset The platoon asset.
+-- @return Ops.Platoon#PLATOON The platoon object.
+function BRIGADE:GetPlatoonOfAsset(Asset)
+  local platoon=self:GetPlatoon(Asset.squadname)
+  return platoon
+end
+
+--- Remove asset from platoon.
+-- @param #BRIGADE self
+-- @param Functional.Warehouse#WAREHOUSE.Assetitem Asset The platoon asset.
+function BRIGADE:RemoveAssetFromPlatoon(Asset)
+  local platoon=self:GetPlatoonOfAsset(Asset)
+  if platoon then
+    platoon:DelAsset(Asset)
+  end
+end
+
+
+--- [ GROUND ] Function to load back an asset in the field that has been filed before.
+-- @param #BRIGADE self
+-- @param #string Templatename e.g."1 PzDv LogRg I\_AID-976" - that's the alias (name) of an platoon spawned as `"platoon - alias"_AID-"asset-ID"`
+-- @param Core.Point#COORDINATE Position where to spawn the platoon
+-- @return #BRIGADE self
+-- @usage
+-- Prerequisites:
+-- Save the assets spawned by BRIGADE/CHIEF regularly (~every 5 mins) into a file, e.g. like this: 
+--   
+--              local Path = FilePath or "C:\\Users\\<yourname>\\Saved Games\\DCS\\Missions\\" -- example path
+--              local BlueOpsFilename = BlueFileName or "ExamplePlatoonSave.csv" -- example filename 
+--              local BlueSaveOps = SET_GROUP:New():FilterCoalitions("blue"):FilterPrefixes("AID"):FilterCategoryGround():FilterOnce()
+--              UTILS.SaveSetOfGroups(BlueSaveOps,Path,BlueOpsFilename)
+--          
+-- where Path and Filename are strings, as chosen by you.
+-- You can then load back the assets at the start of your next mission run. Be aware that it takes a couple of seconds for the 
+-- platoon data to arrive in brigade, so make this an action after ~20 seconds, e.g. like so:
+-- 
+--            function LoadBackAssets()
+--              local Path = FilePath or "C:\\Users\\<yourname>\\Saved Games\\DCS\\Missions\\" -- example path
+--              local BlueOpsFilename = BlueFileName or "ExamplePlatoonSave.csv" -- example filename  
+--              if UTILS.CheckFileExists(Path,BlueOpsFilename) then
+--                local loadback = UTILS.LoadSetOfGroups(Path,BlueOpsFilename,false)
+--                for _,_platoondata in pairs (loadback) do
+--                  local groupname = _platoondata.groupname -- #string
+--                  local coordinate = _platoondata.coordinate -- Core.Point#COORDINATE
+--                  Your_Brigade:LoadBackAssetInPosition(groupname,coordinate)
+--                end
+--              end
+--            end
+--  
+--            local AssetLoader = TIMER:New(LoadBackAssets)
+--            AssetLoader:Start(20)
+-- 
+-- The assets loaded back into the mission will be considered for AUFTRAG type missions from CHIEF and BRIGADE.
+function BRIGADE:LoadBackAssetInPosition(Templatename,Position)
+  self:T(self.lid .. "LoadBackAssetInPosition: " .. tostring(Templatename))
+  
+  -- get Platoon alias from Templatename
+  local nametbl = UTILS.Split(Templatename,"_")
+
+  local name = nametbl[1]
+  
+  self:T(string.format("*** Target Platoon = %s ***",name))
+  
+  -- find a matching asset table from BRIGADE
+  local cohorts = self.cohorts or {}
+  local thisasset = nil --Functional.Warehouse#WAREHOUSE.Assetitem
+  local found = false
+  
+  for _,_cohort in pairs(cohorts) do
+    local asset = _cohort:GetName()
+    self:T(string.format("*** Looking at Platoon = %s ***",asset))
+    if asset == name then
+      self:T("**** Found Platoon ****")
+      local cohassets = _cohort.assets or {}
+      for _,_zug in pairs (cohassets) do
+        local zug = _zug -- Functional.Warehouse#WAREHOUSE.Assetitem   
+        if zug.assignment == name and zug.requested == false then
+          self:T("**** Found Asset ****")
+          found = true
+          thisasset = zug --Functional.Warehouse#WAREHOUSE.Assetitem         
+        break
+        end
+      end
+    end
+  end
+  
+  if found then
+  
+    -- prep asset
+    thisasset.rid = thisasset.uid
+    thisasset.requested = false
+    thisasset.score=100
+    thisasset.missionTask="CAS"
+    thisasset.spawned = true
+    local template = thisasset.templatename
+    local alias = thisasset.spawngroupname
+            
+    -- Spawn group
+    local spawnasset = SPAWN:NewWithAlias(template,alias)
+      :InitDelayOff()
+      :SpawnFromCoordinate(Position)
+    
+    -- build a new self request
+    local request = {} --Functional.Warehouse#WAREHOUSE.Pendingitem
+    request.assignment = name
+    request.warehouse = self
+    request.assets = {thisasset}
+    request.ntransporthome = 0
+    request.ndelivered = 0
+    request.ntransport = 0
+    request.cargoattribute = thisasset.attribute
+    request.category = thisasset.category
+    request.cargoassets = {thisasset}
+    request.assetdesc = WAREHOUSE.Descriptor.ASSETLIST
+    request.cargocategory = thisasset.category
+    request.toself = true
+    request.transporttype = WAREHOUSE.TransportType.SELFPROPELLED
+    request.assetproblem = {}
+    request.born = true
+    request.prio = 50
+    request.uid = thisasset.uid
+    request.airbase = nil
+    request.timestamp = timer.getAbsTime()
+    request.assetdescval = {thisasset}
+    request.nasset = 1
+    request.cargogroupset = SET_GROUP:New()
+    request.cargogroupset:AddGroup(spawnasset)
+    request.iscargo = true
+    
+    -- Call Brigade self
+    self:__AssetSpawned(2, spawnasset, thisasset, request) 
+     
+  end
+  return self
+end
+
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- FSM Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Start BRIGADE FSM.
+-- @param #BRIGADE self
+function BRIGADE:onafterStart(From, Event, To)
+
+  -- Start parent Warehouse.
+  self:GetParent(self, BRIGADE).onafterStart(self, From, Event, To)
+
+  -- Info.
+  self:I(self.lid..string.format("Starting BRIGADE v%s", BRIGADE.version))
+
+end
+
+--- Update status.
+-- @param #BRIGADE self
+function BRIGADE:onafterStatus(From, Event, To)
+
+  -- Status of parent Warehouse.
+  self:GetParent(self).onafterStatus(self, From, Event, To)
+
+  -- FSM state.
+  local fsmstate=self:GetState()
+  
+  ----------------
+  -- Transport ---
+  ----------------
+  
+  self:CheckTransportQueue()
+
+  --------------
+  -- Mission ---
+  --------------
+
+  -- Check if any missions should be cancelled.
+  self:CheckMissionQueue()
+
+  ---------------------
+  -- Rearming Zones ---
+  ---------------------
+
+  for _,_rearmingzone in pairs(self.rearmingZones) do
+    local rearmingzone=_rearmingzone --#BRIGADE.SupplyZone
+    if (not rearmingzone.mission) or rearmingzone.mission:IsOver() then
+      rearmingzone.mission=AUFTRAG:NewAMMOSUPPLY(rearmingzone.zone)
+      self:AddMission(rearmingzone.mission)
+    end
+  end
+
+  -----------------------
+  -- Refuelling Zones ---
+  -----------------------
+
+  -- Check refuelling zones.
+  for _,_supplyzone in pairs(self.refuellingZones) do
+    local supplyzone=_supplyzone --#BRIGADE.SupplyZone
+    -- Check if mission is nil or over.      
+    if (not supplyzone.mission) or supplyzone.mission:IsOver() then
+      supplyzone.mission=AUFTRAG:NewFUELSUPPLY(supplyzone.zone)
+      self:AddMission(supplyzone.mission)
+    end
+  end    
+
+
+  -----------
+  -- Info ---
+  -----------    
+
+  -- General info:
+  if self.verbose>=1 then
+
+    -- Count missions not over yet.
+    local Nmissions=self:CountMissionsInQueue()
+
+    -- Asset count.
+    local Npq, Np, Nq=self:CountAssetsOnMission()
+
+    -- Asset string.
+    local assets=string.format("%d [OnMission: Total=%d, Active=%d, Queued=%d]", self:CountAssets(), Npq, Np, Nq)
+
+    -- Output.
+    local text=string.format("%s: Missions=%d, Platoons=%d, Assets=%s", fsmstate, Nmissions, #self.cohorts, assets)
+    self:I(self.lid..text)
+  end
+
+  ------------------
+  -- Mission Info --
+  ------------------
+  if self.verbose>=2 then
+    local text=string.format("Missions Total=%d:", #self.missionqueue)
+    for i,_mission in pairs(self.missionqueue) do
+      local mission=_mission --Ops.Auftrag#AUFTRAG
+
+      local prio=string.format("%d/%s", mission.prio, tostring(mission.importance)) ; if mission.urgent then prio=prio.." (!)" end
+      local assets=string.format("%d/%d", mission:CountOpsGroups(), mission.Nassets or 0)
+      local target=string.format("%d/%d Damage=%.1f", mission:CountMissionTargets(), mission:GetTargetInitialNumber(), mission:GetTargetDamage())
+
+      text=text..string.format("\n[%d] %s %s: Status=%s, Prio=%s, Assets=%s, Targets=%s", i, mission.name, mission.type, mission.status, prio, assets, target)
+    end
+    self:I(self.lid..text)
+  end
+
+  --------------------
+  -- Transport Info --
+  --------------------
+  if self.verbose>=2 then
+    local text=string.format("Transports Total=%d:", #self.transportqueue)
+    for i,_transport in pairs(self.transportqueue) do
+      local transport=_transport --Ops.OpsTransport#OPSTRANSPORT
+
+      local prio=string.format("%d/%s", transport.prio, tostring(transport.importance)) ; if transport.urgent then prio=prio.." (!)" end
+      local carriers=string.format("Ncargo=%d/%d, Ncarriers=%d", transport.Ncargo, transport.Ndelivered, transport.Ncarrier)
+
+      text=text..string.format("\n[%d] UID=%d: Status=%s, Prio=%s, Cargo: %s", i, transport.uid, transport:GetState(), prio, carriers)
+    end
+    self:I(self.lid..text)
+  end
+
+  -------------------
+  -- Platoon Info --
+  -------------------
+  if self.verbose>=3 then
+    local text="Platoons:"
+    for i,_platoon in pairs(self.cohorts) do
+      local platoon=_platoon --Ops.Platoon#PLATOON
+
+      local callsign=platoon.callsignName and UTILS.GetCallsignName(platoon.callsignName) or "N/A"
+      local modex=platoon.modex and platoon.modex or -1
+      local skill=platoon.skill and tostring(platoon.skill) or "N/A"
+
+      -- Platoon text.
+      text=text..string.format("\n* %s %s: %s*%d/%d, Callsign=%s, Modex=%d, Skill=%s", platoon.name, platoon:GetState(), platoon.aircrafttype, platoon:CountAssets(true), #platoon.assets, callsign, modex, skill)
+    end
+    self:I(self.lid..text)
+  end
+
+  -------------------
+  -- Rearming Info --
+  -------------------
+  if self.verbose>=4 then
+    local text="Rearming Zones:"
+    for i,_rearmingzone in pairs(self.rearmingZones) do
+      local rearmingzone=_rearmingzone --#BRIGADE.SupplyZone
+      -- Info text.
+      text=text..string.format("\n* %s: Mission status=%s, suppliers=%d", rearmingzone.zone:GetName(), rearmingzone.mission:GetState(), rearmingzone.mission:CountOpsGroups())      
+    end
+    self:I(self.lid..text)
+  end
+  
+  ---------------------
+  -- Refuelling Info --
+  ---------------------
+  if self.verbose>=4 then
+    local text="Refuelling Zones:"
+    for i,_refuellingzone in pairs(self.refuellingZones) do
+      local refuellingzone=_refuellingzone --#BRIGADE.SupplyZone
+      -- Info text.
+      text=text..string.format("\n* %s: Mission status=%s, suppliers=%d", refuellingzone.zone:GetName(), refuellingzone.mission:GetState(), refuellingzone.mission:CountOpsGroups())      
+    end
+    self:I(self.lid..text)
+  end
+  
+  ----------------
+  -- Asset Info --
+  ----------------
+  if self.verbose>=5 then
+    local text="Assets in stock:"
+    for i,_asset in pairs(self.stock) do
+      local asset=_asset --Functional.Warehouse#WAREHOUSE.Assetitem
+      -- Info text.
+      text=text..string.format("\n* %s: spawned=%s", asset.spawngroupname, tostring(asset.spawned))      
+    end
+    self:I(self.lid..text)
+  end    
+
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- FSM Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- On after "ArmyOnMission".
+-- @param #BRIGADE self
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Ops.ArmyGroup#ARMYGROUP ArmyGroup Ops army group on mission.
+-- @param Ops.Auftrag#AUFTRAG Mission The requested mission.
+function BRIGADE:onafterArmyOnMission(From, Event, To, ArmyGroup, Mission)
+  -- Debug info.
+  self:T(self.lid..string.format("Group %s on %s mission %s", ArmyGroup:GetName(), Mission:GetType(), Mission:GetName()))  
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Ops/CSAR.lua

@@ -31,6 +31,7 @@
 -- @image OPS_CSAR.jpg
 
 -- Date: May 2023
+-- Last: Update Oct 2024
 
 -------------------------------------------------------------------------
 --- **CSAR** class, extends Core.Base#BASE, Core.Fsm#FSM
@@ -46,8 +47,6 @@
 --
 -- ===
 --
--- ![Banner Image](OPS_CSAR.jpg)
---
 -- # CSAR Concept
 -- 
 --  * MOOSE-based Helicopter CSAR Operations for Players.
@@ -61,6 +60,8 @@
 -- You need to load an .ogg soundfile for the pilot\'s beacons into the mission, e.g. "beacon.ogg", use a once trigger, "sound to country" for that.
 -- Create a late-activated single infantry unit as template in the mission editor and name it e.g. "Downed Pilot".
 -- 
+-- Example sound files are here: [Moose Sound](https://github.com/FlightControl-Master/MOOSE_SOUND/tree/master/CTLD%20CSAR)
+-- 
 -- ## 1. Basic Setup
 -- 
 -- A basic setup example is the following:
@@ -116,21 +117,21 @@
 --         mycsar.ADFRadioPwr = 1000 -- ADF Beacons sending with 1KW as default
 --         mycsar.PilotWeight = 80 --  Loaded pilots weigh 80kgs each
 --         
--- ## 2.1 Experimental Features
+-- ## 2.1 SRS Features and Other Features
 -- 
---       WARNING - Here\'ll be dragons!
---       DANGER - For this to work you need to de-sanitize your mission environment (all three entries) in <DCS root>\Scripts\MissionScripting.lua
---       Needs SRS => 1.9.6 to work (works on the **server** side of SRS)
 --       mycsar.useSRS = false -- Set true to use FF\'s SRS integration
 --       mycsar.SRSPath = "C:\\Progra~1\\DCS-SimpleRadio-Standalone\\" -- adjust your own path in your SRS installation -- server(!)
 --       mycsar.SRSchannel = 300 -- radio channel
 --       mycsar.SRSModulation = radio.modulation.AM -- modulation
 --       mycsar.SRSport = 5002  -- and SRS Server port
 --       mycsar.SRSCulture = "en-GB" -- SRS voice culture
---       mycsar.SRSVoice = nil -- SRS voice, relevant for Google TTS
+--       mycsar.SRSVoice = nil -- SRS voice for downed pilot, relevant for Google TTS
 --       mycsar.SRSGPathToCredentials = nil -- Path to your Google credentials json file, set this if you want to use Google TTS
 --       mycsar.SRSVolume = 1 -- Volume, between 0 and 1
 --       mycsar.SRSGender = "male" -- male or female voice
+--       mycsar.CSARVoice = MSRS.Voices.Google.Standard.en_US_Standard_A -- SRS voice for CSAR Controller, relevant for Google TTS
+--       mycsar.CSARVoiceMS = MSRS.Voices.Microsoft.Hedda -- SRS voice for CSAR Controller, relevant for MS Desktop TTS
+--       mycsar.coordinate -- Coordinate from which CSAR TTS is sending. Defaults to a random MASH object position
 --       --
 --       mycsar.csarUsePara = false -- If set to true, will use the LandingAfterEjection Event instead of Ejection. Requires mycsar.enableForAI to be set to true. --shagrat
 --       mycsar.wetfeettemplate = "man in floating thingy" -- if you use a mod to have a pilot in a rescue float, put the template name in here for wet feet spawns. Note: in conjunction with csarUsePara this might create dual ejected pilots in edge cases.
@@ -230,7 +231,7 @@ CSAR = {
   takenOff = {},
   csarUnits = {},  -- table of unit names
   downedPilots = {},
-  woundedGroups = {},
+  -- = {},
   landedStatus = {},
   addedTo = {},
   woundedGroups = {}, -- contains the new group of units
@@ -465,7 +466,10 @@ function CSAR:New(Coalition, Template, Alias)
   self.SRSGPathToCredentials = nil
   self.SRSVolume = 1.0 -- volume 0.0 to 1.0
   self.SRSGender = "male" -- male or female
-  
+  self.CSARVoice = MSRS.Voices.Google.Standard.en_US_Standard_A
+  self.CSARVoiceMS = MSRS.Voices.Microsoft.Hedda
+  self.coordinate = nil -- Core.Point#COORDINATE
+    
   local AliaS = string.gsub(self.alias," ","_")
   self.filename = string.format("CSAR_%s_Persist.csv",AliaS)
   
@@ -1306,7 +1310,7 @@ end
 -- @param #string UnitName
 -- @return #string CallSign
 function CSAR:_GetCustomCallSign(UnitName)
-  local callsign = Unitname
+  local callsign = UnitName
   local unit = UNIT:FindByName(UnitName)
   if unit and unit:IsAlive() then
     local group = unit:GetGroup()
@@ -1737,7 +1741,16 @@ function CSAR:_DisplayMessageToSAR(_unit, _text, _time, _clear, _speak, _overrid
   end
   -- integrate SRS
   if _speak and self.useSRS then
-    self.SRSQueue:NewTransmission(_text,nil,self.msrs,nil,2)
+    local coord = _unit:GetCoordinate()
+    if coord then
+      self.msrs:SetCoordinate(coord)
+    end
+    _text = string.gsub(_text,"km"," kilometer")
+    _text = string.gsub(_text,"nm"," nautical miles")
+    --self.msrs:SetVoice(self.SRSVoice)
+    --self.SRSQueue:NewTransmission(_text,nil,self.msrs,nil,1)
+    self:I("Voice = "..self.SRSVoice)
+    self.SRSQueue:NewTransmission(_text,duration,self.msrs,tstart,2,subgroups,subtitle,subduration,self.SRSchannel,self.SRSModulation,gender,culture,self.SRSVoice,volume,label,coord)
   end
   return self
 end
@@ -1876,7 +1889,7 @@ function CSAR:_SignalFlare(_unitName)
   if _closest ~= nil and _closest.pilot ~= nil and _closest.distance > 0 and _closest.distance < smokedist then
   
       local _clockDir = self:_GetClockDirection(_heli, _closest.pilot)
-      local _distance = 0
+      local _distance = ""
       if _SETTINGS:IsImperial() then
         _distance = string.format("%.1fnm",UTILS.MetersToNM(_closest.distance))
       else
@@ -1889,12 +1902,13 @@ function CSAR:_SignalFlare(_unitName)
       _coord:FlareRed(_clockDir)
   else
       local _distance = smokedist
+      local dtext = ""
       if _SETTINGS:IsImperial() then
-        _distance = string.format("%.1fnm",UTILS.MetersToNM(smokedist))
+        dtext = string.format("%.1fnm",UTILS.MetersToNM(smokedist))
       else
-        _distance = string.format("%.1fkm",smokedist/1000)
+        dtext = string.format("%.1fkm",smokedist/1000)
       end 
-      self:_DisplayMessageToSAR(_heli, string.format("No Pilots within %s",_distance), self.messageTime, false, false, true)
+      self:_DisplayMessageToSAR(_heli, string.format("No Pilots within %s",dtext), self.messageTime, false, false, true)
   end
   return self
 end
@@ -1907,6 +1921,14 @@ end
 function CSAR:_DisplayToAllSAR(_message, _side, _messagetime)
   self:T(self.lid .. " _DisplayToAllSAR")
   local messagetime = _messagetime or self.messageTime
+  if self.msrs then
+    local voice = self.CSARVoice or MSRS.Voices.Google.Standard.en_GB_Standard_F
+    if self.msrs.google == nil then
+      voice = self.CSARVoiceMS or MSRS.Voices.Microsoft.Hedda
+    end
+    self:I("Voice = "..voice)
+    self.SRSQueue:NewTransmission(_message,duration,self.msrs,tstart,2,subgroups,subtitle,subduration,self.SRSchannel,self.SRSModulation,gender,culture,voice,volume,label,self.coordinate)
+  end
   for _, _unitName in pairs(self.csarUnits) do
     local _unit = self:_GetSARHeli(_unitName)
     if _unit and not self.suppressmessages then
@@ -1930,7 +1952,7 @@ function CSAR:_Reqsmoke( _unitName )
   local _closest = self:_GetClosestDownedPilot(_heli)
   if _closest ~= nil and _closest.pilot ~= nil and _closest.distance > 0 and _closest.distance < smokedist then
       local _clockDir = self:_GetClockDirection(_heli, _closest.pilot)
-      local _distance = 0
+      local _distance = string.format("%.1fkm",_closest.distance/1000)
       if _SETTINGS:IsImperial() then
         _distance = string.format("%.1fnm",UTILS.MetersToNM(_closest.distance))
       else
@@ -1942,7 +1964,7 @@ function CSAR:_Reqsmoke( _unitName )
       local color = self.smokecolor
       _coord:Smoke(color)
   else
-      local _distance = 0
+      local _distance = string.format("%.1fkm",smokedist/1000)
       if _SETTINGS:IsImperial() then
         _distance = string.format("%.1fnm",UTILS.MetersToNM(smokedist))
       else
@@ -2267,6 +2289,12 @@ function CSAR:onafterStart(From, Event, To)
     self.allheligroupset = SET_GROUP:New():FilterCoalitions(self.coalitiontxt):FilterCategoryHelicopter():FilterStart()
   end
   self.mash = SET_GROUP:New():FilterCoalitions(self.coalitiontxt):FilterPrefixes(self.mashprefix):FilterStart() -- currently only GROUP objects, maybe support STATICs also?
+  if not self.coordinate then
+    local csarhq = self.mash:GetRandom()
+    if csarhq then 
+      self.coordinate = csarhq:GetCoordinate()
+    end
+  end
   if self.wetfeettemplate then
     self.usewetfeet = true
   end
@@ -2274,7 +2302,7 @@ function CSAR:onafterStart(From, Event, To)
     local path = self.SRSPath
     local modulation = self.SRSModulation
     local channel = self.SRSchannel
-    self.msrs = MSRS:New(path,channel,modulation)
+    self.msrs = MSRS:New(path,channel,modulation) -- Sound.SRS#MSRS
     self.msrs:SetPort(self.SRSport)
     self.msrs:SetLabel("CSAR")
     self.msrs:SetCulture(self.SRSCulture)
@@ -2286,7 +2314,7 @@ function CSAR:onafterStart(From, Event, To)
     end
     self.msrs:SetVolume(self.SRSVolume)
     self.msrs:SetLabel("CSAR")
-    self.SRSQueue = MSRSQUEUE:New("CSAR")
+    self.SRSQueue = MSRSQUEUE:New("CSAR") -- Sound.SRS#MSRSQUEUE
   end
   
   self:__Status(-10)

Moose Development/Moose/Ops/CTLD.lua

@@ -19,10 +19,12 @@
 -- ===
 --
 -- ### Author: **Applevangelist** (Moose Version), ***Ciribob*** (original), Thanks to: Shadowze, Cammel (testing), bbirchnz (additional code!!)
+-- ### Repack addition for crates: **Raiden**
+-- 
 -- @module Ops.CTLD
 -- @image OPS_CTLD.jpg
 
--- Last Update June 2023
+-- Last Update October 2023
 
 do 
 
@@ -599,7 +601,7 @@ do
 --
 -- ===
 --
--- ![Banner Image](OPS_CTLD.jpg)
+-- ![Banner Image](../Images/OPS_CTLD.jpg)
 --
 -- # CTLD Concept
 -- 
@@ -616,6 +618,8 @@ do
 -- You need to load an .ogg soundfile for the pilot\'s beacons into the mission, e.g. "beacon.ogg", use a once trigger, "sound to country" for that.
 -- Create the late-activated troops, vehicles, that will make up your deployable forces.
 -- 
+-- Example sound files are here: [Moose Sound](https://github.com/FlightControl-Master/MOOSE_SOUND/tree/master/CTLD%20CSAR)
+-- 
 -- ## 1. Basic Setup
 -- 
 -- ## 1.1 Create and start a CTLD instance
@@ -698,6 +702,7 @@ do
 --
 --          my_ctld.useprefix = true -- (DO NOT SWITCH THIS OFF UNLESS YOU KNOW WHAT YOU ARE DOING!) Adjust **before** starting CTLD. If set to false, *all* choppers of the coalition side will be enabled for CTLD.
 --          my_ctld.CrateDistance = 35 -- List and Load crates in this radius only.
+--          my_ctld.PackDistance = 35 -- Pack crates in this radius only
 --          my_ctld.dropcratesanywhere = false -- Option to allow crates to be dropped anywhere.
 --          my_ctld.dropAsCargoCrate = false -- Parachuted herc cargo is not unpacked automatically but placed as crate to be unpacked. Needs a cargo with the same name defined like the cargo that was dropped.
 --          my_ctld.maximumHoverHeight = 15 -- Hover max this high to load.
@@ -1119,6 +1124,7 @@ CTLD = {
   Spawned_Crates = {}, -- Holds objects for crates spawned generally
   Spawned_Cargo = {}, -- Binds together spawned_crates and their CTLD_CARGO objects
   CrateDistance = 35, -- list crates in this radius
+  PackDistance = 35,  -- pack crates in this radius
   debug = false,
   wpZones = {},
   dropOffZones = {},
@@ -1142,6 +1148,7 @@ CTLD = {
 -- DONE: List cargo in stock
 -- DONE: Limit of troops, crates buildable?
 -- DONE: Allow saving of Troops & Vehicles
+-- DONE: Adding re-packing dropped units
 ------------------------------
 
 --- Radio Beacons
@@ -1221,7 +1228,7 @@ CTLD.UnitTypes = {
 
 --- CTLD class version.
 -- @field #string version
-CTLD.version="1.0.40"
+CTLD.version="1.0.41"
 
 --- Instantiate a new CTLD.
 -- @param #CTLD self
@@ -1339,6 +1346,7 @@ function CTLD:New(Coalition, Prefixes, Alias)
   
   -- setup
   self.CrateDistance = 35 -- list/load crates in this radius
+  self.PackDistance = 35 -- pack objects in this radius
   self.ExtractFactor = 3.33 -- factor for troops extraction, i.e. CrateDistance * Extractfactor
   self.prefixes = Prefixes or {"Cargoheli"}
   self.useprefix = true
@@ -2258,9 +2266,10 @@ end
 -- @param #CTLD_CARGO Cargo
 -- @param #number number Number of crates to generate (for dropping)
 -- @param #boolean drop If true we\'re dropping from heli rather than loading.
-function CTLD:_GetCrates(Group, Unit, Cargo, number, drop)
+-- @param #boolean pack If true we\'re packing crates from a template rather than loading or dropping
+function CTLD:_GetCrates(Group, Unit, Cargo, number, drop, pack)
   self:T(self.lid .. " _GetCrates")
-  if not drop then
+  if not drop and not pack then
     local cgoname = Cargo:GetName()
     -- check if we have stock
     local instock = Cargo:GetStock()
@@ -2277,18 +2286,20 @@ function CTLD:_GetCrates(Group, Unit, Cargo, number, drop)
   local width = 20
   local distance = nil
   local zone = nil
-  if not drop then 
+  if not drop and not pack then 
     inzone = self:IsUnitInZone(Unit,CTLD.CargoZoneType.LOAD)
     if not inzone then
 ---@diagnostic disable-next-line: cast-local-type
       inzone, ship, zone, distance, width  = self:IsUnitInZone(Unit,CTLD.CargoZoneType.SHIP)
     end
-  else
+  elseif drop and not pack then
     if self.dropcratesanywhere then -- #1570
       inzone = true
     else
       inzone = self:IsUnitInZone(Unit,CTLD.CargoZoneType.DROP)
     end
+  elseif pack and not drop then
+    inzone = true
   end
   
   if not inzone then
@@ -3227,6 +3238,42 @@ function CTLD:_BuildCrates(Group, Unit,Engineering)
   return self
 end
 
+--- (Internal) Function to repair nearby vehicles / FOBs
+-- @param #CTLD self
+-- @param Wrapper.Group#GROUP Group
+-- @param Wrapper.Unit#UNIT Unit
+
+function CTLD:_PackCratesNearby(Group, Unit)
+  self:T(self.lid .. " _PackCratesNearby")
+  -----------------------------------------
+  -- search for nearest group to player
+  -- determine if group is packable
+  -- generate crates and destroy group
+  -----------------------------------------
+
+  -- get nearby vehicles
+  local location = Group:GetCoordinate() -- get coordinate of group using function
+  local nearestGroups = SET_GROUP:New():FilterCoalitions("blue"):FilterZones({ZONE_RADIUS:New("TempZone", location:GetVec2(), self.PackDistance, false)}):FilterOnce() -- get all groups withing PackDistance from group using function
+  -- get template name of all vehicles in zone
+
+  -- determine if group is packable
+  for _, _Group in pairs(nearestGroups.Set) do -- convert #SET_GROUP to a list of Wrapper.Group#GROUP
+    for _, _Template in pairs(_DATABASE.Templates.Groups) do -- iterate through the database of templates
+      if (string.match(_Group:GetName(), _Template.GroupName)) then -- check if the Wrapper.Group#GROUP near the player is in the list of templates by name
+        -- generate crates and destroy group
+        for _, _entry in pairs(self.Cargo_Crates) do -- iterate through #CTLD_CARGO
+          if (_entry.Templates[1] == _Template.GroupName) then -- check if the #CTLD_CARGO matches the template name
+            _Group:Destroy() -- if a match is found destroy the Wrapper.Group#GROUP near the player
+            self:_GetCrates(Group, Unit, _entry, nil, false, true) -- spawn the appropriate crates near the player
+            return self
+          end
+        end
+      end
+    end
+  end
+  return self
+end
+
 --- (Internal) Function to repair nearby vehicles / FOBs
 -- @param #CTLD self
 -- @param Wrapper.Group#GROUP Group
@@ -3539,6 +3586,7 @@ function CTLD:_RefreshF10Menus()
           if cancrates then 
             local loadmenu = MENU_GROUP_COMMAND:New(_group,"Load crates",topcrates, self._LoadCratesNearby, self, _group, _unit)
             local cratesmenu = MENU_GROUP:New(_group,"Get Crates",topcrates)
+            local packmenu = MENU_GROUP_COMMAND:New(_group, "Pack crates", topcrates, self._PackCratesNearby, self, _group, _unit)
             
             if self.usesubcats then
               local subcatmenus = {}