Update CTLD.lua (#2058)

Add Remove Crates option

.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)" --retry-errors --retry-errors-count 3 --retry-errors-jitter

.gitignore

@@ -28,13 +28,6 @@ local.properties
 .buildpath
 
 
-#####################
-## Visual Studio Code
-#####################
-*.code-workspace
-.vscode/
-
-
 #################
 ## Visual Studio
 #################
@@ -42,6 +35,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
@@ -227,11 +222,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

.vs/VSWorkspaceState.json

@@ -0,0 +1,10 @@
+{
+  "ExpandedNodes": [
+    "",
+    "\\Moose Development",
+    "\\Moose Development\\Moose",
+    "\\Moose Development\\Moose\\Ops"
+  ],
+  "SelectedNode": "\\Moose Development\\Moose\\Ops\\Airboss.lua",
+  "PreviewInSolutionExplorer": false
+}

MOOSE_INCLUDE/Moose_Include_Dynamic/Moose.lua

@@ -1,24 +0,0 @@
-env.info( '*** MOOSE DYNAMIC INCLUDE START *** ' )
-
-local base = _G
-
-__Moose = {}
-
-__Moose.Include = function( IncludeFile )
-	if not __Moose.Includes[ IncludeFile ] then
-		__Moose.Includes[IncludeFile] = IncludeFile
-		local f = assert( base.loadfile( IncludeFile ) )
-		if f == nil then
-			error ("Moose: Could not load Moose file " .. IncludeFile )
-		else
-			env.info( "Moose: " .. IncludeFile .. " dynamically loaded." )
-			return f()
-		end
-	end
-end
-
-__Moose.Includes = {}
-
-__Moose.Include( 'Scripts/Moose/Modules.lua' )
-BASE:TraceOnOff( true )
-env.info( '*** MOOSE INCLUDE END *** ' )

Moose Development/Moose/.editorconfig

@@ -0,0 +1,166 @@
+# Repository: https://github.com/CppCXY/EmmyLuaCodeStyle
+# English documentation: https://github.com/CppCXY/EmmyLuaCodeStyle/blob/master/README_EN.md
+[*.lua]
+# [basic]
+
+# optional space/tab
+indent_style = space
+# if indent_style is space, this is valid
+indent_size = 4
+# if indent_style is tab, this is valid
+tab_width = 4
+# none/single/double
+quote_style = none
+
+# only support number
+continuation_indent_size = 0
+
+# optional crlf/lf/cr/auto, if it is 'auto', in windows it is crlf other platforms are lf
+end_of_line = auto
+
+detect_end_of_line = false
+
+# this mean utf8 length , if this is 'unset' then the line width is no longer checked
+# this option decides when to chopdown the code
+max_line_length = 9999
+
+# this will check text end with new line
+insert_final_newline = true
+
+# [function]
+
+# function call expression's args will align to first arg
+# optional true/false/only_after_more_indention_statement/only_not_exist_cross_row_expression
+align_call_args = false
+
+# if true, all function define params will align to first param
+align_function_define_params = true
+
+remove_expression_list_finish_comma = true
+
+# keep/remove/remove_table_only/remove_string_only/unambiguous_remove_string_only
+call_arg_parentheses = keep
+
+# [table]
+
+#optional none/comma/semicolon
+table_separator_style = none
+
+#optional keep/never/always/smart
+trailing_table_separator = keep
+
+# see document for detail
+continuous_assign_table_field_align_to_equal_sign = true
+
+# if true, format like this "local t = { 1, 2, 3 }"
+keep_one_space_between_table_and_bracket = true
+
+# if indent_style is tab, this option is invalid
+align_table_field_to_first_field = true
+
+# [statement]
+
+align_chained_expression_statement = false
+
+# continous line distance
+max_continuous_line_distance = 1
+
+# see document for detail
+continuous_assign_statement_align_to_equal_sign = true
+
+# if statement will align like switch case 
+if_condition_align_with_each_other = false
+
+# if true, continuation_indent_size for local or assign statement is invalid
+# however, if the expression list has cross row expression, it will not be aligned to the first expression
+local_assign_continuation_align_to_first_expression = false
+
+statement_inline_comment_space = 1
+
+# [indentation]
+
+# if true, the label loses its current indentation
+label_no_indent = false
+# if true, there will be no indentation in the do statement
+do_statement_no_indent = false
+# if true, the conditional expression of the if statement will not be a continuation line indent
+if_condition_no_continuation_indent = false
+
+if_branch_comments_after_block_no_indent = false
+
+# [space]
+
+# if true, t[#t+1] will not space wrapper '+'
+table_append_expression_no_space = false
+
+long_chain_expression_allow_one_space_after_colon = false
+
+remove_empty_header_and_footer_lines_in_function = true
+
+space_before_function_open_parenthesis = false
+
+space_inside_function_call_parentheses = false
+
+space_inside_function_param_list_parentheses = false
+
+space_before_open_square_bracket = false
+
+space_inside_square_brackets = false
+
+# if true, ormat like this "local t <const> = 1"
+keep_one_space_between_namedef_and_attribute = true
+
+# [row_layout]
+# The following configuration supports four expressions
+# minLine:${n}   
+# keepLine   
+# keepLine:${n}
+# maxLine:${n}
+
+keep_line_after_if_statement = minLine:0
+
+keep_line_after_do_statement = minLine:0
+
+keep_line_after_while_statement = minLine:0
+
+keep_line_after_repeat_statement = minLine:0
+
+keep_line_after_for_statement = minLine:0
+
+keep_line_after_local_or_assign_statement = keepLine
+
+keep_line_after_function_define_statement = keepLine:1
+
+keep_line_after_expression_statement = keepLine
+
+# [diagnostic]
+
+# the following is code diagnostic options
+enable_check_codestyle = true
+
+# [diagnostic.name_style]
+enable_name_style_check = false
+# the following is name style check rule 
+# base option off/camel_case/snake_case/upper_snake_case/pascal_case/same(filename/first_param/'<const string>', snake_case/pascal_case/camel_case)
+# all option can use '|' represent or 
+# for example:
+# snake_case | upper_snake_case
+# same(first_param, snake_case)
+# same('m')
+local_name_define_style = snake_case
+
+function_param_name_style = snake_case
+
+function_name_define_style = snake_case
+
+local_function_name_define_style = snake_case
+
+table_field_name_define_style = snake_case
+
+global_variable_name_define_style = snake_case|upper_snake_case
+
+module_name_define_style = same('m')|same(filename, snake_case)
+
+require_module_name_style = same(first_param, snake_case)
+
+class_name_define_style = same(filename, snake_case)

Moose Development/Moose/.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+    "Lua.workspace.preloadFileSize": 1000,
+    "Lua.diagnostics.disable": [
+        "undefined-doc-name"
+    ],
+    "Lua.diagnostics.globals": [
+        "BASE",
+        "lfs",
+        "__Moose",
+        "trigger",
+        "coord",
+        "missionCommands"
+    ],
+    "Lua.completion.displayContext": 5,
+    "Lua.runtime.version": "Lua 5.1",
+    "Lua.completion.callSnippet": "Both"
+}

Moose Development/Moose/AI/AI_A2A_Cap.lua

@@ -1,4 +1,6 @@
---- **AI** -- (R2.2) - Models the process of Combat Air Patrol (CAP) for airplanes.
+--- **AI** - Models the process of Combat Air Patrol (CAP) for airplanes.
+--
+-- This is a class used in the @{AI.AI_A2A_Dispatcher}.
 --
 -- ===
 --
@@ -13,8 +15,7 @@
 -- @extends AI.AI_Air_Patrol#AI_AIR_PATROL
 -- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE
 
-
---- The AI_A2A_CAP class implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group}
+--- The AI_A2A_CAP class implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group}
 -- and automatically engage any airborne enemies that are within a certain range or within a certain zone.
 --
 -- ![Process](..\Presentations\AI_CAP\Dia3.JPG)
@@ -40,8 +41,8 @@
 --
 -- ![Process](..\Presentations\AI_CAP\Dia10.JPG)
 --
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- 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_CAP\Dia13.JPG)
 --
@@ -71,7 +72,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_A2A_CAP.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
 --   * **@{#AI_A2A_CAP.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 tresholds have been reached, the AI will RTB.
+--   * **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
 --
@@ -81,15 +82,20 @@
 -- 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_A2A_CAP.SetEngageRange}() to define that range.
+-- Use the method @{#AI_A2A_CAP.SetEngageRange}() to define that range.
 --
 -- ## 4. Set the Zone of Engagement
 --
 -- ![Zone](..\Presentations\AI_CAP\Dia12.JPG)
 --
--- An optional @{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_A2A_CAP.SetEngageZone}() to define that Zone.
+-- 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
 --
 -- ===
 --
@@ -106,7 +112,7 @@ AI_A2A_CAP = {
 -- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
 -- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
 -- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
 -- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
@@ -117,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
 
@@ -132,7 +138,7 @@ end
 --- Creates a new AI_A2A_CAP object
 -- @param #AI_A2A_CAP self
 -- @param Wrapper.Group#GROUP AICap
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
@@ -191,7 +197,7 @@ end
 --- Evaluate the attack and create an AttackUnitTask list.
 -- @param #AI_A2A_CAP self
 -- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
--- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param Wrapper.Group#GROUP DefenderGroup The group of defenders.
 -- @param #number EngageAltitude The altitude to engage the targets.
 -- @return #AI_A2A_CAP self
 function AI_A2A_CAP:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )

Moose Development/Moose/AI/AI_A2A_Gci.lua

@@ -1,6 +1,6 @@
---- **AI** -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.
+--- **AI** - Models the process of Ground Controlled Interception (GCI) for airplanes.
 --
--- This is a class used in the @{AI_A2A_Dispatcher}.
+-- This is a class used in the @{AI.AI_A2A_Dispatcher}.
 --
 -- ===
 --
@@ -8,44 +8,30 @@
 --
 -- ===
 --
--- @module AI.AI_A2A_GCI
+-- @module AI.AI_A2A_Gci
 -- @image AI_Ground_Control_Intercept.JPG
 
 
 
 --- @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 treshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
---
--- ![Process](..\Presentations\AI_GCI\Dia13.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.
 --
 -- ## 1. AI_A2A_GCI constructor
 --
@@ -53,8 +39,6 @@
 --
 -- ## 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.
@@ -73,25 +57,12 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_A2A_GCI.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
 --   * **@{#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 tresholds have been reached, the AI will RTB.
+--   * **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 @{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_A2A_GCI.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
 --
 -- ===
 --
@@ -153,7 +124,7 @@ end
 --- Evaluate the attack and create an AttackUnitTask list.
 -- @param #AI_A2A_GCI self
 -- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
--- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param Wrapper.Group#GROUP DefenderGroup The group of defenders.
 -- @param #number EngageAltitude The altitude to engage the targets.
 -- @return #AI_A2A_GCI self
 function AI_A2A_GCI:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )

Moose Development/Moose/AI/AI_A2A_Patrol.lua

@@ -1,4 +1,4 @@
---- **AI** -- (R2.2) - Models the process of air patrol of airplanes.
+--- **AI** - Models the process of air patrol of airplanes.
 -- 
 -- ===
 -- 
@@ -11,9 +11,9 @@
 
 
 --- @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 @{Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group}.
+--- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group}.
 -- 
 -- ![Process](..\Presentations\AI_PATROL\Dia3.JPG)
 -- 
@@ -39,8 +39,8 @@
 -- 
 -- ![Process](..\Presentations\AI_PATROL\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- 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_PATROL\Dia11.JPG)
 -- 
@@ -68,7 +68,7 @@
 --   * **RTB** ( Group ): Route the AI to the home base.
 --   * **Detect** ( Group ): The AI is detecting targets.
 --   * **Detected** ( Group ): The AI has detected new targets.
---   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status** ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 --    
 -- ## 3. Set or Get the AI controllable
 -- 
@@ -100,18 +100,23 @@
 -- ## 6. Manage the "out of fuel" in the AI_A2A_PATROL
 -- 
 -- When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
--- Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
--- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, 
--- while a new AI is targetted to the AI_A2A_PATROL.
+-- Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
+-- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, 
+-- while a new AI is targeted to the AI_A2A_PATROL.
 -- Once the time is finished, the old AI will return to the base.
 -- Use the method @{#AI_A2A_PATROL.ManageFuel}() to have this proces in place.
 -- 
 -- ## 7. Manage "damage" behaviour of the AI in the AI_A2A_PATROL
 -- 
 -- 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 treshold is reached, the AI will return immediately to the home base (RTB).
+-- 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
@@ -122,7 +127,7 @@ AI_A2A_PATROL = {
 --- Creates a new AI_A2A_PATROL object
 -- @param #AI_A2A_PATROL self
 -- @param Wrapper.Group#GROUP AIPatrol The patrol group object.
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
@@ -264,7 +269,7 @@ function AI_A2A_PATROL:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
 end
 
 
---- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+--- Defines a new patrol route using the @{AI.AI_Patrol#AI_PATROL_ZONE} parameters and settings.
 -- @param #AI_A2A_PATROL self
 -- @return #AI_A2A_PATROL self
 -- @param Wrapper.Group#GROUP AIPatrol The Group Object managed by the FSM.
@@ -287,7 +292,7 @@ function AI_A2A_PATROL:onafterPatrol( AIPatrol, From, Event, To )
 end
 
 
---- This statis method is called from the route path within the last task at the last waaypoint of the AIPatrol.
+--- This static method is called from the route path within the last task at the last waypoint of the AIPatrol.
 -- Note that this method is required, as triggers the next route when patrolling for the AIPatrol.
 -- @param Wrapper.Group#GROUP AIPatrol The AI group.
 -- @param #AI_A2A_PATROL Fsm The FSM.
@@ -302,7 +307,7 @@ function AI_A2A_PATROL.PatrolRoute( AIPatrol, Fsm )
 end
 
 
---- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+--- Defines a new patrol route using the @{AI.AI_Patrol#AI_PATROL_ZONE} parameters and settings.
 -- @param #AI_A2A_PATROL self
 -- @param Wrapper.Group#GROUP AIPatrol The Group managed by the FSM.
 -- @param #string From The From State string.

Moose Development/Moose/AI/AI_A2G_BAI.lua

@@ -1,6 +1,6 @@
---- **AI** -- Models the process of air to ground BAI engagement for airplanes and helicopters.
+--- **AI** - Models the process of air to ground BAI engagement for airplanes and helicopters.
 --
--- This is a class used in the @{AI_A2G_Dispatcher}.
+-- This is a class used in the @{AI.AI_A2G_Dispatcher}.
 -- 
 -- ===
 -- 
@@ -11,14 +11,17 @@
 -- @module AI.AI_A2G_BAI
 -- @image AI_Air_To_Ground_Engage.JPG
 
-
-
 --- @type AI_A2G_BAI
--- @extends AI.AI_A2A_Engage#AI_A2A_Engage
-
+-- @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
@@ -26,8 +29,6 @@ AI_A2G_BAI = {
   ClassName = "AI_A2G_BAI",
 }
 
-
-
 --- Creates a new AI_A2G_BAI object
 -- @param #AI_A2G_BAI self
 -- @param Wrapper.Group#GROUP AIGroup
@@ -36,7 +37,7 @@ AI_A2G_BAI = {
 -- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
 -- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
 -- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
@@ -46,14 +47,13 @@ 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 )
 
   return self
 end
 
-
 --- Creates a new AI_A2G_BAI object
 -- @param #AI_A2G_BAI self
 -- @param Wrapper.Group#GROUP AIGroup
@@ -61,7 +61,7 @@ end
 -- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
 -- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
 -- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
@@ -76,7 +76,7 @@ end
 --- Evaluate the attack and create an AttackUnitTask list. 
 -- @param #AI_A2G_BAI self
 -- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
--- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param Wrapper.Group#GROUP DefenderGroup The group of defenders.
 -- @param #number EngageAltitude The altitude to engage the targets.
 -- @return #AI_A2G_BAI self
 function AI_A2G_BAI:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )
@@ -92,8 +92,6 @@ function AI_A2G_BAI:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageA
       end
     end
   end
-  
+
   return AttackUnitTasks
 end
-
-

Moose Development/Moose/AI/AI_A2G_CAS.lua

@@ -1,6 +1,6 @@
---- **AI** -- Models the process of air to ground engagement for airplanes and helicopters.
+--- **AI** - Models the process of air to ground engagement for airplanes and helicopters.
 --
--- This is a class used in the @{AI_A2G_Dispatcher}.
+-- This is a class used in the @{AI.AI_A2G_Dispatcher}.
 -- 
 -- ===
 -- 
@@ -11,14 +11,17 @@
 -- @module AI.AI_A2G_CAS
 -- @image AI_Air_To_Ground_Engage.JPG
 
-
-
 --- @type AI_A2G_CAS
--- @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 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
@@ -26,8 +29,6 @@ AI_A2G_CAS = {
   ClassName = "AI_A2G_CAS",
 }
 
-
-
 --- Creates a new AI_A2G_CAS object
 -- @param #AI_A2G_CAS self
 -- @param Wrapper.Group#GROUP AIGroup
@@ -36,7 +37,7 @@ AI_A2G_CAS = {
 -- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
 -- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
 -- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
@@ -46,14 +47,13 @@ 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 )
 
   return self
 end
 
-
 --- Creates a new AI_A2G_CAS object
 -- @param #AI_A2G_CAS self
 -- @param Wrapper.Group#GROUP AIGroup
@@ -61,7 +61,7 @@ end
 -- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
 -- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
 -- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
@@ -76,7 +76,7 @@ end
 --- Evaluate the attack and create an AttackUnitTask list. 
 -- @param #AI_A2G_CAS self
 -- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
--- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param Wrapper.Group#GROUP DefenderGroup The group of defenders.
 -- @param #number EngageAltitude The altitude to engage the targets.
 -- @return #AI_A2G_CAS self
 function AI_A2G_CAS:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )
@@ -92,9 +92,6 @@ function AI_A2G_CAS:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageA
       end
     end
   end
-  
+
   return AttackUnitTasks
 end
-
-
-

Moose Development/Moose/AI/AI_A2G_SEAD.lua

@@ -1,6 +1,6 @@
---- **AI** -- Models the process of air to ground SEAD engagement for airplanes and helicopters.
+--- **AI** - Models the process of air to ground SEAD engagement for airplanes and helicopters.
 --
--- This is a class used in the @{AI_A2G_Dispatcher}.
+-- This is a class used in the @{AI.AI_A2G_Dispatcher}.
 -- 
 -- ===
 -- 
@@ -14,38 +14,25 @@
 
 
 --- @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 treshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
--- 
--- ![Process](..\Presentations\AI_GCI\Dia13.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.
 -- 
 -- ## 1. AI_A2G_SEAD constructor
 --   
@@ -53,22 +40,17 @@
 --
 -- ## 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 @{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_A2G_SEAD.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_A2G_SEAD
@@ -76,8 +58,6 @@ AI_A2G_SEAD = {
   ClassName = "AI_A2G_SEAD",
 }
 
-
-
 --- Creates a new AI_A2G_SEAD object
 -- @param #AI_A2G_SEAD self
 -- @param Wrapper.Group#GROUP AIGroup
@@ -86,7 +66,7 @@ AI_A2G_SEAD = {
 -- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
 -- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
 -- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
@@ -96,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 )
 
@@ -111,7 +91,7 @@ end
 -- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
 -- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
 -- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
@@ -127,7 +107,7 @@ end
 --- Evaluate the attack and create an AttackUnitTask list. 
 -- @param #AI_A2G_SEAD self
 -- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
--- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param Wrapper.Group#GROUP DefenderGroup The group of defenders.
 -- @param #number EngageAltitude The altitude to engage the targets.
 -- @return #AI_A2G_SEAD self
 function AI_A2G_SEAD:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )

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",
@@ -253,6 +258,9 @@ function AI_AIR:New( AIGroup )
   
   self.IdleCount = 0
   
+  self.RTBSpeedMaxFactor = 0.6
+  self.RTBSpeedMinFactor = 0.5
+  
   return self
 end
 
@@ -370,11 +378,11 @@ end
 
 
 --- When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
--- Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
--- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_AIR.
+-- Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
+-- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targeted to the AI_AIR.
 -- Once the time is finished, the old AI will return to the base.
 -- @param #AI_AIR self
--- @param #number FuelThresholdPercentage The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
+-- @param #number FuelThresholdPercentage The threshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
 -- @param #number OutOfFuelOrbitTime The amount of seconds the out of fuel AIControllable will orbit before returning to the base.
 -- @return #AI_AIR self
 function AI_AIR:SetFuelThreshold( FuelThresholdPercentage, OutOfFuelOrbitTime )
@@ -387,14 +395,14 @@ function AI_AIR:SetFuelThreshold( FuelThresholdPercentage, OutOfFuelOrbitTime )
   return self
 end
 
---- When the AI is damaged beyond a certain treshold, it is required that the AI returns to the home base.
+--- When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.
 -- However, damage cannot be foreseen early on. 
--- Therefore, when the damage treshold is reached, 
+-- Therefore, when the damage threshold is reached, 
 -- the AI will return immediately to the home base (RTB).
 -- Note that for groups, the average damage of the complete group will be calculated.
--- So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold will be 0.25.
+-- So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshold will be 0.25.
 -- @param #AI_AIR self
--- @param #number PatrolDamageThreshold The treshold in percentage (between 0 and 1) when the AI is considered to be damaged.
+-- @param #number PatrolDamageThreshold The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.
 -- @return #AI_AIR self
 function AI_AIR:SetDamageThreshold( PatrolDamageThreshold )
 
@@ -406,7 +414,7 @@ end
 
 
 
---- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+--- Defines a new patrol route using the @{AI.AI_Patrol#AI_PATROL_ZONE} parameters and settings.
 -- @param #AI_AIR self
 -- @return #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
@@ -470,27 +478,27 @@ function AI_AIR:onafterStatus()
 --        self:Home( "Destroy" )
 --      end
 --    end
-    
+
 
     if not self:Is( "Fuel" ) and not self:Is( "Home" ) and not self:is( "Refuelling" )then
-      
+
       local Fuel = self.Controllable:GetFuelMin()
-      
-      -- If the fuel in the controllable is below the treshold percentage,
+
+      -- If the fuel in the controllable is below the threshold percentage,
       -- then send for refuel in case of a tanker, otherwise RTB.
       if Fuel < self.FuelThresholdPercentage then
-      
+
         if self.TankerName then
           self:I( self.Controllable:GetName() .. " is out of fuel: " .. Fuel .. " ... Refuelling at Tanker!" )
           self:Refuel()
         else
           self:I( self.Controllable:GetName() .. " is out of fuel: " .. Fuel .. " ... RTB!" )
           local OldAIControllable = self.Controllable
-          
+
           local OrbitTask = OldAIControllable:TaskOrbitCircle( math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude ), self.PatrolMinSpeed )
           local TimedOrbitTask = OldAIControllable:TaskControlled( OrbitTask, OldAIControllable:TaskCondition(nil,nil,nil,nil,self.OutOfFuelOrbitTime,nil ) )
           OldAIControllable:SetTask( TimedOrbitTask, 10 )
-    
+
           self:Fuel()
           RTB = true
         end
@@ -501,11 +509,11 @@ function AI_AIR:onafterStatus()
     if self:Is( "Fuel" ) and not self:Is( "Home" ) and not self:is( "Refuelling" ) then
       RTB = true
     end
-    
+
     -- TODO: Check GROUP damage function.
     local Damage = self.Controllable:GetLife()
     local InitialLife = self.Controllable:GetLife0()
-    
+
     -- If the group is damaged, then RTB.
     -- Note that a group can consist of more units, so if one unit is damaged of a group, the mission may continue.
     -- The damaged unit will RTB due to DCS logic, and the others will continue to engage.
@@ -515,7 +523,7 @@ function AI_AIR:onafterStatus()
       RTB = true
       self:SetStatusOff()
     end
-    
+
     -- Check if planes went RTB and are out of control.
     -- We only check if planes are out of control, when they are in duty.
     if self.Controllable:HasTask() == false then
@@ -529,7 +537,7 @@ function AI_AIR:onafterStatus()
             self:Damaged()
           else  
             self:I( self.Controllable:GetName() .. " control lost! " )
-            
+
             self:LostControl()
           end
         else
@@ -547,7 +555,7 @@ function AI_AIR:onafterStatus()
     if not self:Is("Home") then
       self:__Status( 10 )
     end
-    
+
   end
 end
 
@@ -556,11 +564,11 @@ end
 function AI_AIR.RTBRoute( AIGroup, Fsm )
 
   AIGroup:F( { "AI_AIR.RTBRoute:", AIGroup:GetName() } )
-  
+
   if AIGroup:IsAlive() then
     Fsm:RTB()
   end
-  
+
 end
 
 --- @param Wrapper.Group#GROUP AIGroup
@@ -573,7 +581,20 @@ function AI_AIR.RTBHold( AIGroup, Fsm )
     local Task = AIGroup:TaskOrbitCircle( 4000, 400 )
     AIGroup:SetTask( Task )
   end
-  
+
+end
+
+--- Set the min and max factors on RTB speed. Use this, if your planes are heading back to base too fast. Default values are 0.5 and 0.6. 
+-- The RTB speed is calculated as the max speed of the unit multiplied by MinFactor (lower bracket) and multiplied by MaxFactor (upper bracket). 
+-- A random value in this bracket is then applied in the waypoint routing generation.
+-- @param #AI_AIR self
+-- @param #number MinFactor Lower bracket factor. Defaults to 0.5.
+-- @param #number MaxFactor Upper bracket factor. Defaults to 0.6.
+-- @return #AI_AIR self
+function AI_AIR:SetRTBSpeedFactors(MinFactor,MaxFactor)
+  self.RTBSpeedMaxFactor = MaxFactor or 0.6
+  self.RTBSpeedMinFactor = MinFactor or 0.5
+  return self
 end
 
 
@@ -582,52 +603,53 @@ end
 function AI_AIR:onafterRTB( AIGroup, From, Event, To )
   self:F( { AIGroup, From, Event, To } )
 
-  
-  if AIGroup and AIGroup:IsAlive() then
+    if AIGroup and AIGroup:IsAlive() then
 
     self:T( "Group " .. AIGroup:GetName() .. " ... RTB! ( " .. self:GetState() .. " )" )
-    
+
     self:ClearTargetDistance()
     --AIGroup:ClearTasks()
-    
+
     AIGroup:OptionProhibitAfterburner(true)
-      
+
     local EngageRoute = {}
 
     --- Calculate the target route point.
-    
+
     local FromCoord = AIGroup:GetCoordinate()
     local ToTargetCoord = self.HomeAirbase:GetCoordinate() -- coordinate is on land height(!)
     local ToTargetVec3 = ToTargetCoord:GetVec3()
-    ToTargetVec3.y = ToTargetCoord:GetLandHeight()+1000 -- let's set this 1000m/3000 feet above ground
+    ToTargetVec3.y = ToTargetCoord:GetLandHeight()+3000 -- let's set this 1000m/3000 feet above ground
     local ToTargetCoord2 = COORDINATE:NewFromVec3( ToTargetVec3 )
-     
+
     if not self.RTBMinSpeed or not self.RTBMaxSpeed then    
       local RTBSpeedMax = AIGroup:GetSpeedMax()
-      self:SetRTBSpeed( RTBSpeedMax * 0.5, RTBSpeedMax * 0.6 )  
+      local RTBSpeedMaxFactor = self.RTBSpeedMaxFactor or 0.6
+      local RTBSpeedMinFactor = self.RTBSpeedMinFactor or 0.5
+      self:SetRTBSpeed( RTBSpeedMax * RTBSpeedMinFactor, RTBSpeedMax * RTBSpeedMaxFactor)  
     end
-    
+
     local RTBSpeed = math.random( self.RTBMinSpeed, self.RTBMaxSpeed )
     --local ToAirbaseAngle = FromCoord:GetAngleDegrees( FromCoord:GetDirectionVec3( ToTargetCoord2 ) )
 
     local Distance = FromCoord:Get2DDistance( ToTargetCoord2 )
-    
+
     --local ToAirbaseCoord = FromCoord:Translate( 5000, ToAirbaseAngle )
     local ToAirbaseCoord = ToTargetCoord2
-		
+
     if Distance < 5000 then
       self:I( "RTB and near the airbase!" )
       self:Home()
       return
     end
-    
+
     if not AIGroup:InAir() == true then
       self:I( "Not anymore in the air, considered Home." )
       self:Home()
       return
     end
-      
-    
+
+
     --- Create a route point of type air.
     local FromRTBRoutePoint = FromCoord:WaypointAir( 
       self.PatrolAltType, 
@@ -648,10 +670,10 @@ function AI_AIR:onafterRTB( AIGroup, From, Event, To )
 
     EngageRoute[#EngageRoute+1] = FromRTBRoutePoint
     EngageRoute[#EngageRoute+1] = ToRTBRoutePoint
-    
+
     local Tasks = {}
     Tasks[#Tasks+1] = AIGroup:TaskFunction( "AI_AIR.RTBRoute", self )
-    
+
     EngageRoute[#EngageRoute].task = AIGroup:TaskCombo( Tasks )
 
     AIGroup:OptionROEHoldFire()
@@ -659,9 +681,9 @@ function AI_AIR:onafterRTB( AIGroup, From, Event, To )
 
     --- NOW ROUTE THE GROUP!
     AIGroup:Route( EngageRoute, self.TaskDelay )
-      
+
   end
-    
+
 end
 
 --- @param #AI_AIR self

Moose Development/Moose/AI/AI_Air_Dispatcher.lua

@@ -1,4 +1,4 @@
---- **AI** - Create an automated AIR defense system based on a detection network of reconnaissance vehicles and air units, coordinating SEAD, BAI and CAP operations.
+--- **AI** - Create an automated AIR defense system with reconnaissance units, coordinating SEAD, BAI and CAP operations.
 -- 
 -- ===
 -- 
@@ -7,14 +7,14 @@
 --    * Setup quickly an AIR defense system for a coalition.
 --    * Setup multiple defense zones to defend specific coordinates in your battlefield.
 --    * Setup (SEAD) Suppression of Air Defense squadrons, to gain control in the air of enemy grounds.
---    * Setup (CAS) Controlled Air Support squadrons, to attack closeby enemy ground units near friendly installations.
+--    * Setup (CAS) Controlled Air Support squadrons, to attack close by enemy ground units near friendly installations.
 --    * Setup (BAI) Battleground Air Interdiction squadrons to attack remote enemy ground units and targets.
 --    * Define and use a detection network controlled by recce.
---    * Define AIR defense squadrons at airbases, farps and carriers.
+--    * Define AIR defense squadrons at airbases, FARPs and carriers.
 --    * Enable airbases for AIR defenses.
 --    * Add different planes and helicopter templates to squadrons.
 --    * Assign squadrons to execute a specific engagement type depending on threat level of the detected ground enemy unit composition.
---    * Add multiple squadrons to different airbases, farps or carriers.
+--    * Add multiple squadrons to different airbases, FARPs or carriers.
 --    * Define different ranges to engage upon.
 --    * Establish an automatic in air refuel process for planes using refuel tankers.
 --    * Setup default settings for all squadrons and AIR defenses.
@@ -24,7 +24,7 @@
 -- 
 -- ## Missions:
 -- 
--- [AID-AIR - AI AIR Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-AIR%20-%20AI%20AIR%20Dispatching)
+-- [AID-AIR - AI AIR Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching)
 -- 
 -- ===
 -- 
@@ -40,7 +40,7 @@
 -- 
 -- AI_AIR_DISPATCHER is the main AIR defense class that models the AIR defense system.
 -- 
--- Before you start using the AI_AIR_DISPATCHER, ask youself the following questions.
+-- Before you start using the AI_AIR_DISPATCHER, ask yourself the following questions.
 -- 
 -- 
 -- ## 1. Which coalition am I modeling an AIR defense system for? blue or red?
@@ -88,7 +88,7 @@
 -- 
 -- ## 4. How do the defenses decide **when and where to engage** on approaching enemy units?
 -- 
--- The AIR dispacher needs you to setup (various) defense coordinates, which are strategic positions in the battle field to be defended. 
+-- The AIR dispatcher needs you to setup (various) defense coordinates, which are strategic positions in the battle field to be defended. 
 -- Any ground based enemy approaching within the proximity of such a defense point, may trigger for a defensive action by friendly air units.
 -- 
 -- There are 2 important parameters that play a role in the defensive decision making: defensiveness and reactivity.
@@ -108,7 +108,7 @@
 -- ## 5. Are defense coordinates and defense reactivity the only parameters?
 -- 
 -- No, depending on the target type, and the threat level of the target, the probability of defense will be higher.
--- In other words, when a SAM-10 radar emitter is detected, its probabilty for defense will be much higher than when a BMP-1 vehicle is
+-- In other words, when a SAM-10 radar emitter is detected, its probability for defense will be much higher than when a BMP-1 vehicle is
 -- detected, even when both enemies are at the same distance from a defense coordinate.
 -- This will ensure optimal defenses, SEAD tasks will be launched much more quicker against engaging radar emitters, to ensure air superiority.
 -- Approaching main battle tanks will be engaged much faster, than a group of approaching trucks.
@@ -117,18 +117,18 @@
 -- ## 6. Which Squadrons will I create and which name will I give each Squadron?
 -- 
 -- The AIR defense system works with **Squadrons**. Each Squadron must be given a unique name, that forms the **key** to the squadron.
--- Several options and activities can be set per Squadron. A free format name can be given, but always ensure that the name is meaningfull 
+-- Several options and activities can be set per Squadron. A free format name can be given, but always ensure that the name is meaningful 
 -- for your mission, and remember that squadron names are used for communication to the players of your mission.
 -- 
 -- There are mainly 3 types of defenses: **SEAD**, **CAS** and **BAI**.
 -- 
--- Suppression of Air Defenses (SEAD) are effective agains radar emitters. Close Air Support (CAS) is launched when the enemy is close near friendly units.
+-- Suppression of Air Defenses (SEAD) are effective against radar emitters. Close Air Support (CAS) is launched when the enemy is close near friendly units.
 -- Battleground Air Interdiction (BAI) tasks are launched when there are no friendlies around.
 -- 
 -- Depending on the defense type, different payloads will be needed. See further points on squadron definition.
 -- 
 -- 
--- ## 7. Where will the Squadrons be located? On Airbases? On Carrier Ships? On Farps?
+-- ## 7. Where will the Squadrons be located? On Airbases? On Carrier Ships? On FARPs?
 -- 
 -- Squadrons are placed at the **home base** on an **airfield**, **carrier** or **farp**.
 -- Carefully plan where each Squadron will be located as part of the defense system required for mission effective defenses.
@@ -174,13 +174,13 @@
 --    * polygon zones
 --    * moving zones
 -- 
--- Depending on the type of zone selected, a different @{Zone} object needs to be created from a ZONE_ class.
+-- Depending on the type of zone selected, a different @{Core.Zone} object needs to be created from a ZONE_ class.
 -- 
 -- 
 -- ## 12. Are moving defense coordinates possible?
 -- 
 -- Yes, different COORDINATE types are possible to be used.
--- The COORDINATE_UNIT will help you to specify a defense coodinate that is attached to a moving unit.
+-- The COORDINATE_UNIT will help you to specify a defense coordinate that is attached to a moving unit.
 -- 
 -- 
 -- ## 13. How much defense coordinates do I need to create?
@@ -214,7 +214,7 @@
 --    * From a parking spot with running engines
 --    * From a parking spot with cold engines
 -- 
--- **The default takeoff method is staight in the air.**
+-- **The default takeoff method is straight in the air.**
 -- This takeoff method is the most useful if you want to avoid airplane clutter at airbases!
 -- But it is the least realistic one!
 -- 
@@ -236,10 +236,10 @@
 -- 
 -- For each Squadron, depending on the helicopter or airplane type (modern, old) and payload, which overhead is required to provide any defense?
 -- 
--- In other words, if **X** enemy ground units are detected, how many **Y** defense helicpters or airplanes need to engage (per squadron)?
+-- In other words, if **X** enemy ground units are detected, how many **Y** defense helicopters or airplanes need to engage (per squadron)?
 -- The **Y** is dependent on the type of airplane (era), payload, fuel levels, skills etc.
 -- But the most important factor is the payload, which is the amount of AIR weapons the defense can carry to attack the enemy ground units.
--- For example, a Ka-50 can carry 16 vikrs, that means, that it potentially can destroy at least 8 ground units without a reload of ammunication.
+-- For example, a Ka-50 can carry 16 vikrs, that means, that it potentially can destroy at least 8 ground units without a reload of ammunition.
 -- That means, that one defender can destroy more enemy ground units. 
 -- Thus, the overhead is a **factor** that will calculate dynamically how many **Y** defenses will be required based on **X** attackers detected.
 -- 
@@ -259,7 +259,7 @@
 -- 
 -- ### Author: **FlightControl** rework of GCICAP + introduction of new concepts (squadrons).
 -- 
--- @module AI.AI_AIR_Dispatcher
+-- @module AI.AI_Air_Dispatcher
 -- @image AI_Air_To_Ground_Dispatching.JPG
 
 
@@ -279,7 +279,7 @@ do -- AI_AIR_DISPATCHER
   -- Multiple defense coordinates can be setup. Defense coordinates can be strategic or tactical positions or references to strategic units or scenery.
   -- The AIR dispatcher will evaluate every x seconds the tactical situation around each defense coordinate. When a defense coordinate
   -- is under threat, it will communicate through the command center that defensive actions need to be taken and will launch groups of air units for defense.
-  -- The level of threat to the defense coordinate varyies upon the strength and types of the enemy units, the distance to the defense point, and the defensiveness parameters.
+  -- The level of threat to the defense coordinate varies upon the strength and types of the enemy units, the distance to the defense point, and the defensiveness parameters.
   -- Defensive actions are taken through probability, but the closer and the more threat the enemy poses to the defense coordinate, the faster it will be attacked by friendly AIR units.
   -- 
   -- Please study carefully the underlying explanations how to setup and use this module, as it has many features.
@@ -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.
@@ -328,7 +324,7 @@ do -- AI_AIR_DISPATCHER
   -- By spawning in dynamically additional recce, you can ensure that there is sufficient reconnaissance coverage so the defense mechanism is continuously
   -- alerted of new enemy ground targets.
   -- 
-  -- The following example defens a new reconnaissance network using a @{Functional.Detection#DETECTION_AREAS} object.
+  -- The following example defense a new reconnaissance network using a @{Functional.Detection#DETECTION_AREAS} object.
   -- 
   --        -- Define a SET_GROUP object that builds a collection of groups that define the recce network.
   --        -- Here we build the network with all the groups that have a name starting with CCCP Recce.
@@ -354,7 +350,7 @@ do -- AI_AIR_DISPATCHER
   -- **DetectionSetGroup** is then calling `FilterStart()`, which is starting the dynamic filtering or inclusion of these groups. 
   -- Note that any destroy or new spawn of a group having a name, starting with the above prefix, will be removed or added to the set.
   -- 
-  -- Then a new detection object is created from the class `DETECTION_AREAS`. A grouping radius of 1000 meters (1km) is choosen.
+  -- Then a new detection object is created from the class `DETECTION_AREAS`. A grouping radius of 1000 meters (1km) is chosen.
   -- 
   -- The `Detection` object is then passed to the @{#AI_AIR_DISPATCHER.New}() method to indicate the reconnaissance network 
   -- configuration and setup the AIR defense detection mechanism.
@@ -473,7 +469,7 @@ do -- AI_AIR_DISPATCHER
   --     the mission designer can choose to increase or reduce the amount of planes spawned.
   -- 
   -- The method @{#AI_AIR_DISPATCHER.SetSquadron}() defines for you a new squadron. 
-  -- The provided parameters are the squadron name, airbase name and a list of template prefixe, and a number that indicates the amount of resources.
+  -- The provided parameters are the squadron name, airbase name and a list of template prefixes, and a number that indicates the amount of resources.
   -- 
   -- For example, this defines 3 new squadrons:
   -- 
@@ -619,7 +615,7 @@ do -- AI_AIR_DISPATCHER
   -- Depending on the demand of requested takeoffs by the AIR dispatcher, an airfield can become overloaded. Too many aircraft need to be taken
   -- off at the same time, which will result in clutter as described above. In order to better control this behaviour, a takeoff scheduler is implemented,
   -- which can be used to control how many aircraft are ordered for takeoff between specific time intervals.
-  -- The takeff intervals can be specified per squadron, which make sense, as each squadron have a "home" airfield.
+  -- The takeoff intervals can be specified per squadron, which make sense, as each squadron have a "home" airfield.
   -- 
   -- For this purpose, the method @{#AI_AIR_DISPATCHER.SetSquadronTakeOffInterval}() can be used to specify the takeoff intervals of 
   -- aircraft groups per squadron to avoid cluttering of aircraft at airbases.
@@ -647,7 +643,7 @@ do -- AI_AIR_DISPATCHER
   --   * @{#AI_AIR_DISPATCHER.SetSquadronLandingAtRunway}() will despawn the returning aircraft directly after landing at the runway.
   --   * @{#AI_AIR_DISPATCHER.SetSquadronLandingAtEngineShutdown}() will despawn the returning aircraft when the aircraft has returned to its parking spot and has turned off its engines.
   -- 
-  -- You can use these methods to minimize the airbase coodination overhead and to increase the airbase efficiency.
+  -- You can use these methods to minimize the airbase coordination overhead and to increase the airbase efficiency.
   -- When there are lots of aircraft returning for landing, at the same airbase, the takeoff process will be halted, which can cause a complete failure of the
   -- A2A defense system, as no new CAP or GCI planes can takeoff.
   -- Note that the method @{#AI_AIR_DISPATCHER.SetSquadronLandingNearAirbase}() will only work for returning aircraft, not for damaged or out of fuel aircraft.
@@ -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,
@@ -724,13 +716,13 @@ do -- AI_AIR_DISPATCHER
   -- 
   -- Use the method @{#AI_AIR_DISPATCHER.SetSquadronEngageLimit}() to limit the amount of aircraft that will engage with the enemy, per squadron.
   --
-  -- ## 4. Set the **fuel treshold**.
+  -- ## 4. Set the **fuel threshold**.
   -- 
-  -- When aircraft get **out of fuel** to a certain %-tage, which is by default **15% (0.15)**, there are two possible actions that can be taken:
+  -- When aircraft get **out of fuel** to a certain %, which is by default **15% (0.15)**, there are two possible actions that can be taken:
   --  - The aircraft will go RTB, and will be replaced with a new aircraft if possible.
   --  - The aircraft will refuel at a tanker, if a tanker has been specified for the squadron.
   -- 
-  -- Use the method @{#AI_AIR_DISPATCHER.SetSquadronFuelThreshold}() to set the **squadron fuel treshold** of the aircraft for all squadrons.
+  -- Use the method @{#AI_AIR_DISPATCHER.SetSquadronFuelThreshold}() to set the **squadron fuel threshold** of the aircraft for all squadrons.
   -- 
   -- ## 6. Other configuration options
   -- 
@@ -786,17 +778,17 @@ do -- AI_AIR_DISPATCHER
   -- 
   -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultGrouping}() to set the **default grouping** of spawned airplanes for all squadrons.
   -- 
-  -- ## 10.5. Default RTB fuel treshold.
+  -- ## 10.5. Default RTB fuel threshold.
   -- 
-  -- When an airplane gets **out of fuel** to a certain %-tage, which is **15% (0.15)**, it will go RTB, and will be replaced with a new airplane when applicable.
+  -- When an airplane gets **out of fuel** to a certain %, which is **15% (0.15)**, it will go RTB, and will be replaced with a new airplane when applicable.
   -- 
-  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultFuelThreshold}() to set the **default fuel treshold** of spawned airplanes for all squadrons.
+  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultFuelThreshold}() to set the **default fuel threshold** of spawned airplanes for all squadrons.
   -- 
-  -- ## 10.6. Default RTB damage treshold.
+  -- ## 10.6. Default RTB damage threshold.
   -- 
-  -- When an airplane is **damaged** to a certain %-tage, which is **40% (0.40)**, it will go RTB, and will be replaced with a new airplane when applicable.
+  -- When an airplane is **damaged** to a certain %, which is **40% (0.40)**, it will go RTB, and will be replaced with a new airplane when applicable.
   -- 
-  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultDamageThreshold}() to set the **default damage treshold** of spawned airplanes for all squadrons.
+  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultDamageThreshold}() to set the **default damage threshold** of spawned airplanes for all squadrons.
   -- 
   -- ## 10.7. Default settings for **patrol**.
   -- 
@@ -829,21 +821,19 @@ do -- AI_AIR_DISPATCHER
   -- 
   -- In the mission editor, setup a group with task Refuelling. A tanker unit of the correct coalition will be automatically selected.
   -- Then, use the method @{#AI_AIR_DISPATCHER.SetDefaultTanker}() to set the tanker for the dispatcher.
-  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultFuelThreshold}() to set the %-tage left in the defender airplane tanks when a refuel action is needed.
+  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultFuelThreshold}() to set the % left in the defender airplane tanks when a refuel action is needed.
   -- 
   -- When the tanker specified is alive and in the air, the tanker will be used for refuelling.
   -- 
   -- 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 )
   --      A2ADispatcher:SetSquadronCapInterval("Sochi", 2, 30, 600, 1 ) 
   --      A2ADispatcher:SetSquadronGci( "Sochi", 900, 1200 )
   --      
-  --      -- Set the default tanker for refuelling to "Tanker", when the default fuel treshold has reached 90% fuel left.
+  --      -- Set the default tanker for refuelling to "Tanker", when the default fuel threshold has reached 90% fuel left.
   --      A2ADispatcher:SetDefaultFuelThreshold( 0.9 )
   --      A2ADispatcher:SetDefaultTanker( "Tanker" )
   --  
@@ -882,10 +872,12 @@ do -- AI_AIR_DISPATCHER
   -- As a result, the GCI and CAP will stop!
   -- 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",
@@ -914,10 +906,10 @@ do -- AI_AIR_DISPATCHER
   --- Enumerator for spawns at airbases
   -- @type AI_AIR_DISPATCHER.Takeoff
   -- @extends Wrapper.Group#GROUP.Takeoff
-  
+
   --- @field #AI_AIR_DISPATCHER.Takeoff Takeoff
   AI_AIR_DISPATCHER.Takeoff = GROUP.Takeoff
-  
+
   --- Defnes Landing location.
   -- @field #AI_AIR_DISPATCHER.Landing
   AI_AIR_DISPATCHER.Landing = {
@@ -925,7 +917,7 @@ do -- AI_AIR_DISPATCHER
     AtRunway = 2,
     AtEngineShutdown = 3,
   }
-  
+
   --- A defense queue item description
   -- @type AI_AIR_DISPATCHER.DefenseQueueItem
   -- @field Squadron
@@ -936,7 +928,7 @@ do -- AI_AIR_DISPATCHER
   -- @field Functional.Detection#DETECTION_BASE AttackerDetection
   -- @field DefenderGrouping
   -- @field #string SquadronName The name of the squadron.
-  
+
   --- Queue of planned defenses to be launched.
   -- This queue exists because defenses must be launched on FARPS, or in the air, or on an airbase, or on carriers.
   -- And some of these platforms have very limited amount of "launching" platforms.
@@ -945,40 +937,39 @@ do -- AI_AIR_DISPATCHER
   -- This guarantees that launched defenders are also directly existing ...
   -- @type AI_AIR_DISPATCHER.DefenseQueue
   -- @list<#AI_AIR_DISPATCHER.DefenseQueueItem> DefenseQueueItem A list of all defenses being queued ...
-  
+
   --- @field #AI_AIR_DISPATCHER.DefenseQueue DefenseQueue
   AI_AIR_DISPATCHER.DefenseQueue = {}
-  
-  
+
   --- Defense approach types
-  -- @type #AI_AIR_DISPATCHER.DefenseApproach
+  -- @type AI_AIR_DISPATCHER.DefenseApproach
   AI_AIR_DISPATCHER.DefenseApproach = {
     Random = 1,
     Distance = 2,
   }
-  
+
   --- AI_AIR_DISPATCHER constructor.
-  -- This is defining the AIR DISPATCHER for one coaliton.
+  -- This is defining the AIR DISPATCHER for one coalition.
   -- The Dispatcher works with a @{Functional.Detection#DETECTION_BASE} object that is taking of the detection of targets using the EWR units.
-  -- The Detection object is polymorphic, depending on the type of detection object choosen, the detection will work differently.
+  -- The Detection object is polymorphic, depending on the type of detection object chosen, the detection will work differently.
   -- @param #AI_AIR_DISPATCHER self
   -- @param Functional.Detection#DETECTION_BASE Detection The DETECTION object that will detects targets using the the Early Warning Radar network.
   -- @return #AI_AIR_DISPATCHER self
   -- @usage
-  --   
-  --   -- Setup the Detection, using DETECTION_AREAS.
-  --   -- First define the SET of GROUPs that are defining the EWR network.
-  --   -- Here with prefixes DF CCCP AWACS, DF CCCP EWR.
-  --   DetectionSetGroup = SET_GROUP:New()
-  --   DetectionSetGroup:FilterPrefixes( { "DF CCCP AWACS", "DF CCCP EWR" } )
-  --   DetectionSetGroup:FilterStart()
-  --   
-  --   -- Define the DETECTION_AREAS, using the DetectionSetGroup, with a 30km grouping radius.
-  --   Detection = DETECTION_AREAS:New( DetectionSetGroup, 30000 )
-  -- 
-  --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
-  --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  --   
-  -- 
+  --
+  --     -- Setup the Detection, using DETECTION_AREAS.
+  --     -- First define the SET of GROUPs that are defining the EWR network.
+  --     -- Here with prefixes DF CCCP AWACS, DF CCCP EWR.
+  --     DetectionSetGroup = SET_GROUP:New()
+  --     DetectionSetGroup:FilterPrefixes( { "DF CCCP AWACS", "DF CCCP EWR" } )
+  --     DetectionSetGroup:FilterStart()
+  --
+  --     -- Define the DETECTION_AREAS, using the DetectionSetGroup, with a 30km grouping radius.
+  --     Detection = DETECTION_AREAS:New( DetectionSetGroup, 30000 )
+  --
+  --     -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
+  --     AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )
+  --
   function AI_AIR_DISPATCHER:New( Detection )
 
     -- Inherits from DETECTION_MANAGER
@@ -1025,7 +1016,7 @@ do -- AI_AIR_DISPATCHER
     -- @param #string From The From State string.
     -- @param #string Event The Event string.
     -- @param #string To The To State string.
-    -- @param Tasking.Task_AIR#AI_AIR Task
+    -- @param AI.AI_Air#AI_AIR Task
     -- @param Wrapper.Unit#UNIT TaskUnit
     -- @param #string PlayerName
     
@@ -1228,7 +1219,7 @@ do -- AI_AIR_DISPATCHER
     
     self:I( "Captured " .. AirbaseName )
     
-    -- Now search for all squadrons located at the airbase, and sanatize them.
+    -- Now search for all squadrons located at the airbase, and sanitize them.
     for SquadronName, Squadron in pairs( self.DefenderSquadrons ) do
       if Squadron.AirbaseName == AirbaseName then
         Squadron.ResourceCount = -999 -- The base has been captured, and the resources are eliminated. No more spawning.
@@ -1380,7 +1371,7 @@ do -- AI_AIR_DISPATCHER
   --- Define a border area to simulate a **cold war** scenario.
   -- A **cold war** is one where Patrol aircraft patrol their territory but will not attack enemy aircraft or launch GCI aircraft unless enemy aircraft enter their territory. In other words the EWR may detect an enemy aircraft but will only send aircraft to attack it if it crosses the border.
   -- A **hot war** is one where Patrol aircraft will intercept any detected enemy aircraft and GCI aircraft will launch against detected enemy aircraft without regard for territory. In other words if the ground radar can detect the enemy aircraft then it will send Patrol and GCI aircraft to attack it.
-  -- If it's a cold war then the **borders of red and blue territory** need to be defined using a @{zone} object derived from @{Core.Zone#ZONE_BASE}. This method needs to be used for this.
+  -- If it's a cold war then the **borders of red and blue territory** need to be defined using a @{Core.Zone} object derived from @{Core.Zone#ZONE_BASE}. This method needs to be used for this.
   -- If a hot war is chosen then **no borders** actually need to be defined using the helicopter units other than 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. Set the noborders parameter to 1
   -- @param #AI_AIR_DISPATCHER self
   -- @param Core.Zone#ZONE_BASE BorderZone An object derived from ZONE_BASE, or a list of objects derived from ZONE_BASE.
@@ -1435,17 +1426,17 @@ do -- AI_AIR_DISPATCHER
   end  
 
 
-  --- Set the default damage treshold when defenders will RTB.
-  -- The default damage treshold is by default set to 40%, which means that when the airplane is 40% damaged, it will go RTB.
+  --- Set the default damage threshold when defenders will RTB.
+  -- The default damage threshold is by default set to 40%, which means that when the airplane is 40% damaged, it will go RTB.
   -- @param #AI_AIR_DISPATCHER self
-  -- @param #number DamageThreshold A decimal number between 0 and 1, that expresses the %-tage of the damage treshold before going RTB.
+  -- @param #number DamageThreshold A decimal number between 0 and 1, that expresses the % of the damage threshold before going RTB.
   -- @return #AI_AIR_DISPATCHER
   -- @usage
   -- 
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the default damage treshold.
+  --   -- Now Setup the default damage threshold.
   --   AIRDispatcher:SetDefaultDamageThreshold( 0.90 ) -- Go RTB when the airplane 90% damaged.
   --   
   function AI_AIR_DISPATCHER:SetDefaultDamageThreshold( DamageThreshold )
@@ -1800,12 +1791,12 @@ do -- AI_AIR_DISPATCHER
   --   
   -- @return #AI_AIR_DISPATCHER
   function AI_AIR_DISPATCHER:SetSquadron2( Squadron )
-  
+
     local SquadronName = Squadron:GetName() -- Retrieves the Squadron Name.
-    self.DefenderSquadrons[SquadronName] = self.DefenderSquadrons[SquadronName] or {} 
+    self.DefenderSquadrons[SquadronName] = self.DefenderSquadrons[SquadronName] or {}
 
     local DefenderSquadron = self.DefenderSquadrons[SquadronName]
-    
+
     return self
   end
   
@@ -1816,15 +1807,15 @@ do -- AI_AIR_DISPATCHER
   function AI_AIR_DISPATCHER:GetSquadron( SquadronName )
 
     local DefenderSquadron = self.DefenderSquadrons[SquadronName]
-    
+
     if not DefenderSquadron then
       error( "Unknown Squadron for Dispatcher:" .. SquadronName )
     end
-    
+
     return DefenderSquadron
   end
 
-  
+
   --- Set the Squadron visible before startup of the dispatcher.
   -- All planes will be spawned as uncontrolled on the parking spot.
   -- They will lock the parking spot.
@@ -1856,7 +1847,7 @@ do -- AI_AIR_DISPATCHER
   --- Check if the Squadron is visible before startup of the dispatcher.
   -- @param #AI_AIR_DISPATCHER self
   -- @param #string SquadronName The squadron name.
-  -- @return #bool true if visible.
+  -- @return #boolean true if visible.
   -- @usage
   -- 
   --        -- Set the Squadron visible before startup of dispatcher.
@@ -1989,7 +1980,7 @@ do -- AI_AIR_DISPATCHER
 
   --- Defines the default amount of extra planes that will take-off as part of the defense system.
   -- @param #AI_AIR_DISPATCHER self
-  -- @param #number Overhead The %-tage of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
+  -- @param #number Overhead The % of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
   -- The default overhead is 1, so equal balance. The @{#AI_AIR_DISPATCHER.SetOverhead}() method can be used to tweak the defense strength,
   -- taking into account the plane types of the squadron. For example, a MIG-31 with full long-distance AIR missiles payload, may still be less effective than a F-15C with short missiles...
   -- So in this case, one may want to use the Overhead method to allocate more defending planes as the amount of detected attacking planes.
@@ -2028,7 +2019,7 @@ do -- AI_AIR_DISPATCHER
   --- Defines the amount of extra planes that will take-off as part of the defense system.
   -- @param #AI_AIR_DISPATCHER self
   -- @param #string SquadronName The name of the squadron.
-  -- @param #number Overhead The %-tage of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
+  -- @param #number Overhead The % of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
   -- The default overhead is 1, so equal balance. The @{#AI_AIR_DISPATCHER.SetOverhead}() method can be used to tweak the defense strength,
   -- taking into account the plane types of the squadron. For example, a MIG-31 with full long-distance AIR missiles payload, may still be less effective than a F-15C with short missiles...
   -- So in this case, one may want to use the Overhead method to allocate more defending planes as the amount of detected attacking planes.
@@ -2068,7 +2059,7 @@ do -- AI_AIR_DISPATCHER
   --- Gets the overhead of planes as part of the defense system, in comparison with the attackers.
   -- @param #AI_AIR_DISPATCHER self
   -- @param #string SquadronName The name of the squadron.
-  -- @return #number The %-tage of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
+  -- @return #number The % of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
   -- The default overhead is 1, so equal balance. The @{#AI_AIR_DISPATCHER.SetOverhead}() method can be used to tweak the defense strength,
   -- taking into account the plane types of the squadron. For example, a MIG-31 with full long-distance AIR missiles payload, may still be less effective than a F-15C with short missiles...
   -- So in this case, one may want to use the Overhead method to allocate more defending planes as the amount of detected attacking planes.
@@ -2674,17 +2665,17 @@ do -- AI_AIR_DISPATCHER
     return self
   end
   
-  --- Set the default fuel treshold when defenders will RTB or Refuel in the air.
-  -- The fuel treshold is by default set to 15%, which means that an airplane will stay in the air until 15% of its fuel has been consumed.
+  --- Set the default fuel threshold when defenders will RTB or Refuel in the air.
+  -- The fuel threshold is by default set to 15%, which means that an airplane will stay in the air until 15% of its fuel has been consumed.
   -- @param #AI_AIR_DISPATCHER self
-  -- @param #number FuelThreshold A decimal number between 0 and 1, that expresses the %-tage of the treshold of fuel remaining in the tank when the plane will go RTB or Refuel.
+  -- @param #number FuelThreshold A decimal number between 0 and 1, that expresses the % of the threshold of fuel remaining in the tank when the plane will go RTB or Refuel.
   -- @return #AI_AIR_DISPATCHER
   -- @usage
   -- 
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the default fuel treshold.
+  --   -- Now Setup the default fuel threshold.
   --   AIRDispatcher:SetDefaultFuelThreshold( 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   function AI_AIR_DISPATCHER:SetDefaultFuelThreshold( FuelThreshold )
@@ -2695,18 +2686,18 @@ do -- AI_AIR_DISPATCHER
   end  
 
 
-  --- Set the fuel treshold for the squadron when defenders will RTB or Refuel in the air.
-  -- The fuel treshold is by default set to 15%, which means that an airplane will stay in the air until 15% of its fuel has been consumed.
+  --- Set the fuel threshold for the squadron when defenders will RTB or Refuel in the air.
+  -- The fuel threshold is by default set to 15%, which means that an airplane will stay in the air until 15% of its fuel has been consumed.
   -- @param #AI_AIR_DISPATCHER self
   -- @param #string SquadronName The name of the squadron.
-  -- @param #number FuelThreshold A decimal number between 0 and 1, that expresses the %-tage of the treshold of fuel remaining in the tank when the plane will go RTB or Refuel.
+  -- @param #number FuelThreshold A decimal number between 0 and 1, that expresses the % of the threshold of fuel remaining in the tank when the plane will go RTB or Refuel.
   -- @return #AI_AIR_DISPATCHER
   -- @usage
   -- 
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the default fuel treshold.
+  --   -- Now Setup the default fuel threshold.
   --   AIRDispatcher:SetSquadronRefuelThreshold( "SquadronName", 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   function AI_AIR_DISPATCHER:SetSquadronFuelThreshold( SquadronName, FuelThreshold )
@@ -2726,7 +2717,7 @@ do -- AI_AIR_DISPATCHER
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the default fuel treshold.
+  --   -- Now Setup the default fuel threshold.
   --   AIRDispatcher:SetDefaultFuelThreshold( 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   --   -- Now Setup the default tanker.
@@ -2749,7 +2740,7 @@ do -- AI_AIR_DISPATCHER
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the squadron fuel treshold.
+  --   -- Now Setup the squadron fuel threshold.
   --   AIRDispatcher:SetSquadronRefuelThreshold( "SquadronName", 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   --   -- Now Setup the squadron tanker.
@@ -2847,7 +2838,7 @@ do -- AI_AIR_DISPATCHER
   -- @param #AI_AIR_DISPATCHER self
   function AI_AIR_DISPATCHER:CountDefendersEngaged( AttackerDetection, AttackerCount )
 
-    -- First, count the active AIGroups Units, targetting the DetectedSet
+    -- First, count the active AIGroups Units, targeting the DetectedSet
     local DefendersEngaged = 0
     local DefendersTotal = 0
     

Moose Development/Moose/AI/AI_Air_Engage.lua

@@ -1,6 +1,6 @@
---- **AI** -- Models the process of air to ground engagement for airplanes and helicopters.
+--- **AI** - Models the process of air to ground engagement for airplanes and helicopters.
 --
--- This is a class used in the @{AI_A2G_Dispatcher}.
+-- This is a class used in the @{AI.AI_A2G_Dispatcher}.
 -- 
 -- ===
 -- 
@@ -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 treshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
--- 
--- ![Process](..\Presentations\AI_GCI\Dia13.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.
 -- 
 -- ## 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 @{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.
---  
+-- 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

@@ -1,4 +1,4 @@
---- **AI** -- Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
+--- **AI** - Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
 --
 -- ===
 -- 
@@ -12,8 +12,7 @@
 --- @type AI_AIR_PATROL
 -- @extends AI.AI_Air#AI_AIR
 
-
---- The AI_AIR_PATROL class implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group} 
+--- The AI_AIR_PATROL class implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Group}
 -- and automatically engage any airborne enemies that are within a certain range or within a certain zone.
 -- 
 -- ![Process](..\Presentations\AI_CAP\Dia3.JPG)
@@ -39,8 +38,8 @@
 -- 
 -- ![Process](..\Presentations\AI_CAP\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- 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_CAP\Dia13.JPG)
 -- 
@@ -70,7 +69,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_AIR_PATROL.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
 --   * **@{#AI_AIR_PATROL.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 tresholds have been reached, the AI will RTB.
+--   * **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
 -- 
@@ -80,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 @{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
@@ -101,7 +97,7 @@ AI_AIR_PATROL = {
 -- @param #AI_AIR_PATROL self
 -- @param AI.AI_Air#AI_AIR AI_Air The AI_AIR FSM.
 -- @param Wrapper.Group#GROUP AIGroup The AI group.
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude (optional, default = 1000m ) The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude (optional, default = 1500m ) The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed (optional, default = 50% of max speed) The minimum speed of the @{Wrapper.Group} in km/h.
@@ -114,17 +110,17 @@ function AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, Pa
   local self = BASE:Inherit( self, AI_Air ) -- #AI_AIR_PATROL
 
   local SpeedMax = AIGroup:GetSpeedMax()
-  
+
   self.PatrolZone = PatrolZone
-  
+
   self.PatrolFloorAltitude = PatrolFloorAltitude or 1000
   self.PatrolCeilingAltitude = PatrolCeilingAltitude or 1500
   self.PatrolMinSpeed = PatrolMinSpeed or SpeedMax * 0.5
   self.PatrolMaxSpeed = PatrolMaxSpeed or SpeedMax * 0.75
-  
+
   -- defafult PatrolAltType to "RADIO" if not specified
   self.PatrolAltType = PatrolAltType or "RADIO"
-  
+
   self:AddTransition( { "Started", "Airborne", "Refuelling" }, "Patrol", "Patrolling" )
 
   --- OnBefore Transition Handler for Event Patrol.
@@ -135,7 +131,7 @@ function AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, Pa
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
   -- @return #boolean Return false to cancel Transition.
-  
+
   --- OnAfter Transition Handler for Event Patrol.
   -- @function [parent=#AI_AIR_PATROL] OnAfterPatrol
   -- @param #AI_AIR_PATROL self
@@ -143,16 +139,16 @@ function AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, Pa
   -- @param #string From The From State string.
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
-    
+
   --- Synchronous Event Trigger for Event Patrol.
   -- @function [parent=#AI_AIR_PATROL] Patrol
   -- @param #AI_AIR_PATROL self
-  
+
   --- Asynchronous Event Trigger for Event Patrol.
   -- @function [parent=#AI_AIR_PATROL] __Patrol
   -- @param #AI_AIR_PATROL self
   -- @param #number Delay The delay in seconds.
-  
+
   --- OnLeave Transition Handler for State Patrolling.
   -- @function [parent=#AI_AIR_PATROL] OnLeavePatrolling
   -- @param #AI_AIR_PATROL self
@@ -161,7 +157,7 @@ function AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, Pa
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
   -- @return #boolean Return false to cancel Transition.
-  
+
   --- OnEnter Transition Handler for State Patrolling.
   -- @function [parent=#AI_AIR_PATROL] OnEnterPatrolling
   -- @param #AI_AIR_PATROL self
@@ -169,9 +165,9 @@ function AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, Pa
   -- @param #string From The From State string.
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
-  
+
     self:AddTransition( "Patrolling", "PatrolRoute", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_PATROL.
-  
+
   --- OnBefore Transition Handler for Event PatrolRoute.
   -- @function [parent=#AI_AIR_PATROL] OnBeforePatrolRoute
   -- @param #AI_AIR_PATROL self
@@ -180,7 +176,7 @@ function AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, Pa
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
   -- @return #boolean Return false to cancel Transition.
-  
+
   --- OnAfter Transition Handler for Event PatrolRoute.
   -- @function [parent=#AI_AIR_PATROL] OnAfterPatrolRoute
   -- @param #AI_AIR_PATROL self
@@ -188,23 +184,21 @@ function AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, Pa
   -- @param #string From The From State string.
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
-    
+
   --- Synchronous Event Trigger for Event PatrolRoute.
   -- @function [parent=#AI_AIR_PATROL] PatrolRoute
   -- @param #AI_AIR_PATROL self
-  
+
   --- Asynchronous Event Trigger for Event PatrolRoute.
   -- @function [parent=#AI_AIR_PATROL] __PatrolRoute
   -- @param #AI_AIR_PATROL self
   -- @param #number Delay The delay in seconds.
 
-
   self:AddTransition( "*", "Reset", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_PATROL.
 
   return self
 end
 
-
 --- Set the Engage Range when the AI will engage with airborne enemies. 
 -- @param #AI_AIR_PATROL self
 -- @param #number EngageRange The Engage Range.
@@ -230,7 +224,7 @@ end
 -- @param #table CapCoordinates Table of coordinates of first race track point. Second point is determined by leg length and heading. 
 -- @return #AI_AIR_PATROL self
 function AI_AIR_PATROL:SetRaceTrackPattern(LegMin, LegMax, HeadingMin, HeadingMax, DurationMin, DurationMax, CapCoordinates)
-  
+
   self.racetrack=true
   self.racetracklegmin=LegMin or 10000
   self.racetracklegmax=LegMax or 15000
@@ -238,18 +232,16 @@ function AI_AIR_PATROL:SetRaceTrackPattern(LegMin, LegMax, HeadingMin, HeadingMa
   self.racetrackheadingmax=HeadingMax or 180
   self.racetrackdurationmin=DurationMin
   self.racetrackdurationmax=DurationMax
-  
+
   if self.racetrackdurationmax and not self.racetrackdurationmin then
     self.racetrackdurationmin=self.racetrackdurationmax
   end
-  
+
   self.racetrackcapcoordinates=CapCoordinates
-  
+
 end
 
-
-
---- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+--- Defines a new patrol route using the @{AI.AI_Patrol#AI_PATROL_ZONE} parameters and settings.
 -- @param #AI_AIR_PATROL self
 -- @return #AI_AIR_PATROL self
 -- @param Wrapper.Group#GROUP AIPatrol The Group Object managed by the FSM.
@@ -262,7 +254,7 @@ function AI_AIR_PATROL:onafterPatrol( AIPatrol, From, Event, To )
   self:ClearTargetDistance()
 
   self:__PatrolRoute( self.TaskDelay )
-  
+
   AIPatrol:OnReSpawn(
     function( PatrolGroup )
       self:__Reset( self.TaskDelay )
@@ -271,7 +263,7 @@ function AI_AIR_PATROL:onafterPatrol( AIPatrol, From, Event, To )
   )
 end
 
---- This statis method is called from the route path within the last task at the last waaypoint of the AIPatrol.
+--- This static method is called from the route path within the last task at the last waypoint of the AIPatrol.
 -- Note that this method is required, as triggers the next route when patrolling for the AIPatrol.
 -- @param Wrapper.Group#GROUP AIPatrol The AI group.
 -- @param #AI_AIR_PATROL Fsm The FSM.
@@ -282,10 +274,10 @@ function AI_AIR_PATROL.___PatrolRoute( AIPatrol, Fsm )
   if AIPatrol and AIPatrol:IsAlive() then
     Fsm:PatrolRoute()
   end
-  
+
 end
 
---- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+--- Defines a new patrol route using the @{AI.AI_Patrol#AI_PATROL_ZONE} parameters and settings.
 -- @param #AI_AIR_PATROL self
 -- @param Wrapper.Group#GROUP AIPatrol The Group managed by the FSM.
 -- @param #string From The From State string.
@@ -300,21 +292,20 @@ function AI_AIR_PATROL:onafterPatrolRoute( AIPatrol, From, Event, To )
     return
   end
 
-  
   if AIPatrol and  AIPatrol:IsAlive() then
-    
+
     local PatrolRoute = {}
 
     --- Calculate the target route point.
-    
+
     local CurrentCoord = AIPatrol:GetCoordinate()
-    
+
     local altitude= math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude )
-    
+
     local ToTargetCoord = self.PatrolZone:GetRandomPointVec2()
     ToTargetCoord:SetAlt( altitude )
     self:SetTargetDistance( ToTargetCoord ) -- For RTB status check
-    
+
     local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
     local speedkmh=ToTargetSpeed
 
@@ -322,31 +313,31 @@ function AI_AIR_PATROL:onafterPatrolRoute( AIPatrol, From, Event, To )
     PatrolRoute[#PatrolRoute+1] = FromWP
 
     if self.racetrack then
-      
+
       -- Random heading.
       local heading = math.random(self.racetrackheadingmin, self.racetrackheadingmax)
-      
+
       -- Random leg length.
       local leg=math.random(self.racetracklegmin, self.racetracklegmax)
-      
+
       -- Random duration if any.
       local duration = self.racetrackdurationmin
       if self.racetrackdurationmax then
         duration=math.random(self.racetrackdurationmin, self.racetrackdurationmax)
       end
-      
+
       -- CAP coordinate.
       local c0=self.PatrolZone:GetRandomCoordinate()
       if self.racetrackcapcoordinates and #self.racetrackcapcoordinates>0 then
         c0=self.racetrackcapcoordinates[math.random(#self.racetrackcapcoordinates)]
       end
-      
+
       -- Race track points.
       local c1=c0:SetAltitude(altitude) --Core.Point#COORDINATE
       local c2=c1:Translate(leg, heading):SetAltitude(altitude)
-      
+
       self:SetTargetDistance(c0) -- For RTB status check
-      
+
       -- Debug:
       self:T(string.format("Patrol zone race track: v=%.1f knots, h=%.1f ft, heading=%03d, leg=%d m, t=%s sec", UTILS.KmphToKnots(speedkmh), UTILS.MetersToFeet(altitude), heading, leg, tostring(duration)))
       --c1:MarkToAll("Race track c1")
@@ -354,39 +345,41 @@ function AI_AIR_PATROL:onafterPatrolRoute( AIPatrol, From, Event, To )
 
       -- Task to orbit.              
       local taskOrbit=AIPatrol:TaskOrbit(c1, altitude, UTILS.KmphToMps(speedkmh), c2)
-      
+
       -- Task function to redo the patrol at other random position.
       local taskPatrol=AIPatrol:TaskFunction("AI_AIR_PATROL.___PatrolRoute", self)
-      
+
       -- Controlled task with task condition.
       local taskCond=AIPatrol:TaskCondition(nil, nil, nil, nil, duration, nil)
       local taskCont=AIPatrol:TaskControlled(taskOrbit, taskCond)
-      
+
       -- Second waypoint
       PatrolRoute[2]=c1:WaypointAirTurningPoint(self.PatrolAltType, speedkmh, {taskCont, taskPatrol}, "CAP Orbit")
 
     else
-    
+
       --- Create a route point of type air.
       local ToWP = ToTargetCoord:WaypointAir(self.PatrolAltType, POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.TurningPoint, ToTargetSpeed, true)  
       PatrolRoute[#PatrolRoute+1] = ToWP
-      
+
       local Tasks = {}
       Tasks[#Tasks+1] = AIPatrol:TaskFunction("AI_AIR_PATROL.___PatrolRoute", self)
       PatrolRoute[#PatrolRoute].task = AIPatrol:TaskCombo( Tasks )
-      
+
     end
-    
+
     AIPatrol:OptionROEReturnFire()
     AIPatrol:OptionROTEvadeFire()
-  
+
     AIPatrol:Route( PatrolRoute, self.TaskDelay )
-    
+
   end
 
 end
 
---- @param Wrapper.Group#GROUP AIPatrol
+--- Resumes the AIPatrol
+-- @param Wrapper.Group#GROUP AIPatrol
+-- @param Core.Fsm#FSM Fsm
 function AI_AIR_PATROL.Resume( AIPatrol, Fsm )
 
   AIPatrol:F( { "AI_AIR_PATROL.Resume:", AIPatrol:GetName() } )
@@ -394,5 +387,5 @@ function AI_AIR_PATROL.Resume( AIPatrol, Fsm )
     Fsm:__Reset( Fsm.TaskDelay )
     Fsm:__PatrolRoute( Fsm.TaskDelay )
   end
-  
+
 end

Moose Development/Moose/AI/AI_Air_Squadron.lua

@@ -1,6 +1,6 @@
 --- **AI** - Models squadrons for airplanes and helicopters.
 --
--- This is a class used in the @{AI_Air_Dispatcher} and derived dispatcher classes.
+-- This is a class used in the @{AI.AI_Air_Dispatcher} and derived dispatcher classes.
 -- 
 -- ===
 -- 
@@ -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

@@ -1,4 +1,4 @@
---- **AI** -- Peform Battlefield Area Interdiction (BAI) within an engagement zone.
+--- **AI** - Peform Battlefield Area Interdiction (BAI) within an engagement zone.
 --
 -- **Features:**
 -- 
@@ -22,21 +22,21 @@
 -- ### Author: **FlightControl**
 -- ### Contributions: 
 -- 
---   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
+--   * **Gunterlund**: Test case revision.
 -- 
 -- ===
 --
--- @module AI.AI_Bai
+-- @module AI.AI_BAI
 -- @image AI_Battlefield_Air_Interdiction.JPG
 
 
 --- AI_BAI_ZONE class
 -- @type AI_BAI_ZONE
 -- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
--- @field Core.Zone#ZONE_BASE TargetZone The @{Zone} where the patrol needs to be executed.
+-- @field Core.Zone#ZONE_BASE TargetZone The @{Core.Zone} where the patrol needs to be executed.
 -- @extends AI.AI_Patrol#AI_PATROL_ZONE
 
---- Implements the core functions to provide BattleGround Air Interdiction in an Engage @{Zone} by an AIR @{Wrapper.Controllable} or @{Wrapper.Group}.
+--- Implements the core functions to provide BattleGround Air Interdiction in an Engage @{Core.Zone} by an AIR @{Wrapper.Controllable} or @{Wrapper.Group}.
 -- 
 -- The AI_BAI_ZONE runs a process. It holds an AI in a Patrol Zone and when the AI is commanded to engage, it will fly to an Engage Zone.
 -- 
@@ -49,7 +49,7 @@
 -- Upon started, The AI will **Route** itself towards the random 3D point within a 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.
--- This cycle will continue until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- This cycle will continue until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
 -- 
 -- ![Route Event](..\Presentations\AI_BAI\Dia5.JPG)
 -- 
@@ -87,7 +87,7 @@
 -- It will keep patrolling there, until it is notified to RTB or move to another BOMB Zone.
 -- It can be notified to go RTB through the **RTB** event.
 -- 
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Engage Event](..\Presentations\AI_BAI\Dia12.JPG)
 --
@@ -117,7 +117,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_BAI_ZONE.Destroy}**: The AI has destroyed a target @{Wrapper.Unit}.
 --   * **@{#AI_BAI_ZONE.Destroyed}**: The AI has destroyed all target @{Wrapper.Unit}s assigned in the BOMB task.
---   * **Status**: The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status**: The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 -- 
 -- ## 3. Modify the Engage Zone behaviour to pinpoint a **map object** or **scenery object**
 -- 
@@ -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
@@ -142,7 +147,7 @@ AI_BAI_ZONE = {
 
 --- Creates a new AI_BAI_ZONE object
 -- @param #AI_BAI_ZONE self
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
@@ -566,7 +571,7 @@ function AI_BAI_ZONE:onafterEngage( Controllable, From, Event, To,
 
     EngageRoute[#EngageRoute].task = Controllable:TaskCombo( AttackTasks )
 
-    --- Define a random point in the @{Zone}. The AI will fly to that point within the zone.
+    --- Define a random point in the @{Core.Zone}. The AI will fly to that point within the zone.
     
       --- Find a random 2D point in EngageZone.
     local ToTargetVec2 = self.EngageZone:GetRandomVec2()
@@ -602,7 +607,7 @@ function AI_BAI_ZONE:onafterEngage( Controllable, From, Event, To,
 
     self:SetRefreshTimeInterval( 2 )
     self:SetDetectionActivated()
-    self:__Target( -2 ) -- Start Targetting
+    self:__Target( -2 ) -- Start targeting
   end
 end
 

Moose Development/Moose/AI/AI_Balancer.lua

@@ -1,4 +1,4 @@
---- **AI** -- Balance player slots with AI to create an engaging simulation environment, independent of the amount of players. 
+--- **AI** - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players. 
 -- 
 -- **Features:**
 -- 
@@ -9,7 +9,7 @@
 -- 
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/AIB%20-%20AI%20Balancing)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AIB%20-%20AI%20Balancing)
 -- 
 -- ===
 -- 
@@ -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

@@ -1,16 +1,15 @@
---- **AI** -- Perform Combat Air Patrolling (CAP) for airplanes.
+--- **AI** - Perform Combat Air Patrolling (CAP) for airplanes.
 --
 -- **Features:**
 -- 
 --   * Patrol AI airplanes within a given zone.
 --   * Trigger detected events when enemy airplanes are detected.
---   * Manage a fuel treshold to RTB on time.
+--   * Manage a fuel threshold to RTB on time.
 --   * Engage the enemy when detected.
--- 
 --
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAP%20-%20Combat%20Air%20Patrol)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAP%20-%20Combat%20Air%20Patrol)
 -- 
 -- ===
 -- 
@@ -19,27 +18,25 @@
 -- ===
 -- 
 -- ### Author: **FlightControl**
--- ### Contributions: 
+-- ### 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.
 -- 
 -- ===       
 --
--- @module AI.AI_Cap
+-- @module AI.AI_CAP
 -- @image AI_Combat_Air_Patrol.JPG
 
-
 --- @type AI_CAP_ZONE
 -- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
--- @field Core.Zone#ZONE_BASE TargetZone The @{Zone} where the patrol needs to be executed.
+-- @field Core.Zone#ZONE_BASE TargetZone The @{Core.Zone} where the patrol needs to be executed.
 -- @extends AI.AI_Patrol#AI_PATROL_ZONE
 
-
---- Implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group} 
+--- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group} 
 -- and automatically engage any airborne enemies that are within a certain range or within a certain zone.
 -- 
 -- ![Process](..\Presentations\AI_CAP\Dia3.JPG)
@@ -65,8 +62,8 @@
 -- 
 -- ![Process](..\Presentations\AI_CAP\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- 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_CAP\Dia13.JPG)
 -- 
@@ -96,7 +93,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_CAP_ZONE.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
 --   * **@{#AI_CAP_ZONE.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 tresholds have been reached, the AI will RTB.
+--   * **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
 -- 
@@ -106,16 +103,21 @@
 -- 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_CAP_ZONE.SetEngageRange}() to define that range.
+-- Use the method @{#AI_CAP_ZONE.SetEngageRange}() to define that range.
 --
 -- ## 4. Set the Zone of Engagement
 -- 
 -- ![Zone](..\Presentations\AI_CAP\Dia12.JPG)
 -- 
--- An optional @{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_CAP_ZONE.SetEngageZone}() to define that Zone.
---  
+-- 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
@@ -123,11 +125,9 @@ AI_CAP_ZONE = {
   ClassName = "AI_CAP_ZONE",
 }
 
-
-
 --- Creates a new AI_CAP_ZONE object
 -- @param #AI_CAP_ZONE self
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
@@ -141,7 +141,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
 
   self.Accomplished = false
   self.Engaging = false
-  
+
   self:AddTransition( { "Patrolling", "Engaging" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
 
   --- OnBefore Transition Handler for Event Engage.
@@ -152,7 +152,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
   -- @return #boolean Return false to cancel Transition.
-  
+
   --- OnAfter Transition Handler for Event Engage.
   -- @function [parent=#AI_CAP_ZONE] OnAfterEngage
   -- @param #AI_CAP_ZONE self
@@ -160,11 +160,11 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string From The From State string.
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
-  	
+
   --- Synchronous Event Trigger for Event Engage.
   -- @function [parent=#AI_CAP_ZONE] Engage
   -- @param #AI_CAP_ZONE self
-  
+
   --- Asynchronous Event Trigger for Event Engage.
   -- @function [parent=#AI_CAP_ZONE] __Engage
   -- @param #AI_CAP_ZONE self
@@ -188,7 +188,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
 -- @param #string To The To State string.
 
   self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
-  
+
   --- OnBefore Transition Handler for Event Fired.
   -- @function [parent=#AI_CAP_ZONE] OnBeforeFired
   -- @param #AI_CAP_ZONE self
@@ -197,7 +197,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
   -- @return #boolean Return false to cancel Transition.
-  
+
   --- OnAfter Transition Handler for Event Fired.
   -- @function [parent=#AI_CAP_ZONE] OnAfterFired
   -- @param #AI_CAP_ZONE self
@@ -205,11 +205,11 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string From The From State string.
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
-  	
+
   --- Synchronous Event Trigger for Event Fired.
   -- @function [parent=#AI_CAP_ZONE] Fired
   -- @param #AI_CAP_ZONE self
-  
+
   --- Asynchronous Event Trigger for Event Fired.
   -- @function [parent=#AI_CAP_ZONE] __Fired
   -- @param #AI_CAP_ZONE self
@@ -225,7 +225,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
   -- @return #boolean Return false to cancel Transition.
-  
+
   --- OnAfter Transition Handler for Event Destroy.
   -- @function [parent=#AI_CAP_ZONE] OnAfterDestroy
   -- @param #AI_CAP_ZONE self
@@ -233,17 +233,16 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string From The From State string.
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
-  	
+
   --- Synchronous Event Trigger for Event Destroy.
   -- @function [parent=#AI_CAP_ZONE] Destroy
   -- @param #AI_CAP_ZONE self
-  
+
   --- Asynchronous Event Trigger for Event Destroy.
   -- @function [parent=#AI_CAP_ZONE] __Destroy
   -- @param #AI_CAP_ZONE self
   -- @param #number Delay The delay in seconds.
 
-
   self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
 
   --- OnBefore Transition Handler for Event Abort.
@@ -254,7 +253,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
   -- @return #boolean Return false to cancel Transition.
-  
+
   --- OnAfter Transition Handler for Event Abort.
   -- @function [parent=#AI_CAP_ZONE] OnAfterAbort
   -- @param #AI_CAP_ZONE self
@@ -262,11 +261,11 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string From The From State string.
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
-  	
+
   --- Synchronous Event Trigger for Event Abort.
   -- @function [parent=#AI_CAP_ZONE] Abort
   -- @param #AI_CAP_ZONE self
-  
+
   --- Asynchronous Event Trigger for Event Abort.
   -- @function [parent=#AI_CAP_ZONE] __Abort
   -- @param #AI_CAP_ZONE self
@@ -282,7 +281,7 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
   -- @return #boolean Return false to cancel Transition.
-  
+
   --- OnAfter Transition Handler for Event Accomplish.
   -- @function [parent=#AI_CAP_ZONE] OnAfterAccomplish
   -- @param #AI_CAP_ZONE self
@@ -290,11 +289,11 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @param #string From The From State string.
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
-  	
+
   --- Synchronous Event Trigger for Event Accomplish.
   -- @function [parent=#AI_CAP_ZONE] Accomplish
   -- @param #AI_CAP_ZONE self
-  
+
   --- Asynchronous Event Trigger for Event Accomplish.
   -- @function [parent=#AI_CAP_ZONE] __Accomplish
   -- @param #AI_CAP_ZONE self
@@ -303,7 +302,6 @@ function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   return self
 end
 
-
 --- Set the Engage Zone which defines where the AI will engage bogies. 
 -- @param #AI_CAP_ZONE self
 -- @param Core.Zone#ZONE EngageZone The zone where the AI is performing CAP.
@@ -311,7 +309,7 @@ end
 function AI_CAP_ZONE:SetEngageZone( EngageZone )
   self:F2()
 
-  if EngageZone then  
+  if EngageZone then
     self.EngageZone = EngageZone
   else
     self.EngageZone = nil
@@ -346,7 +344,6 @@ function AI_CAP_ZONE:onafterStart( Controllable, From, Event, To )
 
 end
 
-
 --- @param AI.AI_CAP#AI_CAP_ZONE 
 -- @param Wrapper.Group#GROUP EngageGroup
 function AI_CAP_ZONE.EngageRoute( EngageGroup, Fsm )
@@ -358,8 +355,6 @@ function AI_CAP_ZONE.EngageRoute( EngageGroup, Fsm )
   end
 end
 
-
-
 --- @param #AI_CAP_ZONE self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
@@ -380,11 +375,11 @@ end
 function AI_CAP_ZONE:onafterDetected( Controllable, From, Event, To )
 
   if From ~= "Engaging" then
-  
+
     local Engage = false
-  
+
     for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
-    
+
       local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
       self:T( DetectedUnit )
       if DetectedUnit:IsAlive() and DetectedUnit:IsAir() then
@@ -392,7 +387,7 @@ function AI_CAP_ZONE:onafterDetected( Controllable, From, Event, To )
         break
       end
     end
-  
+
     if Engage == true then
       self:F( 'Detected -> Engaging' )
       self:__Engage( 1 )
@@ -400,7 +395,6 @@ function AI_CAP_ZONE:onafterDetected( Controllable, From, Event, To )
   end
 end
 
-
 --- @param #AI_CAP_ZONE self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
@@ -411,9 +405,6 @@ function AI_CAP_ZONE:onafterAbort( Controllable, From, Event, To )
   self:__Route( 1 )
 end
 
-
-
-
 --- @param #AI_CAP_ZONE self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
@@ -427,24 +418,23 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To )
 
     --- Calculate the current route point.
     local CurrentVec2 = self.Controllable:GetVec2()
-    
+
     if not CurrentVec2 then return self end
-    
+
     --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
     local CurrentAltitude = self.Controllable:GetAltitude()
     local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
     local ToEngageZoneSpeed = self.PatrolMaxSpeed
-    local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-        self.PatrolAltType, 
-        POINT_VEC3.RoutePointType.TurningPoint, 
-        POINT_VEC3.RoutePointAction.TurningPoint, 
-        ToEngageZoneSpeed, 
-        true 
+    local CurrentRoutePoint = CurrentPointVec3:WaypointAir(
+        self.PatrolAltType,
+        POINT_VEC3.RoutePointType.TurningPoint,
+        POINT_VEC3.RoutePointAction.TurningPoint,
+        ToEngageZoneSpeed,
+        true
       )
-    
+
     EngageRoute[#EngageRoute+1] = CurrentRoutePoint
 
-    
      --- Find a random 2D point in PatrolZone.
     local ToTargetVec2 = self.PatrolZone:GetRandomVec2()
     self:T2( ToTargetVec2 )
@@ -453,17 +443,17 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To )
     local ToTargetAltitude = math.random( self.EngageFloorAltitude, self.EngageCeilingAltitude )
     local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
     self:T2( { self.PatrolMinSpeed, self.PatrolMaxSpeed, ToTargetSpeed } )
-    
+
     --- Obtain a 3D @{Point} from the 2D point + altitude.
     local ToTargetPointVec3 = POINT_VEC3:New( ToTargetVec2.x, ToTargetAltitude, ToTargetVec2.y )
-    
+
     --- Create a route point of type air.
-    local ToPatrolRoutePoint = ToTargetPointVec3:WaypointAir( 
-      self.PatrolAltType, 
-      POINT_VEC3.RoutePointType.TurningPoint, 
-      POINT_VEC3.RoutePointAction.TurningPoint, 
-      ToTargetSpeed, 
-      true 
+    local ToPatrolRoutePoint = ToTargetPointVec3:WaypointAir(
+      self.PatrolAltType,
+      POINT_VEC3.RoutePointType.TurningPoint,
+      POINT_VEC3.RoutePointAction.TurningPoint,
+      ToTargetSpeed,
+      true
     )
 
     EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
@@ -482,7 +472,7 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To )
             self:F( {"Within Zone and Engaging ", DetectedUnit } )
             AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit )
           end
-        else        
+        else 
           if self.EngageRange then
             if DetectedUnit:GetPointVec3():Get2DDistance(Controllable:GetPointVec3() ) <= self.EngageRange then
               self:F( {"Within Range and Engaging", DetectedUnit } )
@@ -506,12 +496,12 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To )
 
       AttackTasks[#AttackTasks+1] = Controllable:TaskFunction( "AI_CAP_ZONE.EngageRoute", self )
       EngageRoute[1].task = Controllable:TaskCombo( AttackTasks )
-      
+
       self:SetDetectionDeactivated()
     end
-    
+
     Controllable:Route( EngageRoute, 0.5 )
-  
+
   end
 end
 

Moose Development/Moose/AI/AI_CAS.lua

@@ -1,4 +1,4 @@
---- **AI** -- Perform Close Air Support (CAS) near friendlies.
+--- **AI** - Perform Close Air Support (CAS) near friendlies.
 --
 -- **Features:**
 -- 
@@ -11,7 +11,7 @@
 --
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAS%20-%20Close%20Air%20Support)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAS%20-%20Close%20Air%20Support)
 -- 
 -- ===
 -- 
@@ -22,22 +22,22 @@
 -- ### 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.
 --
 -- ===
 --
--- @module AI.AI_Cas
+-- @module AI.AI_CAS
 -- @image AI_Close_Air_Support.JPG
 
 --- AI_CAS_ZONE class
 -- @type AI_CAS_ZONE
 -- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
--- @field Core.Zone#ZONE_BASE TargetZone The @{Zone} where the patrol needs to be executed.
+-- @field Core.Zone#ZONE_BASE TargetZone The @{Core.Zone} where the patrol needs to be executed.
 -- @extends AI.AI_Patrol#AI_PATROL_ZONE
 
---- Implements the core functions to provide Close Air Support in an Engage @{Zone} by an AIR @{Wrapper.Controllable} or @{Wrapper.Group}.
+--- Implements the core functions to provide Close Air Support in an Engage @{Core.Zone} by an AIR @{Wrapper.Controllable} or @{Wrapper.Group}.
 -- The AI_CAS_ZONE runs a process. It holds an AI in a Patrol Zone and when the AI is commanded to engage, it will fly to an Engage Zone.
 -- 
 -- ![HoldAndEngage](..\Presentations\AI_CAS\Dia3.JPG)
@@ -49,7 +49,7 @@
 -- Upon started, The AI will **Route** itself towards the random 3D point within a 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.
--- This cycle will continue until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- This cycle will continue until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
 -- 
 -- ![Route Event](..\Presentations\AI_CAS\Dia5.JPG)
 -- 
@@ -87,7 +87,7 @@
 -- It will keep patrolling there, until it is notified to RTB or move to another CAS Zone.
 -- It can be notified to go RTB through the **RTB** event.
 -- 
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Engage Event](..\Presentations\AI_CAS\Dia12.JPG)
 --
@@ -117,8 +117,13 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#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 tresholds have been reached, the AI will RTB.
+--   * **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
@@ -130,7 +135,7 @@ AI_CAS_ZONE = {
 
 --- Creates a new AI_CAS_ZONE object
 -- @param #AI_CAS_ZONE self
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
@@ -496,7 +501,7 @@ function AI_CAS_ZONE:onafterEngage( Controllable, From, Event, To,
     AttackTasks[#AttackTasks+1] = Controllable:TaskFunction( "AI_CAS_ZONE.EngageRoute", self )
     EngageRoute[#EngageRoute].task = Controllable:TaskCombo( AttackTasks )
 
-    --- Define a random point in the @{Zone}. The AI will fly to that point within the zone.
+    --- Define a random point in the @{Core.Zone}. The AI will fly to that point within the zone.
     
       --- Find a random 2D point in EngageZone.
     local ToTargetVec2 = self.EngageZone:GetRandomVec2()
@@ -520,7 +525,7 @@ function AI_CAS_ZONE:onafterEngage( Controllable, From, Event, To,
     
     self:SetRefreshTimeInterval( 2 )
     self:SetDetectionActivated()
-    self:__Target( -2 ) -- Start Targetting
+    self:__Target( -2 ) -- Start targeting
   end
 end
 

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

@@ -1,4 +1,4 @@
---- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes.
+--- **AI** - Models the intelligent transportation of infantry and other cargo using Planes.
 --
 -- ## Features:
 --
@@ -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

@@ -1,4 +1,4 @@
---- **AI** -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.
+--- **AI** - Models the intelligent transportation of infantry and other cargo using Helicopters.
 --
 -- ## Features:
 -- 
@@ -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

@@ -1,4 +1,4 @@
---- **AI** -- (2.5.1) - Models the intelligent transportation of infantry and other cargo using Ships
+--- **AI** - Models the intelligent transportation of infantry and other cargo using Ships.
 --
 -- ## Features:
 -- 
@@ -37,14 +37,14 @@
 --
 -- This will be particularly helpful in order to determine how to **Tailor the different cargo handling events**.
 --
--- The AI_CARGO_DISPATCHER_SHIP class uses the @{Cargo.Cargo} capabilities within the MOOSE framwork.
+-- The AI_CARGO_DISPATCHER_SHIP class uses the @{Cargo.Cargo} capabilities within the MOOSE framework.
 -- Also ensure that you fully understand how to declare and setup Cargo objects within the MOOSE framework before using this class.
 -- CARGO derived objects must generally be declared within the mission to make the AI_CARGO_DISPATCHER_SHIP object recognize the cargo.
 --
 --
 -- # 1) AI_CARGO_DISPATCHER_SHIP constructor.
 -- 
---   * @{AI_CARGO_DISPATCHER_SHIP.New}(): Creates a new AI_CARGO_DISPATCHER_SHIP object.
+--   * @{#AI_CARGO_DISPATCHER_SHIP.New}(): Creates a new AI_CARGO_DISPATCHER_SHIP object.
 --
 -- ---
 --
@@ -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

@@ -1,4 +1,4 @@
---- **AI** -- (R2.5.1) - Models the intelligent transportation of infantry and other cargo.
+--- **AI** - Models the intelligent transportation of infantry and other cargo.
 --
 -- ===
 --
@@ -46,15 +46,20 @@
 --
 -- ## Cargo deployment.
 --
--- Using the @{AI_CARGO_SHIP.Deploy}() method, you are able to direct the Ship towards a Deploy zone to unboard/unload the cargo at the
+-- Using the @{#AI_CARGO_SHIP.Deploy}() method, you are able to direct the Ship towards a Deploy zone to unboard/unload the cargo at the
 -- specified coordinate. The Ship will follow the Shipping Lane to ensure consistent cargo transportation within the simulation environment.
 --
 -- ## Cargo pickup.
 --
--- Using the @{AI_CARGO_SHIP.Pickup}() method, you are able to direct the Ship towards a Pickup zone to board/load the cargo at the specified
+-- Using the @{#AI_CARGO_SHIP.Pickup}() method, you are able to direct the Ship towards a Pickup zone to board/load the cargo at the specified
 -- 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

@@ -1,4 +1,4 @@
---- **Functional** -- Taking the lead of AI escorting your flight or of other AI.
+--- **AI** - Taking the lead of AI escorting your flight or of other AI.
 -- 
 -- ===
 -- 
@@ -147,8 +147,8 @@
 -- @image Escorting.JPG
 
 
-
---- @type AI_ESCORT
+---
+-- @type AI_ESCORT
 -- @extends AI.AI_Formation#AI_FORMATION
 
 
@@ -168,10 +168,17 @@
 -- 
 -- -- First find the GROUP object and the CLIENT object.
 -- local EscortUnit = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
--- local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
+-- local EscortGroup = SET_GROUP:New():FilterPrefixes("Escort"):FilterOnce() -- The the group name of the escorts contains "Escort".
 -- 
 -- -- Now use these 2 objects to construct the new EscortPlanes object.
 -- 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 = {
@@ -189,16 +196,9 @@ AI_ESCORT = {
   TaskPoints = {}
 }
 
---- @field Functional.Detection#DETECTION_AREAS
+-- @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.
@@ -211,10 +211,14 @@ AI_ESCORT.Detection = nil
 -- 
 -- -- First find the GROUP object and the CLIENT object.
 -- local EscortUnit = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
--- local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
+-- local EscortGroup = SET_GROUP:New():FilterPrefixes("Escort"):FilterOnce() -- The the group name of the escorts contains "Escort".
 -- 
 -- -- Now use these 2 objects to construct the new EscortPlanes object.
 -- 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)
+-- 
+-- 
 function AI_ESCORT:New( EscortUnit, EscortGroupSet, EscortName, EscortBriefing )
   
   local self = BASE:Inherit( self, AI_FORMATION:New( EscortUnit, EscortGroupSet, EscortName, EscortBriefing ) ) -- #AI_ESCORT
@@ -227,10 +231,17 @@ function AI_ESCORT:New( EscortUnit, EscortGroupSet, EscortName, EscortBriefing )
   self.EscortGroupSet = EscortGroupSet
   
   self.EscortGroupSet:SetSomeIteratorLimit( 8 )
-  
+
   self.EscortBriefing = EscortBriefing
  
   self.Menu = {}
+  self.Menu.HoldAtEscortPosition = self.Menu.HoldAtEscortPosition or {}
+  self.Menu.HoldAtLeaderPosition = self.Menu.HoldAtLeaderPosition or {}
+  self.Menu.Flare = self.Menu.Flare or {}
+  self.Menu.Smoke = self.Menu.Smoke or {}
+  self.Menu.Targets = self.Menu.Targets or {}
+  self.Menu.ROE = self.Menu.ROE or {}
+  self.Menu.ROT = self.Menu.ROT or {}
   
 --  if not EscortBriefing then
 --    EscortGroup:MessageToClient( EscortGroup:GetCategoryName() .. " '" .. EscortName .. "' (" .. EscortGroup:GetCallsign() .. ") reporting! " ..
@@ -250,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
@@ -325,14 +336,14 @@ function AI_ESCORT:_InitEscortRoute( EscortGroup )
 end
 
 
---- @param #AI_ESCORT self
+-- @param #AI_ESCORT self
 -- @param Core.Set#SET_GROUP EscortGroupSet
 function AI_ESCORT:onafterStart( EscortGroupSet )
 
   self:F()
 
   EscortGroupSet:ForEachGroup(
-    --- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       EscortGroup:WayPointInitialize()
     
@@ -370,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 )
@@ -378,7 +389,7 @@ function AI_ESCORT:onafterStart( EscortGroupSet )
 
       self:SetFlightModeFormation( EscortGroup )
       
-      --- @param #AI_ESCORT self
+      -- @param #AI_ESCORT self
       -- @param Core.Event#EVENTDATA EventData
       function EscortGroup:OnEventDeadOrCrash( EventData )
         self:F( { "EventDead", EventData } )
@@ -394,14 +405,14 @@ function AI_ESCORT:onafterStart( EscortGroupSet )
 
 end
 
---- @param #AI_ESCORT self
+-- @param #AI_ESCORT self
 -- @param Core.Set#SET_GROUP EscortGroupSet
 function AI_ESCORT:onafterStop( EscortGroupSet )
 
   self:F()
 
   EscortGroupSet:ForEachGroup(
-    --- @param Core.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       EscortGroup:WayPointInitialize()
     
@@ -443,9 +454,9 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
 -- @param #number YSpace The space between groups on the Y-axis in meters for each sequent group.
--- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
+-- @param #number ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @param #number ZLevels The amount of levels on the Z-axis.
 -- @return #AI_ESCORT
@@ -493,9 +504,9 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
 -- @param #number YSpace The space between groups on the Y-axis in meters for each sequent group.
--- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
+-- @param #number ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @param #number ZLevels The amount of levels on the Z-axis.
 -- @return #AI_ESCORT
@@ -550,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})
@@ -580,7 +591,7 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
 -- @return #AI_ESCORT
 function AI_ESCORT:MenuFormationTrail( XStart, XSpace, YStart )
 
@@ -594,7 +605,7 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
 -- @param #number YSpace The space between groups on the Y-axis in meters for each sequent group.
 -- @return #AI_ESCORT
 function AI_ESCORT:MenuFormationStack( XStart, XSpace, YStart, YSpace )
@@ -609,8 +620,8 @@ end
 -- This menu will appear under **Formation**.
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
--- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
+-- @param #number ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @return #AI_ESCORT
 function AI_ESCORT:MenuFormationLeftLine( XStart, YStart, ZStart, ZSpace )
@@ -625,8 +636,8 @@ end
 -- This menu will appear under **Formation**.
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
--- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
+-- @param #number ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @return #AI_ESCORT
 function AI_ESCORT:MenuFormationRightLine( XStart, YStart, ZStart, ZSpace )
@@ -642,8 +653,8 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
--- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
+-- @param #number ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @return #AI_ESCORT
 function AI_ESCORT:MenuFormationLeftWing( XStart, XSpace, YStart, ZStart, ZSpace )
@@ -659,8 +670,8 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
--- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
+-- @param #number ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @return #AI_ESCORT
 function AI_ESCORT:MenuFormationRightWing( XStart, XSpace, YStart, ZStart, ZSpace )
@@ -676,9 +687,9 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
 -- @param #number YSpace The space between groups on the Y-axis in meters for each sequent group.
--- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
+-- @param #number ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @return #AI_ESCORT
 function AI_ESCORT:MenuFormationCenterWing( XStart, XSpace, YStart, YSpace, ZStart, ZSpace )
@@ -694,9 +705,9 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
 -- @param #number YSpace The space between groups on the Y-axis in meters for each sequent group.
--- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
+-- @param #number ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @return #AI_ESCORT
 function AI_ESCORT:MenuFormationVic( XStart, XSpace, YStart, YSpace, ZStart, ZSpace )
@@ -712,9 +723,9 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
 -- @param #number YSpace The space between groups on the Y-axis in meters for each sequent group.
--- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
+-- @param #number ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @param #number ZLevels The amount of levels on the Z-axis.
 -- @return #AI_ESCORT
@@ -764,7 +775,7 @@ end
 
 function AI_ESCORT:SetFlightMenuHoldAtEscortPosition()
 
-  for _, MenuHoldAtEscortPosition in pairs( self.Menu.HoldAtEscortPosition ) do
+  for _, MenuHoldAtEscortPosition in pairs( self.Menu.HoldAtEscortPosition or {} ) do
     local FlightMenuReportNavigation = MENU_GROUP:New( self.PlayerGroup, "Navigation", self.FlightMenu )
   
     local FlightMenuHoldPosition = MENU_GROUP_COMMAND
@@ -785,7 +796,7 @@ end
 
 function AI_ESCORT:SetEscortMenuHoldAtEscortPosition( EscortGroup )
 
-  for _, HoldAtEscortPosition in pairs( self.Menu.HoldAtEscortPosition ) do
+  for _, HoldAtEscortPosition in pairs( self.Menu.HoldAtEscortPosition or {}) do
     if EscortGroup:IsAir() then
       local EscortGroupName = EscortGroup:GetName()
       local EscortMenuReportNavigation = MENU_GROUP:New( self.PlayerGroup, "Navigation", EscortGroup.EscortMenu )
@@ -853,7 +864,7 @@ end
 
 function AI_ESCORT:SetFlightMenuHoldAtLeaderPosition()
 
-  for _, MenuHoldAtLeaderPosition in pairs( self.Menu.HoldAtLeaderPosition ) do
+  for _, MenuHoldAtLeaderPosition in pairs( self.Menu.HoldAtLeaderPosition or {}) do
     local FlightMenuReportNavigation = MENU_GROUP:New( self.PlayerGroup, "Navigation", self.FlightMenu )
   
     local FlightMenuHoldAtLeaderPosition = MENU_GROUP_COMMAND
@@ -874,7 +885,7 @@ end
 
 function AI_ESCORT:SetEscortMenuHoldAtLeaderPosition( EscortGroup )
 
-  for _, HoldAtLeaderPosition in pairs( self.Menu.HoldAtLeaderPosition ) do
+  for _, HoldAtLeaderPosition in pairs( self.Menu.HoldAtLeaderPosition or {}) do
     if EscortGroup:IsAir() then
       
       local EscortGroupName = EscortGroup:GetName()
@@ -999,7 +1010,7 @@ end
 
 function AI_ESCORT:SetFlightMenuFlare()
 
-  for _, MenuFlare in pairs( self.Menu.Flare) do
+  for _, MenuFlare in pairs( self.Menu.Flare or {}) do
     local FlightMenuReportNavigation = MENU_GROUP:New( self.PlayerGroup, "Navigation", self.FlightMenu )
     local FlightMenuFlare = MENU_GROUP:New( self.PlayerGroup, MenuFlare.MenuText, FlightMenuReportNavigation )
   
@@ -1014,7 +1025,7 @@ end
 
 function AI_ESCORT:SetEscortMenuFlare( EscortGroup )
 
-  for _, MenuFlare in pairs( self.Menu.Flare) do
+  for _, MenuFlare in pairs( self.Menu.Flare or {}) do
     if EscortGroup:IsAir() then
       
       local EscortGroupName = EscortGroup:GetName()
@@ -1059,7 +1070,7 @@ end
 
 function AI_ESCORT:SetFlightMenuSmoke()
 
-  for _, MenuSmoke in pairs( self.Menu.Smoke) do
+  for _, MenuSmoke in pairs( self.Menu.Smoke or {}) do
     local FlightMenuReportNavigation = MENU_GROUP:New( self.PlayerGroup, "Navigation", self.FlightMenu )
     local FlightMenuSmoke = MENU_GROUP:New( self.PlayerGroup, MenuSmoke.MenuText, FlightMenuReportNavigation )
   
@@ -1076,7 +1087,7 @@ end
 
 function AI_ESCORT:SetEscortMenuSmoke( EscortGroup )
 
-  for _, MenuSmoke in pairs( self.Menu.Smoke) do
+  for _, MenuSmoke in pairs( self.Menu.Smoke or {}) do
     if EscortGroup:IsAir() then
       
       local EscortGroupName = EscortGroup:GetName()
@@ -1169,7 +1180,7 @@ function AI_ESCORT:SetFlightMenuTargets()
   local FlightMenuAttackNearbyAir = MENU_GROUP_COMMAND:New( self.PlayerGroup, "Attack nearest airborne targets",  self.FlightMenuAttack, AI_ESCORT._FlightAttackNearestTarget, self, self.__Enum.ReportType.Air ):SetTag( "Attack" )
   local FlightMenuAttackNearbyGround = MENU_GROUP_COMMAND:New( self.PlayerGroup, "Attack nearest ground targets",  self.FlightMenuAttack, AI_ESCORT._FlightAttackNearestTarget, self, self.__Enum.ReportType.Ground ):SetTag( "Attack" )
   
-  for _, MenuTargets in pairs( self.Menu.Targets) do
+  for _, MenuTargets in pairs( self.Menu.Targets or {}) do
     MenuTargets.FlightReportTargetsScheduler = SCHEDULER:New( self, self._FlightReportTargetsScheduler, {}, MenuTargets.Interval, MenuTargets.Interval )
   end
 
@@ -1179,7 +1190,7 @@ end
 
 function AI_ESCORT:SetEscortMenuTargets( EscortGroup )
 
-  for _, MenuTargets in pairs( self.Menu.Targets) do
+  for _, MenuTargets in pairs( self.Menu.Targets or {} or {}) do
     if EscortGroup:IsAir() then
       local EscortGroupName = EscortGroup:GetName()
       --local EscortMenuReportTargets = MENU_GROUP:New( self.PlayerGroup, "Report targets", EscortGroup.EscortMenu )
@@ -1231,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.
@@ -1246,7 +1257,7 @@ end
 
 function AI_ESCORT:SetFlightMenuROE()
 
-  for _, MenuROE in pairs( self.Menu.ROE) do
+  for _, MenuROE in pairs( self.Menu.ROE or {}) do
     local FlightMenuROE = MENU_GROUP:New( self.PlayerGroup, "Rule Of Engagement", self.FlightMenu )
   
     local FlightMenuROEHoldFire   = MENU_GROUP_COMMAND:New( self.PlayerGroup, "Hold fire",          FlightMenuROE, AI_ESCORT._FlightROEHoldFire,   self,  "Holding weapons!" )
@@ -1261,7 +1272,7 @@ end
 
 function AI_ESCORT:SetEscortMenuROE( EscortGroup )
 
-  for _, MenuROE in pairs( self.Menu.ROE) do
+  for _, MenuROE in pairs( self.Menu.ROE or {}) do
     if EscortGroup:IsAir() then
 
       local EscortGroupName = EscortGroup:GetName()
@@ -1302,7 +1313,7 @@ end
 
 function AI_ESCORT:SetFlightMenuROT()
 
-  for _, MenuROT in pairs( self.Menu.ROT) do
+  for _, MenuROT in pairs( self.Menu.ROT or {}) do
     local FlightMenuROT = MENU_GROUP:New( self.PlayerGroup, "Reaction On Threat", self.FlightMenu )
   
     local FlightMenuROTNoReaction     = MENU_GROUP_COMMAND:New( self.PlayerGroup, "Fight until death",             FlightMenuROT, AI_ESCORT._FlightROTNoReaction,     self, "Fighting until death!" )
@@ -1317,7 +1328,7 @@ end
 
 function AI_ESCORT:SetEscortMenuROT( EscortGroup )
 
-  for _, MenuROT in pairs( self.Menu.ROT) do
+  for _, MenuROT in pairs( self.Menu.ROT or {}) do
     if EscortGroup:IsAir() then
 
       local EscortGroupName = EscortGroup:GetName()
@@ -1375,7 +1386,7 @@ function AI_ESCORT:SetEscortMenuResumeMission( EscortGroup )
 end
 
 
---- @param #AI_ESCORT self
+-- @param #AI_ESCORT self
 -- @param Wrapper.Group#GROUP OrbitGroup
 -- @param Wrapper.Group#GROUP EscortGroup
 -- @param #number OrbitHeight
@@ -1419,7 +1430,7 @@ function AI_ESCORT:_HoldPosition( OrbitGroup, EscortGroup, OrbitHeight, OrbitSec
 end
 
 
---- @param #AI_ESCORT self
+-- @param #AI_ESCORT self
 -- @param Wrapper.Group#GROUP OrbitGroup
 -- @param #number OrbitHeight
 -- @param #number OrbitSeconds
@@ -1428,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
@@ -1456,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 )
@@ -1471,7 +1482,7 @@ end
 -- @param #AI_ESCORT self
 -- @param #number XStart The start position on the X-axis in meters for the first group.
 -- @param #number XSpace The space between groups on the X-axis in meters for each sequent group.
--- @param #nubmer YStart The start position on the Y-axis in meters for the first group.
+-- @param #number YStart The start position on the Y-axis in meters for the first group.
 -- @return #AI_ESCORT
 function AI_ESCORT:_EscortFormationTrail( EscortGroup, XStart, XSpace, YStart )
 
@@ -1483,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 )
@@ -1510,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 )
@@ -1533,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 )
@@ -1556,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 )
@@ -1587,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 )
@@ -1679,7 +1690,7 @@ function AI_ESCORT:_ScanTargets( ScanDuration )
 
 end
 
---- @param Wrapper.Group#GROUP EscortGroup
+-- @param Wrapper.Group#GROUP EscortGroup
 -- @param #AI_ESCORT self
 function AI_ESCORT.___Resume( EscortGroup, self )
 
@@ -1701,7 +1712,7 @@ function AI_ESCORT.___Resume( EscortGroup, self )
 end
 
 
---- @param #AI_ESCORT self
+-- @param #AI_ESCORT self
 -- @param Wrapper.Group#GROUP EscortGroup
 -- @param #number WayPoint
 function AI_ESCORT:_ResumeMission( EscortGroup, WayPoint )
@@ -1723,7 +1734,7 @@ function AI_ESCORT:_ResumeMission( EscortGroup, WayPoint )
 end
 
 
---- @param #AI_ESCORT self
+-- @param #AI_ESCORT self
 -- @param Wrapper.Group#GROUP EscortGroup The escort group that will attack the detected item.
 -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
 function AI_ESCORT:_AttackTarget( EscortGroup, DetectedItem )
@@ -1743,7 +1754,7 @@ function AI_ESCORT:_AttackTarget( EscortGroup, DetectedItem )
     local AttackUnitTasks = {}
 
     DetectedSet:ForEachUnit(
-      --- @param Wrapper.Unit#UNIT DetectedUnit
+      -- @param Wrapper.Unit#UNIT DetectedUnit
       function( DetectedUnit, Tasks )
         if DetectedUnit:IsAlive() then
           AttackUnitTasks[#AttackUnitTasks+1] = EscortGroup:TaskAttackUnit( DetectedUnit )
@@ -1767,7 +1778,7 @@ function AI_ESCORT:_AttackTarget( EscortGroup, 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 )
@@ -1795,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 )
@@ -1842,7 +1853,7 @@ end
 
 
 --- 
---- @param #AI_ESCORT self
+-- @param #AI_ESCORT self
 -- @param Wrapper.Group#GROUP EscortGroup The escort group that will attack the detected item.
 -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
 function AI_ESCORT:_AssistTarget( EscortGroup, DetectedItem )
@@ -1854,7 +1865,7 @@ function AI_ESCORT:_AssistTarget( EscortGroup, 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 )
@@ -1881,7 +1892,7 @@ end
 
 function AI_ESCORT:_FlightROEHoldFire( EscortROEMessage )
   self.EscortGroupSet:ForEachGroupAlive(
-    --- @param Wrapper.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       self:_ROE( EscortGroup, EscortGroup.OptionROEHoldFire, EscortROEMessage )
     end
@@ -1890,7 +1901,7 @@ end
 
 function AI_ESCORT:_FlightROEOpenFire( EscortROEMessage )
   self.EscortGroupSet:ForEachGroupAlive(
-    --- @param Wrapper.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       self:_ROE( EscortGroup, EscortGroup.OptionROEOpenFire, EscortROEMessage )
     end
@@ -1899,7 +1910,7 @@ end
 
 function AI_ESCORT:_FlightROEReturnFire( EscortROEMessage )
   self.EscortGroupSet:ForEachGroupAlive(
-    --- @param Wrapper.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       self:_ROE( EscortGroup, EscortGroup.OptionROEReturnFire, EscortROEMessage )
     end
@@ -1908,7 +1919,7 @@ end
 
 function AI_ESCORT:_FlightROEWeaponFree( EscortROEMessage )
   self.EscortGroupSet:ForEachGroupAlive(
-    --- @param Wrapper.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       self:_ROE( EscortGroup, EscortGroup.OptionROEWeaponFree, EscortROEMessage )
     end
@@ -1924,7 +1935,7 @@ end
 
 function AI_ESCORT:_FlightROTNoReaction( EscortROTMessage )
   self.EscortGroupSet:ForEachGroupAlive(
-    --- @param Wrapper.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       self:_ROT( EscortGroup, EscortGroup.OptionROTNoReaction, EscortROTMessage )
     end
@@ -1933,7 +1944,7 @@ end
 
 function AI_ESCORT:_FlightROTPassiveDefense( EscortROTMessage )
   self.EscortGroupSet:ForEachGroupAlive(
-    --- @param Wrapper.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       self:_ROT( EscortGroup, EscortGroup.OptionROTPassiveDefense, EscortROTMessage )
     end
@@ -1942,7 +1953,7 @@ end
 
 function AI_ESCORT:_FlightROTEvadeFire( EscortROTMessage )
   self.EscortGroupSet:ForEachGroupAlive(
-    --- @param Wrapper.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       self:_ROT( EscortGroup, EscortGroup.OptionROTEvadeFire, EscortROTMessage )
     end
@@ -1951,7 +1962,7 @@ end
 
 function AI_ESCORT:_FlightROTVertical( EscortROTMessage )
   self.EscortGroupSet:ForEachGroupAlive(
-    --- @param Wrapper.Group#GROUP EscortGroup
+    -- @param Wrapper.Group#GROUP EscortGroup
     function( EscortGroup )
       self:_ROT( EscortGroup, EscortGroup.OptionROTVertical, EscortROTMessage )
     end
@@ -2178,5 +2189,3 @@ function AI_ESCORT:_FlightReportTargetsScheduler()
   
   return false
 end
-
-

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

@@ -11,7 +11,7 @@
 -- 
 -- ===       
 --
--- @module AI.AI_ESCORT_DISPATCHER_REQUEST
+-- @module AI.AI_Escort_Dispatcher_Request
 -- @image MOOSE.JPG
 
 
@@ -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

@@ -1,4 +1,4 @@
---- **Functional** -- Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
+--- **AI** - Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
 -- 
 -- ===
 -- 
@@ -137,13 +137,18 @@
 -- 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** 
 -- 
 -- ===
 --
--- @module AI.AI_Escort
+-- @module AI.AI_Escort_Request
 -- @image Escorting.JPG
 
 
@@ -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

@@ -1,4 +1,4 @@
---- **AI** -- Build large airborne formations of aircraft.
+--- **AI** - Build large airborne formations of aircraft.
 -- 
 -- **Features:**
 --
@@ -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,17 +31,17 @@
 -- @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.
 
 
 --- Build large formations, make AI follow a @{Wrapper.Client#CLIENT} (player) leader or a @{Wrapper.Unit#UNIT} (AI) leader.
 --
--- AI_FORMATION makes AI @{GROUP}s fly in formation of various compositions.
+-- AI_FORMATION makes AI @{Wrapper.Group#GROUP}s fly in formation of various compositions.
 -- The AI_FORMATION class models formations in a different manner than the internal DCS formation logic!!!
 -- The purpose of the class is to:
 -- 
@@ -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

@@ -1,10 +1,10 @@
---- **AI** -- Perform Air Patrolling for airplanes.
+--- **AI** - Perform Air Patrolling for airplanes.
 -- 
 -- **Features:**
 -- 
 --   * Patrol AI airplanes within a given zone.
 --   * Trigger detected events when enemy airplanes are detected.
---   * Manage a fuel treshold to RTB on time.
+--   * Manage a fuel threshold to RTB on time.
 -- 
 -- ===
 -- 
@@ -16,7 +16,7 @@
 --   
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/PAT%20-%20Patrolling)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/PAT%20-%20Patrolling)
 -- 
 -- ===
 -- 
@@ -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.
 -- 
 -- ===
 -- 
@@ -38,7 +38,7 @@
 --- AI_PATROL_ZONE class
 -- @type AI_PATROL_ZONE
 -- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
--- @field Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @field Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @field DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @field DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @field DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
@@ -46,7 +46,7 @@
 -- @field Core.Spawn#SPAWN CoordTest
 -- @extends Core.Fsm#FSM_CONTROLLABLE
 
---- Implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group}.
+--- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group}.
 -- 
 -- ![Process](..\Presentations\AI_PATROL\Dia3.JPG)
 -- 
@@ -72,8 +72,8 @@
 -- 
 -- ![Process](..\Presentations\AI_PATROL\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- 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_PATROL\Dia11.JPG)
 -- 
@@ -101,7 +101,7 @@
 --   * **RTB** ( Group ): Route the AI to the home base.
 --   * **Detect** ( Group ): The AI is detecting targets.
 --   * **Detected** ( Group ): The AI has detected new targets.
---   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status** ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 --    
 -- ## 3. Set or Get the AI controllable
 -- 
@@ -133,18 +133,23 @@
 -- ## 6. Manage the "out of fuel" in the AI_PATROL_ZONE
 -- 
 -- When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
--- Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
--- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, 
--- while a new AI is targetted to the AI_PATROL_ZONE.
+-- Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
+-- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, 
+-- while a new AI is targeted to the AI_PATROL_ZONE.
 -- Once the time is finished, the old AI will return to the base.
--- Use the method @{#AI_PATROL_ZONE.ManageFuel}() to have this proces in place.
+-- Use the method @{#AI_PATROL_ZONE.ManageFuel}() to have this process in place.
 -- 
 -- ## 7. Manage "damage" behaviour of the AI in the AI_PATROL_ZONE
 -- 
 -- 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 treshold is reached, the AI will return immediately to the home base (RTB).
--- Use the method @{#AI_PATROL_ZONE.ManageDamage}() to have this proces in place.
+-- 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
@@ -154,7 +159,7 @@ AI_PATROL_ZONE = {
 
 --- Creates a new AI_PATROL_ZONE object
 -- @param #AI_PATROL_ZONE self
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
@@ -170,27 +175,27 @@ function AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltit
 
   -- Inherits from BASE
   local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- #AI_PATROL_ZONE
-  
-  
+
+
   self.PatrolZone = PatrolZone
   self.PatrolFloorAltitude = PatrolFloorAltitude
   self.PatrolCeilingAltitude = PatrolCeilingAltitude
   self.PatrolMinSpeed = PatrolMinSpeed
   self.PatrolMaxSpeed = PatrolMaxSpeed
-  
+
   -- defafult PatrolAltType to "BARO" if not specified
   self.PatrolAltType = PatrolAltType or "BARO"
-  
+
   self:SetRefreshTimeInterval( 30 )
-  
+
   self.CheckStatus = true
-  
+
   self:ManageFuel( .2, 60 )
   self:ManageDamage( 1 )
-  
+
 
   self.DetectedUnits = {} -- This table contains the targets detected during patrol.
-  
+
   self:SetStartState( "None" ) 
 
   self:AddTransition( "*", "Stop", "Stopped" )
@@ -228,7 +233,7 @@ function AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltit
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
-	
+
 --- Synchronous Event Trigger for Event Stop.
 -- @function [parent=#AI_PATROL_ZONE] Stop
 -- @param #AI_PATROL_ZONE self
@@ -256,7 +261,7 @@ function AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltit
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
-	
+
 --- Synchronous Event Trigger for Event Start.
 -- @function [parent=#AI_PATROL_ZONE] Start
 -- @param #AI_PATROL_ZONE self
@@ -329,7 +334,7 @@ function AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltit
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
-	
+
 --- Synchronous Event Trigger for Event Status.
 -- @function [parent=#AI_PATROL_ZONE] Status
 -- @param #AI_PATROL_ZONE self
@@ -413,7 +418,7 @@ function AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltit
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
-	
+
 --- Synchronous Event Trigger for Event RTB.
 -- @function [parent=#AI_PATROL_ZONE] RTB
 -- @param #AI_PATROL_ZONE self
@@ -441,11 +446,11 @@ function AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltit
 -- @param #string To The To State string.
 
   self:AddTransition( "*", "Reset", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
-  
+
   self:AddTransition( "*", "Eject", "*" )
   self:AddTransition( "*", "Crash", "Crashed" )
   self:AddTransition( "*", "PilotDead", "*" )
-  
+
   return self
 end
 
@@ -459,7 +464,7 @@ end
 -- @return #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
   self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
-  
+
   self.PatrolMinSpeed = PatrolMinSpeed
   self.PatrolMaxSpeed = PatrolMaxSpeed
 end
@@ -473,7 +478,7 @@ end
 -- @return #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
   self:F2( { PatrolFloorAltitude, PatrolCeilingAltitude } )
-  
+
   self.PatrolFloorAltitude = PatrolFloorAltitude
   self.PatrolCeilingAltitude = PatrolCeilingAltitude
 end
@@ -581,56 +586,56 @@ function AI_PATROL_ZONE:ClearDetectedUnits()
 end
 
 --- When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
--- Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
--- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_PATROL_ZONE.
+-- Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
+-- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targeted to the AI_PATROL_ZONE.
 -- Once the time is finished, the old AI will return to the base.
 -- @param #AI_PATROL_ZONE self
--- @param #number PatrolFuelThresholdPercentage The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
+-- @param #number PatrolFuelThresholdPercentage The threshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
 -- @param #number PatrolOutOfFuelOrbitTime The amount of seconds the out of fuel AIControllable will orbit before returning to the base.
 -- @return #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:ManageFuel( PatrolFuelThresholdPercentage, PatrolOutOfFuelOrbitTime )
 
   self.PatrolFuelThresholdPercentage = PatrolFuelThresholdPercentage
   self.PatrolOutOfFuelOrbitTime = PatrolOutOfFuelOrbitTime
-  
+
   return self
 end
 
---- When the AI is damaged beyond a certain treshold, it is required that the AI returns to the home base.
+--- When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.
 -- However, damage cannot be foreseen early on. 
--- Therefore, when the damage treshold is reached, 
+-- Therefore, when the damage threshold is reached, 
 -- the AI will return immediately to the home base (RTB).
 -- Note that for groups, the average damage of the complete group will be calculated.
--- So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold will be 0.25.
+-- So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshold will be 0.25.
 -- @param #AI_PATROL_ZONE self
--- @param #number PatrolDamageThreshold The treshold in percentage (between 0 and 1) when the AI is considered to be damaged.
+-- @param #number PatrolDamageThreshold The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.
 -- @return #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:ManageDamage( PatrolDamageThreshold )
 
   self.PatrolManageDamage = true
   self.PatrolDamageThreshold = PatrolDamageThreshold
-  
+
   return self
 end
 
---- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+--- Defines a new patrol route using the @{#AI_PATROL_ZONE} parameters and settings.
 -- @param #AI_PATROL_ZONE self
--- @return #AI_PATROL_ZONE self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
+-- @return #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:onafterStart( Controllable, From, Event, To )
   self:F2()
 
   self:__Route( 1 ) -- Route to the patrol point. The asynchronous trigger is important, because a spawned group and units takes at least one second to come live.
   self:__Status( 60 ) -- Check status status every 30 seconds.
   self:SetDetectionActivated()
-  
+
   self:HandleEvent( EVENTS.PilotDead, self.OnPilotDead )
   self:HandleEvent( EVENTS.Crash, self.OnCrash )
   self:HandleEvent( EVENTS.Ejection, self.OnEjection )
-  
+
   Controllable:OptionROEHoldFire()
   Controllable:OptionROTVertical()
 
@@ -667,12 +672,12 @@ function AI_PATROL_ZONE:onafterDetect( Controllable, From, Event, To )
     if TargetObject and TargetObject:isExist() and TargetObject.id_ < 50000000 then
 
       local TargetUnit = UNIT:Find( TargetObject )
-      
+
       -- Check that target is alive due to issue https://github.com/FlightControl-Master/MOOSE/issues/1234
       if TargetUnit and TargetUnit:IsAlive() then
-      
+
         local TargetUnitName = TargetUnit:GetName()
-        
+
         if self.DetectionZone then
           if TargetUnit:IsInZone( self.DetectionZone ) then
             self:T( {"Detected ", TargetUnit } )
@@ -687,13 +692,13 @@ function AI_PATROL_ZONE:onafterDetect( Controllable, From, Event, To )
           end
           Detected = true
         end
-        
+  
       end
     end
   end
 
   self:__Detect( -self.DetectInterval )
-  
+
   if Detected == true then
     self:__Detected( 1.5 )
   end
@@ -701,7 +706,7 @@ function AI_PATROL_ZONE:onafterDetect( Controllable, From, Event, To )
 end
 
 --- @param Wrapper.Controllable#CONTROLLABLE AIControllable
--- This statis method is called from the route path within the last task at the last waaypoint of the Controllable.
+-- This static method is called from the route path within the last task at the last waypoint of the Controllable.
 -- Note that this method is required, as triggers the next route when patrolling for the Controllable.
 function AI_PATROL_ZONE:_NewPatrolRoute( AIControllable )
 
@@ -710,7 +715,7 @@ function AI_PATROL_ZONE:_NewPatrolRoute( AIControllable )
 end
 
 
---- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+--- Defines a new patrol route using the @{#AI_PATROL_ZONE} parameters and settings.
 -- @param #AI_PATROL_ZONE self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
@@ -729,7 +734,7 @@ function AI_PATROL_ZONE:onafterRoute( Controllable, From, Event, To )
   if self.Controllable:IsAlive() and life > 1 then
     -- Determine if the AIControllable is within the PatrolZone. 
     -- If not, make a waypoint within the to that the AIControllable will fly at maximum speed to that point.
-    
+
     local PatrolRoute = {}
 
     -- Calculate the current route point of the controllable as the start point of the route.
@@ -775,7 +780,7 @@ function AI_PATROL_ZONE:onafterRoute( Controllable, From, Event, To )
     end    
     
     
-    --- Define a random point in the @{Zone}. The AI will fly to that point within the zone.
+    --- Define a random point in the @{Core.Zone}. The AI will fly to that point within the zone.
     
       --- Find a random 2D point in PatrolZone.
     local ToTargetVec2 = self.PatrolZone:GetRandomVec2()

Moose Development/Moose/Actions/Act_Account.lua

@@ -1,10 +1,10 @@
---- **Actions** - ACT_ACCOUNT_ classes **account for** (detect, count & report) various DCS events occuring on @{Wrapper.Unit}s.
+--- **Actions** - ACT_ACCOUNT_ classes **account for** (detect, count & report) various DCS events occurring on UNITs.
 --
 -- ![Banner Image](..\Presentations\ACT_ACCOUNT\Dia1.JPG)
 --
 -- ===
 --
--- @module Actions.Account
+-- @module Actions.Act_Account
 -- @image MOOSE.JPG
 
 do -- ACT_ACCOUNT
@@ -20,7 +20,7 @@ do -- ACT_ACCOUNT
   --
   -- ### ACT_ACCOUNT States
   --
-  --   * **Asigned**: The player is assigned.
+  --   * **Assigned**: The player is assigned.
   --   * **Waiting**: Waiting for an event.
   --   * **Report**: Reporting.
   --   * **Account**: Account for an event.
@@ -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
@@ -104,7 +109,6 @@ do -- ACT_ACCOUNT
     self:__Wait( 1 )
   end
 
-
     --- StateMachine callback function
     -- @param #ACT_ACCOUNT self
     -- @param Wrapper.Unit#UNIT ProcessUnit
@@ -138,10 +142,10 @@ 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 @{Set} of units that will be tracked upon successful destruction.
+  -- The process is given a @{Core.Set} of units that will be tracked upon successful destruction.
   -- The process will end after each target has been successfully destroyed.
   -- Each successful dead will trigger an Account state transition that can be scored, modified or administered.
   --
@@ -157,7 +161,6 @@ do -- ACT_ACCOUNT_DEADS
     ClassName = "ACT_ACCOUNT_DEADS",
   }
 
-
   --- Creates a new DESTROY process.
   -- @param #ACT_ACCOUNT_DEADS self
   -- @param Core.Set#SET_UNIT TargetSetUnit
@@ -195,7 +198,6 @@ do -- ACT_ACCOUNT_DEADS
     self:GetCommandCenter():MessageTypeToGroup( MessageText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
   end
 
-
   --- StateMachine callback function
   -- @param #ACT_ACCOUNT_DEADS self
   -- @param Wrapper.Unit#UNIT ProcessUnit
@@ -270,7 +272,6 @@ do -- ACT_ACCOUNT_DEADS
     end
   end
 
-
   --- DCS Events
 
   --- @param #ACT_ACCOUNT_DEADS self

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.
@@ -77,7 +82,7 @@
 --
 -- ===
 --
--- @module Actions.Assign
+-- @module Actions.Act_Assign
 -- @image MOOSE.JPG
 
 

Moose Development/Moose/Actions/Act_Assist.lua

@@ -48,9 +48,9 @@
 --
 -- ===
 --
--- # 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 @{Zone}.
+-- 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.
 -- At random intervals, a new target is smoked.
 --
@@ -58,9 +58,14 @@
 --
 --   * @{#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.Assist
+-- @module Actions.Act_Assist
 -- @image MOOSE.JPG
 
 

Moose Development/Moose/Actions/Act_Route.lua

@@ -60,9 +60,9 @@
 --
 -- ===
 --
--- # 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 @{Zone}.
+-- 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.
 -- Upon arrival at the zone, a confirmation of arrival is sent, and the process will be ended.
 --
@@ -70,9 +70,14 @@
 --
 --   * @{#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.Route
+-- @module Actions.Act_Route
 -- @image MOOSE.JPG
 
 

Moose Development/Moose/Cargo/Cargo.lua

@@ -66,7 +66,7 @@
 -- you can board the cargo into the carrier `CargoCarrier`.
 -- Simple, isn't it? Told you, and this is only the beginning.
 -- 
--- The boarding, unboarding, loading, unloading of cargo is however something that is not meant to be coded manualy by mission designers.
+-- The boarding, unboarding, loading, unloading of cargo is however something that is not meant to be coded manually by mission designers.
 -- It would be too low-level and not end-user friendly to deal with cargo handling complexity.
 -- Things can become really complex if you want to make cargo being handled and behave in multiple scenarios.
 -- 
@@ -77,8 +77,8 @@
 -- 
 -- ## 3.1) AI Cargo handlers.
 -- 
---   - @{AI.AI_Cargo_APC} will create for you the capatility to make an APC group handle cargo.
---   - @{AI.AI_Cargo_Helicopter} will create for you the capatility to make a Helicopter group handle cargo.
+--   - @{AI.AI_Cargo_APC} will create for you the capability to make an APC group handle cargo.
+--   - @{AI.AI_Cargo_Helicopter} will create for you the capability to make a Helicopter group handle cargo.
 --   
 --   
 -- ## 3.2) AI Cargo transportation dispatchers.
@@ -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 helicpter 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.
 --   
@@ -94,7 +94,7 @@
 --   
 --   - @{Tasking.Task_CARGO} derived classes will create for you cargo transportation tasks, that allow human players to interact with MOOSE cargo objects to complete tasks.
 -- 
--- Please refer to the documentation reflected within these modules to understand the detailed capabilties.
+-- Please refer to the documentation reflected within these modules to understand the detailed capabilities.
 -- 
 -- # 4) Cargo SETs.
 -- 
@@ -194,7 +194,7 @@
 --    * is of type `Workmaterials`
 --    * will report when a carrier is within 500 meters
 --    * will board to carriers when the carrier is within 500 meters from the cargo object
---    * will dissapear when the cargo is within 25 meters from the carrier during boarding
+--    * will disappear when the cargo is within 25 meters from the carrier during boarding
 -- 
 -- So the overall syntax of the #CARGO naming tag and arguments are:
 -- 
@@ -206,32 +206,39 @@
 --    * **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.
 -- 
--- ## 5.2) The \#CARGO tag to create CARGO_CRATE objects:
+-- ## 5.2) The \#CARGO tag to create CARGO_CRATE or CARGO_SLINGLOAD objects:
 -- 
 -- You can also use the \#CARGO tag on **static** objects, including **static cargo** objects of the mission editor.
 -- 
 -- For example, the following #CARGO naming in the **static name** of the object, will create a CARGO_CRATE object when the mission starts.
 -- 
---   `Static #CARGO(T=Workmaterials,RR=500,NR=25)`
+--   `Static #CARGO(T=Workmaterials,C=CRATE,RR=500,NR=25)`
 -- 
 -- This will create a CARGO_CRATE object:
 -- 
 --    * with the group name `Static #CARGO`
 --    * is of type `Workmaterials`
+--    * is of category `CRATE` (as opposed to `SLING`)
 --    * will report when a carrier is within 500 meters
 --    * will board to carriers when the carrier is within 500 meters from the cargo object
---    * will dissapear when the cargo is within 25 meters from the carrier during boarding
+--    * will disappear when the cargo is within 25 meters from the carrier during boarding
 -- 
 -- So the overall syntax of the #CARGO naming tag and arguments are:
 -- 
---   `StaticName #CARGO(T=CargoTypeName,RR=Range,NR=Range)`
+--   `StaticName #CARGO(T=CargoTypeName,C=Category,RR=Range,NR=Range)`
 -- 
 --    * **T=** Provide a text that contains the type name of the cargo object. This type name can be used to filter cargo within a SET_CARGO object.
+--    * **C=** Provide either `CRATE` or `SLING` to have this static created as a CARGO_CRATE or CARGO_SLINGLOAD respectively.
 --    * **RR=** Provide the minimal range in meters when the report to the carrier, and board to the carrier.
 --      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**
@@ -375,7 +382,7 @@ do -- CARGO
   -- @field #boolean Moveable This flag defines if the cargo is moveable.
   -- @field #boolean Representable This flag defines if the cargo can be represented by a DCS Unit.
   -- @field #boolean Containable This flag defines if the cargo can be contained within a DCS Unit.
-  
+
   --- Defines the core functions that defines a cargo object within MOOSE.
   -- 
   -- A cargo is a **logical object** defined that is available for transport, and has a life status within a simulation.
@@ -391,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:
@@ -428,8 +435,7 @@ do -- CARGO
 
   --- @type CARGO.CargoObjects
   -- @map < #string, Wrapper.Positionable#POSITIONABLE > The alive POSITIONABLE objects representing the the cargo.
-  
-  
+
   --- CARGO Constructor. This class is an abstract class and should not be instantiated.
   -- @param #CARGO self
   -- @param #string Type
@@ -439,10 +445,10 @@ do -- CARGO
   -- @param #number NearRadius (optional)
   -- @return #CARGO
   function CARGO:New( Type, Name, Weight, LoadRadius, NearRadius ) --R2.1
-  
+
     local self = BASE:Inherit( self, FSM:New() ) -- #CARGO
     self:F( { Type, Name, Weight, LoadRadius, NearRadius } )
-    
+
     self:SetStartState( "UnLoaded" )
     self:AddTransition( { "UnLoaded", "Boarding" }, "Board", "Boarding" )
     self:AddTransition( "Boarding" , "Boarding", "Boarding" )
@@ -457,7 +463,7 @@ do -- CARGO
     self:AddTransition( "*", "Destroyed", "Destroyed" )
     self:AddTransition( "*", "Respawn", "UnLoaded" )
     self:AddTransition( "*", "Reset", "UnLoaded" )
-  
+
     self.Type = Type
     self.Name = Name
     self.Weight = Weight or 0
@@ -469,31 +475,29 @@ do -- CARGO
     self.Containable = false
 
     self.CargoLimit = 0
-    
+
     self.LoadRadius = LoadRadius or 500
     --self.NearRadius = NearRadius or 25
-    
+
     self:SetDeployed( false )
-  
+
     self.CargoScheduler = SCHEDULER:New()
-  
+
     CARGOS[self.Name] = self
-  
-    
+
     return self
   end
-  
-  
+
   --- Find a CARGO in the _DATABASE.
   -- @param #CARGO self
   -- @param #string CargoName The Cargo Name.
   -- @return #CARGO self
   function CARGO:FindByName( CargoName )
-    
+
     local CargoFound = _DATABASE:FindCargo( CargoName )
     return CargoFound
   end
-  
+
   --- Get the x position of the cargo.
   -- @param #CARGO self
   -- @return #number
@@ -502,9 +506,9 @@ do -- CARGO
       return self.CargoCarrier:GetCoordinate().x
     else
       return self.CargoObject:GetCoordinate().x
-    end 
+    end
   end
-  
+
   --- Get the y position of the cargo.
   -- @param #CARGO self
   -- @return #number
@@ -513,9 +517,9 @@ do -- CARGO
       return self.CargoCarrier:GetCoordinate().z
     else
       return self.CargoObject:GetCoordinate().z
-    end 
+    end
   end
-  
+
   --- Get the heading of the cargo.
   -- @param #CARGO self
   -- @return #number
@@ -524,22 +528,21 @@ do -- CARGO
       return self.CargoCarrier:GetHeading()
     else
       return self.CargoObject:GetHeading()
-    end 
+    end
   end
-  
-  
+
   --- Check if the cargo can be Slingloaded.
   -- @param #CARGO self
   function CARGO:CanSlingload()
     return false
   end
-  
+
   --- Check if the cargo can be Boarded.
   -- @param #CARGO self
   function CARGO:CanBoard()
     return true
   end
-  
+
   --- Check if the cargo can be Unboarded.
   -- @param #CARGO self
   function CARGO:CanUnboard()
@@ -551,14 +554,13 @@ do -- CARGO
   function CARGO:CanLoad()
     return true
   end
-  
+
   --- Check if the cargo can be Unloaded.
   -- @param #CARGO self
   function CARGO:CanUnload()
     return true
   end
 
-  
   --- Destroy the cargo.
   -- @param #CARGO self
   function CARGO:Destroy()
@@ -567,14 +569,14 @@ do -- CARGO
     end
     self:Destroyed()
   end
-  
+
   --- Get the name of the Cargo.
   -- @param #CARGO self
   -- @return #string The name of the Cargo.
   function CARGO:GetName() --R2.1
     return self.Name
   end
-  
+
   --- Get the current active object representing or being the Cargo.
   -- @param #CARGO self
   -- @return Wrapper.Positionable#POSITIONABLE The object representing or being the Cargo.
@@ -583,9 +585,9 @@ do -- CARGO
       return self.CargoCarrier
     else
       return self.CargoObject
-    end 
+    end
   end
-  
+
   --- Get the object name of the Cargo.
   -- @param #CARGO self
   -- @return #string The object name of the Cargo.
@@ -594,9 +596,9 @@ do -- CARGO
       return self.CargoCarrier:GetName()
     else
       return self.CargoObject:GetName()
-    end 
+    end
   end
-  
+
   --- Get the amount of Cargo.
   -- @param #CARGO self
   -- @return #number The amount of Cargo.
@@ -611,7 +613,6 @@ do -- CARGO
     return self.Type
   end
 
-    
   --- Get the transportation method of the Cargo.
   -- @param #CARGO self
   -- @return #string The transportation method of the Cargo.
@@ -619,7 +620,6 @@ do -- CARGO
     return self.TransportationMethod
   end
 
-    
   --- Get the coalition of the Cargo.
   -- @param #CARGO self
   -- @return Coalition
@@ -628,32 +628,30 @@ do -- CARGO
       return self.CargoCarrier:GetCoalition()
     else
       return self.CargoObject:GetCoalition()
-    end 
+    end
   end
 
-  
   --- Get the current coordinates of the Cargo.
   -- @param #CARGO self
   -- @return Core.Point#COORDINATE The coordinates of the Cargo.
   function CARGO:GetCoordinate()
     return self.CargoObject:GetCoordinate()
   end
-  
+
   --- Check if cargo is destroyed.
   -- @param #CARGO self
   -- @return #boolean true if destroyed
   function CARGO:IsDestroyed()
     return self:Is( "Destroyed" )
   end
-  
-  
+
   --- Check if cargo is loaded.
   -- @param #CARGO self
   -- @return #boolean true if loaded
   function CARGO:IsLoaded()
     return self:Is( "Loaded" )
   end
-  
+
   --- Check if cargo is loaded.
   -- @param #CARGO self
   -- @param Wrapper.Unit#UNIT Carrier
@@ -661,14 +659,14 @@ do -- CARGO
   function CARGO:IsLoadedInCarrier( Carrier )
     return self.CargoCarrier and self.CargoCarrier:GetName() == Carrier:GetName()
   end
-  
+
   --- Check if cargo is unloaded.
   -- @param #CARGO self
   -- @return #boolean true if unloaded
   function CARGO:IsUnLoaded()
     return self:Is( "UnLoaded" )
   end
-  
+
   --- Check if cargo is boarding.
   -- @param #CARGO self
   -- @return #boolean true if boarding
@@ -676,52 +674,47 @@ do -- CARGO
     return self:Is( "Boarding" )
   end
 
-  
   --- Check if cargo is unboarding.
   -- @param #CARGO self
   -- @return #boolean true if unboarding
   function CARGO:IsUnboarding()
     return self:Is( "UnBoarding" )
   end
-  
 
   --- Check if cargo is alive.
   -- @param #CARGO self
   -- @return #boolean true if unloaded
   function CARGO:IsAlive()
-  
+
     if self:IsLoaded() then
       return self.CargoCarrier:IsAlive()
     else
       return self.CargoObject:IsAlive()
-    end 
+    end
   end
-  
+
   --- Set the cargo as deployed.
   -- @param #CARGO self
   -- @param #boolean Deployed true if the cargo is to be deployed. false or nil otherwise.
   function CARGO:SetDeployed( Deployed )
     self.Deployed = Deployed
   end
-  
+
   --- Is the cargo deployed
   -- @param #CARGO self
   -- @return #boolean
   function CARGO:IsDeployed()
     return self.Deployed
   end
-  
-  
-  
-  
+
   --- Template method to spawn a new representation of the CARGO in the simulator.
   -- @param #CARGO self
   -- @return #CARGO
   function CARGO:Spawn( PointVec2 )
     self:F()
-  
+
   end
-  
+
   --- Signal a flare at the position of the CARGO.
   -- @param #CARGO self
   -- @param Utilities.Utils#FLARECOLOR FlareColor
@@ -730,31 +723,31 @@ do -- CARGO
       trigger.action.signalFlare( self.CargoObject:GetVec3(), FlareColor , 0 )
     end
   end
-  
+
   --- Signal a white flare at the position of the CARGO.
   -- @param #CARGO self
   function CARGO:FlareWhite()
     self:Flare( trigger.flareColor.White )
   end
-  
+
   --- Signal a yellow flare at the position of the CARGO.
   -- @param #CARGO self
   function CARGO:FlareYellow()
     self:Flare( trigger.flareColor.Yellow )
   end
-  
+
   --- Signal a green flare at the position of the CARGO.
   -- @param #CARGO self
   function CARGO:FlareGreen()
     self:Flare( trigger.flareColor.Green )
   end
-  
+
   --- Signal a red flare at the position of the CARGO.
   -- @param #CARGO self
   function CARGO:FlareRed()
     self:Flare( trigger.flareColor.Red )
   end
-  
+
   --- Smoke the CARGO.
   -- @param #CARGO self
   -- @param Utilities.Utils#SMOKECOLOR SmokeColor The color of the smoke.
@@ -768,38 +761,37 @@ do -- CARGO
       end
     end
   end
-  
+
   --- Smoke the CARGO Green.
   -- @param #CARGO self
   function CARGO:SmokeGreen()
     self:Smoke( trigger.smokeColor.Green, Range )
   end
-  
+
   --- Smoke the CARGO Red.
   -- @param #CARGO self
   function CARGO:SmokeRed()
     self:Smoke( trigger.smokeColor.Red, Range )
   end
-  
+
   --- Smoke the CARGO White.
   -- @param #CARGO self
   function CARGO:SmokeWhite()
     self:Smoke( trigger.smokeColor.White, Range )
   end
-  
+
   --- Smoke the CARGO Orange.
   -- @param #CARGO self
   function CARGO:SmokeOrange()
     self:Smoke( trigger.smokeColor.Orange, Range )
   end
-  
+
   --- Smoke the CARGO Blue.
   -- @param #CARGO self
   function CARGO:SmokeBlue()
     self:Smoke( trigger.smokeColor.Blue, Range )
   end
-  
-  
+
   --- Set the Load radius, which is the radius till when the Cargo can be loaded.
   -- @param #CARGO self
   -- @param #number LoadRadius The radius till Cargo can be loaded.
@@ -807,23 +799,21 @@ do -- CARGO
   function CARGO:SetLoadRadius( LoadRadius )
     self.LoadRadius = LoadRadius or 150
   end
-  
+
   --- Get the Load radius, which is the radius till when the Cargo can be loaded.
   -- @param #CARGO self
   -- @return #number The radius till Cargo can be loaded.
   function CARGO:GetLoadRadius()
     return self.LoadRadius
   end
-  
-  
-  
+
   --- Check if Cargo is in the LoadRadius for the Cargo to be Boarded or Loaded.
   -- @param #CARGO self
   -- @param Core.Point#COORDINATE Coordinate
   -- @return #boolean true if the CargoGroup is within the loading radius.
   function CARGO:IsInLoadRadius( Coordinate )
     self:F( { Coordinate, LoadRadius = self.LoadRadius } )
-  
+
     local Distance = 0
     if self:IsUnLoaded() then
       local CargoCoordinate = self.CargoObject:GetCoordinate()
@@ -833,18 +823,17 @@ do -- CARGO
         return true
       end
     end
-    
+
     return false
   end
 
-
   --- Check if the Cargo can report itself to be Boarded or Loaded.
   -- @param #CARGO self
   -- @param Core.Point#COORDINATE Coordinate
   -- @return #boolean true if the Cargo can report itself.
   function CARGO:IsInReportRadius( Coordinate )
     self:F( { Coordinate } )
-  
+
     local Distance = 0
     if self:IsUnLoaded() then
       Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
@@ -853,7 +842,7 @@ do -- CARGO
         return true
       end
     end
-    
+
     return false
   end
 
@@ -865,7 +854,7 @@ do -- CARGO
   -- @return #boolean
   function CARGO:IsNear( Coordinate, NearRadius )
     --self:F( { PointVec2 = PointVec2, NearRadius = NearRadius } )
-  
+
     if self.CargoObject:IsAlive() then
       --local Distance = PointVec2:Get2DDistance( self.CargoObject:GetPointVec2() )
       --self:F( { CargoObjectName = self.CargoObject:GetName() } )
@@ -873,26 +862,24 @@ do -- CARGO
       --self:F( { PointVec2 = PointVec2:GetVec2() } )
       local Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
       --self:F( { Distance = Distance, NearRadius = NearRadius or "nil" }  )
-      
+
       if Distance <= NearRadius then
         --self:F( { PointVec2 = PointVec2, NearRadius = NearRadius, IsNear = true } )
         return true
       end
     end
-    
+
     --self:F( { PointVec2 = PointVec2, NearRadius = NearRadius, IsNear = false } )
     return false
   end
-  
-  
-  
-  --- Check if Cargo is the given @{Zone}.
+
+  --- Check if Cargo is the given @{Core.Zone}.
   -- @param #CARGO self
   -- @param Core.Zone#ZONE_BASE Zone
   -- @return #boolean **true** if cargo is in the Zone, **false** if cargo is not in the Zone.
   function CARGO:IsInZone( Zone )
     --self:F( { Zone } )
-  
+
     if self:IsLoaded() then
       return Zone:IsPointVec2InZone( self.CargoCarrier:GetPointVec2() )
     else
@@ -902,34 +889,33 @@ do -- CARGO
       else
         return false
       end
-    end  
-    
+    end
+
     return nil
-  
+
   end
-  
-  
+
   --- Get the current PointVec2 of the cargo.
   -- @param #CARGO self
   -- @return Core.Point#POINT_VEC2
   function CARGO:GetPointVec2()
     return self.CargoObject:GetPointVec2()
   end
-  
+
   --- Get the current Coordinate of the cargo.
   -- @param #CARGO self
   -- @return Core.Point#COORDINATE
   function CARGO:GetCoordinate()
     return self.CargoObject:GetCoordinate()
   end
-  
+
   --- Get the weight of the cargo.
   -- @param #CARGO self
   -- @return #number Weight The weight in kg.
   function CARGO:GetWeight()
     return self.Weight 
   end
-  
+
   --- Set the weight of the cargo.
   -- @param #CARGO self
   -- @param #number Weight The weight in kg.
@@ -938,14 +924,14 @@ do -- CARGO
     self.Weight = Weight
     return self
   end
-  
+
   --- Get the volume of the cargo.
   -- @param #CARGO self
   -- @return #number Volume The volume in kg.
   function CARGO:GetVolume()
     return self.Volume 
   end
-  
+
   --- Set the volume of the cargo.
   -- @param #CARGO self
   -- @param #number Volume The volume in kg.
@@ -954,18 +940,18 @@ do -- CARGO
     self.Volume = Volume
     return self
   end
-  
+
   --- Send a CC message to a @{Wrapper.Group}.
   -- @param #CARGO self
   -- @param #string Message
   -- @param Wrapper.Group#GROUP CarrierGroup The Carrier Group.
   -- @param #string Name (optional) The name of the Group used as a prefix for the message to the Group. If not provided, there will be nothing shown.
   function CARGO:MessageToGroup( Message, CarrierGroup, Name )
-  
+
     MESSAGE:New( Message, 20, "Cargo " .. self:GetName() ):ToGroup( CarrierGroup )
-  
+
   end
-  
+
   --- Report to a Carrier Group.
   -- @param #CARGO self
   -- @param #string Action The string describing the action for the cargo.
@@ -991,28 +977,25 @@ do -- CARGO
       end
     end
   end
-  
-  
+
   --- 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 )
 
     self.ReportFlareColor = FlareColor 
   end
-  
-  
+
   --- 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 )
 
     self.ReportSmokeColor = SmokeColor 
   end
-  
-  
+
   --- Reset the reporting for a Carrier Group.
   -- @param #CARGO self
   -- @param #string Action The string describing the action for the cargo.
@@ -1022,7 +1005,7 @@ do -- CARGO
 
     self.Reported[CarrierGroup][Action] = nil
   end
-  
+
   --- Reset all the reporting for a Carrier Group.
   -- @param #CARGO self
   -- @param Wrapper.Group#GROUP CarrierGroup The Carrier Group to send the report to.
@@ -1031,7 +1014,7 @@ do -- CARGO
 
     self.Reported[CarrierGroup] = nil
   end
-  
+
   --- Respawn the cargo when destroyed
   -- @param #CARGO self
   -- @param #boolean RespawnDestroyed
@@ -1044,11 +1027,8 @@ do -- CARGO
     else
       self.onenterDestroyed = nil
     end
-      
-  end
-  
 
-  
+  end
 
 end -- CARGO
 
@@ -1073,7 +1053,7 @@ do -- CARGO_REPRESENTABLE
   -- @param #number NearRadius (optional) Radius in meters when the cargo is loaded into the carrier.
   -- @return #CARGO_REPRESENTABLE
   function CARGO_REPRESENTABLE:New( CargoObject, Type, Name, LoadRadius, NearRadius )
-  
+
     -- Inherit CARGO.
     local self = BASE:Inherit( self, CARGO:New( Type, Name, 0, LoadRadius, NearRadius ) ) -- #CARGO_REPRESENTABLE
     self:F( { Type, Name, LoadRadius, NearRadius } )
@@ -1081,10 +1061,10 @@ do -- CARGO_REPRESENTABLE
     -- Descriptors.
     local Desc=CargoObject:GetDesc()
     self:T({Desc=Desc})
-    
+
     -- Weight.
     local Weight = math.random( 80, 120 )
-    
+
     -- Adjust weight..
     if Desc then
       if Desc.typeName == "2B11 mortar" then
@@ -1095,8 +1075,8 @@ do -- CARGO_REPRESENTABLE
     end
 
     -- Set weight.
-    self:SetWeight( Weight )      
-    
+    self:SetWeight( Weight )
+
     return self
   end
 
@@ -1104,14 +1084,14 @@ do -- CARGO_REPRESENTABLE
   -- @param #CARGO_REPRESENTABLE self
   -- @return #CARGO_REPRESENTABLE
   function CARGO_REPRESENTABLE:Destroy()
-  
+
     -- Cargo objects are deleted from the _DATABASE and SET_CARGO objects.
     self:F( { CargoName = self:GetName() } )
     --_EVENTDISPATCHER:CreateEventDeleteCargo( self )
-  
+
     return self
   end
-  
+
   --- Route a cargo unit to a PointVec2.
   -- @param #CARGO_REPRESENTABLE self
   -- @param Core.Point#POINT_VEC2 ToPointVec2
@@ -1119,19 +1099,19 @@ do -- CARGO_REPRESENTABLE
   -- @return #CARGO_REPRESENTABLE
   function CARGO_REPRESENTABLE:RouteTo( ToPointVec2, Speed )
     self:F2( ToPointVec2 )
-  
+
     local Points = {}
-  
+
     local PointStartVec2 = self.CargoObject:GetPointVec2()
-  
+
     Points[#Points+1] = PointStartVec2:WaypointGround( Speed )
     Points[#Points+1] = ToPointVec2:WaypointGround( Speed )
-  
+
     local TaskRoute = self.CargoObject:TaskRoute( Points )
     self.CargoObject:SetTask( TaskRoute, 2 )
-    return self  
+    return self
   end
-  
+
   --- Send a message to a @{Wrapper.Group} through a communication channel near the cargo.
   -- @param #CARGO_REPRESENTABLE self
   -- @param #string Message
@@ -1155,20 +1135,19 @@ do -- CARGO_REPRESENTABLE
         end
       end
     end
-  
+
   end
 
-  
 end -- CARGO_REPRESENTABLE
 
 do -- CARGO_REPORTABLE
-  
+
     --- @type CARGO_REPORTABLE
     -- @extends #CARGO
     CARGO_REPORTABLE = {
       ClassName = "CARGO_REPORTABLE"
     }
-  
+
   --- CARGO_REPORTABLE Constructor.
   -- @param #CARGO_REPORTABLE self
   -- @param #string Type
@@ -1180,31 +1159,23 @@ do -- CARGO_REPORTABLE
   function CARGO_REPORTABLE:New( Type, Name, Weight, LoadRadius, NearRadius )
     local self = BASE:Inherit( self, CARGO:New( Type, Name, Weight, LoadRadius, NearRadius ) ) -- #CARGO_REPORTABLE
     self:F( { Type, Name, Weight, LoadRadius, NearRadius } )
-  
+
     return self
   end
-  
+
   --- Send a CC message to a @{Wrapper.Group}.
   -- @param #CARGO_REPORTABLE self
   -- @param #string Message
   -- @param Wrapper.Group#GROUP TaskGroup
   -- @param #string Name (optional) The name of the Group used as a prefix for the message to the Group. If not provided, there will be nothing shown.
   function CARGO_REPORTABLE:MessageToGroup( Message, TaskGroup, Name )
-  
+
     MESSAGE:New( Message, 20, "Cargo " .. self:GetName() .. " reporting" ):ToGroup( TaskGroup )
-  
+
   end
 
-
-  
 end
 
-
-
-
-
-
-
 do -- CARGO_PACKAGE
 
   --- @type CARGO_PACKAGE
@@ -1278,10 +1249,10 @@ function CARGO_PACKAGE:IsNear( CargoCarrier )
   self:F()
 
   local CargoCarrierPoint = CargoCarrier:GetCoordinate()
-  
+
   local Distance = CargoCarrierPoint:Get2DDistance( self.CargoCarrier:GetCoordinate() )
   self:T( Distance )
-  
+
   if Distance <= self.NearRadius then
     return true
   else
@@ -1332,7 +1303,7 @@ function CARGO_PACKAGE:onafterUnBoard( From, Event, To, CargoCarrier, Speed, UnL
   if not self.CargoInAir then
 
     self:_Next( self.FsmP.UnLoad, UnLoadDistance, Angle )
-  
+
     local Points = {}
 
     local StartPointVec2 = CargoCarrier:GetPointVec2()
@@ -1387,7 +1358,7 @@ function CARGO_PACKAGE:onafterLoad( From, Event, To, CargoCarrier, Speed, LoadDi
   local CargoCarrierHeading = self.CargoCarrier:GetHeading() -- Get Heading of object in degrees.
   local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
   local CargoDeployPointVec2 = StartPointVec2:Translate( LoadDistance, CargoDeployHeading )
-  
+
   local Points = {}
   Points[#Points+1] = StartPointVec2:WaypointGround( Speed )
   Points[#Points+1] = CargoDeployPointVec2:WaypointGround( Speed )
@@ -1408,12 +1379,12 @@ end
 -- @param #number Angle
 function CARGO_PACKAGE:onafterUnLoad( From, Event, To, CargoCarrier, Speed, Distance, Angle )
   self:F()
-  
+
   local StartPointVec2 = self.CargoCarrier:GetPointVec2()
   local CargoCarrierHeading = self.CargoCarrier:GetHeading() -- Get Heading of object in degrees.
   local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
   local CargoDeployPointVec2 = StartPointVec2:Translate( Distance, CargoDeployHeading )
-  
+
   self.CargoCarrier = CargoCarrier
 
   local Points = {}
@@ -1425,5 +1396,4 @@ function CARGO_PACKAGE:onafterUnLoad( From, Event, To, CargoCarrier, Speed, Dist
 
 end
 
-
 end

Moose Development/Moose/Cargo/CargoCrate.lua

@@ -1,4 +1,4 @@
---- **Cargo** -- Management of single cargo crates, which are based on a @{Static} object.
+--- **Cargo** - Management of single cargo crates, which are based on a STATIC object.
 --
 -- ===
 -- 
@@ -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

@@ -1,4 +1,4 @@
---- **Cargo** - Management of grouped cargo logistics, which are based on a @{Wrapper.Group} object.
+--- **Cargo** - Management of grouped cargo logistics, which are based on a GROUP object.
 --
 -- ===
 -- 
@@ -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 = {
@@ -47,7 +52,7 @@ do -- CARGO_GROUP
 
   --- CARGO_GROUP constructor.
   -- This make a new CARGO_GROUP from a @{Wrapper.Group} object.
-  -- It will "ungroup" the group object within the sim, and will create a @{Set} of individual Unit objects.
+  -- It will "ungroup" the group object within the sim, and will create a @{Core.Set} of individual Unit objects.
   -- @param #CARGO_GROUP self
   -- @param Wrapper.Group#GROUP CargoGroup Group to be transported as cargo.
   -- @param #string Type Cargo type, e.g. "Infantry". This is the type used in SET_CARGO:New():FilterTypes("Infantry") to define the valid cargo groups of the set.
@@ -727,7 +732,7 @@ do -- CARGO_GROUP
     end
   end
   
-  --- Check if the first element of the CargoGroup is the given @{Zone}.
+  --- Check if the first element of the CargoGroup is the given @{Core.Zone}.
   -- @param #CARGO_GROUP self
   -- @param Core.Zone#ZONE_BASE Zone
   -- @return #boolean **true** if the first element of the CargoGroup is in the Zone

Moose Development/Moose/Cargo/CargoSlingload.lua

@@ -1,4 +1,4 @@
---- **Cargo** -- Management of single cargo crates, which are based on a @{Static} object. The cargo can only be slingloaded.
+--- **Cargo** - Management of single cargo crates, which are based on a STATIC object. The cargo can only be slingloaded.
 --
 -- ===
 -- 
@@ -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

@@ -1,4 +1,4 @@
---- **Cargo** - Management of single cargo logistics, which are based on a @{Wrapper.Unit} object.
+--- **Cargo** - Management of single cargo logistics, which are based on a UNIT object.
 --
 -- ===
 -- 
@@ -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/Beacon.lua

@@ -16,24 +16,24 @@
 --- *In order for the light to shine so brightly, the darkness must be present.* -- Francis Bacon
 -- 
 -- After attaching a @{#BEACON} to your @{Wrapper.Positionable#POSITIONABLE}, you need to select the right function to activate the kind of beacon you want. 
--- There are two types of BEACONs available : the AA TACAN Beacon and the general purpose Radio Beacon.
--- Note that in both case, you can set an optional parameter : the `BeaconDuration`. This can be very usefull to simulate the battery time if your BEACON is
--- attach to a cargo crate, for exemple. 
+-- There are two types of BEACONs available : the (aircraft) TACAN Beacon and the general purpose Radio Beacon.
+-- Note that in both case, you can set an optional parameter : the `BeaconDuration`. This can be very useful to simulate the battery time if your BEACON is
+-- attach to a cargo crate, for example. 
 -- 
--- ## AA TACAN Beacon usage
+-- ## Aircraft TACAN Beacon usage
 -- 
--- This beacon only works with airborne @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}. Use @{#BEACON:AATACAN}() to set the beacon parameters and start the beacon.
--- Use @#BEACON:StopAATACAN}() to stop it.
+-- This beacon only works with airborne @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}. Use @{#BEACON.ActivateTACAN}() to set the beacon parameters and start the beacon.
+-- Use @{#BEACON.StopRadioBeacon}() to stop it.
 -- 
 -- ## General Purpose Radio Beacon usage
 -- 
 -- This beacon will work with any @{Wrapper.Positionable#POSITIONABLE}, but **it won't follow the @{Wrapper.Positionable#POSITIONABLE}** ! This means that you should only use it with
--- @{Wrapper.Positionable#POSITIONABLE} that don't move, or move very slowly. Use @{#BEACON:RadioBeacon}() to set the beacon parameters and start the beacon.
--- Use @{#BEACON:StopRadioBeacon}() to stop it.
+-- @{Wrapper.Positionable#POSITIONABLE} that don't move, or move very slowly. Use @{#BEACON.RadioBeacon}() to set the beacon parameters and start the beacon.
+-- Use @{#BEACON.StopRadioBeacon}() to stop it.
 -- 
 -- @type BEACON
 -- @field #string ClassName Name of the class "BEACON".
--- @field Wrapper.Controllable#CONTROLLABLE Positionable The @{#CONTROLLABLE} that will receive radio capabilities.
+-- @field Wrapper.Controllable#CONTROLLABLE Positionable The @{Wrapper.Controllable#CONTROLLABLE} that will receive radio capabilities.
 -- @extends Core.Base#BASE
 BEACON = {
   ClassName    = "BEACON",
@@ -72,12 +72,12 @@ BEACON.Type={
   TACAN                     = 4,
   VORTAC                    = 5, 
   RSBN                      = 128,
-  BROADCAST_STATION         = 1024, 
+  BROADCAST_STATION         = 1024,
   HOMER                     = 8,
-  AIRPORT_HOMER             = 4104, 
-  AIRPORT_HOMER_WITH_MARKER = 4136, 
+  AIRPORT_HOMER             = 4104,
+  AIRPORT_HOMER_WITH_MARKER = 4136,
   ILS_FAR_HOMER             = 16408,
-  ILS_NEAR_HOMER            = 16424, 
+  ILS_NEAR_HOMER            = 16424,
   ILS_LOCALIZER             = 16640,
   ILS_GLIDESLOPE            = 16896,
   PRMG_LOCALIZER            = 33024,
@@ -97,24 +97,24 @@ BEACON.Type={
 -- @field #number TACAN_TANKER_Y TACtical Air Navigation system for tankers on Y band.
 -- @field #number VOR Very High Frequency Omni-Directional Range
 -- @field #number ILS_LOCALIZER ILS localizer
--- @field #number ILS_GLIDESLOPE ILS glideslope.
+-- @field #number ILS_GLIDESLOPE ILS glide slope.
 -- @field #number PRGM_LOCALIZER PRGM localizer.
--- @field #number PRGM_GLIDESLOPE PRGM glideslope.
+-- @field #number PRGM_GLIDESLOPE PRGM glide slope.
 -- @field #number BROADCAST_STATION Broadcast station.
--- @field #number VORTAC Radio-based navigational aid for aircraft pilots consisting of a co-located VHF omnidirectional range (VOR) beacon and a tactical air navigation system (TACAN) beacon.
+-- @field #number VORTAC Radio-based navigational aid for aircraft pilots consisting of a co-located VHF omni-directional range (VOR) beacon and a tactical air navigation system (TACAN) beacon.
 -- @field #number TACAN_AA_MODE_X TACtical Air Navigation for aircraft on X band.
 -- @field #number TACAN_AA_MODE_Y TACtical Air Navigation for aircraft on Y band.
 -- @field #number VORDME Radio beacon that combines a VHF omnidirectional range (VOR) with a distance measuring equipment (DME).
 -- @field #number ICLS_LOCALIZER Carrier landing system.
 -- @field #number ICLS_GLIDESLOPE Carrier landing system.
 BEACON.System={
-  PAR_10            = 1, 
-  RSBN_5            = 2, 
-  TACAN             = 3, 
+  PAR_10            = 1,
+  RSBN_5            = 2,
+  TACAN             = 3,
   TACAN_TANKER_X    = 4,
   TACAN_TANKER_Y    = 5,
-  VOR               = 6, 
-  ILS_LOCALIZER     = 7, 
+  VOR               = 6,
+  ILS_LOCALIZER     = 7,
   ILS_GLIDESLOPE    = 8,
   PRMG_LOCALIZER    = 9,
   PRMG_GLIDESLOPE   = 10,
@@ -130,16 +130,16 @@ BEACON.System={
 --- Create a new BEACON Object. This doesn't activate the beacon, though, use @{#BEACON.ActivateTACAN} etc.
 -- If you want to create a BEACON, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetBeacon}() instead.
 -- @param #BEACON self
--- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
+-- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Wrapper.Positionable} that will receive radio capabilities.
 -- @return #BEACON Beacon object or #nil if the positionable is invalid.
 function BEACON:New(Positionable)
 
   -- Inherit BASE.
   local self=BASE:Inherit(self, BASE:New()) --#BEACON
-  
+
   -- Debug.
   self:F(Positionable)
-  
+
   -- Set positionable.
   if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
     self.Positionable = Positionable
@@ -147,12 +147,11 @@ function BEACON:New(Positionable)
     self:I(string.format("New BEACON %s", tostring(self.name)))
     return self
   end
-  
+
   self:E({"The passed positionable is invalid, no BEACON created", Positionable})
   return nil
 end
 
-
 --- Activates a TACAN BEACON.
 -- @param #BEACON self
 -- @param #number Channel TACAN channel, i.e. the "10" part in "10Y".
@@ -169,28 +168,28 @@ end
 -- myBeacon:ActivateTACAN(20, "Y", "TEXACO", true) -- Activate the beacon
 function BEACON:ActivateTACAN(Channel, Mode, Message, Bearing, Duration)
   self:T({channel=Channel, mode=Mode, callsign=Message, bearing=Bearing, duration=Duration})
-  
+
   Mode=Mode or "Y"
-  
+
   -- Get frequency.
   local Frequency=UTILS.TACANToFrequency(Channel, Mode)
-  
+
   -- Check.
   if not Frequency then 
     self:E({"The passed TACAN channel is invalid, the BEACON is not emitting"})
     return self
   end
-  
+
   -- Beacon type.
   local Type=BEACON.Type.TACAN
-  
+
   -- Beacon system.  
   local System=BEACON.System.TACAN
-  
+
   -- Check if unit is an aircraft and set system accordingly.
   local AA=self.Positionable:IsAir()
-  
-  
+
+
   if AA then
     System=5 --NOTE: 5 is how you cat the correct tanker behaviour! --BEACON.System.TACAN_TANKER
     -- Check if "Y" mode is selected for aircraft.
@@ -201,21 +200,21 @@ function BEACON:ActivateTACAN(Channel, Mode, Message, Bearing, Duration)
       System=BEACON.System.TACAN_TANKER_Y
     end
   end
-  
+
   -- Attached unit.
   local UnitID=self.Positionable:GetID()
-  
+
   -- Debug.
   self:I({string.format("BEACON Activating TACAN %s: Channel=%d%s, Morse=%s, Bearing=%s, Duration=%s!", tostring(self.name), Channel, Mode, Message, tostring(Bearing), tostring(Duration))})
-    
+
   -- Start beacon.
   self.Positionable:CommandActivateBeacon(Type, System, Frequency, UnitID, Channel, Mode, AA, Message, Bearing)
-      
-  -- Stop sheduler.
+
+  -- Stop scheduler.
   if Duration then
     self.Positionable:DeactivateBeacon(Duration)
   end
-  
+
   return self
 end
 
@@ -227,25 +226,52 @@ end
 -- @return #BEACON self
 function BEACON:ActivateICLS(Channel, Callsign, Duration)
   self:F({Channel=Channel, Callsign=Callsign, Duration=Duration})
-  
+
   -- Attached unit.
   local UnitID=self.Positionable:GetID()
-  
+
   -- Debug
   self:T2({"ICLS BEACON started!"})
-    
+
   -- Start beacon.
   self.Positionable:CommandActivateICLS(Channel, UnitID, Callsign)
-      
-  -- Stop sheduler
+
+  -- Stop scheduler
   if Duration then -- Schedule the stop of the BEACON if asked by the MD
     self.Positionable:DeactivateBeacon(Duration)
   end
-  
+
   return self
 end
 
---- Activates a TACAN BEACON on an Aircraft.
+--- Activates a LINK4 BEACON. The unit the BEACON is attached to should be an aircraft carrier supporting this system.
+-- @param #BEACON self
+-- @param #number Frequency LINK4 FRequency in MHz, eg 336.
+-- @param #string Morse The ID that is going to be coded in Morse and broadcasted by the beacon.
+-- @param #number Duration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+function BEACON:ActivateLink4(Frequency, Morse, Duration)
+  self:F({Frequency=Frequency, Morse=Morse, Duration=Duration})
+
+  -- Attached unit.
+  local UnitID=self.Positionable:GetID()
+
+  -- Debug
+  self:T2({"LINK4 BEACON started!"})
+
+  -- Start beacon.
+  self.Positionable:CommandActivateLink4(Frequency,UnitID,Morse)
+
+  -- Stop sheduler
+  if Duration then -- Schedule the stop of the BEACON if asked by the MD
+    self.Positionable:CommandDeactivateLink4(Duration)
+  end
+
+  return self
+end
+
+--- DEPRECATED: Please use @{#BEACON.ActivateTACAN}() instead.
+-- Activates a TACAN BEACON on an Aircraft.
 -- @param #BEACON self
 -- @param #number TACANChannel (the "10" part in "10Y"). Note that AA TACAN are only available on Y Channels
 -- @param #string Message The Message that is going to be coded in Morse and broadcasted by the beacon
@@ -260,20 +286,20 @@ end
 -- myBeacon:AATACAN(20, "TEXACO", true) -- Activate the beacon
 function BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)
   self:F({TACANChannel, Message, Bearing, BeaconDuration})
-  
+
   local IsValid = true
-  
+
   if not self.Positionable:IsAir() then
     self:E({"The POSITIONABLE you want to attach the AA Tacan Beacon is not an aircraft ! The BEACON is not emitting", self.Positionable})
     IsValid = false
   end
-    
+
   local Frequency = self:_TACANToFrequency(TACANChannel, "Y")
   if not Frequency then 
     self:E({"The passed TACAN channel is invalid, the BEACON is not emitting"})
     IsValid = false
   end
-  
+
   -- I'm using the beacon type 4 (BEACON_TYPE_TACAN). For System, I'm using 5 (TACAN_TANKER_MODE_Y) if the bearing shows its bearing or 14 (TACAN_AA_MODE_Y) if it does not
   local System
   if Bearing then
@@ -281,7 +307,7 @@ function BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)
   else
     System = BEACON.System.TACAN_AA_MODE_Y
   end
-  
+
   if IsValid then -- Starts the BEACON
     self:T2({"AA TACAN BEACON started !"})
     self.Positionable:SetCommand({
@@ -296,7 +322,7 @@ function BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)
         modeChannel = "Y",
         }
       })
-      
+
     if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
       SCHEDULER:New(nil, 
       function()
@@ -304,7 +330,7 @@ function BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)
       end, {}, BeaconDuration)
     end
   end
-  
+
   return self
 end
 
@@ -324,11 +350,10 @@ function BEACON:StopAATACAN()
   end
 end
 
-
---- Activates a general pupose Radio Beacon
+--- Activates a general purpose Radio Beacon
 -- This uses the very generic singleton function "trigger.action.radioTransmission()" provided by DCS to broadcast a sound file on a specific frequency.
--- Although any frequency could be used, only 2 DCS Modules can home on radio beacons at the time of writing : the Huey and the Mi-8. 
--- They can home in on these specific frequencies : 
+-- Although any frequency could be used, only a few DCS Modules can home on radio beacons at the time of writing, i.e. the Mi-8, Huey, Gazelle etc.
+-- The following e.g. can home in on these specific frequencies : 
 -- * **Mi8**
 -- * R-828 -> 20-60MHz
 -- * ARKUD -> 100-150MHz (canal 1 : 114166, canal 2 : 114333, canal 3 : 114583, canal 4 : 121500, canal 5 : 123100, canal 6 : 124100) AM
@@ -354,7 +379,7 @@ end
 function BEACON:RadioBeacon(FileName, Frequency, Modulation, Power, BeaconDuration)
   self:F({FileName, Frequency, Modulation, Power, BeaconDuration})
   local IsValid = false
-  
+
   -- Check the filename
   if type(FileName) == "string" then
     if FileName:find(".ogg") or FileName:find(".wav") then
@@ -367,32 +392,32 @@ function BEACON:RadioBeacon(FileName, Frequency, Modulation, Power, BeaconDurati
   if not IsValid then
     self:E({"File name invalid. Maybe something wrong with the extension ? ", FileName})
   end
-  
+
   -- Check the Frequency
   if type(Frequency) ~= "number" and IsValid then
     self:E({"Frequency invalid. ", Frequency})
     IsValid = false
   end
   Frequency = Frequency * 1000000 -- Conversion to Hz
-  
+
   -- Check the modulation
   if Modulation ~= radio.modulation.AM and Modulation ~= radio.modulation.FM and IsValid then --TODO Maybe make this future proof if ED decides to add an other modulation ?
     self:E({"Modulation is invalid. Use DCS's enum radio.modulation.", Modulation})
     IsValid = false
   end
-  
+
   -- Check the Power
   if type(Power) ~= "number" and IsValid then
     self:E({"Power is invalid. ", Power})
     IsValid = false
   end
   Power = math.floor(math.abs(Power)) --TODO Find what is the maximum power allowed by DCS and limit power to that
-  
+
   if IsValid then
     self:T2({"Activating Beacon on ", Frequency, Modulation})
     -- Note that this is looped. I have to give this transmission a unique name, I use the class ID
     trigger.action.radioTransmission(FileName, self.Positionable:GetPositionVec3(), Modulation, true, Frequency, Power, tostring(self.ID))
-    
+
      if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
        SCHEDULER:New( nil, 
          function()
@@ -402,7 +427,7 @@ function BEACON:RadioBeacon(FileName, Frequency, Modulation, Power, BeaconDurati
   end 
 end
 
---- Stops the AA TACAN BEACON
+--- Stops the Radio Beacon
 -- @param #BEACON self
 -- @return #BEACON self
 function BEACON:StopRadioBeacon()
@@ -426,16 +451,16 @@ function BEACON:_TACANToFrequency(TACANChannel, TACANMode)
       return nil -- error in arguments
     end
   end
-  
+
 -- This code is largely based on ED's code, in DCS World\Scripts\World\Radio\BeaconTypes.lua, line 137.
 -- I have no idea what it does but it seems to work
   local A = 1151 -- 'X', channel >= 64
   local B = 64   -- channel >= 64
-  
+
   if TACANChannel < 64 then
     B = 1
   end
-  
+
   if TACANMode == 'Y' then
     A = 1025
     if TACANChannel < 64 then
@@ -446,6 +471,6 @@ function BEACON:_TACANToFrequency(TACANChannel, TACANMode)
       A = 962
     end
   end
-  
+
   return (A + TACANChannel - B) * 1000000
-end
+end

Moose Development/Moose/Core/Condition.lua

@@ -0,0 +1,464 @@
+--- **Core** - Define any or all conditions to be evaluated.
+--
+-- **Main Features:**
+--
+--    * Add arbitrary numbers of conditon functions
+--    * Evaluate *any* or *all* conditions
+--
+-- ===
+--
+-- ## Example Missions:
+--
+-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Core/Condition).
+--
+-- ===
+--
+-- ### Author: **funkyfranky**
+--
+-- ===
+-- @module Core.Condition
+-- @image MOOSE.JPG
+
+--- CONDITON class.
+-- @type CONDITION
+-- @field #string ClassName Name of the class.
+-- @field #string lid Class id string for output to DCS log file.
+-- @field #string name Name of the condition.
+-- @field #boolean isAny General functions are evaluated as any condition.
+-- @field #boolean negateResult Negate result of evaluation.
+-- @field #boolean noneResult Boolean that is returned if no condition functions at all were specified.
+-- @field #table functionsGen General condition functions.
+-- @field #table functionsAny Any condition functions.
+-- @field #table functionsAll All condition functions.
+-- @field #number functionCounter Running number to determine the unique ID of condition functions.
+-- @field #boolean defaultPersist Default persistence of condition functions.
+-- 
+-- @extends Core.Base#BASE
+
+--- *Better three hours too soon than a minute too late.* - William Shakespeare
+--
+-- ===
+--
+-- # The CONDITION Concept
+-- 
+-- 
+--
+-- @field #CONDITION
+CONDITION = {
+  ClassName       = "CONDITION",
+  lid             =   nil,
+  functionsGen    =    {},
+  functionsAny    =    {},
+  functionsAll    =    {},
+  functionCounter =     0, 
+  defaultPersist  = false,
+}
+
+--- Condition function.
+-- @type CONDITION.Function
+-- @field #number uid Unique ID of the condition function.
+-- @field #string type Type of the condition function: "gen", "any", "all".
+-- @field #boolean persistence If `true`, this is persistent.
+-- @field #function func Callback function to check for a condition. Must return a `#boolean`.
+-- @field #table arg (Optional) Arguments passed to the condition callback function if any.
+
+--- CONDITION class version.
+-- @field #string version
+CONDITION.version="0.3.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- TODO list
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+-- TODO: Make FSM. No sure if really necessary.
+-- DONE: Option to remove condition functions.
+-- DONE: Persistence option for condition functions.
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Constructor
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a new CONDITION object.
+-- @param #CONDITION self
+-- @param #string Name (Optional) Name used in the logs. 
+-- @return #CONDITION self
+function CONDITION:New(Name)
+
+  -- Inherit BASE.
+  local self=BASE:Inherit(self, BASE:New()) --#CONDITION
+  
+  self.name=Name or "Condition X"
+  
+  self:SetNoneResult(false)
+  
+  self.lid=string.format("%s | ", self.name)
+
+  return self
+end
+
+--- Set that general condition functions return `true` if `any` function returns `true`. Default is that *all* functions must return `true`.
+-- @param #CONDITION self
+-- @param #boolean Any If `true`, *any* condition can be true. Else *all* conditions must result `true`.
+-- @return #CONDITION self
+function CONDITION:SetAny(Any)
+  self.isAny=Any
+  return self
+end
+
+--- Negate result.
+-- @param #CONDITION self
+-- @param #boolean Negate If `true`, result is negated else  not.
+-- @return #CONDITION self
+function CONDITION:SetNegateResult(Negate)
+  self.negateResult=Negate
+  return self
+end
+
+--- Set whether `true` or `false` is returned, if no conditions at all were specified. By default `false` is returned.
+-- @param #CONDITION self
+-- @param #boolean ReturnValue Returns this boolean.
+-- @return #CONDITION self
+function CONDITION:SetNoneResult(ReturnValue)
+  if not ReturnValue then
+    self.noneResult=false
+  else
+    self.noneResult=true
+  end
+  return self
+end
+
+--- Set whether condition functions are persistent, *i.e.* are removed.
+-- @param #CONDITION self
+-- @param #boolean IsPersistent If `true`, condition functions are persistent.
+-- @return #CONDITION self
+function CONDITION:SetDefaultPersistence(IsPersistent)
+  self.defaultPersist=IsPersistent
+  return self
+end
+
+--- Add a function that is evaluated. It must return a `#boolean` value, *i.e.* either `true` or `false` (or `nil`).
+-- @param #CONDITION self
+-- @param #function Function The function to call.
+-- @param ... (Optional) Parameters passed to the function (if any).
+-- 
+-- @usage
+-- local function isAequalB(a, b)
+--   return a==b
+-- end
+-- 
+-- myCondition:AddFunction(isAequalB, a, b)
+-- 
+-- @return #CONDITION.Function Condition function table.
+function CONDITION:AddFunction(Function, ...)
+
+  -- Condition function.
+  local condition=self:_CreateCondition(0, Function, ...)
+
+  -- Add to table.
+  table.insert(self.functionsGen, condition)
+
+  return condition
+end
+
+--- Add a function that is evaluated. It must return a `#boolean` value, *i.e.* either `true` or `false` (or `nil`).
+-- @param #CONDITION self
+-- @param #function Function The function to call.
+-- @param ... (Optional) Parameters passed to the function (if any).
+-- @return #CONDITION.Function Condition function table.
+function CONDITION:AddFunctionAny(Function, ...)
+
+  -- Condition function.
+  local condition=self:_CreateCondition(1, Function, ...)
+
+  -- Add to table.
+  table.insert(self.functionsAny, condition)
+
+  return condition
+end
+
+--- Add a function that is evaluated. It must return a `#boolean` value, *i.e.* either `true` or `false` (or `nil`).
+-- @param #CONDITION self
+-- @param #function Function The function to call.
+-- @param ... (Optional) Parameters passed to the function (if any).
+-- @return #CONDITION.Function Condition function table.
+function CONDITION:AddFunctionAll(Function, ...)
+
+  -- Condition function.
+  local condition=self:_CreateCondition(2, Function, ...)
+
+  -- Add to table.
+  table.insert(self.functionsAll, condition)
+
+  return condition
+end
+
+--- Remove a condition function.
+-- @param #CONDITION self
+-- @param #CONDITION.Function ConditionFunction The condition function to be removed.
+-- @return #CONDITION self
+function CONDITION:RemoveFunction(ConditionFunction)
+
+  if ConditionFunction then
+  
+    local data=nil
+    if ConditionFunction.type==0 then
+      data=self.functionsGen
+    elseif ConditionFunction.type==1 then
+      data=self.functionsAny
+    elseif ConditionFunction.type==2 then
+      data=self.functionsAll
+    end
+    
+    if data then
+      for i=#data,1,-1 do
+        local cf=data[i] --#CONDITION.Function
+        if cf.uid==ConditionFunction.uid then
+          self:T(self.lid..string.format("Removed ConditionFunction UID=%d", cf.uid))
+          table.remove(data, i)
+          return self
+        end
+      end
+    end
+  
+  end
+
+  return self
+end
+
+--- Remove all non-persistant condition functions.
+-- @param #CONDITION self
+-- @return #CONDITION self
+function CONDITION:RemoveNonPersistant()
+
+  for i=#self.functionsGen,1,-1 do
+    local cf=self.functionsGen[i] --#CONDITION.Function
+    if not cf.persistence then
+      table.remove(self.functionsGen, i)
+    end
+  end 
+
+  for i=#self.functionsAll,1,-1 do
+    local cf=self.functionsAll[i] --#CONDITION.Function
+    if not cf.persistence then
+      table.remove(self.functionsAll, i)
+    end
+  end 
+
+  for i=#self.functionsAny,1,-1 do
+    local cf=self.functionsAny[i] --#CONDITION.Function
+    if not cf.persistence then
+      table.remove(self.functionsAny, i)
+    end
+  end 
+
+  return self
+end
+
+
+--- Evaluate conditon functions.
+-- @param #CONDITION self
+-- @param #boolean AnyTrue If `true`, evaluation return `true` if *any* condition function returns `true`. By default, *all* condition functions must return true.
+-- @return #boolean Result of condition functions.
+function CONDITION:Evaluate(AnyTrue)
+
+  -- Check if at least one function was given.
+  if #self.functionsAll + #self.functionsAny + #self.functionsAll == 0 then
+    return self.noneResult
+  end
+
+  -- Any condition for gen.
+  local evalAny=self.isAny
+  if AnyTrue~=nil then
+    evalAny=AnyTrue
+  end
+  
+  local isGen=nil
+  if evalAny then
+    isGen=self:_EvalConditionsAny(self.functionsGen)
+  else
+    isGen=self:_EvalConditionsAll(self.functionsGen)
+  end
+  
+  -- Is any?
+  local isAny=self:_EvalConditionsAny(self.functionsAny)
+  
+  -- Is all?
+  local isAll=self:_EvalConditionsAll(self.functionsAll)
+  
+  -- Result.
+  local result=isGen and isAny and isAll
+  
+  -- Negate result.
+  if self.negateResult then
+    result=not result
+  end
+  
+  -- Debug message.
+  self:T(self.lid..string.format("Evaluate: isGen=%s, isAny=%s, isAll=%s (negate=%s) ==> result=%s", tostring(isGen), tostring(isAny), tostring(isAll), tostring(self.negateResult), tostring(result)))
+
+  return result
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Private Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Check if all given condition are true.
+-- @param #CONDITION self
+-- @param #table functions Functions to evaluate.
+-- @return #boolean If true, all conditions were true (or functions was empty/nil). Returns false if at least one condition returned false.
+function CONDITION:_EvalConditionsAll(functions)
+
+  -- At least one condition?
+  local gotone=false
+
+
+  -- Any stop condition must be true.
+  for _,_condition in pairs(functions or {}) do
+    local condition=_condition --#CONDITION.Function
+
+    -- At least one condition was defined.
+    gotone=true
+
+    -- Call function.
+    local istrue=condition.func(unpack(condition.arg))
+
+    -- Any false will return false.
+    if not istrue then
+      return false
+    end
+
+  end
+  
+  -- All conditions were true.
+  return true
+end
+
+
+--- Check if any of the given conditions is true.
+-- @param #CONDITION self
+-- @param #table functions Functions to evaluate.
+-- @return #boolean If true, at least one condition is true (or functions was emtpy/nil).
+function CONDITION:_EvalConditionsAny(functions)
+
+  -- At least one condition?
+  local gotone=false
+
+  -- Any stop condition must be true.
+  for _,_condition in pairs(functions or {}) do
+    local condition=_condition --#CONDITION.Function
+    
+    -- At least one condition was defined.
+    gotone=true
+
+    -- Call function.
+    local istrue=condition.func(unpack(condition.arg))
+
+    -- Any true will return true.
+    if istrue then
+      return true
+    end
+
+  end
+  
+  -- No condition was true.
+  if gotone then
+    return false
+  else
+    -- No functions passed.
+    return true
+  end
+end
+
+--- Create conditon function object.
+-- @param #CONDITION self
+-- @param #number Ftype Function type: 0=Gen, 1=All, 2=Any.
+-- @param #function Function The function to call.
+-- @param ... (Optional) Parameters passed to the function (if any).
+-- @return #CONDITION.Function Condition function.
+function CONDITION:_CreateCondition(Ftype, Function, ...)
+
+  -- Increase counter.
+  self.functionCounter=self.functionCounter+1
+
+  local condition={} --#CONDITION.Function
+
+  condition.uid=self.functionCounter
+  condition.type=Ftype or 0
+  condition.persistence=self.defaultPersist
+  condition.func=Function
+  condition.arg={}
+  if arg then
+    condition.arg=arg
+  end
+  
+  return condition
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Global Condition Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Condition to check if time is greater than a given threshold time.
+-- @param #number Time Time in seconds.
+-- @param #boolean Absolute If `true`, abs. mission time from `timer.getAbsTime()` is checked. Default is relative mission time from `timer.getTime()`.
+-- @return #boolean Returns `true` if time is greater than give the time.
+function CONDITION.IsTimeGreater(Time, Absolute)
+
+  local Tnow=nil 
+  
+  if Absolute then
+    Tnow=timer.getAbsTime()
+  else
+    Tnow=timer.getTime()
+  end
+  
+  if Tnow>Time then
+    return true
+  else
+    return false      
+  end    
+
+  return nil
+end
+
+--- Function that returns `true` (success) with a certain probability. For example, if you specify `Probability=80` there is an 80% chance that `true` is returned.
+-- Technically, a random number between 0 and 100 is created. If the given success probability is less then this number, `true` is returned.
+-- @param #number Probability Success probability in percent. Default 50 %.
+-- @return #boolean Returns `true` for success and `false` otherwise.
+function CONDITION.IsRandomSuccess(Probability)
+
+  Probability=Probability or 50
+  
+  -- Create some randomness.
+  math.random()
+  math.random()
+  math.random()
+
+  -- Number between 0 and 100.
+  local N=math.random()*100
+  
+  if N<Probability then
+    return true
+  else
+    return false
+  end
+
+end
+
+--- Function that returns always `true`
+-- @return #boolean Returns `true` unconditionally.
+function CONDITION.ReturnTrue()
+  return true
+end
+
+--- Function that returns always `false`
+-- @return #boolean Returns `false` unconditionally.
+function CONDITION.ReturnFalse()
+  return false
+end
+
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Core/Database.lua

@@ -31,11 +31,12 @@
 -- @module Core.Database
 -- @image Core_Database.JPG
 
-
---- @type DATABASE
+---
+-- @type DATABASE
 -- @field #string ClassName Name of the class.
 -- @field #table Templates Templates: Units, Groups, Statics, ClientsByName, ClientsByID.
 -- @field #table CLIENTS Clients.
+-- @field #table STORAGES DCS warehouse storages.
 -- @extends Core.Base#BASE
 
 --- Contains collections of wrapper objects defined within MOOSE that reflect objects within the simulator.
@@ -50,8 +51,9 @@
 --  * PLAYERSJOINED
 --  * PLAYERS
 --  * CARGOS
+--  * STORAGES (DCS warehouses)
 --
--- On top, for internal MOOSE administration purposes, the DATBASE administers the Unit and Group TEMPLATES as defined within the Mission Editor.
+-- On top, for internal MOOSE administration purposes, the DATABASE administers the Unit and Group TEMPLATES as defined within the Mission Editor.
 --
 -- The singleton object **_DATABASE** is automatically created by MOOSE, that administers all objects within the mission.
 -- Moose refers to **_DATABASE** within the framework extensively, but you can also refer to the _DATABASE object within your missions if required.
@@ -88,6 +90,9 @@ DATABASE = {
   WAREHOUSES = {},
   FLIGHTGROUPS = {},
   FLIGHTCONTROLS = {},
+  OPSZONES = {},
+  PATHLINES = {},
+  STORAGES = {},
 }
 
 local _DATABASECoalition =
@@ -121,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 )
@@ -211,16 +218,6 @@ function DATABASE:FindStatic( StaticName )
   return StaticFound
 end
 
---- Finds a AIRBASE based on the AirbaseName.
--- @param #DATABASE self
--- @param #string AirbaseName
--- @return Wrapper.Airbase#AIRBASE The found AIRBASE.
-function DATABASE:FindAirbase( AirbaseName )
-
-  local AirbaseFound = self.AIRBASES[AirbaseName]
-  return AirbaseFound
-end
-
 --- Adds a Airbase based on the Airbase Name in the DATABASE.
 -- @param #DATABASE self
 -- @param #string AirbaseName The name of the airbase.
@@ -228,15 +225,7 @@ end
 function DATABASE:AddAirbase( AirbaseName )
 
   if not self.AIRBASES[AirbaseName] then
-
-    -- Register airbase.
-    local airbase = AIRBASE:Register( AirbaseName )  --Wrapper.Airbase#AIRBASE
-
-    -- Add to airbase.
-    self.AIRBASES[AirbaseName]=airbase
-
-    -- Debug info
-    self:I(string.format("Adding airbase %s (ID=%d): %s with %d parking spots", tostring(airbase.AirbaseName), airbase.AirbaseID, airbase.AirbaseCategoryName, tonumber(#airbase.parking)))
+    self.AIRBASES[AirbaseName] = AIRBASE:Register( AirbaseName )
   end
 
   return self.AIRBASES[AirbaseName]
@@ -262,9 +251,41 @@ function DATABASE:FindAirbase( AirbaseName )
 end
 
 
-do -- Zones
 
-  --- Finds a @{Zone} based on the zone name.
+--- Adds a STORAGE (DCS warehouse wrapper) based on the Airbase Name to the DATABASE.
+-- @param #DATABASE self
+-- @param #string AirbaseName The name of the airbase.
+-- @return Wrapper.Storage#STORAGE Storage object.
+function DATABASE:AddStorage( AirbaseName )
+
+  if not self.STORAGES[AirbaseName] then
+    self.STORAGES[AirbaseName] = STORAGE:New( AirbaseName )
+  end
+
+  return self.STORAGES[AirbaseName]
+end
+
+
+--- Deletes a STORAGE from the DATABASE based on the name of the associated airbase.
+-- @param #DATABASE self
+-- @param #string AirbaseName The name of the airbase.
+function DATABASE:DeleteStorage( AirbaseName )
+  self.STORAGES[AirbaseName] = nil
+end
+
+
+--- Finds an STORAGE based on the name of the associated airbase.
+-- @param #DATABASE self
+-- @param #string AirbaseName Name of the airbase.
+-- @return Wrapper.Storage#STORAGE The found STORAGE.
+function DATABASE:FindStorage( AirbaseName )
+  local storage = self.STORAGES[AirbaseName]
+  return storage
+end
+
+do -- Zones and Pathlines
+
+  --- Finds a @{Core.Zone} based on the zone name.
   -- @param #DATABASE self
   -- @param #string ZoneName The name of the zone.
   -- @return Core.Zone#ZONE_BASE The found ZONE.
@@ -274,7 +295,7 @@ do -- Zones
     return ZoneFound
   end
 
-  --- Adds a @{Zone} based on the zone name in the DATABASE.
+  --- Adds a @{Core.Zone} based on the zone name in the DATABASE.
   -- @param #DATABASE self
   -- @param #string ZoneName The name of the zone.
   -- @param Core.Zone#ZONE_BASE Zone The zone.
@@ -285,8 +306,7 @@ do -- Zones
     end
   end
 
-
-  --- Deletes a @{Zone} from the DATABASE based on the zone name.
+  --- Deletes a @{Core.Zone} from the DATABASE based on the zone name.
   -- @param #DATABASE self
   -- @param #string ZoneName The name of the zone.
   function DATABASE:DeleteZone( ZoneName )
@@ -295,6 +315,39 @@ do -- Zones
   end
 
 
+  --- Adds a @{Core.Pathline} based on its name in the DATABASE.
+  -- @param #DATABASE self
+  -- @param #string PathlineName The name of the pathline
+  -- @param Core.Pathline#PATHLINE Pathline The pathline.
+  function DATABASE:AddPathline( PathlineName, Pathline )
+
+    if not self.PATHLINES[PathlineName] then
+      self.PATHLINES[PathlineName]=Pathline
+    end
+  end
+
+  --- Finds a @{Core.Pathline} by its name.
+  -- @param #DATABASE self
+  -- @param #string PathlineName The name of the Pathline.
+  -- @return Core.Pathline#PATHLINE The found PATHLINE.
+  function DATABASE:FindPathline( PathlineName )
+
+    local pathline = self.PATHLINES[PathlineName]
+
+    return pathline
+  end
+
+
+  --- Deletes a @{Core.Pathline} from the DATABASE based on its name.
+  -- @param #DATABASE self
+  -- @param #string PathlineName The name of the PATHLINE.
+  function DATABASE:DeletePathline( PathlineName )
+
+    self.PATHLINES[PathlineName]=nil
+
+    return self
+  end
+
   --- Private method that registers new ZONE_BASE derived objects within the DATABASE Object.
   -- @param #DATABASE self
   -- @return #DATABASE self
@@ -327,7 +380,7 @@ do -- Zones
 
         self:I(string.format("Register ZONE: %s (Polygon, Quad)", ZoneName))
 
-        Zone=ZONE_POLYGON_BASE:New(ZoneName, ZoneData.verticies)
+        Zone=ZONE_POLYGON:NewFromPointsArray(ZoneName, ZoneData.verticies)
 
         --for i,vec2 in pairs(ZoneData.verticies) do
         --  local coord=COORDINATE:NewFromVec2(vec2)
@@ -344,6 +397,17 @@ do -- Zones
         -- Store zone ID.
         Zone.ZoneID=ZoneData.zoneId
 
+        -- Store zone properties (if any)
+        local ZoneProperties = ZoneData.properties or nil
+        Zone.Properties = {}
+        if ZoneName and ZoneProperties then
+          for _,ZoneProp in ipairs(ZoneProperties) do
+            if ZoneProp.key then
+              Zone.Properties[ZoneProp.key] = ZoneProp.value
+            end
+          end
+        end
+
         -- Store in DB.
         self.ZONENAMES[ZoneName] = ZoneName
 
@@ -377,16 +441,153 @@ do -- Zones
         -- Add zone to DB.
         self:AddZone( ZoneName, Zone_Polygon )
       end
+
     end
 
-  end
+    -- Drawings as zones
+    if env.mission.drawings and env.mission.drawings.layers then
 
+      -- Loop over layers.
+      for layerID, layerData in pairs(env.mission.drawings.layers or {}) do
+
+        -- Loop over objects in layers.
+        for objectID, objectData in pairs(layerData.objects or {}) do
+
+          -- Check for polygon which has at least 4 points (we would need 3 but the origin seems to be there twice)
+          if objectData.polygonMode and (objectData.polygonMode=="free") and objectData.points and #objectData.points>=4 then
+
+            ---
+            -- Drawing: Polygon free
+            ---
+
+            -- Name of the zone.
+            local ZoneName=objectData.name or "Unknown free Polygon Drawing"
+
+            -- Reference point. All other points need to be translated by this.
+            local vec2={x=objectData.mapX, y=objectData.mapY}
+
+            -- Debug stuff.
+            --local vec3={x=objectData.mapX, y=0, z=objectData.mapY}
+            --local coord=COORDINATE:NewFromVec2(vec2):MarkToAll("MapX, MapY")
+            --trigger.action.markToAll(id,  "mapXY", vec3)
+
+            -- Copy points array.
+            local points=UTILS.DeepCopy(objectData.points)
+
+            -- Translate points.
+            for i,_point in pairs(points) do
+              local point=_point --DCS#Vec2
+              points[i]=UTILS.Vec2Add(point, vec2)
+            end
+
+            -- Remove last point.
+            table.remove(points, #points)
+
+            -- Debug output
+            self:I(string.format("Register ZONE: %s (Polygon (free) drawing with %d vertices)", ZoneName, #points))
+
+            -- Create new polygon zone.
+            local Zone=ZONE_POLYGON:NewFromPointsArray(ZoneName, points)
+
+            -- Set color.
+            Zone:SetColor({1, 0, 0}, 0.15)
+
+            -- Store in DB.
+            self.ZONENAMES[ZoneName] = ZoneName
+
+            -- Add zone.
+            self:AddZone(ZoneName, Zone)
+
+          -- Check for polygon which has at least 4 points (we would need 3 but the origin seems to be there twice)
+          elseif objectData.polygonMode and objectData.polygonMode=="rect" then
+
+            ---
+            -- Drawing: Polygon rect
+            ---
+
+            -- Name of the zone.
+            local ZoneName=objectData.name or "Unknown rect Polygon Drawing"
+
+            -- Reference point (center of the rectangle).
+            local vec2={x=objectData.mapX, y=objectData.mapY}
+
+            -- For a rectangular polygon drawing, we have the width (y) and height (x).
+            local w=objectData.width
+            local h=objectData.height
+
+            -- Create points from center using with and height (width for y and height for x is a bit confusing, but this is how ED implemented it).
+            local points={}
+            points[1]={x=vec2.x-h/2, y=vec2.y+w/2} --Upper left
+            points[2]={x=vec2.x+h/2, y=vec2.y+w/2} --Upper right
+            points[3]={x=vec2.x+h/2, y=vec2.y-w/2} --Lower right
+            points[4]={x=vec2.x-h/2, y=vec2.y-w/2} --Lower left
+
+            --local coord=COORDINATE:NewFromVec2(vec2):MarkToAll("MapX, MapY")
+
+            -- Debug output
+            self:I(string.format("Register ZONE: %s (Polygon (rect) drawing with %d vertices)", ZoneName, #points))
+
+            -- Create new polygon zone.
+            local Zone=ZONE_POLYGON:NewFromPointsArray(ZoneName, points)
+
+            -- Set color.
+            Zone:SetColor({1, 0, 0}, 0.15)
+
+            -- Store in DB.
+            self.ZONENAMES[ZoneName] = ZoneName
+
+            -- Add zone.
+            self:AddZone(ZoneName, Zone)
+
+          elseif objectData.lineMode and (objectData.lineMode=="segments" or objectData.lineMode=="segment" or objectData.lineMode=="free") and objectData.points and #objectData.points>=2 then
+
+            ---
+            -- Drawing: Line (segments, segment or free)
+            ---
+
+           -- Name of the zone.
+            local Name=objectData.name or "Unknown Line Drawing"
+
+            -- Reference point. All other points need to be translated by this.
+            local vec2={x=objectData.mapX, y=objectData.mapY}
+
+            -- Copy points array.
+            local points=UTILS.DeepCopy(objectData.points)
+
+            -- Translate points.
+            for i,_point in pairs(points) do
+              local point=_point --DCS#Vec2
+              points[i]=UTILS.Vec2Add(point, vec2)
+            end
+
+            -- Debug output
+            self:I(string.format("Register PATHLINE: %s (Line drawing with %d points)", Name, #points))
+
+            -- Create new polygon zone.
+            local Pathline=PATHLINE:NewFromVec2Array(Name, points)
+
+            -- Set color.
+            --Zone:SetColor({1, 0, 0}, 0.15)
+
+            -- Add zone.
+            self:AddPathline(Name,Pathline)
+
+          end
+
+        end
+
+      end
+
+    end
+
+
+  end
 
 end -- zone
 
 do -- Zone_Goal
 
-  --- Finds a @{Zone} based on the zone name.
+  --- Finds a @{Core.Zone} based on the zone name.
   -- @param #DATABASE self
   -- @param #string ZoneName The name of the zone.
   -- @return Core.Zone#ZONE_BASE The found ZONE.
@@ -396,7 +597,7 @@ do -- Zone_Goal
     return ZoneFound
   end
 
-  --- Adds a @{Zone} based on the zone name in the DATABASE.
+  --- Adds a @{Core.Zone} based on the zone name in the DATABASE.
   -- @param #DATABASE self
   -- @param #string ZoneName The name of the zone.
   -- @param Core.Zone#ZONE_BASE Zone The zone.
@@ -408,7 +609,7 @@ do -- Zone_Goal
   end
 
 
-  --- Deletes a @{Zone} from the DATABASE based on the zone name.
+  --- Deletes a @{Core.Zone} from the DATABASE based on the zone name.
   -- @param #DATABASE self
   -- @param #string ZoneName The name of the zone.
   function DATABASE:DeleteZoneGoal( ZoneName )
@@ -417,6 +618,46 @@ do -- Zone_Goal
   end
 
 end -- Zone_Goal
+
+do -- OpsZone
+
+  --- Finds a @{Ops.OpsZone#OPSZONE} based on the zone name.
+  -- @param #DATABASE self
+  -- @param #string ZoneName The name of the zone.
+  -- @return Ops.OpsZone#OPSZONE The found OPSZONE.
+  function DATABASE:FindOpsZone( ZoneName )
+
+    local ZoneFound = self.OPSZONES[ZoneName]
+
+    return ZoneFound
+  end
+
+  --- Adds a @{Ops.OpsZone#OPSZONE} based on the zone name in the DATABASE.
+  -- @param #DATABASE self
+  -- @param Ops.OpsZone#OPSZONE OpsZone The zone.
+  function DATABASE:AddOpsZone( OpsZone )
+
+    if OpsZone then
+
+      local ZoneName=OpsZone:GetName()
+
+      if not self.OPSZONES[ZoneName] then
+        self.OPSZONES[ZoneName] = OpsZone
+      end
+
+    end
+  end
+
+
+  --- Deletes a @{Ops.OpsZone#OPSZONE} from the DATABASE based on the zone name.
+  -- @param #DATABASE self
+  -- @param #string ZoneName The name of the zone.
+  function DATABASE:DeleteOpsZone( ZoneName )
+    self.OPSZONES[ZoneName] = nil
+  end
+
+end -- OpsZone
+
 do -- cargo
 
   --- Adds a Cargo based on the Cargo Name in the DATABASE.
@@ -441,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]
@@ -571,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.
@@ -920,7 +1162,7 @@ end
 -- @param #string AirbaseName Name of the airbase.
 -- @return #number Category.
 function DATABASE:GetCategoryFromAirbase( AirbaseName )
-  return self.AIRBASES[AirbaseName]:GetCategory()
+  return self.AIRBASES[AirbaseName]:GetAirbaseCategory()
 end
 
 
@@ -997,13 +1239,15 @@ function DATABASE:_RegisterClients()
 
   for ClientName, ClientTemplate in pairs( self.Templates.ClientsByName ) do
     self:I(string.format("Register Client: %s", tostring(ClientName)))
-    self:AddClient( ClientName )
+    local client=self:AddClient( ClientName )
+    client.SpawnCoord=COORDINATE:New(ClientTemplate.x, ClientTemplate.alt, ClientTemplate.y)
   end
 
   return self
 end
 
---- @param #DATABASE self
+--- Private method that registeres all static objects.
+-- @param #DATABASE self
 function DATABASE:_RegisterStatics()
 
   local CoalitionsData={GroupsRed=coalition.getStaticObjects(coalition.side.RED), GroupsBlue=coalition.getStaticObjects(coalition.side.BLUE), GroupsNeutral=coalition.getStaticObjects(coalition.side.NEUTRAL)}
@@ -1032,11 +1276,26 @@ function DATABASE:_RegisterAirbases()
 
  for DCSAirbaseId, DCSAirbase in pairs(world.getAirbases()) do
 
+    self:_RegisterAirbase(DCSAirbase)
+
+  end
+
+  return self
+end
+
+--- Register a DCS airbase.
+-- @param #DATABASE self
+-- @param DCS#Airbase airbase Airbase.
+-- @return #DATABASE self
+function DATABASE:_RegisterAirbase(airbase)
+
+  if airbase then
+
     -- Get the airbase name.
-    local DCSAirbaseName = DCSAirbase:getName()
+    local DCSAirbaseName = airbase:getName()
 
     -- This gave the incorrect value to be inserted into the airdromeID for DCS 2.5.6. Is fixed now.
-    local airbaseID=DCSAirbase:getID()
+    local airbaseID=airbase:getID()
 
     -- Add and register airbase.
     local airbase=self:AddAirbase( DCSAirbaseName )
@@ -1045,7 +1304,7 @@ function DATABASE:_RegisterAirbases()
     local airbaseUID=airbase:GetID(true)
 
     -- Debug output.
-    local text=string.format("Register %s: %s (ID=%d UID=%d), parking=%d [", AIRBASE.CategoryName[airbase.category], tostring(DCSAirbaseName), airbaseID, airbaseUID, airbase.NparkingTotal)
+    local text=string.format("Register %s: %s (UID=%d), Runways=%d, Parking=%d [", AIRBASE.CategoryName[airbase.category], tostring(DCSAirbaseName), airbaseUID, #airbase.runways, airbase.NparkingTotal)
     for _,terminalType in pairs(AIRBASE.TerminalType) do
       if airbase.NparkingTerminal and airbase.NparkingTerminal[terminalType] then
         text=text..string.format("%d=%d ", terminalType, airbase.NparkingTerminal[terminalType])
@@ -1054,11 +1313,6 @@ function DATABASE:_RegisterAirbases()
     text=text.."]"
     self:I(text)
 
-    -- Check for DCS bug IDs.
-    if airbaseID~=airbase:GetID() then
-      --self:E("WARNING: :getID does NOT match :GetID!")
-    end
-
   end
 
   return self
@@ -1075,20 +1329,23 @@ function DATABASE:_EventOnBirth( Event )
 
   if Event.IniDCSUnit then
 
-    if Event.IniObjectCategory == 3 then
+    if Event.IniObjectCategory == Object.Category.STATIC then
 
+      -- Add static object to DB.
       self:AddStatic( Event.IniDCSUnitName )
 
     else
 
-      if Event.IniObjectCategory == 1 then
+      if Event.IniObjectCategory == Object.Category.UNIT then
 
+        -- Add unit and group to DB.
         self:AddUnit( Event.IniDCSUnitName )
         self:AddGroup( Event.IniDCSGroupName )
 
-        -- Add airbase if it was spawned later in the mission.
+        -- A unit can also be an airbase (e.g. ships).
         local DCSAirbase = Airbase.getByName(Event.IniDCSUnitName)
         if DCSAirbase then
+          -- Add airbase if it was spawned later in the mission.
           self:I(string.format("Adding airbase %s", tostring(Event.IniDCSUnitName)))
           self:AddAirbase(Event.IniDCSUnitName)
         end
@@ -1096,7 +1353,7 @@ function DATABASE:_EventOnBirth( Event )
       end
     end
 
-    if Event.IniObjectCategory == 1 then
+    if Event.IniObjectCategory == Object.Category.UNIT then
 
       Event.IniUnit = self:FindUnit( Event.IniDCSUnitName )
       Event.IniGroup = self:FindGroup( Event.IniDCSGroupName )
@@ -1114,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
@@ -1216,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
@@ -1259,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)))
@@ -1421,10 +1693,10 @@ end
 -- @param #DATABASE self
 -- @param #function IteratorFunction The function that will be called object in the database. The function needs to accept a CLIENT parameter.
 -- @return #DATABASE self
-function DATABASE:ForEachClient( IteratorFunction, ... )
+function DATABASE:ForEachClient( IteratorFunction, FinalizeFunction, ... )
   self:F2( arg )
 
-  self:ForEach( IteratorFunction, arg, self.CLIENTS )
+  self:ForEach( IteratorFunction, FinalizeFunction, arg, self.CLIENTS )
 
   return self
 end
@@ -1433,10 +1705,10 @@ end
 -- @param #DATABASE self
 -- @param #function IteratorFunction The function that will be called for each object in the database. The function needs to accept a CLIENT parameter.
 -- @return #DATABASE self
-function DATABASE:ForEachCargo( IteratorFunction, ... )
+function DATABASE:ForEachCargo( IteratorFunction, FinalizeFunction, ... )
   self:F2( arg )
 
-  self:ForEach( IteratorFunction, arg, self.CARGOS )
+  self:ForEach( IteratorFunction, FinalizeFunction, arg, self.CARGOS )
 
   return self
 end
@@ -1551,6 +1823,33 @@ function DATABASE:FindOpsGroup(groupname)
   return self.FLIGHTGROUPS[groupname]
 end
 
+--- Find an OPSGROUP (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) in the data base for a given unit.
+-- @param #DATABASE self
+-- @param #string unitname Unit name. Can also be passed as UNIT object.
+-- @return Ops.OpsGroup#OPSGROUP OPS group object.
+function DATABASE:FindOpsGroupFromUnit(unitname)
+
+  local unit=nil --Wrapper.Unit#UNIT
+  local groupname
+
+  -- Get group and group name.
+  if type(unitname)=="string" then
+    unit=UNIT:FindByName(unitname)
+  else
+    unit=unitname
+  end
+
+  if unit then
+    groupname=unit:GetGroup():GetName()
+  end
+
+  if groupname then
+    return self.FLIGHTGROUPS[groupname]
+  else
+    return nil
+  end
+end
+
 --- Add a flight control to the data base.
 -- @param #DATABASE self
 -- @param Ops.FlightControl#FLIGHTCONTROL flightcontrol
@@ -1567,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})
 
@@ -1595,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.
@@ -1724,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

@@ -14,7 +14,7 @@
 -- ![Objects](..\Presentations\EVENT\Dia2.JPG)
 --
 -- Within a running mission, various DCS events occur. Units are dynamically created, crash, die, shoot stuff, get hit etc.
--- This module provides a mechanism to dispatch those events occuring within your running mission, to the different objects orchestrating your mission.
+-- This module provides a mechanism to dispatch those events occurring within your running mission, to the different objects orchestrating your mission.
 --
 -- ![Objects](..\Presentations\EVENT\Dia3.JPG)
 --
@@ -32,11 +32,11 @@
 --
 -- ![Objects](..\Presentations\EVENT\Dia5.JPG)
 --
--- There are 5 levels of kind of objects that the _EVENTDISPATCHER services:
+-- There are 5 types/levels of objects that the _EVENTDISPATCHER services:
 --
 --  * _DATABASE object: The core of the MOOSE objects. Any object that is created, deleted or updated, is done in this database.
---  * SET_ derived classes: Subsets of the _DATABASE object. These subsets are updated by the _EVENTDISPATCHER as the second priority.
---  * UNIT objects: UNIT objects can subscribe to DCS events. Each DCS event will be directly published to teh subscribed UNIT object.
+--  * SET_ derived classes: These are subsets of the global _DATABASE object (an instance of @{Core.Database#DATABASE}). These subsets are updated by the _EVENTDISPATCHER as the second priority.
+--  * UNIT objects: UNIT objects can subscribe to DCS events. Each DCS event will be directly published to the subscribed UNIT object.
 --  * GROUP objects: GROUP objects can subscribe to DCS events. Each DCS event will be directly published to the subscribed GROUP object.
 --  * Any other object: Various other objects can subscribe to DCS events. Each DCS event triggered will be published to each subscribed object.
 --
@@ -52,7 +52,7 @@
 --
 -- ![Objects](..\Presentations\EVENT\Dia8.JPG)
 --
--- The actual event subscribing and handling is not facilitated through the _EVENTDISPATCHER, but it is done through the @{BASE} class, @{UNIT} class and @{GROUP} class.
+-- The actual event subscribing and handling is not facilitated through the _EVENTDISPATCHER, but it is done through the @{Core.Base#BASE} class, @{Wrapper.Unit#UNIT} class and @{Wrapper.Group#GROUP} class.
 -- The _EVENTDISPATCHER is a component that is quietly working in the background of MOOSE.
 --
 -- ![Objects](..\Presentations\EVENT\Dia9.JPG)
@@ -173,7 +173,8 @@
 -- @image Core_Event.JPG
 
 
---- @type EVENT
+---
+-- @type EVENT
 -- @field #EVENT.Events Events
 -- @extends Core.Base#BASE
 
@@ -248,6 +249,27 @@ EVENTS = {
   TriggerZone               = world.event.S_EVENT_TRIGGER_ZONE or -1,
   LandingQualityMark        = world.event.S_EVENT_LANDING_QUALITY_MARK or -1,
   BDA                       = world.event.S_EVENT_BDA or -1,
+  -- Added with DCS 2.8.0
+  AIAbortMission            = world.event.S_EVENT_AI_ABORT_MISSION or -1,
+  DayNight                  = world.event.S_EVENT_DAYNIGHT or -1,
+  FlightTime                = world.event.S_EVENT_FLIGHT_TIME or -1,
+  SelfKillPilot             = world.event.S_EVENT_PLAYER_SELF_KILL_PILOT or -1,
+  PlayerCaptureAirfield     = world.event.S_EVENT_PLAYER_CAPTURE_AIRFIELD or -1, 
+  EmergencyLanding          = world.event.S_EVENT_EMERGENCY_LANDING or -1,
+  UnitCreateTask            = world.event.S_EVENT_UNIT_CREATE_TASK or -1,
+  UnitDeleteTask            = world.event.S_EVENT_UNIT_DELETE_TASK or -1,
+  SimulationStart           = world.event.S_EVENT_SIMULATION_START or -1,
+  WeaponRearm               = world.event.S_EVENT_WEAPON_REARM or -1,
+  WeaponDrop                = world.event.S_EVENT_WEAPON_DROP or -1,
+  -- Added with DCS 2.9.0
+  UnitTaskTimeout           = world.event.S_EVENT_UNIT_TASK_TIMEOUT or -1,
+  UnitTaskStage             = world.event.S_EVENT_UNIT_TASK_STAGE or -1,
+  MacSubtaskScore           = world.event.S_EVENT_MAC_SUBTASK_SCORE or -1, 
+  MacExtraScore             = world.event.S_EVENT_MAC_EXTRA_SCORE or -1,
+  MissionRestart            = world.event.S_EVENT_MISSION_RESTART or -1,
+  MissionWinner             = world.event.S_EVENT_MISSION_WINNER or -1, 
+  PostponedTakeoff          = world.event.S_EVENT_POSTPONED_TAKEOFF or -1, 
+  PostponedLand             = world.event.S_EVENT_POSTPONED_LAND or -1, 
 }
 
 --- The Event structure
@@ -270,6 +292,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.
@@ -285,6 +308,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.
@@ -293,15 +317,15 @@ EVENTS = {
 -- @field Wrapper.Airbase#AIRBASE Place The MOOSE airbase object.
 -- @field #string PlaceName The name of the airbase.
 --
--- @field #table weapon The weapon used during the event.
--- @field #table Weapon
+-- @field DCS#Weapon weapon The weapon used during the event.
+-- @field DCS#Weapon Weapon The weapon used during the event.
 -- @field #string WeaponName Name of the weapon.
 -- @field DCS#Unit WeaponTgtDCSUnit Target DCS unit of the weapon.
 --
 -- @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.
 
 
@@ -560,9 +584,118 @@ local _EVENTMETA = {
      Event = "OnEventBDA",
      Text = "S_EVENT_BDA"
    },
+   -- Added with DCS 2.8
+   [EVENTS.AIAbortMission] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventAIAbortMission",
+     Text = "S_EVENT_AI_ABORT_MISSION"
+   },
+   [EVENTS.DayNight] = {
+     Order = 1,
+     Event = "OnEventDayNight",
+     Text = "S_EVENT_DAYNIGHT"
+   },
+   [EVENTS.FlightTime] = {
+     Order = 1,
+     Event = "OnEventFlightTime",
+     Text = "S_EVENT_FLIGHT_TIME"
+   },
+   [EVENTS.SelfKillPilot] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventSelfKillPilot",
+     Text = "S_EVENT_PLAYER_SELF_KILL_PILOT"
+   },
+   [EVENTS.PlayerCaptureAirfield] = {
+     Order = 1,
+     Event = "OnEventPlayerCaptureAirfield",
+     Text = "S_EVENT_PLAYER_CAPTURE_AIRFIELD"
+   },
+   [EVENTS.EmergencyLanding] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventEmergencyLanding",
+     Text = "S_EVENT_EMERGENCY_LANDING"
+   },
+   [EVENTS.UnitCreateTask] = {
+     Order = 1,
+     Event = "OnEventUnitCreateTask",
+     Text = "S_EVENT_UNIT_CREATE_TASK"
+   },
+   [EVENTS.UnitDeleteTask] = {
+     Order = 1,
+     Event = "OnEventUnitDeleteTask",
+     Text = "S_EVENT_UNIT_DELETE_TASK"
+   },
+   [EVENTS.SimulationStart] = {
+     Order = 1,
+     Event = "OnEventSimulationStart",
+     Text = "S_EVENT_SIMULATION_START"
+   },
+   [EVENTS.WeaponRearm] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventWeaponRearm",
+     Text = "S_EVENT_WEAPON_REARM"
+   },
+   [EVENTS.WeaponDrop] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventWeaponDrop",
+     Text = "S_EVENT_WEAPON_DROP"
+   },
+   -- DCS 2.9
+  [EVENTS.UnitTaskTimeout] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventUnitTaskTimeout",
+     Text = "S_EVENT_UNIT_TASK_TIMEOUT "
+   },
+  [EVENTS.UnitTaskStage] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventUnitTaskStage",
+     Text = "S_EVENT_UNIT_TASK_STAGE "
+   },
+  [EVENTS.MacSubtaskScore] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventMacSubtaskScore",
+     Text = "S_EVENT_MAC_SUBTASK_SCORE"
+   },
+  [EVENTS.MacExtraScore] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventMacExtraScore",
+     Text = "S_EVENT_MAC_EXTRA_SCOREP"
+   },
+  [EVENTS.MissionRestart] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventMissionRestart",
+     Text = "S_EVENT_MISSION_RESTART"
+   },
+  [EVENTS.MissionWinner] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventMissionWinner",
+     Text = "S_EVENT_MISSION_WINNER"
+   },
+  [EVENTS.PostponedTakeoff] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventPostponedTakeoff",
+     Text = "S_EVENT_POSTPONED_TAKEOFF"
+   },
+  [EVENTS.PostponedLand] = {
+     Order = 1,
+     Side = "I",
+     Event = "OnEventPostponedLand",
+     Text = "S_EVENT_POSTPONED_LAND"
+   }, 
 }
 
-
 --- The Events structure
 -- @type EVENT.Events
 -- @field #number IniUnit
@@ -916,7 +1049,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 } )
 
@@ -932,7 +1065,7 @@ do -- Event Creation
 
   --- Creation of a ZoneGoal Deletion Event.
   -- @param #EVENT self
-  -- @param Core.ZoneGoal#ZONE_GOAL ZoneGoal The ZoneGoal created.
+  -- @param Functional.ZoneGoal#ZONE_GOAL ZoneGoal The ZoneGoal created.
   function EVENT:CreateEventDeleteZoneGoal( ZoneGoal )
     self:F( { ZoneGoal } )
 
@@ -1008,9 +1141,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
           ---          
@@ -1046,10 +1179,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
           ---        
@@ -1058,7 +1190,7 @@ function EVENT:onEvent( Event )
           Event.IniUnitName = Event.IniDCSUnitName
           Event.IniDCSGroup = Event.IniDCSUnit:getGroup()
           Event.IniUnit = UNIT:FindByName( Event.IniDCSUnitName )
-          
+                  
           if not Event.IniUnit then
             -- Unit can be a CLIENT. Most likely this will be the case ...
             Event.IniUnit = CLIENT:FindByName( Event.IniDCSUnitName, '', true )
@@ -1072,12 +1204,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
           ---
@@ -1088,22 +1227,19 @@ 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
-          ---
-          
+          ---          
           Event.IniDCSUnit = Event.initiator
           Event.IniDCSUnitName = Event.IniDCSUnit:getName()
           Event.IniUnitName = Event.IniDCSUnitName
           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
           ---
@@ -1114,6 +1250,12 @@ function EVENT:onEvent( Event )
           Event.IniCoalition = Event.IniDCSUnit:getCoalition()
           Event.IniCategory = Event.IniDCSUnit:getDesc().category
           Event.IniTypeName = Event.IniDCSUnit:getTypeName()
+          
+          -- If the airbase does not exist in the DB, we add it (e.g. when FARPS are spawned).
+          if not Event.IniUnit then
+            _DATABASE:_RegisterAirbase(Event.initiator)
+            Event.IniUnit = AIRBASE:FindByName(Event.IniDCSUnitName)
+          end
         end
       end
 
@@ -1124,9 +1266,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()
@@ -1139,21 +1284,33 @@ 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()
-            Event.TgtUnitName = Event.TgtDCSUnitName
-            Event.TgtUnit = STATIC:FindByName( Event.TgtDCSUnitName, false )
-            Event.TgtCoalition = Event.TgtDCSUnit:getCoalition()
-            Event.TgtCategory = Event.TgtDCSUnit:getDesc().category
-            Event.TgtTypeName = Event.TgtDCSUnit:getTypeName()
+            -- Workaround for borked target info on cruise missiles
+            if Event.TgtDCSUnitName and Event.TgtDCSUnitName ~= "" then
+              Event.TgtUnitName = Event.TgtDCSUnitName
+              Event.TgtUnit = STATIC:FindByName( Event.TgtDCSUnitName, false )
+              Event.TgtCoalition = Event.TgtDCSUnit:getCoalition()
+              Event.TgtCategory = Event.TgtDCSUnit:getDesc().category
+              Event.TgtTypeName = Event.TgtDCSUnit:getTypeName()
+            end
           else
             Event.TgtDCSUnitName = string.format("No target object for Event ID %s", tostring(Event.id))
             Event.TgtUnitName = Event.TgtDCSUnitName
@@ -1172,9 +1329,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
@@ -1189,7 +1348,8 @@ function EVENT:onEvent( Event )
         Event.Weapon = Event.weapon
         Event.WeaponName = Event.Weapon:getTypeName()
         Event.WeaponUNIT = CLIENT:Find( Event.Weapon, '', true ) -- Sometimes, the weapon is a player unit!
-        Event.WeaponPlayerName = Event.WeaponUNIT and Event.Weapon:getPlayerName()
+        Event.WeaponPlayerName = Event.WeaponUNIT and Event.Weapon.getPlayerName and Event.Weapon:getPlayerName()
+        --Event.WeaponPlayerName = Event.WeaponUNIT and Event.Weapon:getPlayerName()
         Event.WeaponCoalition = Event.WeaponUNIT and Event.Weapon:getCoalition()
         Event.WeaponCategory = Event.WeaponUNIT and Event.Weapon:getDesc().category
         Event.WeaponTypeName = Event.WeaponUNIT and Event.Weapon:getTypeName()
@@ -1203,9 +1363,11 @@ function EVENT:onEvent( Event )
           --local name=Event.place:getName()  -- This returns a DCS error "Airbase doesn't exit" :(
           -- 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
-          Event.Place=AIRBASE:Find(Event.place)
-          Event.PlaceName=Event.Place:GetName()
+        else  
+          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
         end
       end
 

Moose Development/Moose/Core/Goal.lua

@@ -1,89 +1,87 @@
 --- **Core** - Models the process to achieve goal(s).
 --
 -- ===
--- 
+--
 -- ## Features:
--- 
+--
 --   * Define the goal.
 --   * Monitor the goal achievement.
 --   * Manage goal contribution by players.
--- 
+--
 -- ===
--- 
+--
 -- Classes that implement a goal achievement, will derive from GOAL to implement the ways how the achievements can be realized.
--- 
+--
 -- ===
--- 
+--
 -- ### Author: **FlightControl**
 -- ### Contributions: **funkyfranky**
--- 
+--
 -- ===
--- 
+--
 -- @module Core.Goal
 -- @image Core_Goal.JPG
 
-
 do -- Goal
 
   --- @type GOAL
   -- @extends Core.Fsm#FSM
 
-
   --- Models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized.
-  -- 
+  --
   -- # 1. GOAL constructor
-  --   
+  --
   --   * @{#GOAL.New}(): Creates a new GOAL object.
-  -- 
+  --
   -- # 2. GOAL is a finite state machine (FSM).
-  -- 
+  --
   -- ## 2.1. GOAL States
-  -- 
+  --
   --   * **Pending**: The goal object is in progress.
   --   * **Achieved**: The goal objective is Achieved.
-  -- 
+  --
   -- ## 2.2. GOAL Events
-  -- 
+  --
   --   * **Achieved**: Set the goal objective to Achieved.
-  -- 
+  --
   -- # 3. Player contributions.
-  -- 
+  --
   -- Goals are most of the time achieved by players. These player achievements can be registered as part of the goal achievement.
   -- Use @{#GOAL.AddPlayerContribution}() to add a player contribution to the goal.
   -- The player contributions are based on a points system, an internal counter per player.
-  -- So once the goal has been achieved, the player contributions can be queried using @{#GOAL.GetPlayerContributions}(), 
+  -- So once the goal has been achieved, the player contributions can be queried using @{#GOAL.GetPlayerContributions}(),
   -- that retrieves all contributions done by the players. For one player, the contribution can be queried using @{#GOAL.GetPlayerContribution}().
   -- The total amount of player contributions can be queried using @{#GOAL.GetTotalContributions}().
-  -- 
+  --
   -- # 4. Goal achievement.
-  -- 
+  --
   -- Once the goal is achieved, the mission designer will need to trigger the goal achievement using the **Achieved** event.
   -- The underlying 2 examples will achieve the goals for the `Goal` object:
-  -- 
+  --
   --       Goal:Achieved() -- Achieve the goal immediately.
   --       Goal:__Achieved( 30 ) -- Achieve the goal within 30 seconds.
-  -- 
+  --
   -- # 5. Check goal achievement.
-  -- 
+  --
   -- The method @{#GOAL.IsAchieved}() will return true if the goal is achieved (the trigger **Achieved** was executed).
   -- You can use this method to check asynchronously if a goal has been achieved, for example using a scheduler.
-  -- 
+  --
   -- @field #GOAL
   GOAL = {
     ClassName = "GOAL",
   }
-  
+
   --- @field #table GOAL.Players
   GOAL.Players = {}
 
   --- @field #number GOAL.TotalContributions
   GOAL.TotalContributions = 0
-  
+
   --- GOAL Constructor.
   -- @param #GOAL self
   -- @return #GOAL
   function GOAL:New()
-  
+
     local self = BASE:Inherit( self, FSM:New() ) -- #GOAL
     self:F( {} )
 
@@ -104,11 +102,10 @@ do -- Goal
     -- @param #string From
     -- @param #string Event
     -- @param #string To
-    
-    
+
     self:SetStartState( "Pending" )
-    self:AddTransition( "*",  "Achieved", "Achieved" )
-    
+    self:AddTransition( "*", "Achieved", "Achieved" )
+
     --- Achieved Handler OnBefore for GOAL
     -- @function [parent=#GOAL] OnBeforeAchieved
     -- @param #GOAL self
@@ -116,47 +113,44 @@ do -- Goal
     -- @param #string Event
     -- @param #string To
     -- @return #boolean
-    
+
     --- Achieved Handler OnAfter for GOAL
     -- @function [parent=#GOAL] OnAfterAchieved
     -- @param #GOAL self
     -- @param #string From
     -- @param #string Event
     -- @param #string To
-    
+
     --- Achieved Trigger for GOAL
     -- @function [parent=#GOAL] Achieved
     -- @param #GOAL self
-    
+
     --- Achieved Asynchronous Trigger for GOAL
     -- @function [parent=#GOAL] __Achieved
     -- @param #GOAL self
     -- @param #number Delay
-    
+
     self:SetEventPriority( 5 )
 
     return self
   end
-  
-  
+
   --- Add a new contribution by a player.
   -- @param #GOAL self
   -- @param #string PlayerName The name of the player.
   function GOAL:AddPlayerContribution( PlayerName )
-    self:F({PlayerName})
+    self:F( { PlayerName } )
     self.Players[PlayerName] = self.Players[PlayerName] or 0
     self.Players[PlayerName] = self.Players[PlayerName] + 1
     self.TotalContributions = self.TotalContributions + 1
   end
-  
-  
+
   --- @param #GOAL self
   -- @param #number Player contribution.
   function GOAL:GetPlayerContribution( PlayerName )
-    return self.Players[PlayerName] or 0 
+    return self.Players[PlayerName] or 0
   end
 
-  
   --- Get the players who contributed to achieve the goal.
   -- The result is a list of players, sorted by the name of the players.
   -- @param #GOAL self
@@ -165,7 +159,6 @@ do -- Goal
     return self.Players or {}
   end
 
-  
   --- Gets the total contributions that happened to achieve the goal.
   -- The result is a number.
   -- @param #GOAL self
@@ -173,9 +166,7 @@ do -- Goal
   function GOAL:GetTotalContributions()
     return self.TotalContributions or 0
   end
-  
-  
-  
+
   --- Validates if the goal is achieved.
   -- @param #GOAL self
   -- @return #boolean true if the goal is achieved.
@@ -183,4 +174,4 @@ do -- Goal
     return self:Is( "Achieved" )
   end
 
-end
+end

Moose Development/Moose/Core/MarkerOps_Base.lua

@@ -1,16 +1,23 @@
---- **Core** - MarkerOps_Base.
+--- **Core** - Tap into markers added to the F10 map by users.
 --
 -- **Main Features:**
 --
 --    * Create an easy way to tap into markers added to the F10 map by users.
 --    * Recognize own tag and list of keywords.
 --    * Matched keywords are handed down to functions.
+-- ##Listen for your tag
+--    myMarker = MARKEROPS_BASE:New("tag", {}, false)
+--    function myMarker:OnAfterMarkChanged(From, Event, To, Text, Keywords, Coord, idx)
+--
+--    end
+-- Make sure to use the "MarkChanged" event as "MarkAdded" comes in right after the user places a blank marker and your callback will never be called.
 --
 -- ===
 --
 -- ### Author: **Applevangelist**
 -- 
 -- Date: 5 May 2021
+-- Last Update: Feb 2023
 -- 
 -- ===
 ---
@@ -27,6 +34,7 @@
 -- @field #string Tag Tag to identify commands.
 -- @field #table Keywords Table of keywords to recognize.
 -- @field #string version Version of #MARKEROPS_BASE.
+-- @field #boolean Casesensitive Enforce case when identifying the Tag, i.e. tag ~= Tag
 -- @extends Core.Fsm#FSM
 
 --- *Fiat lux.* -- Latin proverb.
@@ -42,16 +50,18 @@ MARKEROPS_BASE = {
   ClassName = "MARKEROPS",
   Tag = "mytag",
   Keywords = {},
-  version = "0.0.1",
+  version = "0.1.1",
   debug = false,
+  Casesensitive = true,
 }
 
 --- Function to instantiate a new #MARKEROPS_BASE object.
 -- @param #MARKEROPS_BASE self
 -- @param #string Tagname Name to identify us from the event text.
 -- @param #table Keywords Table of keywords  recognized from the event text.
+-- @param #boolean Casesensitive (Optional) Switch case sensitive identification of Tagname. Defaults to true.
 -- @return #MARKEROPS_BASE self
-function MARKEROPS_BASE:New(Tagname,Keywords)
+function MARKEROPS_BASE:New(Tagname,Keywords,Casesensitive)
    -- Inherit FSM
   local self=BASE:Inherit(self, FSM:New()) -- #MARKEROPS_BASE
   
@@ -61,6 +71,11 @@ function MARKEROPS_BASE:New(Tagname,Keywords)
   self.Tag = Tagname or "mytag"-- #string
   self.Keywords = Keywords or {} -- #table - might want to use lua regex here, too
   self.debug = false
+  self.Casesensitive = true
+  
+  if Casesensitive and Casesensitive == false then
+    self.Casesensitive = false
+  end
   
   -----------------------
   --- FSM Transitions ---
@@ -109,7 +124,8 @@ function MARKEROPS_BASE:New(Tagname,Keywords)
    -- @param #string Text The text on the marker
    -- @param #table Keywords Table of matching keywords found in the Event text
    -- @param Core.Point#COORDINATE Coord Coordinate of the marker.
-  
+   -- @param #number idx DCS Marker ID
+
    --- On after "MarkDeleted" event. Triggered when a Marker is deleted from the F10 map.
    -- @function [parent=#MARKEROPS_BASE] OnAfterMarkDeleted
    -- @param #MARKEROPS_BASE self
@@ -123,7 +139,7 @@ function MARKEROPS_BASE:New(Tagname,Keywords)
 end
 
 --- (internal) Handle events.
--- @param #MARKEROPS self
+-- @param #MARKEROPS_BASE self
 -- @param Core.Event#EVENTDATA Event
 function MARKEROPS_BASE:OnEventMark(Event)
   self:T({Event})
@@ -157,7 +173,7 @@ function MARKEROPS_BASE:OnEventMark(Event)
       if Eventtext~=nil then
         if self:_MatchTag(Eventtext) then
          local matchtable = self:_MatchKeywords(Eventtext)
-         self:MarkChanged(Eventtext,matchtable,coord)
+         self:MarkChanged(Eventtext,matchtable,coord,Event.idx)
         end
       end
     elseif Event.id==world.event.S_EVENT_MARK_REMOVED then
@@ -173,20 +189,27 @@ function MARKEROPS_BASE:OnEventMark(Event)
 end
 
 --- (internal) Match tag.
--- @param #MARKEROPS self
+-- @param #MARKEROPS_BASE self
 -- @param #string Eventtext Text added to the marker.
 -- @return #boolean
 function MARKEROPS_BASE:_MatchTag(Eventtext)
   local matches = false
-  local type = string.lower(self.Tag) -- #string
-  if string.find(string.lower(Eventtext),type) then
-    matches = true --event text contains tag
+  if not self.Casesensitive then
+    local type = string.lower(self.Tag) -- #string
+    if string.find(string.lower(Eventtext),type) then
+      matches = true --event text contains tag
+    end
+  else
+    local type = self.Tag -- #string
+    if string.find(Eventtext,type) then
+      matches = true --event text contains tag
+    end
   end
   return matches
 end
 
 --- (internal) Match keywords table.
--- @param #MARKEROPS self
+-- @param #MARKEROPS_BASE self
 -- @param #string Eventtext Text added to the marker.
 -- @return #table
 function MARKEROPS_BASE:_MatchKeywords(Eventtext)

Moose Development/Moose/Core/Menu.lua

@@ -239,6 +239,7 @@ do -- MENU_BASE
   function MENU_BASE:GetMenu( MenuText )
     return self.Menus[MenuText]
   end
+  
   --- Sets a menu stamp for later prevention of menu removal.
   -- @param #MENU_BASE self
   -- @param MenuStamp
@@ -376,6 +377,7 @@ do -- MENU_MISSION
     end
   
   end
+  
   --- Refreshes a radio item for a mission
   -- @param #MENU_MISSION self
   -- @return #MENU_MISSION
@@ -511,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}.
@@ -813,6 +815,7 @@ do
     end
     
   end
+  
   --- Refreshes a new radio item for a group and submenus
   -- @param #MENU_GROUP self
   -- @return #MENU_GROUP
@@ -829,6 +832,29 @@ do
     return self
   end
   
+  --- Refreshes a new radio item for a group and submenus, ordering by (numerical) MenuTag
+  -- @param #MENU_GROUP self
+  -- @return #MENU_GROUP
+  function MENU_GROUP:RefreshAndOrderByTag()
+
+    do
+      missionCommands.removeItemForGroup( self.GroupID, self.MenuPath )
+      missionCommands.addSubMenuForGroup( self.GroupID, self.MenuText, self.MenuParentPath )
+      
+      local MenuTable = {}
+      for MenuText, Menu in pairs( self.Menus or {} ) do
+        local tag = Menu.MenuTag or math.random(1,10000)
+        MenuTable[#MenuTable+1] = {Tag=tag, Enty=Menu}
+      end
+      table.sort(MenuTable, function (k1, k2) return k1.tag < k2.tag end )
+      for _, Menu in pairs( MenuTable ) do
+        Menu.Entry:Refresh()
+      end 
+    end
+    
+    return self
+  end
+  
   --- Removes the sub menus recursively of this MENU_GROUP.
   -- @param #MENU_GROUP self
   -- @param MenuStamp

Moose Development/Moose/Core/Message.lua

@@ -1,9 +1,9 @@
 --- **Core** - Informs the players using messages during a simulation.
--- 
+--
 -- ===
--- 
+--
 -- ## Features:
--- 
+--
 --   * A more advanced messaging system using the DCS message system.
 --   * Time messages.
 --   * Send messages based on a message type, which has a pre-defined duration that can be tweaked in SETTINGS.
@@ -13,7 +13,7 @@
 --   * Send messages to a specific unit or client.
 -- 
 -- ===
--- 
+--
 -- @module Core.Message
 -- @image Core_Message.JPG
 
@@ -24,43 +24,43 @@
 --- Message System to display Messages to Clients, Coalitions or All.
 -- Messages are shown on the display panel for an amount of seconds, and will then disappear.
 -- Messages can contain a category which is indicating the category of the message.
--- 
+--
 -- ## MESSAGE construction
--- 
+--
 -- Messages are created with @{#MESSAGE.New}. Note that when the MESSAGE object is created, no message is sent yet.
 -- To send messages, you need to use the To functions.
--- 
+--
 -- ## Send messages to an audience
--- 
+--
 -- Messages are sent:
 --
---   * To a @{Client} using @{#MESSAGE.ToClient}().
+--   * To a @{Wrapper.Client} using @{#MESSAGE.ToClient}().
 --   * To a @{Wrapper.Group} using @{#MESSAGE.ToGroup}()
 --   * To a @{Wrapper.Unit} using @{#MESSAGE.ToUnit}()
 --   * To a coalition using @{#MESSAGE.ToCoalition}().
 --   * To the red coalition using @{#MESSAGE.ToRed}().
 --   * To the blue coalition using @{#MESSAGE.ToBlue}().
 --   * To all Players using @{#MESSAGE.ToAll}().
--- 
+--
 -- ## Send conditionally to an audience
--- 
+--
 -- Messages can be sent conditionally to an audience (when a condition is true):
---   
+--
 --   * To all players using @{#MESSAGE.ToAllIf}().
 --   * To a coalition using @{#MESSAGE.ToCoalitionIf}().
--- 
+--
 -- ===
---  
+--
 -- ### Author: **FlightControl**
--- ### Contributions: 
--- 
+-- ### Contributions: **Applevangelist**
+--
 -- ===
--- 
+--
 -- @field #MESSAGE
 MESSAGE = {
-	ClassName = "MESSAGE", 
-	MessageCategory = 0,
-	MessageID = 0,
+  ClassName = "MESSAGE",
+  MessageCategory = 0,
+  MessageID = 0,
 }
 
 --- Message Types
@@ -70,11 +70,10 @@ MESSAGE.Type = {
   Information = "Information",
   Briefing = "Briefing Report",
   Overview = "Overview Report",
-  Detailed = "Detailed Report"
+  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.
@@ -82,119 +81,119 @@ MESSAGE.Type = {
 -- @param #boolean ClearScreen (optional) Clear all previous messages if true.
 -- @return #MESSAGE
 -- @usage
--- -- Create a series of new Messages.
--- -- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
--- -- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
--- -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
--- -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
--- MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!",  25, "End of Mission" )
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
--- MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target",  25, "Score" )
--- MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")
+--
+--    -- Create a series of new Messages.
+--    -- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
+--    -- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
+--    -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+--    -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+--   MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!",  25, "End of Mission" )
+--   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
+--   MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target",  25, "Score" )
+--   MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")
+--
 function MESSAGE:New( MessageText, MessageDuration, MessageCategory, ClearScreen )
-	local self = BASE:Inherit( self, BASE:New() )
-	self:F( { MessageText, MessageDuration, MessageCategory } )
-
+  local self = BASE:Inherit( self, BASE:New() )
+  self:F( { MessageText, MessageDuration, MessageCategory } )
 
   self.MessageType = nil
-  
-  -- When no MessageCategory is given, we don't show it as a title...	
-	if MessageCategory and MessageCategory ~= "" then
-	  if MessageCategory:sub(-1) ~= "\n" then
+
+  -- When no MessageCategory is given, we don't show it as a title... 
+  if MessageCategory and MessageCategory ~= "" then
+    if MessageCategory:sub( -1 ) ~= "\n" then
       self.MessageCategory = MessageCategory .. ": "
     else
-      self.MessageCategory = MessageCategory:sub( 1, -2 ) .. ":\n" 
+      self.MessageCategory = MessageCategory:sub( 1, -2 ) .. ":\n"
     end
   else
     self.MessageCategory = ""
   end
-  
-  self.ClearScreen=false
-  if ClearScreen~=nil then
-    self.ClearScreen=ClearScreen
+
+  self.ClearScreen = false
+  if ClearScreen ~= nil then
+    self.ClearScreen = ClearScreen
   end
 
-	self.MessageDuration = MessageDuration or 5
-	self.MessageTime = timer.getTime()
-	self.MessageText = MessageText:gsub("^\n","",1):gsub("\n$","",1)
-	
-	self.MessageSent = false
-	self.MessageGroup = false
-	self.MessageCoalition = false
+  self.MessageDuration = MessageDuration or 5
+  self.MessageTime = timer.getTime()
+  self.MessageText = MessageText:gsub( "^\n", "", 1 ):gsub( "\n$", "", 1 )
 
-	return self
+  self.MessageSent = false
+  self.MessageGroup = false
+  self.MessageCoalition = false
+
+  return self
 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.
--- The message display times are automatically defined based on the timing settings in the @{Settings} menu.
+--- 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 @{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.
 -- @param #MESSAGE.Type MessageType The type of the message.
 -- @param #boolean ClearScreen (optional) Clear all previous messages.
 -- @return #MESSAGE
 -- @usage
+--
 --   MessageAll = MESSAGE:NewType( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", MESSAGE.Type.Information )
 --   MessageRED = MESSAGE:NewType( "To the RED Players: You receive a penalty because you've killed one of your own units", MESSAGE.Type.Information )
 --   MessageClient1 = MESSAGE:NewType( "Congratulations, you've just hit a target", MESSAGE.Type.Update )
 --   MessageClient2 = MESSAGE:NewType( "Congratulations, you've just killed a target", MESSAGE.Type.Update )
+--
 function MESSAGE:NewType( MessageText, MessageType, ClearScreen )
 
   local self = BASE:Inherit( self, BASE:New() )
   self:F( { MessageText } )
-  
+
   self.MessageType = MessageType
-  
-  self.ClearScreen=false
-  if ClearScreen~=nil then
-    self.ClearScreen=ClearScreen
+
+  self.ClearScreen = false
+  if ClearScreen ~= nil then
+    self.ClearScreen = ClearScreen
   end
 
   self.MessageTime = timer.getTime()
-  self.MessageText = MessageText:gsub("^\n","",1):gsub("\n$","",1)
-  
+  self.MessageText = MessageText:gsub( "^\n", "", 1 ):gsub( "\n$", "", 1 )
+
   return self
 end
 
-
-
---- Clears all previous messages from the screen before the new message is displayed. Not that this must come before all functions starting with ToX(), e.g. ToAll(), ToGroup() etc. 
+--- Clears all previous messages from the screen before the new message is displayed. Not that this must come before all functions starting with ToX(), e.g. ToAll(), ToGroup() etc.
 -- @param #MESSAGE self
 -- @return #MESSAGE
 function MESSAGE:Clear()
   self:F()
-  self.ClearScreen=true
+  self.ClearScreen = true
   return self
 end
 
-
-
 --- Sends a MESSAGE to a Client Group. Note that the Group needs to be defined within the ME with the skillset "Client" or "Player".
 -- @param #MESSAGE self
 -- @param Wrapper.Client#CLIENT Client is the Group of the Client.
--- @param Core.Settings#SETTINGS Settings Settings used to display the message.
+-- @param Core.Settings#SETTINGS Settings used to display the message.
 -- @return #MESSAGE
 -- @usage
--- -- Send the 2 messages created with the @{New} method to the Client Group.
--- -- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
--- ClientGroup = Group.getByName( "ClientGroup" )
 --
--- MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
--- MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
--- or
--- MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
--- MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
--- or
--- MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
--- MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
--- MessageClient1:ToClient( ClientGroup )
--- MessageClient2:ToClient( ClientGroup )
+--   -- Send the 2 messages created with the @{New} method to the Client Group.
+--   -- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
+--   ClientGroup = Group.getByName( "ClientGroup" )
+--
+--   MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+--   MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+--   or
+--   MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25 ):ToClient( ClientGroup )
+--   MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25 ):ToClient( ClientGroup )
+--   or
+--   MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25 )
+--   MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25 )
+--   MessageClient1:ToClient( ClientGroup )
+--   MessageClient2:ToClient( ClientGroup )
+--
 function MESSAGE:ToClient( Client, Settings )
-	self:F( Client )
+  self:F( Client )
 
-	if Client and Client:GetClientGroupID() then
+  if Client and Client:GetClientGroupID() then
 
     if self.MessageType then
       local Settings = Settings or ( Client and _DATABASE:GetPlayerSettings( Client:GetPlayerName() ) ) or _SETTINGS -- Core.Settings#SETTINGS
@@ -205,43 +204,45 @@ function MESSAGE:ToClient( Client, Settings )
     local Unit = Client:GetClient()
     
     if self.MessageDuration ~= 0 then
-  		local ClientGroupID = Client:GetClientGroupID()
-  		self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
-  		--trigger.action.outTextForGroup( ClientGroupID, self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration , self.ClearScreen)
-  		trigger.action.outTextForUnit( Unit:GetID(), self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration , self.ClearScreen)
-		end
-	end
-	
-	return self
-end
-
---- Sends a MESSAGE to a Group. 
--- @param #MESSAGE self
--- @param Wrapper.Group#GROUP Group to which the message is displayed.
--- @return #MESSAGE Message object.
-function MESSAGE:ToGroup( Group, Settings )
-  self:F( Group.GroupName )
-
-  if Group then
-    
-    if self.MessageType then
-      local Settings = Settings or ( Group and _DATABASE:GetPlayerSettings( Group:GetPlayerName() ) ) or _SETTINGS -- Core.Settings#SETTINGS
-      self.MessageDuration = Settings:GetMessageTime( self.MessageType )
-      self.MessageCategory = "" -- self.MessageType .. ": "
-    end
-
-    if self.MessageDuration ~= 0 then
+      local ClientGroupID = Client:GetClientGroupID()
       self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
-      trigger.action.outTextForGroup( Group:GetID(), self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration, self.ClearScreen )
+      --trigger.action.outTextForGroup( ClientGroupID, self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration , self.ClearScreen)
+      trigger.action.outTextForUnit( Unit:GetID(), self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration , self.ClearScreen)
     end
   end
   
   return self
 end
 
+--- Sends a MESSAGE to a Group.
+-- @param #MESSAGE self
+-- @param Wrapper.Group#GROUP Group to which the message is displayed.
+-- @param Core.Settings#Settings Settings (Optional) Settings for message display.
+-- @return #MESSAGE Message object.
+function MESSAGE:ToGroup( Group, Settings )
+  self:F( Group.GroupName )
+
+  if Group then
+
+    if self.MessageType then
+      local Settings = Settings or (Group and _DATABASE:GetPlayerSettings( Group:GetPlayerName() )) or _SETTINGS -- Core.Settings#SETTINGS
+      self.MessageDuration = Settings:GetMessageTime( self.MessageType )
+      self.MessageCategory = "" -- self.MessageType .. ": "
+    end
+
+    if self.MessageDuration ~= 0 then
+      self:T( self.MessageCategory .. self.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ) .. " / " .. self.MessageDuration )
+      trigger.action.outTextForGroup( Group:GetID(), self.MessageCategory .. self.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ), self.MessageDuration, self.ClearScreen )
+    end
+  end
+
+  return self
+end
+
 --- Sends a MESSAGE to a Unit. 
 -- @param #MESSAGE self
 -- @param Wrapper.Unit#UNIT Unit to which the message is displayed.
+-- @param Core.Settings#Settings Settings (Optional) Settings for message display.
 -- @return #MESSAGE Message object.
 function MESSAGE:ToUnit( Unit, Settings )
   self:F( Unit.IdentifiableName )
@@ -263,59 +264,100 @@ function MESSAGE:ToUnit( Unit, Settings )
   return self
 end
 
+--- Sends a MESSAGE to a Country. 
+-- @param #MESSAGE self
+-- @param #number Country to which the message is displayed, e.g. country.id.GERMANY. For all country numbers see here: [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_country)
+-- @param Core.Settings#Settings Settings (Optional) Settings for message display.
+-- @return #MESSAGE Message object.
+function MESSAGE:ToCountry( Country, Settings )
+  self:F(Country )
+  if Country then   
+    if self.MessageType then
+      local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
+      self.MessageDuration = Settings:GetMessageTime( self.MessageType )
+      self.MessageCategory = "" -- self.MessageType .. ": "
+    end
+    if self.MessageDuration ~= 0 then
+      self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
+      trigger.action.outTextForCountry( Country, self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration, self.ClearScreen )
+    end
+  end  
+  return self
+end
+
+--- Sends a MESSAGE to a Country. 
+-- @param #MESSAGE self
+-- @param #number Country to which the message is displayed, , e.g. country.id.GERMANY. For all country numbers see here: [Hoggit Wiki](https://wiki.hoggitworld.com/view/DCS_enum_country)
+-- @param #boolean Condition Sends the message only if the condition is true.
+-- @param Core.Settings#Settings Settings (Optional) Settings for message display.
+-- @return #MESSAGE Message object.
+function MESSAGE:ToCountryIf( Country, Condition, Settings )
+  self:F(Country )
+  if Country and Condition == true then
+    self:ToCountry( Country, Settings )
+  end
+  return self
+end
+
 --- Sends a MESSAGE to the Blue coalition.
--- @param #MESSAGE self 
+-- @param #MESSAGE self
 -- @return #MESSAGE
 -- @usage
--- -- Send a message created with the @{New} method to the BLUE coalition.
--- MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
--- or
--- MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
--- or
--- MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
--- MessageBLUE:ToBlue()
+--
+--   -- Send a message created with the @{New} method to the BLUE coalition.
+--   MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25):ToBlue()
+--   or
+--   MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25 ):ToBlue()
+--   or
+--   MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25 )
+--   MessageBLUE:ToBlue()
+--
 function MESSAGE:ToBlue()
-	self:F()
+  self:F()
 
-	self:ToCoalition( coalition.side.BLUE )
-	
-	return self
+  self:ToCoalition( coalition.side.BLUE )
+
+  return self
 end
 
---- Sends a MESSAGE to the Red Coalition. 
+--- Sends a MESSAGE to the Red Coalition.
 -- @param #MESSAGE self
 -- @return #MESSAGE
 -- @usage
--- -- Send a message created with the @{New} method to the RED coalition.
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
--- or
--- MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
--- or
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
--- MessageRED:ToRed()
-function MESSAGE:ToRed( )
-	self:F()
+--
+--   -- Send a message created with the @{New} method to the RED coalition.
+--   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25 ):ToRed()
+--   or
+--   MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25 ):ToRed()
+--   or
+--   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25 )
+--   MessageRED:ToRed()
+--
+function MESSAGE:ToRed()
+  self:F()
 
-	self:ToCoalition( coalition.side.RED )
-	
-	return self
+  self:ToCoalition( coalition.side.RED )
+
+  return self
 end
 
---- Sends a MESSAGE to a Coalition. 
+--- 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
--- -- Send a message created with the @{New} method to the RED coalition.
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
--- or
--- MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
--- or
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
--- MessageRED:ToCoalition( coalition.side.RED )
+--
+--   -- Send a message created with the @{New} method to the RED coalition.
+--   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25 ):ToCoalition( coalition.side.RED )
+--   or
+--   MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25 ):ToCoalition( coalition.side.RED )
+--   or
+--   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25 )
+--   MessageRED:ToCoalition( coalition.side.RED )
+--
 function MESSAGE:ToCoalition( CoalitionSide, Settings )
-	self:F( CoalitionSide )
+  self:F( CoalitionSide )
 
   if self.MessageType then
     local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
@@ -323,20 +365,22 @@ function MESSAGE:ToCoalition( CoalitionSide, Settings )
     self.MessageCategory = "" -- self.MessageType .. ": "
   end
 
-	if CoalitionSide then
+  if CoalitionSide then
     if self.MessageDuration ~= 0 then
-  		self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
-  		trigger.action.outTextForCoalition( CoalitionSide, self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration, self.ClearScreen )
+      self:T( self.MessageCategory .. self.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ) .. " / " .. self.MessageDuration )
+      trigger.action.outTextForCoalition( CoalitionSide, self.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ), self.MessageDuration, self.ClearScreen )
     end
-	end
-	
-	return self
+  end
+  
+  self.CoalitionSide = CoalitionSide
+  
+  return self
 end
 
---- Sends a MESSAGE to a Coalition if the given Condition is true. 
+--- 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 #boolean Condition Sends the message only if the condition is true. 
+-- @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 )
   self:F( CoalitionSide )
@@ -344,7 +388,7 @@ function MESSAGE:ToCoalitionIf( CoalitionSide, Condition )
   if Condition and Condition == true then
     self:ToCoalition( CoalitionSide )
   end
-  
+
   return self
 end
 
@@ -353,14 +397,16 @@ end
 -- @param Core.Settings#Settings Settings (Optional) Settings for message display.
 -- @return #MESSAGE
 -- @usage
--- -- Send a message created to all players.
--- MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
--- or
--- MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
--- or
--- MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
--- MessageAll:ToAll()
-function MESSAGE:ToAll(Settings)
+--
+--   -- Send a message created to all players.
+--   MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25 ):ToAll()
+--   or
+--   MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25 ):ToAll()
+--   or
+--   MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25 )
+--   MessageAll:ToAll()
+--
+function MESSAGE:ToAll( Settings )
   self:F()
 
   if self.MessageType then
@@ -370,16 +416,16 @@ function MESSAGE:ToAll(Settings)
   end
 
   if self.MessageDuration ~= 0 then
-    self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
-    trigger.action.outText( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration, self.ClearScreen )
+    self:T( self.MessageCategory .. self.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ) .. " / " .. self.MessageDuration )
+    trigger.action.outText( self.MessageCategory .. self.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ), self.MessageDuration, self.ClearScreen )
   end
 
   return self
 end
 
-
 --- Sends a MESSAGE to all players if the given Condition is true.
 -- @param #MESSAGE self
+-- @param #boolean Condition
 -- @return #MESSAGE
 function MESSAGE:ToAllIf( Condition )
 
@@ -387,5 +433,186 @@ function MESSAGE:ToAllIf( Condition )
     self:ToAll()
   end
 
-	return self
+  return self
+end
+
+--- Sends a MESSAGE to DCS log file.
+-- @param #MESSAGE self
+-- @return #MESSAGE self
+function MESSAGE:ToLog()
+
+  env.info(self.MessageCategory .. self.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ))
+
+  return self
+end
+
+--- Sends a MESSAGE to DCS log file if the given Condition is true.
+-- @param #MESSAGE self
+-- @return #MESSAGE self
+function MESSAGE:ToLogIf( Condition )
+  
+  if Condition and Condition == true then
+    env.info(self.MessageCategory .. self.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ))
+  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

@@ -0,0 +1,370 @@
+--- **Core** - Path from A to B.
+--
+-- **Main Features:**
+--
+--    * Path from A to B
+--    * Arbitrary number of points
+--    * Automatically from lines drawtool
+--
+-- ===
+--
+-- ### Author: **funkyfranky**
+-- 
+-- ===
+-- @module Core.Pathline
+-- @image CORE_Pathline.png
+
+
+--- PATHLINE class.
+-- @type PATHLINE
+-- @field #string ClassName Name of the class.
+-- @field #string lid Class id string for output to DCS log file.
+-- @field #string name Name of the path line.
+-- @field #table points List of 3D points defining the path.
+-- @extends Core.Base#BASE
+
+--- *The shortest distance between two points is a straight line.* -- Archimedes
+--
+-- ===
+--
+-- # The PATHLINE Concept
+-- 
+-- List of points defining a path from A to B. The pathline can consist of multiple points. Each point holds the information of its position, the surface type, the land height
+-- and the water depth (if over sea).
+-- 
+-- Line drawings created in the mission editor are automatically registered as pathlines and stored in the MOOSE database.
+-- They can be accessed with the @{#PATHLINE.FindByName) function.
+-- 
+-- # Constructor
+-- 
+-- The @{PATHLINE.New) function creates a new PATHLINE object. This does not hold any points. Points can be added with the @{#PATHLINE.AddPointFromVec2} and @{#PATHLINE.AddPointFromVec3}
+-- 
+-- For a given table of 2D or 3D positions, a new PATHLINE object can be created with the @{#PATHLINE.NewFromVec2Array} or @{#PATHLINE.NewFromVec3Array}, respectively.
+-- 
+-- # Line Drawings
+-- 
+-- The most convenient way to create a pathline is the draw panel feature in the DCS mission editor. You can select "Line" and then "Segments", "Segment" or "Free" to draw your lines.
+-- These line drawings are then automatically added to the MOOSE database as PATHLINE objects and can be retrieved with the @{#PATHLINE.FindByName) function, where the name is the one
+-- you specify in the draw panel.
+-- 
+-- # Mark on F10 map
+-- 
+-- The ponints of the PATHLINE can be marked on the F10 map with the @{#PATHLINE.MarkPoints}(`true`) function. The mark points contain information of the surface type, land height and 
+-- water depth.
+-- 
+-- To remove the marks, use @{#PATHLINE.MarkPoints}(`false`).
+--
+-- @field #PATHLINE
+PATHLINE = {
+  ClassName      = "PATHLINE",
+  lid            =   nil,
+  points         =    {},
+}
+
+--- Point of line.
+-- @type PATHLINE.Point
+-- @field DCS#Vec3 vec3 3D position.
+-- @field DCS#Vec2 vec2 2D position.
+-- @field #number surfaceType Surface type.
+-- @field #number landHeight Land height in meters.
+-- @field #number depth Water depth in meters.
+-- @field #number markerID Marker ID.
+
+
+--- PATHLINE class version.
+-- @field #string version
+PATHLINE.version="0.1.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- TODO list
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+-- TODO: A lot...
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Constructor
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a new PATHLINE object. Points need to be added later.
+-- @param #PATHLINE self
+-- @param #string Name Name of the path.
+-- @return #PATHLINE self
+function PATHLINE:New(Name)
+
+  -- Inherit everything from INTEL class.
+  local self=BASE:Inherit(self, BASE:New()) --#PATHLINE
+  
+  self.name=Name or "Unknown Path"
+
+  self.lid=string.format("PATHLINE %s | ", Name)
+
+  return self
+end
+
+--- Create a new PATHLINE object from a given list of 2D points.
+-- @param #PATHLINE self
+-- @param #string Name Name of the pathline.
+-- @param #table Vec2Array List of DCS#Vec2 points.
+-- @return #PATHLINE self
+function PATHLINE:NewFromVec2Array(Name, Vec2Array)
+
+  local self=PATHLINE:New(Name)
+
+  for i=1,#Vec2Array do
+    self:AddPointFromVec2(Vec2Array[i])
+  end
+
+  return self
+end
+
+--- Create a new PATHLINE object from a given list of 3D points.
+-- @param #PATHLINE self
+-- @param #string Name Name of the pathline.
+-- @param #table Vec3Array List of DCS#Vec3 points.
+-- @return #PATHLINE self
+function PATHLINE:NewFromVec3Array(Name, Vec3Array)
+
+  local self=PATHLINE:New(Name)
+
+  for i=1,#Vec3Array do
+    self:AddPointFromVec3(Vec3Array[i])
+  end
+
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- User functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Find a pathline in the database.
+-- @param #PATHLINE self
+-- @param #string Name The name of the pathline.
+-- @return #PATHLINE self
+function PATHLINE:FindByName(Name)
+  local pathline = _DATABASE:FindPathline(Name)
+  return pathline
+end
+
+
+
+--- Add a point to the path from a given 2D position. The third dimension is determined from the land height.
+-- @param #PATHLINE self
+-- @param DCS#Vec2 Vec2 The 2D vector (x,y) to add.
+-- @return #PATHLINE self
+function PATHLINE:AddPointFromVec2(Vec2)
+
+  if Vec2 then
+  
+    local point=self:_CreatePoint(Vec2)
+
+    table.insert(self.points, point)
+    
+  end
+  
+  return self
+end
+
+--- Add a point to the path from a given 3D position.
+-- @param #PATHLINE self
+-- @param DCS#Vec3 Vec3 The 3D vector (x,y) to add.
+-- @return #PATHLINE self
+function PATHLINE:AddPointFromVec3(Vec3)
+
+  if Vec3 then
+  
+    local point=self:_CreatePoint(Vec3)
+
+    table.insert(self.points, point)
+    
+  end
+  
+  return self
+end
+
+--- Get name of pathline.
+-- @param #PATHLINE self
+-- @return #string Name of the pathline.
+function PATHLINE:GetName()  
+  return self.name
+end
+
+--- Get number of points.
+-- @param #PATHLINE self
+-- @return #number Number of points.
+function PATHLINE:GetNumberOfPoints()
+  local N=#self.points
+  return N
+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 #list <#PATHLINE.Point> List of points.
+function PATHLINE:GetPoints()  
+  return self.points
+end
+
+--- Get 3D points of pathline.
+-- @param #PATHLINE self
+-- @return <DCS#Vec3> List of DCS#Vec3 points.
+function PATHLINE:GetPoints3D()
+
+  local vecs={}
+  
+  for _,_point in pairs(self.points) do
+    local point=_point --#PATHLINE.Point
+    table.insert(vecs, point.vec3)
+  end
+
+  return vecs
+end
+
+--- Get 2D points of pathline.
+-- @param #PATHLINE self
+-- @return <DCS#Vec2> List of DCS#Vec2 points.
+function PATHLINE:GetPoints2D()
+
+  local vecs={}
+  
+  for _,_point in pairs(self.points) do
+    local point=_point --#PATHLINE.Point
+    table.insert(vecs, point.vec2)
+  end
+
+  return vecs
+end
+
+--- Get COORDINATES of pathline. Note that COORDINATE objects are created when calling this function. That does involve deep copy calls and can have an impact on performance if done too often.
+-- @param #PATHLINE self
+-- @return <Core.Point#COORDINATE> List of COORDINATES points.
+function PATHLINE:GetCoordinats()
+
+  local vecs={}
+  
+  for _,_point in pairs(self.points) do
+    local point=_point --#PATHLINE.Point
+    local coord=COORDINATE:NewFromVec3(point.vec3)
+  end
+
+  return vecs
+end
+
+--- Get the n-th point of the pathline.
+-- @param #PATHLINE self
+-- @param #number n The index of the point. Default is the first point.
+-- @return #PATHLINE.Point Point.
+function PATHLINE:GetPointFromIndex(n)
+
+  local N=self:GetNumberOfPoints()
+  
+  n=n or 1
+
+  local point=nil --#PATHLINE.Point
+  
+  if n>=1 and n<=N then
+    point=self.point[n]
+  else
+    self:E(self.lid..string.format("ERROR: No point in pathline for N=%s", tostring(n)))
+  end
+
+  return point
+end
+
+--- Get the 3D position of the n-th point.
+-- @param #PATHLINE self
+-- @param #number n The n-th point.
+-- @return DCS#VEC3 Position in 3D.
+function PATHLINE:GetPoint3DFromIndex(n)
+
+  local point=self:GetPointFromIndex(n)
+  
+  if point then
+    return point.vec3
+  end
+  
+  return nil
+end
+
+--- Get the 2D position of the n-th point.
+-- @param #PATHLINE self
+-- @param #number n The n-th point.
+-- @return DCS#VEC2 Position in 3D.
+function PATHLINE:GetPoint2DFromIndex(n)
+
+  local point=self:GetPointFromIndex(n)
+  
+  if point then
+    return point.vec2
+  end
+  
+  return nil
+end
+
+
+--- Mark points on F10 map.
+-- @param #PATHLINE self
+-- @param #boolean Switch If `true` or nil, set marks. If `false`, remove marks.
+-- @return <DCS#Vec3> List of DCS#Vec3 points.
+function PATHLINE:MarkPoints(Switch)
+  for i,_point in pairs(self.points) do
+    local point=_point --#PATHLINE.Point
+    if Switch==false then
+      
+      if point.markerID then
+        UTILS.RemoveMark(point.markerID, Delay)
+      end
+      
+    else
+    
+      if point.markerID then
+        UTILS.RemoveMark(point.markerID)
+      end
+    
+      point.markerID=UTILS.GetMarkID()
+      
+      local text=string.format("Pathline %s: Point #%d\nSurface Type=%d\nHeight=%.1f m\nDepth=%.1f m", self.name, i, point.surfaceType, point.landHeight, point.depth)
+      
+      trigger.action.markToAll(point.markerID, text, point.vec3, "")
+    
+    end
+  end
+end
+
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Private functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Get 3D points of pathline.
+-- @param #PATHLINE self
+-- @param DCS#Vec3 Vec Position vector. Can also be a DCS#Vec2 in which case the altitude at landheight is taken.
+-- @return #PATHLINE.Point
+function PATHLINE:_CreatePoint(Vec)
+
+  local point={} --#PATHLINE.Point
+
+  if Vec.z then
+    -- Given vec is 3D
+    point.vec3=UTILS.DeepCopy(Vec)
+    point.vec2={x=Vec.x, y=Vec.z}
+  else
+    -- Given vec is 2D  
+    point.vec2=UTILS.DeepCopy(Vec)
+    point.vec3={x=Vec.x, y=land.getHeight(Vec), z=Vec.y}
+  end
+
+  -- Get surface type.
+  point.surfaceType=land.getSurfaceType(point.vec2)
+  
+  -- Get land height and depth.
+  point.landHeight, point.depth=land.getSurfaceHeightWithSeabed(point.vec2)
+  
+  point.markerID=nil
+
+  return point
+end
+
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Core/Report.lua

@@ -1,13 +1,13 @@
 --- **Core** - Provides a handy means to create messages and reports.
 --
 -- ===
--- 
+--
 -- ## Features:
--- 
+--
 --   * Create text blocks that are formatted.
 --   * Create automatic indents.
 --   * Variate the delimiters between reporting lines.
--- 
+--
 -- ===
 --
 -- ### Authors: FlightControl : Design & Programming
@@ -15,7 +15,6 @@
 -- @module Core.Report
 -- @image Core_Report.JPG
 
-
 --- @type REPORT
 -- @extends Core.Base#BASE
 
@@ -36,7 +35,7 @@ function REPORT:New( Title )
 
   self.Report = {}
 
-  self:SetTitle( Title or "" )  
+  self:SetTitle( Title or "" )
   self:SetIndent( 3 )
 
   return self
@@ -45,28 +44,26 @@ end
 --- Has the REPORT Text?
 -- @param #REPORT self
 -- @return #boolean
-function REPORT:HasText() --R2.1
-  
+function REPORT:HasText() -- R2.1
+
   return #self.Report > 0
 end
 
-
 --- Set indent of a REPORT.
 -- @param #REPORT self
 -- @param #number Indent
 -- @return #REPORT
-function REPORT:SetIndent( Indent ) --R2.1
+function REPORT:SetIndent( Indent ) -- R2.1
   self.Indent = Indent
   return self
 end
 
-
 --- Add a new line to a REPORT.
 -- @param #REPORT self
 -- @param #string Text
 -- @return #REPORT
 function REPORT:Add( Text )
-  self.Report[#self.Report+1] = Text
+  self.Report[#self.Report + 1] = Text
   return self
 end
 
@@ -76,17 +73,17 @@ end
 -- @param #string Separator (optional) The start of each report line can begin with an optional separator character. This can be a "-", or "#", or "*". You're free to choose what you find the best.
 -- @return #REPORT
 function REPORT:AddIndent( Text, Separator )
-  self.Report[#self.Report+1] = ( ( Separator and Separator .. string.rep( " ", self.Indent - 1 ) ) or string.rep(" ", self.Indent ) ) .. Text:gsub("\n","\n"..string.rep( " ", self.Indent ) )
+  self.Report[#self.Report + 1] = ((Separator and Separator .. string.rep( " ", self.Indent - 1 )) or string.rep( " ", self.Indent )) .. Text:gsub( "\n", "\n" .. string.rep( " ", self.Indent ) )
   return self
 end
 
---- Produces the text of the report, taking into account an optional delimeter, which is \n by default.
+--- Produces the text of the report, taking into account an optional delimiter, which is \n by default.
 -- @param #REPORT self
 -- @param #string Delimiter (optional) A delimiter text.
 -- @return #string The report text.
 function REPORT:Text( Delimiter )
   Delimiter = Delimiter or "\n"
-  local ReportText = ( self.Title ~= "" and self.Title .. Delimiter or self.Title ) .. table.concat( self.Report, Delimiter ) or ""
+  local ReportText = (self.Title ~= "" and self.Title .. Delimiter or self.Title) .. table.concat( self.Report, Delimiter ) or ""
   return ReportText
 end
 
@@ -95,7 +92,7 @@ end
 -- @param #string Title The title of the report.
 -- @return #REPORT
 function REPORT:SetTitle( Title )
-  self.Title = Title  
+  self.Title = Title
   return self
 end
 

Moose Development/Moose/Core/ScheduleDispatcher.lua

@@ -1,36 +1,36 @@
---- **Core** -- SCHEDULEDISPATCHER dispatches the different schedules.
--- 
+--- **Core** - SCHEDULEDISPATCHER dispatches the different schedules.
+--
 -- ===
--- 
+--
 -- Takes care of the creation and dispatching of scheduled functions for SCHEDULER objects.
--- 
+--
 -- This class is tricky and needs some thorough explanation.
 -- SCHEDULE classes are used to schedule functions for objects, or as persistent objects.
 -- The SCHEDULEDISPATCHER class ensures that:
--- 
+--
 --   - Scheduled functions are planned according the SCHEDULER object parameters.
 --   - Scheduled functions are repeated when requested, according the SCHEDULER object parameters.
 --   - Scheduled functions are automatically removed when the schedule is finished, according the SCHEDULER object parameters.
--- 
+--
 -- The SCHEDULEDISPATCHER class will manage SCHEDULER object in memory during garbage collection:
--- 
+--
 --   - When a SCHEDULER object is not attached to another object (that is, it's first :Schedule() parameter is nil), then the SCHEDULER object is _persistent_ within memory.
 --   - When a SCHEDULER object *is* attached to another object, then the SCHEDULER object is _not persistent_ within memory after a garbage collection!
---   
--- The none persistency of SCHEDULERS attached to objects is required to allow SCHEDULER objects to be garbage collectged, when the parent object is also desroyed or nillified and garbage collected.
--- Even when there are pending timer scheduled functions to be executed for the SCHEDULER object,  
+--
+-- The non-persistency of SCHEDULERS attached to objects is required to allow SCHEDULER objects to be garbage collected when the parent object is destroyed, or set to nil and garbage collected.
+-- Even when there are pending timer scheduled functions to be executed for the SCHEDULER object,
 -- these will not be executed anymore when the SCHEDULER object has been destroyed.
--- 
+--
 -- The SCHEDULEDISPATCHER allows multiple scheduled functions to be planned and executed for one SCHEDULER object.
 -- The SCHEDULER object therefore keeps a table of "CallID's", which are returned after each planning of a new scheduled function by the SCHEDULEDISPATCHER.
--- The SCHEDULER object plans new scheduled functions through the @{Core.Scheduler#SCHEDULER.Schedule}() method. 
+-- The SCHEDULER object plans new scheduled functions through the @{Core.Scheduler#SCHEDULER.Schedule}() method.
 -- The Schedule() method returns the CallID that is the reference ID for each planned schedule.
--- 
+--
 -- ===
--- 
+--
 -- ### Contributions: -
 -- ### Authors: FlightControl : Design & Programming
--- 
+--
 -- @module Core.ScheduleDispatcher
 -- @image Core_Schedule_Dispatcher.JPG
 
@@ -38,7 +38,7 @@
 -- @type SCHEDULEDISPATCHER
 -- @field #string ClassName Name of the class.
 -- @field #number CallID Call ID counter.
--- @field #table PersistentSchedulers Persistant schedulers.
+-- @field #table PersistentSchedulers Persistent schedulers.
 -- @field #table ObjectSchedulers Schedulers that only exist as long as the master object exists.
 -- @field #table Schedule Meta table setmetatable( {}, { __mode = "k" } ).
 -- @extends Core.Base#BASE
@@ -46,11 +46,11 @@
 --- The SCHEDULEDISPATCHER structure
 -- @type SCHEDULEDISPATCHER
 SCHEDULEDISPATCHER = {
-  ClassName            = "SCHEDULEDISPATCHER",
-  CallID               =   0,
-  PersistentSchedulers =  {},
-  ObjectSchedulers     =  {},
-  Schedule             = nil,
+  ClassName = "SCHEDULEDISPATCHER",
+  CallID = 0,
+  PersistentSchedulers = {},
+  ObjectSchedulers = {},
+  Schedule = nil,
 }
 
 --- Player data table holding all important parameters of each player.
@@ -58,7 +58,7 @@ SCHEDULEDISPATCHER = {
 -- @field #function Function The schedule function to be called.
 -- @field #table Arguments Schedule function arguments.
 -- @field #number Start Start time in seconds.
--- @field #number Repeat Repeat time intervall in seconds.
+-- @field #number Repeat Repeat time interval in seconds.
 -- @field #number Randomize Randomization factor [0,1].
 -- @field #number Stop Stop time in seconds.
 -- @field #number StartTime Time in seconds when the scheduler is created.
@@ -77,7 +77,7 @@ end
 
 --- Add a Schedule to the ScheduleDispatcher.
 -- The development of this method was really tidy.
--- It is constructed as such that a garbage collection is executed on the weak tables, when the Scheduler is nillified.
+-- It is constructed as such that a garbage collection is executed on the weak tables, when the Scheduler is set to nil.
 -- Nothing of this code should be modified without testing it thoroughly.
 -- @param #SCHEDULEDISPATCHER self
 -- @param Core.Scheduler#SCHEDULER Scheduler Scheduler object.
@@ -85,7 +85,7 @@ end
 -- @param #table ScheduleArguments Table of arguments passed to the ScheduleFunction.
 -- @param #number Start Start time in seconds.
 -- @param #number Repeat Repeat interval in seconds.
--- @param #number Randomize Radomization factor [0,1].
+-- @param #number Randomize Randomization factor [0,1].
 -- @param #number Stop Stop time in seconds.
 -- @param #number TraceLevel Trace level [0,3].
 -- @param Core.Fsm#FSM Fsm Finite state model.
@@ -95,32 +95,32 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
 
   -- Increase counter.
   self.CallID = self.CallID + 1
-  
+
   -- Create ID.
-  local CallID = self.CallID .. "#" .. ( Scheduler.MasterObject and Scheduler.MasterObject.GetClassNameAndID and Scheduler.MasterObject:GetClassNameAndID() or "" ) or ""
-  
-  self:T2(string.format("Adding schedule #%d CallID=%s", self.CallID, CallID))
+  local CallID = self.CallID .. "#" .. (Scheduler.MasterObject and Scheduler.MasterObject.GetClassNameAndID and Scheduler.MasterObject:GetClassNameAndID() or "") or ""
+
+  self:T2( string.format( "Adding schedule #%d CallID=%s", self.CallID, CallID ) )
 
   -- Initialize PersistentSchedulers
   self.PersistentSchedulers = self.PersistentSchedulers or {}
 
   -- Initialize the ObjectSchedulers array, which is a weakly coupled table.
   -- If the object used as the key is nil, then the garbage collector will remove the item from the Functions array.
-  self.ObjectSchedulers = self.ObjectSchedulers or setmetatable( {}, { __mode = "v" } ) 
-  
+  self.ObjectSchedulers = self.ObjectSchedulers or setmetatable( {}, { __mode = "v" } )
+
   if Scheduler.MasterObject then
     --env.info("FF Object Scheduler")
     self.ObjectSchedulers[CallID] = Scheduler
-    self:F3( { CallID = CallID, ObjectScheduler = tostring(self.ObjectSchedulers[CallID]), MasterObject = tostring(Scheduler.MasterObject) } )
+    self:F3( { CallID = CallID, ObjectScheduler = tostring( self.ObjectSchedulers[CallID] ), MasterObject = tostring( Scheduler.MasterObject ) } )
   else
     --env.info("FF Persistent Scheduler")
     self.PersistentSchedulers[CallID] = Scheduler
     self:F3( { CallID = CallID, PersistentScheduler = self.PersistentSchedulers[CallID] } )
   end
-  
+
   self.Schedule = self.Schedule or setmetatable( {}, { __mode = "k" } )
   self.Schedule[Scheduler] = self.Schedule[Scheduler] or {}
-  self.Schedule[Scheduler][CallID] = {}  --#SCHEDULEDISPATCHER.ScheduleData
+  self.Schedule[Scheduler][CallID] = {} -- #SCHEDULEDISPATCHER.ScheduleData
   self.Schedule[Scheduler][CallID].Function = ScheduleFunction
   self.Schedule[Scheduler][CallID].Arguments = ScheduleArguments
   self.Schedule[Scheduler][CallID].StartTime = timer.getTime() + ( Start or 0 )
@@ -128,8 +128,7 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
   self.Schedule[Scheduler][CallID].Repeat = Repeat or 0
   self.Schedule[Scheduler][CallID].Randomize = Randomize or 0
   self.Schedule[Scheduler][CallID].Stop = Stop
-  
-  
+
   -- This section handles the tracing of the scheduled calls.
   -- Because these calls will be executed with a delay, we inspect the place where these scheduled calls are initiated.
   -- The Info structure contains the output of the debug.getinfo() calls, which inspects the call stack for the function name, line number and source name.
@@ -151,10 +150,10 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
   -- Therefore, in the call stack, at the TraceLevel these functions are mentioned as "tail calls", and the Info.name field will be nil as a result.
   -- To obtain the correct function name for FSM object calls, the function is mentioned in the call stack at a higher stack level.
   -- So when function name stored in Info.name is nil, then I inspect the function name within the call stack one level higher.
-  -- So this little piece of code does its magic wonderfully, preformance overhead is neglectible, as scheduled calls don't happen that often.
+  -- So this little piece of code does its magic wonderfully, performance overhead is negligible, as scheduled calls don't happen that often.
 
   local Info = {}
-  
+
   if debug then
     TraceLevel = TraceLevel or 2
     Info = debug.getinfo( TraceLevel, "nlS" )
@@ -168,7 +167,7 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
 
   --- Function passed to the DCS timer.scheduleFunction()
   self.Schedule[Scheduler][CallID].CallHandler = function( Params )
-    
+
     local CallID = Params.CallID
     local Info = Params.Info or {}
     local Source = Info.source or "?"
@@ -182,27 +181,27 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
       end
       return errmsg
     end
-    
-    -- Get object or persistant scheduler object.
-    local Scheduler = self.ObjectSchedulers[CallID]  --Core.Scheduler#SCHEDULER
+
+    -- Get object or persistent scheduler object.
+    local Scheduler = self.ObjectSchedulers[CallID] -- Core.Scheduler#SCHEDULER
     if not Scheduler then
       Scheduler = self.PersistentSchedulers[CallID]
     end
-    
-    --self:T3( { Scheduler = Scheduler } )
-    
+
+    -- self:T3( { Scheduler = Scheduler } )
+
     if Scheduler then
 
-      local MasterObject = tostring(Scheduler.MasterObject)
-      
-      -- Schedule object.
-      local Schedule = self.Schedule[Scheduler][CallID]  --#SCHEDULEDISPATCHER.ScheduleData
-      
-      --self:T3( { Schedule = Schedule } )
+      local MasterObject = tostring( Scheduler.MasterObject )
 
-      local SchedulerObject = Scheduler.MasterObject --Scheduler.SchedulerObject Now is this the Maste or Scheduler object?
+      -- Schedule object.
+      local Schedule = self.Schedule[Scheduler][CallID] -- #SCHEDULEDISPATCHER.ScheduleData
+
+      -- self:T3( { Schedule = Schedule } )
+
+      local SchedulerObject = Scheduler.MasterObject -- Scheduler.SchedulerObject Now is this the Master or Scheduler object?
       local ShowTrace       = Scheduler.ShowTrace
-      
+
       local ScheduleFunction  = Schedule.Function
       local ScheduleArguments = Schedule.Arguments or {}
       local Start             = Schedule.Start
@@ -210,12 +209,11 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
       local Randomize         = Schedule.Randomize or 0
       local Stop              = Schedule.Stop or 0
       local ScheduleID        = Schedule.ScheduleID
-      
-      
-      local Prefix = ( Repeat == 0 ) and "--->" or "+++>"
-      
+
+      local Prefix = (Repeat == 0) and "--->" or "+++>"
+
       local Status, Result
-      --self:E( { SchedulerObject = SchedulerObject } )
+      -- self:E( { SchedulerObject = SchedulerObject } )
       if SchedulerObject then
         local function Timer()
           if ShowTrace then
@@ -230,40 +228,39 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
           if ShowTrace then
             self:T( Prefix .. Name .. ":" .. Line .. " (" .. Source .. ")" )
           end
-          return ScheduleFunction( unpack( ScheduleArguments ) ) 
+          return ScheduleFunction( unpack( ScheduleArguments ) )
         end
         Status, Result = xpcall( Timer, ErrorHandler )
       end
-      
+
       local CurrentTime = timer.getTime()
       local StartTime = Schedule.StartTime
 
       -- Debug info.
-      self:F3( { CallID=CallID, ScheduleID=ScheduleID, Master = MasterObject, CurrentTime = CurrentTime, StartTime = StartTime, Start = Start, Repeat = Repeat, Randomize = Randomize, Stop = Stop } )
-      
-      
-      if Status and (( Result == nil ) or ( Result and Result ~= false ) ) then
-      
-        if Repeat ~= 0 and ( ( Stop == 0 ) or ( Stop ~= 0 and CurrentTime <= StartTime + Stop ) ) then
-          local ScheduleTime = CurrentTime + Repeat + math.random(- ( Randomize * Repeat / 2 ), ( Randomize * Repeat  / 2 )) + 0.0001  -- Accuracy
-          --self:T3( { Repeat = CallID, CurrentTime, ScheduleTime, ScheduleArguments } )
+      self:F3( { CallID = CallID, ScheduleID = ScheduleID, Master = MasterObject, CurrentTime = CurrentTime, StartTime = StartTime, Start = Start, Repeat = Repeat, Randomize = Randomize, Stop = Stop } )
+
+      if Status and ((Result == nil) or (Result and Result ~= false)) then
+
+        if Repeat ~= 0 and ((Stop == 0) or (Stop ~= 0 and CurrentTime <= StartTime + Stop)) then
+          local ScheduleTime = CurrentTime + Repeat + math.random( -(Randomize * Repeat / 2), (Randomize * Repeat / 2) ) + 0.0001 -- Accuracy
+          -- self:T3( { Repeat = CallID, CurrentTime, ScheduleTime, ScheduleArguments } )
           return ScheduleTime -- returns the next time the function needs to be called.
         else
           self:Stop( Scheduler, CallID )
         end
-        
+
       else
         self:Stop( Scheduler, CallID )
       end
     else
       self:I( "<<<>" .. Name .. ":" .. Line .. " (" .. Source .. ")" )
     end
-    
+
     return nil
   end
-  
+
   self:Start( Scheduler, CallID, Info )
-  
+
   return CallID
 end
 
@@ -287,33 +284,33 @@ end
 -- @param #string Info (Optional) Debug info.
 function SCHEDULEDISPATCHER:Start( Scheduler, CallID, Info )
   self:F2( { Start = CallID, Scheduler = Scheduler } )
-  
+
   if CallID then
-  
-    local Schedule = self.Schedule[Scheduler][CallID] --#SCHEDULEDISPATCHER.ScheduleData
-    
+
+    local Schedule = self.Schedule[Scheduler][CallID] -- #SCHEDULEDISPATCHER.ScheduleData
+
     -- Only start when there is no ScheduleID defined!
     -- This prevents to "Start" the scheduler twice with the same CallID...
     if not Schedule.ScheduleID then
-    
+
       -- Current time in seconds.
-      local Tnow=timer.getTime()
-    
-      Schedule.StartTime = Tnow  -- Set the StartTime field to indicate when the scheduler started.
-            
+      local Tnow = timer.getTime()
+
+      Schedule.StartTime = Tnow -- Set the StartTime field to indicate when the scheduler started.
+
       -- Start DCS schedule function https://wiki.hoggitworld.com/view/DCS_func_scheduleFunction
-      Schedule.ScheduleID = timer.scheduleFunction(Schedule.CallHandler, { CallID = CallID, Info = Info }, Tnow + Schedule.Start)
-      
-      self:T(string.format("Starting scheduledispatcher Call ID=%s ==> Schedule ID=%s", tostring(CallID), tostring(Schedule.ScheduleID)))
+      Schedule.ScheduleID = timer.scheduleFunction( Schedule.CallHandler, { CallID = CallID, Info = Info }, Tnow + Schedule.Start )
+
+      self:T( string.format( "Starting SCHEDULEDISPATCHER Call ID=%s ==> Schedule ID=%s", tostring( CallID ), tostring( Schedule.ScheduleID ) ) )
     end
-    
+
   else
-  
+
     -- Recursive.
     for CallID, Schedule in pairs( self.Schedule[Scheduler] or {} ) do
       self:Start( Scheduler, CallID, Info ) -- Recursive
     end
-    
+
   end
 end
 
@@ -325,29 +322,29 @@ function SCHEDULEDISPATCHER:Stop( Scheduler, CallID )
   self:F2( { Stop = CallID, Scheduler = Scheduler } )
 
   if CallID then
-  
-    local Schedule = self.Schedule[Scheduler][CallID] --#SCHEDULEDISPATCHER.ScheduleData
-    
+
+    local Schedule = self.Schedule[Scheduler][CallID] -- #SCHEDULEDISPATCHER.ScheduleData
+
     -- Only stop when there is a ScheduleID defined for the CallID. So, when the scheduler was stopped before, do nothing.
     if Schedule.ScheduleID then
-    
-      self:T(string.format("scheduledispatcher stopping scheduler CallID=%s, ScheduleID=%s", tostring(CallID), tostring(Schedule.ScheduleID)))
-    
+
+      self:T( string.format( "SCHEDULEDISPATCHER stopping scheduler CallID=%s, ScheduleID=%s", tostring( CallID ), tostring( Schedule.ScheduleID ) ) )
+
       -- Remove schedule function https://wiki.hoggitworld.com/view/DCS_func_removeFunction
-      timer.removeFunction(Schedule.ScheduleID)
-      
+      timer.removeFunction( Schedule.ScheduleID )
+
       Schedule.ScheduleID = nil
-      
+
     else
-      self:T(string.format("Error no ScheduleID for CallID=%s", tostring(CallID)))
+      self:T( string.format( "Error no ScheduleID for CallID=%s", tostring( CallID ) ) )
     end
-    
+
   else
-  
+
     for CallID, Schedule in pairs( self.Schedule[Scheduler] or {} ) do
       self:Stop( Scheduler, CallID ) -- Recursive
     end
-    
+
   end
 end
 
@@ -362,7 +359,7 @@ function SCHEDULEDISPATCHER:Clear( Scheduler )
   end
 end
 
---- Shopw tracing info.
+--- Show tracing info.
 -- @param #SCHEDULEDISPATCHER self
 -- @param Core.Scheduler#SCHEDULER Scheduler Scheduler object.
 function SCHEDULEDISPATCHER:ShowTrace( Scheduler )

Moose Development/Moose/Core/Scheduler.lua

@@ -3,39 +3,39 @@
 -- ===
 -- 
 -- ## Features:
--- 
+--
 --   * Schedule functions over time,
---   * optionally in an optional specified time interval, 
---   * optionally **repeating** with a specified time repeat interval, 
---   * optionally **randomizing** with a specified time interval randomization factor, 
---   * optionally **stop** the repeating after a specified time interval. 
+--   * optionally in an optional specified time interval,
+--   * optionally **repeating** with a specified time repeat interval,
+--   * optionally **randomizing** with a specified time interval randomization factor,
+--   * optionally **stop** the repeating after a specified time interval.
 --
 -- ===
--- 
+--
 -- # Demo Missions
 -- 
--- ### [SCHEDULER Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/SCH%20-%20Scheduler)
+-- ### [SCHEDULER Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SCH%20-%20Scheduler)
 -- 
 -- ### [SCHEDULER Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SCH%20-%20Scheduler)
 --
 -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
--- 
--- ===
--- 
--- # YouTube Channel
--- 
--- ### [SCHEDULER YouTube Channel (none)]()
--- 
+--
 -- ===
 --
--- ### Contributions: 
--- 
+-- # YouTube Channel
+--
+-- ### [SCHEDULER YouTube Channel (none)]()
+--
+-- ===
+--
+-- ### Contributions:
+--
 --   * FlightControl : Concept & Testing
--- 
--- ### Authors: 
--- 
+--
+-- ### Authors:
+--
 --   * FlightControl : Design & Programming
--- 
+--
 -- ===
 --
 -- @module Core.Scheduler
@@ -48,62 +48,61 @@
 -- @field #boolean ShowTrace Trace info if true.
 -- @extends Core.Base#BASE
 
-
 --- Creates and handles schedules over time, which allow to execute code at specific time intervals with randomization.
--- 
+--
 -- 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
--- 
+--
 -- The SCHEDULER class is quite easy to use, but note that the New constructor has variable parameters:
--- 
+--
 -- The @{#SCHEDULER.New}() method returns 2 variables:
---   
+--
 --  1. The SCHEDULER object reference.
 --  2. The first schedule planned in the SCHEDULER object.
--- 
+--
 -- To clarify the different appliances, lets have a look at the following examples: 
---  
+--
 -- ### Construct a SCHEDULER object without a persistent schedule.
--- 
+--
 --   * @{#SCHEDULER.New}( nil ): Setup a new SCHEDULER object, which is persistently executed after garbage collection.
--- 
+--
 --     MasterObject = SCHEDULER:New()
 --     SchedulerID = MasterObject:Schedule( nil, ScheduleFunction, {} )
--- 
+--
 -- The above example creates a new MasterObject, but does not schedule anything.
 -- A separate schedule is created by using the MasterObject using the method :Schedule..., which returns a ScheduleID
--- 
+--
 -- ### Construct a SCHEDULER object without a volatile schedule, but volatile to the Object existence...
--- 
---   * @{#SCHEDULER.New}( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is nillified or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.
--- 
+--
+--   * @{#SCHEDULER.New}( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is set to nil or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.
+--
 --     ZoneObject = ZONE:New( "ZoneName" )
 --     MasterObject = SCHEDULER:New( ZoneObject )
 --     SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {} )
 --     ...
 --     ZoneObject = nil
 --     garbagecollect()
--- 
+--
 -- The above example creates a new MasterObject, but does not schedule anything, and is bound to the existence of ZoneObject, which is a ZONE.
 -- A separate schedule is created by using the MasterObject using the method :Schedule()..., which returns a ScheduleID
 -- Later in the logic, the ZoneObject is put to nil, and garbage is collected.
 -- As a result, the MasterObject will cancel any planned schedule.
---      
+--
 -- ### Construct a SCHEDULER object with a persistent schedule.
--- 
+--
 --   * @{#SCHEDULER.New}( nil, Function, FunctionArguments, Start, ... ): Setup a new persistent SCHEDULER object, and start a new schedule for the Function with the defined FunctionArguments according the Start and sequent parameters.
---   
+--
 --     MasterObject, SchedulerID = SCHEDULER:New( nil, ScheduleFunction, {} )
---     
+--
 -- The above example creates a new MasterObject, and does schedule the first schedule as part of the call.
 -- Note that 2 variables are returned here: MasterObject, ScheduleID...
---   
+--
 -- ### Construct a SCHEDULER object without a schedule, but volatile to the Object existence...
--- 
+--
 --   * @{#SCHEDULER.New}( Object, Function, FunctionArguments, Start, ... ): Setup a new SCHEDULER object, linked to Object, and start a new schedule for the Function with the defined FunctionArguments according the Start and sequent parameters.
 --
 --     ZoneObject = ZONE:New( "ZoneName" )
@@ -112,13 +111,13 @@
 --     ...
 --     ZoneObject = nil
 --     garbagecollect()
---     
+--
 -- The above example creates a new MasterObject, and schedules a method call (ScheduleFunction), 
 -- and is bound to the existence of ZoneObject, which is a ZONE object (ZoneObject).
 -- Both a MasterObject and a SchedulerID variable are returned.
 -- Later in the logic, the ZoneObject is put to nil, and garbage is collected.
 -- As a result, the MasterObject will cancel the planned schedule.
---  
+--
 -- ## SCHEDULER timer stopping and (re-)starting.
 --
 -- The SCHEDULER can be stopped and restarted with the following methods:
@@ -133,70 +132,70 @@
 --     MasterObject:Stop( SchedulerID )
 --     ...
 --     MasterObject:Start( SchedulerID )
---     
+--
 -- The above example creates a new MasterObject, and does schedule the first schedule as part of the call.
--- Note that 2 variables are returned here: MasterObject, ScheduleID...  
--- Later in the logic, the repeating schedule with SchedulerID is stopped.  
--- A bit later, the repeating schedule with SchedulerId is (re)-started.  
--- 
+-- Note that 2 variables are returned here: MasterObject, ScheduleID...
+-- Later in the logic, the repeating schedule with SchedulerID is stopped.
+-- A bit later, the repeating schedule with SchedulerId is (re)-started.
+--
 -- ## Create a new schedule
--- 
--- With the method @{#SCHEDULER.Schedule}() a new time event can be scheduled. 
+--
+-- With the method @{#SCHEDULER.Schedule}() a new time event can be scheduled.
 -- This method is used by the :New() constructor when a new schedule is planned.
--- 
+--
 -- Consider the following code fragment of the SCHEDULER object creation.
--- 
+--
 --     ZoneObject = ZONE:New( "ZoneName" )
 --     MasterObject = SCHEDULER:New( ZoneObject )
--- 
--- Several parameters can be specified that influence the behaviour of a Schedule.
--- 
+--
+-- Several parameters can be specified that influence the behavior of a Schedule.
+--
 -- ### A single schedule, immediately executed
--- 
+--
 --     SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {} )
--- 
--- The above example schedules a new ScheduleFunction call to be executed asynchronously, within milleseconds ...
--- 
+--
+-- The above example schedules a new ScheduleFunction call to be executed asynchronously, within milliseconds ...
+--
 -- ### A single schedule, planned over time
--- 
+--
 --     SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10 )
---     
+--
 -- The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds ...
--- 
+--
 -- ### A schedule with a repeating time interval, planned over time
--- 
+--
 --     SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60 )
---     
--- The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, 
+--
+-- The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds,
 -- and repeating 60 every seconds ...
--- 
+--
 -- ### A schedule with a repeating time interval, planned over time, with time interval randomization
--- 
+--
 --     SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5 )
---     
--- The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, 
+--
+-- The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds,
 -- and repeating 60 seconds, with a 50% time interval randomization ...
--- So the repeating time interval will be randomized using the **0.5**,  
--- and will calculate between **60 - ( 60 * 0.5 )** and **60 + ( 60 * 0.5 )** for each repeat, 
+-- So the repeating time interval will be randomized using the **0.5**,
+-- and will calculate between **60 - ( 60 * 0.5 )** and **60 + ( 60 * 0.5 )** for each repeat,
 -- which is in this example between **30** and **90** seconds.
--- 
+--
 -- ### A schedule with a repeating time interval, planned over time, with time interval randomization, and stop after a time interval
--- 
+--
 --     SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5, 300 )
---     
--- The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, 
+--
+-- The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds,
 -- The schedule will repeat every 60 seconds.
--- So the repeating time interval will be randomized using the **0.5**,  
--- and will calculate between **60 - ( 60 * 0.5 )** and **60 + ( 60 * 0.5 )** for each repeat, 
+-- So the repeating time interval will be randomized using the **0.5**,
+-- and will calculate between **60 - ( 60 * 0.5 )** and **60 + ( 60 * 0.5 )** for each repeat,
 -- which is in this example between **30** and **90** seconds.
 -- The schedule will stop after **300** seconds.
--- 
+--
 -- @field #SCHEDULER
 SCHEDULER = {
-  ClassName       = "SCHEDULER",
-  Schedules       = {},
-  MasterObject    = nil,
-  ShowTrace       = nil,
+  ClassName = "SCHEDULER",
+  Schedules = {},
+  MasterObject = nil,
+  ShowTrace = nil,
 }
 
 --- SCHEDULER constructor.
@@ -209,17 +208,17 @@ 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
   self:F2( { Start, Repeat, RandomizeFactor, Stop } )
 
   local ScheduleID = nil
-  
+
   self.MasterObject = MasterObject
   self.ShowTrace = false
-  
+
   if SchedulerFunction then
     ScheduleID = self:Schedule( MasterObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop, 3 )
   end
@@ -235,7 +234,7 @@ end
 -- @param #number Start Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
 -- @param #number Repeat Specifies the time interval in seconds when the scheduler will call the event function.
 -- @param #number RandomizeFactor Specifies a randomization factor between 0 and 1 to randomize the Repeat.
--- @param #number Stop Time interval in seconds after which the scheduler will be stoppe.
+-- @param #number Stop Time interval in seconds after which the scheduler will be stopped.
 -- @param #number TraceLevel Trace level [0,3]. Default 3.
 -- @param Core.Fsm#FSM Fsm Finite state model.
 -- @return #string The Schedule ID of the planned schedule.
@@ -245,28 +244,27 @@ function SCHEDULER:Schedule( MasterObject, SchedulerFunction, SchedulerArguments
 
   -- Debug info.
   local ObjectName = "-"
-  if MasterObject and MasterObject.ClassName and MasterObject.ClassID then 
+  if MasterObject and MasterObject.ClassName and MasterObject.ClassID then
     ObjectName = MasterObject.ClassName .. MasterObject.ClassID
   end
-  self:F3( { "Schedule :", ObjectName, tostring( MasterObject ),  Start, Repeat, RandomizeFactor, Stop } )
-  
+  self:F3( { "Schedule :", ObjectName, tostring( MasterObject ), Start, Repeat, RandomizeFactor, Stop } )
+
   -- Set master object.
   self.MasterObject = MasterObject
-  
+
   -- Add schedule.
-  local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule( 
-    self, 
-    SchedulerFunction,
-    SchedulerArguments,
-    Start,
-    Repeat,
-    RandomizeFactor,
-    Stop,
-    TraceLevel or 3,
-    Fsm
-  )
-  
-  self.Schedules[#self.Schedules+1] = ScheduleID
+  local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule( self,
+                                                      SchedulerFunction,
+                                                      SchedulerArguments,
+                                                      Start,
+                                                      Repeat,
+                                                      RandomizeFactor,
+                                                      Stop,
+                                                      TraceLevel or 3,
+                                                      Fsm
+                                                    )
+
+  self.Schedules[#self.Schedules + 1] = ScheduleID
 
   return ScheduleID
 end
@@ -276,7 +274,7 @@ end
 -- @param #string ScheduleID (Optional) The Schedule ID of the planned (repeating) schedule.
 function SCHEDULER:Start( ScheduleID )
   self:F3( { ScheduleID } )
-  self:T(string.format("Starting scheduler ID=%s", tostring(ScheduleID)))
+  self:T( string.format( "Starting scheduler ID=%s", tostring( ScheduleID ) ) )
   _SCHEDULEDISPATCHER:Start( self, ScheduleID )
 end
 
@@ -285,7 +283,7 @@ end
 -- @param #string ScheduleID (Optional) The ScheduleID of the planned (repeating) schedule.
 function SCHEDULER:Stop( ScheduleID )
   self:F3( { ScheduleID } )
-  self:T(string.format("Stopping scheduler ID=%s", tostring(ScheduleID)))
+  self:T( string.format( "Stopping scheduler ID=%s", tostring( ScheduleID ) ) )
   _SCHEDULEDISPATCHER:Stop( self, ScheduleID )
 end
 
@@ -294,15 +292,15 @@ end
 -- @param #string ScheduleID (optional) The ScheduleID of the planned (repeating) schedule.
 function SCHEDULER:Remove( ScheduleID )
   self:F3( { ScheduleID } )
-  self:T(string.format("Removing scheduler ID=%s", tostring(ScheduleID)))
+  self:T( string.format( "Removing scheduler ID=%s", tostring( ScheduleID ) ) )
   _SCHEDULEDISPATCHER:RemoveSchedule( self, ScheduleID )
 end
 
 --- Clears all pending schedules.
 -- @param #SCHEDULER self
 function SCHEDULER:Clear()
-  self:F3( )
-  self:T(string.format("Clearing scheduler"))
+  self:F3()
+  self:T( string.format( "Clearing scheduler" ) )
   _SCHEDULEDISPATCHER:Clear( self )
 end
 

Moose Development/Moose/Core/Settings.lua

@@ -1,4 +1,4 @@
---- **Core** - Manages various settings for running missions, consumed by moose classes and provides a menu system for players to tweak settings in running missions.
+--- **Core** - Manages various settings for missions, providing a menu for players to tweak settings in running missions.
 --
 -- ===
 --
@@ -29,15 +29,14 @@
 -- @module Core.Settings
 -- @image Core_Settings.JPG
 
-
 --- @type SETTINGS
 -- @extends Core.Base#BASE
 
---- Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
+--- Takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework.
 --
 -- ===
 --
--- The SETTINGS class takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
+-- The SETTINGS class takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework.
 -- SETTINGS can work on 2 levels:
 --
 --   - **Default settings**: A running mission has **Default settings**.
@@ -59,7 +58,7 @@
 --
 -- A menu is created automatically per Command Center that allows to modify the **Default** settings.
 -- So, when joining a CC unit, a menu will be available that allows to change the settings parameters **FOR ALL THE PLAYERS**!
--- Note that the **Default settings** will only be used when a player has not choosen its own settings.
+-- Note that the **Default settings** will only be used when a player has not chosen its own settings.
 --
 -- ## 2.2) Player settings menu
 --
@@ -69,7 +68,7 @@
 --
 -- ## 2.3) Show or Hide the Player Setting menus
 --
--- Of course, it may be requried not to show any setting menus. In this case, a method is available on the **\_SETTINGS object**.
+-- Of course, it may be required not to show any setting menus. In this case, a method is available on the **\_SETTINGS object**.
 -- Use @{#SETTINGS.SetPlayerMenuOff}() to hide the player menus, and use @{#SETTINGS.SetPlayerMenuOn}() show the player menus.
 -- Note that when this method is used, any player already in a slot will not have its menus visibility changed.
 -- The option will only have effect when a player enters a new slot or changes a slot.
@@ -92,10 +91,10 @@
 --
 -- 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: Lattitude Longitude [Degrees Minutes Seconds](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion). The accuracy can also be adapted.
---   - A2G LL DDM: Lattitude Longitude [Decimal Degrees Minutes](https://en.wikipedia.org/wiki/Decimal_degrees). 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.
 --
 -- ### 3.1.2) A2G coordinates setting **menu**
 --
@@ -106,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
 --
@@ -121,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.
@@ -136,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
@@ -183,7 +182,7 @@
 -- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
 --
 -- Each Message Type has specific timings that will be applied when the message is displayed.
--- The Settings Menu will provide for each Message Type a selection of proposed durations from which can be choosen.
+-- The Settings Menu will provide for each Message Type a selection of proposed durations from which can be chosen.
 -- So the player can choose its own amount of seconds how long a message should be displayed of a certain type.
 -- Note that **Update** messages can be chosen not to be displayed at all!
 --
@@ -191,12 +190,12 @@
 --
 -- 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
 --
--- The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greather threat in WWII than on modern warfare.
+-- The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greater threat in WWII than on modern warfare.
 -- Therefore, there are 4 era that are defined within the settings:
 --
 --   - **WWII** era: Use for warfare with equipment during the world war II time.
@@ -213,8 +212,8 @@
 SETTINGS = {
   ClassName = "SETTINGS",
   ShowPlayerMenu = true,
-  MenuShort      = false,
-  MenuStatic     = false,
+  MenuShort = false,
+  MenuStatic = false,
 }
 
 SETTINGS.__Enum = {}
@@ -231,7 +230,6 @@ SETTINGS.__Enum.Era = {
   Modern = 4,
 }
 
-
 do -- SETTINGS
 
   --- SETTINGS constructor.
@@ -269,14 +267,14 @@ do -- SETTINGS
   -- Short text are better suited for, e.g., VR.
   -- @param #SETTINGS self
   -- @param #boolean onoff If *true* use short menu texts. If *false* long ones (default).
-  function SETTINGS:SetMenutextShort(onoff)
+  function SETTINGS:SetMenutextShort( onoff )
     _SETTINGS.MenuShort = onoff
   end
 
   --- Set menu to be static.
   -- @param #SETTINGS self
   -- @param #boolean onoff If *true* menu is static. If *false* menu will be updated after changes (default).
-  function SETTINGS:SetMenuStatic(onoff)
+  function SETTINGS:SetMenuStatic( onoff )
     _SETTINGS.MenuStatic = onoff
   end
 
@@ -285,26 +283,26 @@ 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.
   function SETTINGS:IsMetric()
-    return ( self.Metric ~= nil and self.Metric == true ) or ( self.Metric == nil and _SETTINGS:IsMetric() )
+    return (self.Metric ~= nil and self.Metric == true) or (self.Metric == nil and _SETTINGS:IsMetric())
   end
 
   --- Sets the SETTINGS imperial.
@@ -317,7 +315,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if imperial.
   function SETTINGS:IsImperial()
-    return ( self.Metric ~= nil and self.Metric == false ) or ( self.Metric == nil and _SETTINGS:IsMetric() )
+    return (self.Metric ~= nil and self.Metric == false) or (self.Metric == nil and _SETTINGS:IsImperial())
   end
 
   --- Sets the SETTINGS LL accuracy.
@@ -337,7 +335,7 @@ do -- SETTINGS
 
   --- Sets the SETTINGS MGRS accuracy.
   -- @param #SETTINGS self
-  -- @param #number MGRS_Accuracy
+  -- @param #number MGRS_Accuracy 0 to 5
   -- @return #SETTINGS
   function SETTINGS:SetMGRS_Accuracy( MGRS_Accuracy )
     self.MGRS_Accuracy = MGRS_Accuracy
@@ -359,13 +357,12 @@ do -- SETTINGS
     self.MessageTypeTimings[MessageType] = MessageTime
   end
 
-
   --- Gets the SETTINGS Message Display Timing of a MessageType
   -- @param #SETTINGS self
   -- @param Core.Message#MESSAGE MessageType The type of the message.
   -- @return #number
   function SETTINGS:GetMessageTime( MessageType )
-    return ( self.MessageTypeTimings and self.MessageTypeTimings[MessageType] ) or _SETTINGS:GetMessageTime( MessageType )
+    return (self.MessageTypeTimings and self.MessageTypeTimings[MessageType]) or _SETTINGS:GetMessageTime( MessageType )
   end
 
   --- Sets A2G LL DMS
@@ -386,14 +383,14 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if LL DMS
   function SETTINGS:IsA2G_LL_DMS()
-    return ( self.A2GSystem and self.A2GSystem == "LL DMS" ) or ( not self.A2GSystem and _SETTINGS:IsA2G_LL_DMS() )
+    return (self.A2GSystem and self.A2GSystem == "LL DMS") or (not self.A2GSystem and _SETTINGS:IsA2G_LL_DMS())
   end
 
   --- Is LL DDM
   -- @param #SETTINGS self
   -- @return #boolean true if LL DDM
   function SETTINGS:IsA2G_LL_DDM()
-    return ( self.A2GSystem and self.A2GSystem == "LL DDM" ) or ( not self.A2GSystem and _SETTINGS:IsA2G_LL_DDM() )
+    return (self.A2GSystem and self.A2GSystem == "LL DDM") or (not self.A2GSystem and _SETTINGS:IsA2G_LL_DDM())
   end
 
   --- Sets A2G MGRS
@@ -407,7 +404,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if MGRS
   function SETTINGS:IsA2G_MGRS()
-    return ( self.A2GSystem and self.A2GSystem == "MGRS" ) or ( not self.A2GSystem and _SETTINGS:IsA2G_MGRS() )
+    return (self.A2GSystem and self.A2GSystem == "MGRS") or (not self.A2GSystem and _SETTINGS:IsA2G_MGRS())
   end
 
   --- Sets A2G BRA
@@ -421,7 +418,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if BRA
   function SETTINGS:IsA2G_BR()
-    return ( self.A2GSystem and self.A2GSystem == "BR" ) or ( not self.A2GSystem and _SETTINGS:IsA2G_BR() )
+    return (self.A2GSystem and self.A2GSystem == "BR") or (not self.A2GSystem and _SETTINGS:IsA2G_BR())
   end
 
   --- Sets A2A BRA
@@ -435,7 +432,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if BRA
   function SETTINGS:IsA2A_BRAA()
-    return ( self.A2ASystem and self.A2ASystem == "BRAA" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_BRAA() )
+    return (self.A2ASystem and self.A2ASystem == "BRAA") or (not self.A2ASystem and _SETTINGS:IsA2A_BRAA())
   end
 
   --- Sets A2A BULLS
@@ -449,7 +446,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if BULLS
   function SETTINGS:IsA2A_BULLS()
-    return ( self.A2ASystem and self.A2ASystem == "BULLS" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_BULLS() )
+    return (self.A2ASystem and self.A2ASystem == "BULLS") or (not self.A2ASystem and _SETTINGS:IsA2A_BULLS())
   end
 
   --- Sets A2A LL DMS
@@ -470,14 +467,14 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if LL DMS
   function SETTINGS:IsA2A_LL_DMS()
-    return ( self.A2ASystem and self.A2ASystem == "LL DMS" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_LL_DMS() )
+    return (self.A2ASystem and self.A2ASystem == "LL DMS") or (not self.A2ASystem and _SETTINGS:IsA2A_LL_DMS())
   end
 
   --- Is LL DDM
   -- @param #SETTINGS self
   -- @return #boolean true if LL DDM
   function SETTINGS:IsA2A_LL_DDM()
-    return ( self.A2ASystem and self.A2ASystem == "LL DDM" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_LL_DDM() )
+    return (self.A2ASystem and self.A2ASystem == "LL DDM") or (not self.A2ASystem and _SETTINGS:IsA2A_LL_DDM())
   end
 
   --- Sets A2A MGRS
@@ -491,7 +488,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if MGRS
   function SETTINGS:IsA2A_MGRS()
-    return ( self.A2ASystem and self.A2ASystem == "MGRS" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_MGRS() )
+    return (self.A2ASystem and self.A2ASystem == "MGRS") or (not self.A2ASystem and _SETTINGS:IsA2A_MGRS())
   end
 
   --- @param #SETTINGS self
@@ -510,37 +507,37 @@ do -- SETTINGS
     -- A2G Coordinate System
     -------
 
-    local text="A2G Coordinate System"
+    local text = "A2G Coordinate System"
     if _SETTINGS.MenuShort then
-      text="A2G Coordinates"
+      text = "A2G Coordinates"
     end
     local A2GCoordinateMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
     -- Set LL DMS
     if not self:IsA2G_LL_DMS() then
-      local text="Lat/Lon Degree Min Sec (LL DMS)"
+      local text = "Lat/Lon Degree Min Sec (LL DMS)"
       if _SETTINGS.MenuShort then
-        text="LL DMS"
+        text = "LL DMS"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "LL DMS" ):SetTime( MenuTime )
     end
 
     -- Set LL DDM
     if not self:IsA2G_LL_DDM() then
-      local text="Lat/Lon Degree Dec Min (LL DDM)"
+      local text = "Lat/Lon Degree Dec Min (LL DDM)"
       if _SETTINGS.MenuShort then
-        text="LL DDM"
+        text = "LL DDM"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "LL DDM" ):SetTime( MenuTime )
     end
 
     -- Set LL DMS accuracy.
     if self:IsA2G_LL_DDM() then
-      local text1="LL DDM Accuracy 1"
-      local text2="LL DDM Accuracy 2"
-      local text3="LL DDM Accuracy 3"
+      local text1 = "LL DDM Accuracy 1"
+      local text2 = "LL DDM Accuracy 2"
+      local text3 = "LL DDM Accuracy 3"
       if _SETTINGS.MenuShort then
-        text1="LL DDM"
+        text1 = "LL DDM"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 1", A2GCoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 1 ):SetTime( MenuTime )
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 2", A2GCoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 2 ):SetTime( MenuTime )
@@ -549,18 +546,18 @@ do -- SETTINGS
 
     -- Set BR.
     if not self:IsA2G_BR() then
-      local text="Bearing, Range (BR)"
+      local text = "Bearing, Range (BR)"
       if _SETTINGS.MenuShort then
-        text="BR"
+        text = "BR"
       end
-      MENU_GROUP_COMMAND:New( MenuGroup, text , A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "BR" ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, text, A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "BR" ):SetTime( MenuTime )
     end
 
     -- Set MGRS.
     if not self:IsA2G_MGRS() then
-      local text="Military Grid (MGRS)"
+      local text = "Military Grid (MGRS)"
       if _SETTINGS.MenuShort then
-        text="MGRS"
+        text = "MGRS"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "MGRS" ):SetTime( MenuTime )
     end
@@ -578,24 +575,24 @@ do -- SETTINGS
     -- A2A Coordinate System
     -------
 
-    local text="A2A Coordinate System"
+    local text = "A2A Coordinate System"
     if _SETTINGS.MenuShort then
-      text="A2A Coordinates"
+      text = "A2A Coordinates"
     end
     local A2ACoordinateMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
     if not self:IsA2A_LL_DMS() then
-      local text="Lat/Lon Degree Min Sec (LL DMS)"
+      local text = "Lat/Lon Degree Min Sec (LL DMS)"
       if _SETTINGS.MenuShort then
-        text="LL DMS"
+        text = "LL DMS"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "LL DMS" ):SetTime( MenuTime )
     end
 
     if not self:IsA2A_LL_DDM() then
-      local text="Lat/Lon Degree Dec Min (LL DDM)"
+      local text = "Lat/Lon Degree Dec Min (LL DDM)"
       if _SETTINGS.MenuShort then
-        text="LL DDM"
+        text = "LL DDM"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "LL DDM" ):SetTime( MenuTime )
     end
@@ -608,25 +605,25 @@ do -- SETTINGS
     end
 
     if not self:IsA2A_BULLS() then
-      local text="Bullseye (BULLS)"
+      local text = "Bullseye (BULLS)"
       if _SETTINGS.MenuShort then
-        text="Bulls"
+        text = "Bulls"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "BULLS" ):SetTime( MenuTime )
     end
 
     if not self:IsA2A_BRAA() then
-      local text="Bearing Range Altitude Aspect (BRAA)"
+      local text = "Bearing Range Altitude Aspect (BRAA)"
       if _SETTINGS.MenuShort then
-        text="BRAA"
+        text = "BRAA"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "BRAA" ):SetTime( MenuTime )
     end
 
     if not self:IsA2A_MGRS() then
-      local text="Military Grid (MGRS)"
+      local text = "Military Grid (MGRS)"
       if _SETTINGS.MenuShort then
-        text="MGRS"
+        text = "MGRS"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "MGRS" ):SetTime( MenuTime )
     end
@@ -639,31 +636,31 @@ do -- SETTINGS
       MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 5", A2ACoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 5 ):SetTime( MenuTime )
     end
 
-    local text="Measures and Weights System"
+    local text = "Measures and Weights System"
     if _SETTINGS.MenuShort then
-      text="Unit System"
+      text = "Unit System"
     end
     local MetricsMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
     if self:IsMetric() then
-      local text="Imperial (Miles,Feet)"
+      local text = "Imperial (Miles,Feet)"
       if _SETTINGS.MenuShort then
-        text="Imperial"
+        text = "Imperial"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, MetricsMenu, self.MenuMWSystem, self, MenuGroup, RootMenu, false ):SetTime( MenuTime )
     end
 
     if self:IsImperial() then
-      local text="Metric (Kilometers,Meters)"
+      local text = "Metric (Kilometers,Meters)"
       if _SETTINGS.MenuShort then
-        text="Metric"
+        text = "Metric"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, MetricsMenu, self.MenuMWSystem, self, MenuGroup, RootMenu, true ):SetTime( MenuTime )
     end
 
-    local text="Messages and Reports"
+    local text = "Messages and Reports"
     if _SETTINGS.MenuShort then
-      text="Messages & Reports"
+      text = "Messages & Reports"
     end
     local MessagesMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
@@ -704,7 +701,6 @@ do -- SETTINGS
     MENU_GROUP_COMMAND:New( MenuGroup, "2 minutes", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 120 ):SetTime( MenuTime )
     MENU_GROUP_COMMAND:New( MenuGroup, "3 minutes", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 180 ):SetTime( MenuTime )
 
-
     SettingsMenu:Remove( MenuTime )
 
     return self
@@ -748,11 +744,11 @@ 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 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "LL 1 Decimal",  submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "LL 1 Decimal", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "LL 2 Decimals", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "LL 3 Decimals", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "LL 4 Decimals", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
@@ -769,40 +765,40 @@ do -- SETTINGS
       -- A2G Coordinate System
       ------
 
-      local text="A2G Coordinate System"
+      local text = "A2G Coordinate System"
       if _SETTINGS.MenuShort then
-        text="A2G Coordinates"
+        text = "A2G Coordinates"
       end
       local A2GCoordinateMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
 
       if not self:IsA2G_LL_DMS() or _SETTINGS.MenuStatic then
-        local text="Lat/Lon Degree Min Sec (LL DMS)"
+        local text = "Lat/Lon Degree Min Sec (LL DMS)"
         if _SETTINGS.MenuShort then
-          text="A2G LL DMS"
+          text = "A2G LL DMS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
       end
 
       if not self:IsA2G_LL_DDM() or _SETTINGS.MenuStatic then
-        local text="Lat/Lon Degree Dec Min (LL DDM)"
+        local text = "Lat/Lon Degree Dec Min (LL DDM)"
         if _SETTINGS.MenuShort then
-          text="A2G LL DDM"
+          text = "A2G LL DDM"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
       end
 
       if not self:IsA2G_BR() or _SETTINGS.MenuStatic then
-        local text="Bearing, Range (BR)"
+        local text = "Bearing, Range (BR)"
         if _SETTINGS.MenuShort then
-          text="A2G BR"
+          text = "A2G BR"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "BR" )
       end
 
       if not self:IsA2G_MGRS() or _SETTINGS.MenuStatic then
-        local text="Military Grid (MGRS)"
+        local text = "Military Grid (MGRS)"
         if _SETTINGS.MenuShort then
-          text="A2G MGRS"
+          text = "A2G MGRS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
       end
@@ -811,49 +807,48 @@ do -- SETTINGS
       -- A2A Coordinates Menu
       ------
 
-      local text="A2A Coordinate System"
+      local text = "A2A Coordinate System"
       if _SETTINGS.MenuShort then
-        text="A2A Coordinates"
+        text = "A2A Coordinates"
       end
       local A2ACoordinateMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
 
-
       if not self:IsA2A_LL_DMS() or _SETTINGS.MenuStatic then
-        local text="Lat/Lon Degree Min Sec (LL DMS)"
+        local text = "Lat/Lon Degree Min Sec (LL DMS)"
         if _SETTINGS.MenuShort then
-          text="A2A LL DMS"
+          text = "A2A LL DMS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
       end
 
       if not self:IsA2A_LL_DDM() or _SETTINGS.MenuStatic then
-        local text="Lat/Lon Degree Dec Min (LL DDM)"
+        local text = "Lat/Lon Degree Dec Min (LL DDM)"
         if _SETTINGS.MenuShort then
-          text="A2A LL DDM"
+          text = "A2A LL DDM"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
       end
 
       if not self:IsA2A_BULLS() or _SETTINGS.MenuStatic then
-        local text="Bullseye (BULLS)"
+        local text = "Bullseye (BULLS)"
         if _SETTINGS.MenuShort then
-          text="A2A BULLS"
+          text = "A2A BULLS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BULLS" )
       end
 
       if not self:IsA2A_BRAA() or _SETTINGS.MenuStatic then
-        local text="Bearing Range Altitude Aspect (BRAA)"
+        local text = "Bearing Range Altitude Aspect (BRAA)"
         if _SETTINGS.MenuShort then
-          text="A2A BRAA"
+          text = "A2A BRAA"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BRAA" )
       end
 
       if not self:IsA2A_MGRS() or _SETTINGS.MenuStatic then
-        local text="Military Grid (MGRS)"
+        local text = "Military Grid (MGRS)"
         if _SETTINGS.MenuShort then
-          text="A2A MGRS"
+          text = "A2A MGRS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
       end
@@ -862,24 +857,24 @@ do -- SETTINGS
       -- Unit system
       ---
 
-      local text="Measures and Weights System"
+      local text = "Measures and Weights System"
       if _SETTINGS.MenuShort then
-        text="Unit System"
+        text = "Unit System"
       end
       local MetricsMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
 
       if self:IsMetric() or _SETTINGS.MenuStatic then
-        local text="Imperial (Miles,Feet)"
+        local text = "Imperial (Miles,Feet)"
         if _SETTINGS.MenuShort then
-          text="Imperial"
+          text = "Imperial"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, false )
       end
 
       if self:IsImperial() or _SETTINGS.MenuStatic then
-        local text="Metric (Kilometers,Meters)"
+        local text = "Metric (Kilometers,Meters)"
         if _SETTINGS.MenuShort then
-          text="Metric"
+          text = "Metric"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, true )
       end
@@ -888,9 +883,9 @@ do -- SETTINGS
       -- Messages and Reports
       ---
 
-      local text="Messages and Reports"
+      local text = "Messages and Reports"
       if _SETTINGS.MenuShort then
-        text="Messages & Reports"
+        text = "Messages & Reports"
       end
       local MessagesMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
 
@@ -950,39 +945,38 @@ do -- SETTINGS
     return self
   end
 
-
   --- @param #SETTINGS self
   function SETTINGS:A2GMenuSystem( MenuGroup, RootMenu, A2GSystem )
     self.A2GSystem = A2GSystem
-    MESSAGE:New( string.format("Settings: Default A2G coordinate system set to %s for all players!", A2GSystem ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default A2G coordinate system set to %s for all players!", A2GSystem ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
   --- @param #SETTINGS self
   function SETTINGS:A2AMenuSystem( MenuGroup, RootMenu, A2ASystem )
     self.A2ASystem = A2ASystem
-    MESSAGE:New( string.format("Settings: Default A2A coordinate system set to %s for all players!", A2ASystem ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default A2A coordinate system set to %s for all players!", A2ASystem ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
   --- @param #SETTINGS self
   function SETTINGS:MenuLL_DDM_Accuracy( MenuGroup, RootMenu, LL_Accuracy )
     self.LL_Accuracy = LL_Accuracy
-    MESSAGE:New( string.format("Settings: Default LL accuracy set to %s for all players!", LL_Accuracy ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default LL accuracy set to %s for all players!", LL_Accuracy ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
   --- @param #SETTINGS self
   function SETTINGS:MenuMGRS_Accuracy( MenuGroup, RootMenu, MGRS_Accuracy )
     self.MGRS_Accuracy = MGRS_Accuracy
-    MESSAGE:New( string.format("Settings: Default MGRS accuracy set to %s for all players!", MGRS_Accuracy ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default MGRS accuracy set to %s for all players!", MGRS_Accuracy ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
   --- @param #SETTINGS self
   function SETTINGS:MenuMWSystem( MenuGroup, RootMenu, MW )
     self.Metric = MW
-    MESSAGE:New( string.format("Settings: Default measurement format set to %s for all players!", MW and "Metric" or "Imperial" ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default measurement format set to %s for all players!", MW and "Metric" or "Imperial" ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
@@ -995,12 +989,12 @@ 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
-        self:RemovePlayerMenu(PlayerUnit)
-        self:SetPlayerMenu(PlayerUnit)
+      if _SETTINGS.MenuStatic == false then
+        self:RemovePlayerMenu( PlayerUnit )
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -1008,9 +1002,9 @@ do -- SETTINGS
     function SETTINGS:MenuGroupA2ASystem( PlayerUnit, PlayerGroup, PlayerName, A2ASystem )
       self.A2ASystem = A2ASystem
       MESSAGE:New( string.format( "Settings: A2A format set to %s for player %s.", A2ASystem, PlayerName ), 5 ):ToGroup( PlayerGroup )
-      if _SETTINGS.MenuStatic==false then
-        self:RemovePlayerMenu(PlayerUnit)
-        self:SetPlayerMenu(PlayerUnit)
+      if _SETTINGS.MenuStatic == false then
+        self:RemovePlayerMenu( PlayerUnit )
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -1018,9 +1012,9 @@ do -- SETTINGS
     function SETTINGS:MenuGroupLL_DDM_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy )
       self.LL_Accuracy = LL_Accuracy
       MESSAGE:New( string.format( "Settings: LL format accuracy set to %d decimal places for player %s.", LL_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup )
-      if _SETTINGS.MenuStatic==false then
-        self:RemovePlayerMenu(PlayerUnit)
-        self:SetPlayerMenu(PlayerUnit)
+      if _SETTINGS.MenuStatic == false then
+        self:RemovePlayerMenu( PlayerUnit )
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -1028,9 +1022,9 @@ do -- SETTINGS
     function SETTINGS:MenuGroupMGRS_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy )
       self.MGRS_Accuracy = MGRS_Accuracy
       MESSAGE:New( string.format( "Settings: MGRS format accuracy set to %d for player %s.", MGRS_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup )
-      if _SETTINGS.MenuStatic==false then
-        self:RemovePlayerMenu(PlayerUnit)
-        self:SetPlayerMenu(PlayerUnit)
+      if _SETTINGS.MenuStatic == false then
+        self:RemovePlayerMenu( PlayerUnit )
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -1038,9 +1032,9 @@ do -- SETTINGS
     function SETTINGS:MenuGroupMWSystem( PlayerUnit, PlayerGroup, PlayerName, MW )
       self.Metric = MW
       MESSAGE:New( string.format( "Settings: Measurement format set to %s for player %s.", MW and "Metric" or "Imperial", PlayerName ), 5 ):ToGroup( PlayerGroup )
-      if _SETTINGS.MenuStatic==false then
-        self:RemovePlayerMenu(PlayerUnit)
-        self:SetPlayerMenu(PlayerUnit)
+      if _SETTINGS.MenuStatic == false then
+        self:RemovePlayerMenu( PlayerUnit )
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -1070,7 +1064,6 @@ do -- SETTINGS
 
   end
 
-
   --- Configures the era of the mission to be Cold war.
   -- @param #SETTINGS self
   -- @return #SETTINGS self
@@ -1080,7 +1073,6 @@ do -- SETTINGS
 
   end
 
-
   --- Configures the era of the mission to be Modern war.
   -- @param #SETTINGS self
   -- @return #SETTINGS self
@@ -1090,7 +1082,4 @@ do -- SETTINGS
 
   end
 
-
-
-
 end

Moose Development/Moose/Core/SpawnStatic.lua

@@ -57,15 +57,15 @@
 -- @extends Core.Base#BASE
 
 
---- Allows to spawn dynamically new @{Static}s into your mission.
+--- Allows to spawn dynamically new @{Wrapper.Static}s into your mission.
 -- 
 -- Through creating a copy of an existing static object template as defined in the Mission Editor (ME), SPAWNSTATIC can retireve the properties of the defined static object template (like type, category etc), 
 -- and "copy" these properties to create a new static object and place it at the desired coordinate.
 -- 
--- New spawned @{Static}s get **the same name** as the name of the template Static, or gets the given name when a new name is provided at the Spawn method.  
--- By default, spawned @{Static}s will follow a naming convention at run-time:
+-- New spawned @{Wrapper.Static}s get **the same name** as the name of the template Static, or gets the given name when a new name is provided at the Spawn method.  
+-- By default, spawned @{Wrapper.Static}s will follow a naming convention at run-time:
 -- 
---   * Spawned @{Static}s will have the name _StaticName_#_nnn_, where _StaticName_ is the name of the **Template Static**, and _nnn_ is a **counter from 0 to 99999**.
+--   * Spawned @{Wrapper.Static}s will have the name _StaticName_#_nnn_, where _StaticName_ is the name of the **Template Static**, and _nnn_ is a **counter from 0 to 99999**.
 -- 
 -- # SPAWNSTATIC Constructors
 -- 
@@ -106,7 +106,7 @@
 --   * @{#SPAWNSTATIC.Spawn}(Heading, NewName) spawns the static with the set parameters. Optionally, heading and name can be given. The name **must be unique**!
 --   * @{#SPAWNSTATIC.SpawnFromCoordinate}(Coordinate, Heading, NewName) spawn the static at the given coordinate. Optionally, heading and name can be given. The name **must be unique**!
 --   * @{#SPAWNSTATIC.SpawnFromPointVec2}(PointVec2, Heading, NewName) spawns the static at a POINT_VEC2 coordinate. Optionally, heading and name can be given. The name **must be unique**!
---   * @{#SPAWNSTATIC.SpawnFromZone}(Zone, Heading, NewName) spawns the static at the center of a @{Zone}. Optionally, heading and name can be given. The name **must be unique**!
+--   * @{#SPAWNSTATIC.SpawnFromZone}(Zone, Heading, NewName) spawns the static at the center of a @{Core.Zone}. Optionally, heading and name can be given. The name **must be unique**!
 --  
 -- @field #SPAWNSTATIC SPAWNSTATIC
 -- 
@@ -131,7 +131,7 @@ SPAWNSTATIC = {
 -- @field #number mass Cargo mass in kg.
 -- @field #boolean canCargo Static can be a cargo.
 
---- Creates the main object to spawn a @{Static} defined in the mission editor (ME).
+--- Creates the main object to spawn a @{Wrapper.Static} defined in the mission editor (ME).
 -- @param #SPAWNSTATIC self
 -- @param #string SpawnTemplateName Name of the static object in the ME. Each new static will have the name starting with this prefix.
 -- @param DCS#country.id SpawnCountryID (Optional) The ID of the country.
@@ -158,7 +158,7 @@ function SPAWNSTATIC:NewFromStatic(SpawnTemplateName, SpawnCountryID)
   return self
 end
 
---- Creates the main object to spawn a @{Static} given a template table.
+--- Creates the main object to spawn a @{Wrapper.Static} given a template table.
 -- @param #SPAWNSTATIC self
 -- @param #table SpawnTemplate Template used for spawning.
 -- @param DCS#country.id CountryID The ID of the country. Default `country.id.USA`.
@@ -174,7 +174,7 @@ function SPAWNSTATIC:NewFromTemplate(SpawnTemplate, CountryID)
   return self
 end
 
---- Creates the main object to spawn a @{Static} from a given type.
+--- Creates the main object to spawn a @{Wrapper.Static} from a given type.
 -- NOTE that you have to init many other parameters as spawn coordinate etc.
 -- @param #SPAWNSTATIC self
 -- @param #string StaticType Type of the static.
@@ -275,7 +275,7 @@ end
 
 --- Initialize as dead.
 -- @param #SPAWNSTATIC self
--- @param #boolean IsCargo If true, this static is dead.
+-- @param #boolean IsDead If true, this static is dead.
 -- @return #SPAWNSTATIC self
 function SPAWNSTATIC:InitDead(IsDead)
   self.InitStaticDead=IsDead
@@ -336,7 +336,7 @@ function SPAWNSTATIC:Spawn(Heading, NewName)
   
 end
 
---- Creates a new @{Static} from a POINT_VEC2.
+--- Creates a new @{Wrapper.Static} from a POINT_VEC2.
 -- @param #SPAWNSTATIC self
 -- @param Core.Point#POINT_VEC2 PointVec2 The 2D coordinate where to spawn the static.
 -- @param #number Heading The heading of the static, which is a number in degrees from 0 to 360.
@@ -352,7 +352,7 @@ function SPAWNSTATIC:SpawnFromPointVec2(PointVec2, Heading, NewName)
 end
 
 
---- Creates a new @{Static} from a COORDINATE.
+--- Creates a new @{Wrapper.Static} from a COORDINATE.
 -- @param #SPAWNSTATIC self
 -- @param Core.Point#COORDINATE Coordinate The 3D coordinate where to spawn the static.
 -- @param #number Heading (Optional) Heading The heading of the static in degrees. Default is 0 degrees.
@@ -375,7 +375,7 @@ function SPAWNSTATIC:SpawnFromCoordinate(Coordinate, Heading, NewName)
 end
 
 
---- Creates a new @{Static} from a @{Zone}.
+--- Creates a new @{Wrapper.Static} from a @{Core.Zone}.
 -- @param #SPAWNSTATIC self
 -- @param Core.Zone#ZONE_BASE Zone The Zone where to spawn the static.
 -- @param #number Heading (Optional)The heading of the static in degrees. Default is the heading of the template.
@@ -467,7 +467,7 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
   self:T(Template)
   
   -- Add static to the game.
-  local Static=nil
+  local Static=nil  --DCS#StaticObject
   
   if self.InitFarp then
     
@@ -487,6 +487,17 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
     
     -- ED's dirty way to spawn FARPS.
     Static=coalition.addGroup(CountryID, -1, TemplateGroup)
+
+    -- Currently DCS 2.8 does not trigger birth events if FAPRS are spawned!
+    -- We create such an event. The airbase is registered in Core.Event
+    local Event = {
+      id = EVENTS.Birth,
+      time = timer.getTime(),
+      initiator = Static
+      }
+    -- Create BIRTH event.
+    world.onEvent(Event)
+
   else
     self:T("Spawning Static")        
     self:T2({Template=Template})  

Moose Development/Moose/Core/Spot.lua

@@ -5,7 +5,7 @@
 -- SPOT implements the DCS Spot class functionality, but adds additional luxury to be able to:
 -- 
 --   * Spot for a defined duration.
---   * Updates of laer spot position every 0.2 seconds for moving targets.
+--   * Updates of laser spot position every 0.2 seconds for moving targets.
 --   * Wiggle the spot at the target.
 --   * Provide a @{Wrapper.Unit} as a target, instead of a point.
 --   * Implement a status machine, LaseOn, LaseOff.
@@ -13,27 +13,17 @@
 -- ===
 -- 
 -- # Demo Missions
--- 
--- ### [SPOT Demo Missions source code]()
--- 
--- ### [SPOT Demo Missions, only for beta testers]()
 --
--- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
--- 
--- ===
--- 
--- # YouTube Channel
--- 
--- ### [SPOT YouTube Channel]()
+-- ### [Demo Missions on GitHub](https://github.com/FlightControl-Master/MOOSE_MISSIONS)
 -- 
 -- ===
 -- 
 -- ### 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
 -- 
 -- ===
 -- 
@@ -43,21 +33,22 @@
 
 do
 
-  --- @type SPOT
+  ---
+  -- @type SPOT
   -- @extends Core.Fsm#FSM
 
 
   --- Implements the target spotting or marking functionality, but adds additional luxury to be able to:
   -- 
   --   * Mark targets for a defined duration.
-  --   * Updates of laer spot position every 0.2 seconds for moving targets.
+  --   * Updates of laser spot position every 0.25 seconds for moving targets.
   --   * Wiggle the spot at the target.
   --   * Provide a @{Wrapper.Unit} as a target, instead of a point.
   --   * Implement a status machine, LaseOn, LaseOff.
   -- 
   -- ## 1. SPOT constructor
   --   
-  --   * @{#SPOT.New}(..\Presentations\SPOT\Dia2.JPG): Creates a new SPOT object.
+  --   * @{#SPOT.New}(): Creates a new SPOT object.
   -- 
   -- ## 2. SPOT is a FSM
   -- 
@@ -217,6 +208,8 @@ do
     
   
     self.Recce = Recce
+    
+    self.RecceName = self.Recce:GetName()
   
     self.LaseScheduler = SCHEDULER:New( self )
   
@@ -236,21 +229,27 @@ do
   -- @param #number LaserCode Laser code.
   -- @param #number Duration Duration of lasing in seconds.
   function SPOT:onafterLaseOn( From, Event, To, Target, LaserCode, Duration )
-    self:F( { "LaseOn", Target, LaserCode, Duration } )
+    self:T({From, Event, To})
+    self:T2( { "LaseOn", Target, LaserCode, Duration } )
 
     local function StopLase( self )
       self:LaseOff()
     end
     
     self.Target = Target
+    
+    self.TargetName = Target:GetName()
+    
     self.LaserCode = LaserCode
     
     self.Lasing = true
     
     local RecceDcsUnit = self.Recce:GetDCSObject()
     
-    self.SpotIR = Spot.createInfraRed( RecceDcsUnit, { x = 0, y = 2, z = 0 }, Target:GetPointVec3():AddY(1):GetVec3() )
-    self.SpotLaser = Spot.createLaser( RecceDcsUnit, { x = 0, y = 2, z = 0 }, Target:GetPointVec3():AddY(1):GetVec3(), LaserCode )
+    local relativespot = self.relstartpos or { x = 0, y = 2, z = 0 }
+    
+    self.SpotIR = Spot.createInfraRed( RecceDcsUnit, relativespot, Target:GetPointVec3():AddY(1):GetVec3() )
+    self.SpotLaser = Spot.createLaser( RecceDcsUnit, relativespot, Target:GetPointVec3():AddY(1):GetVec3(), LaserCode )
 
     if Duration then
       self.ScheduleID = self.LaseScheduler:Schedule( self, StopLase, {self}, Duration )
@@ -259,6 +258,8 @@ do
     self:HandleEvent( EVENTS.Dead )
     
     self:__Lasing( -1 )
+    
+    return self
   end
   
   
@@ -271,7 +272,7 @@ do
   -- @param #number LaserCode Laser code.
   -- @param #number Duration Duration of lasing in seconds.
   function SPOT:onafterLaseOnCoordinate(From, Event, To, Coordinate, LaserCode, Duration)
-    self:F( { "LaseOnCoordinate", Coordinate, LaserCode, Duration } )
+    self:T2( { "LaseOnCoordinate", Coordinate, LaserCode, Duration } )
 
     local function StopLase( self )
       self:LaseOff()
@@ -293,55 +294,72 @@ do
     end
     
     self:__Lasing(-1)
+    return self
   end  
-
-  --- @param #SPOT self
+  
+  ---
+  -- @param #SPOT self
   -- @param Core.Event#EVENTDATA EventData
   function SPOT:OnEventDead(EventData)
-    self:F( { Dead = EventData.IniDCSUnitName, Target = self.Target } )
+    self:T2( { Dead = EventData.IniDCSUnitName, Target = self.Target } )
     if self.Target then
-      if EventData.IniDCSUnitName == self.Target:GetName() then
-        self:F( {"Target dead ", self.Target:GetName() } )
+      if EventData.IniDCSUnitName == self.TargetName then
+        self:F( {"Target dead ", self.TargetName } )
         self:Destroyed()
         self:LaseOff()
       end
     end
+    if self.Recce then
+      if EventData.IniDCSUnitName == self.RecceName then
+        self:F( {"Recce dead ", self.RecceName } )
+        self:LaseOff()
+      end
+    end
+    return self
   end
   
-  --- @param #SPOT self
+  ---
+  -- @param #SPOT self
   -- @param From
   -- @param Event
   -- @param To
   function SPOT:onafterLasing( From, Event, To )
-  
-    if self.Target and self.Target:IsAlive() then
-      self.SpotIR:setPoint( self.Target:GetPointVec3():AddY(1):AddY(math.random(-100,100)/100):AddX(math.random(-100,100)/100):GetVec3() )
-      self.SpotLaser:setPoint( self.Target:GetPointVec3():AddY(1):GetVec3() )
-      self:__Lasing( -0.2 )
-    elseif self.TargetCoord then
+    self:T({From, Event, To})
     
-      -- Wiggle the IR spot a bit.  
-      local irvec3={x=self.TargetCoord.x+math.random(-100,100)/100, y=self.TargetCoord.y+math.random(-100,100)/100, z=self.TargetCoord.z} --#DCS.Vec3
-      local lsvec3={x=self.TargetCoord.x, y=self.TargetCoord.y, z=self.TargetCoord.z} --#DCS.Vec3
+    if self.Lasing then
+      if self.Target and self.Target:IsAlive() then
+        
+        self.SpotIR:setPoint( self.Target:GetPointVec3():AddY(1):AddY(math.random(-100,100)/200):AddX(math.random(-100,100)/200):GetVec3() )
+        self.SpotLaser:setPoint( self.Target:GetPointVec3():AddY(1):GetVec3() )
+        
+        self:__Lasing(0.2)
+      elseif self.TargetCoord then
       
-      self.SpotIR:setPoint(irvec3)
-      self.SpotLaser:setPoint(lsvec3)
-      
-      self:__Lasing(-0.25)    
-    else
-      self:F( { "Target is not alive", self.Target:IsAlive() } )
+        -- Wiggle the IR spot a bit.  
+        local irvec3={x=self.TargetCoord.x+math.random(-100,100)/200, y=self.TargetCoord.y+math.random(-100,100)/200, z=self.TargetCoord.z} --#DCS.Vec3
+        local lsvec3={x=self.TargetCoord.x, y=self.TargetCoord.y, z=self.TargetCoord.z} --#DCS.Vec3
+        
+        self.SpotIR:setPoint(irvec3)
+        self.SpotLaser:setPoint(lsvec3)
+        
+        self:__Lasing(0.2)    
+      else
+        self:F( { "Target is not alive", self.Target:IsAlive() } )
+      end
     end
-  
+    return self
   end
-
-  --- @param #SPOT self
+  
+  ---
+  -- @param #SPOT self
   -- @param From
   -- @param Event
   -- @param To
   -- @return #SPOT
   function SPOT:onafterLaseOff( From, Event, To )
-  
-    self:F( {"Stopped lasing for ", self.Target and self.Target:GetName() or "coord", SpotIR = self.SportIR, SpotLaser = self.SpotLaser } )
+    self:T({From, Event, To})
+    
+    self:T2( {"Stopped lasing for ", self.Target and self.Target:GetName() or "coord", SpotIR = self.SportIR, SpotLaser = self.SpotLaser } )
     
     self.Lasing = false
     
@@ -368,4 +386,16 @@ do
     return self.Lasing
   end
   
-end
+  --- Set laser start position relative to the lasing unit.
+  -- @param #SPOT self
+  -- @param #table position Start position of the laser relative to the lasing unit. Default is { x = 0, y = 2, z = 0 }
+  -- @return #SPOT self
+  -- @usage
+  --      -- Set lasing position to be the position of the optics of the Gazelle M:
+  --      myspot:SetRelativeStartPosition({ x = 1.7, y = 1.2, z = 0 })
+  function SPOT:SetRelativeStartPosition(position)
+    self.relstartpos = position or { x = 0, y = 2, z = 0 }
+    return self
+  end
+  
+end

Moose Development/Moose/Core/TextAndSound.lua

@@ -1,4 +1,4 @@
---- **Core** - TEXTANDSOUND (MOOSE gettext) system
+--- **Core** - A Moose GetText system.
 --
 -- ===
 -- 

Moose Development/Moose/Core/Timer.lua

@@ -107,7 +107,7 @@ _TIMERID=0
 
 --- TIMER class version.
 -- @field #string version
-TIMER.version="0.1.2"
+TIMER.version="0.2.0"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
@@ -155,7 +155,7 @@ function TIMER:New(Function, ...)
   return self
 end
 
---- Create a new TIMER object.
+--- Start TIMER object.
 -- @param #TIMER self
 -- @param #number Tstart Relative start time in seconds.
 -- @param #number dT Interval between function calls in seconds. If not specified `nil`, the function is called only once.
@@ -167,7 +167,7 @@ function TIMER:Start(Tstart, dT, Duration)
   local Tnow=timer.getTime()
 
   -- Start time in sec.
-  self.Tstart=Tstart and Tnow+Tstart or Tnow+0.001  -- one millisecond delay if Tstart=nil
+  self.Tstart=Tstart and Tnow+math.max(Tstart, 0.001) or Tnow+0.001  -- one millisecond delay if Tstart=nil
   
   -- Set time interval.
   self.dT=dT
@@ -192,6 +192,20 @@ function TIMER:Start(Tstart, dT, Duration)
   return self
 end
 
+--- Start TIMER object if a condition is met. Useful for e.g. debugging.
+-- @param #TIMER self
+-- @param #boolean Condition Must be true for the TIMER to start
+-- @param #number Tstart Relative start time in seconds.
+-- @param #number dT Interval between function calls in seconds. If not specified `nil`, the function is called only once.
+-- @param #number Duration Time in seconds for how long the timer is running. If not specified `nil`, the timer runs forever or until stopped manually by the `TIMER:Stop()` function.
+-- @return #TIMER self
+function TIMER:StartIf(Condition,Tstart, dT, Duration)
+  if Condition then
+    self:Start(Tstart, dT, Duration)
+  end
+  return self
+end
+
 --- Stop the timer by removing the timer function.
 -- @param #TIMER self
 -- @param #number Delay (Optional) Delay in seconds, before the timer is stopped.
@@ -208,7 +222,20 @@ function TIMER:Stop(Delay)
     
       -- Remove timer function.
       self:T(self.lid..string.format("Stopping timer by removing timer function after %d calls!", self.ncalls))
-      timer.removeFunction(self.tid)
+
+      -- We use a pcall here because if the DCS timer does not exist any more, it crashes the whole script!
+      local status=pcall(
+        function ()
+          timer.removeFunction(self.tid)
+        end 
+      )
+      
+      -- Debug messages.
+      if status then
+        self:T2(self.lid..string.format("Stopped timer!"))
+      else
+        self:E(self.lid..string.format("WARNING: Could not remove timer function! isrunning=%s", tostring(self.isrunning)))
+      end
       
       -- Not running any more.
       self.isrunning=false

Moose Development/Moose/Core/UserFlag.lua

@@ -35,13 +35,13 @@ do -- UserFlag
     ClassName    = "USERFLAG",
     UserFlagName = nil,
   }
-  
+
   --- USERFLAG Constructor.
   -- @param #USERFLAG self
   -- @param #string UserFlagName The name of the userflag, which is a free text string.
   -- @return #USERFLAG
   function USERFLAG:New( UserFlagName ) --R2.3
-  
+
     local self = BASE:Inherit( self, BASE:New() ) -- #USERFLAG
 
     self.UserFlagName = UserFlagName
@@ -52,7 +52,7 @@ do -- UserFlag
   --- Get the userflag name.
   -- @param #USERFLAG self
   -- @return #string Name of the user flag.
-  function USERFLAG:GetName()    
+  function USERFLAG:GetName()
     return self.UserFlagName
   end  
 
@@ -66,18 +66,17 @@ do -- UserFlag
   --   BlueVictory:Set( 100 ) -- Set the UserFlag VictoryBlue to 100.
   --   
   function USERFLAG:Set( Number, Delay ) --R2.3
-  
+
     if Delay and Delay>0 then
       self:ScheduleOnce(Delay, USERFLAG.Set, self, Number)
     else
       --env.info(string.format("Setting flag \"%s\" to %d at T=%.1f", self.UserFlagName, Number, timer.getTime()))
       trigger.action.setUserFlag( self.UserFlagName, Number )
     end
-    
-    return self
-  end  
 
-  
+    return self
+  end
+
   --- Get the userflag Number.
   -- @param #USERFLAG self
   -- @return #number Number The number value to be checked if it is the same as the userflag.
@@ -86,12 +85,10 @@ do -- UserFlag
   --   local BlueVictoryValue = BlueVictory:Get() -- Get the UserFlag VictoryBlue value.
   --   
   function USERFLAG:Get() --R2.3
-    
-    return trigger.misc.getUserFlag( self.UserFlagName )
-  end  
 
-  
-  
+    return trigger.misc.getUserFlag( self.UserFlagName )
+  end
+
   --- Check if the userflag has a value of Number.
   -- @param #USERFLAG self
   -- @param #number Number The number value to be checked if it is the same as the userflag.
@@ -102,9 +99,9 @@ do -- UserFlag
   --     return "Blue has won"
   --   end
   function USERFLAG:Is( Number ) --R2.3
-    
+
     return trigger.misc.getUserFlag( self.UserFlagName ) == Number
-    
-  end  
+
+  end
 
 end

Moose Development/Moose/Core/Velocity.lua

@@ -54,7 +54,7 @@ do -- Velocity
     self.Velocity = VelocityMps
     return self
   end
-  
+
   --- Get the velocity in Mps (meters per second).
   -- @param #VELOCITY self
   -- @return #number The velocity in meters per second. 
@@ -70,12 +70,12 @@ do -- Velocity
     self.Velocity = UTILS.KmphToMps( VelocityKmph )
     return self
   end
-  
+
   --- Get the velocity in Kmph (kilometers per hour).
   -- @param #VELOCITY self
   -- @return #number The velocity in kilometers per hour. 
   function VELOCITY:GetKmph()
-  
+
     return UTILS.MpsToKmph( self.Velocity )
   end
 
@@ -87,7 +87,7 @@ do -- Velocity
     self.Velocity = UTILS.MiphToMps( VelocityMiph )
     return self
   end
-  
+
   --- Get the velocity in Miph (miles per hour).
   -- @param #VELOCITY self
   -- @return #number The velocity in miles per hour. 
@@ -95,8 +95,7 @@ do -- Velocity
     return UTILS.MpsToMiph( self.Velocity )
   end
 
-  
-  --- Get the velocity in text, according the player @{Settings}.
+  --- Get the velocity in text, according the player @{Core.Settings}.
   -- @param #VELOCITY self
   -- @param Core.Settings#SETTINGS Settings
   -- @return #string The velocity in text. 
@@ -113,11 +112,11 @@ do -- Velocity
     end
   end
 
-  --- Get the velocity in text, according the player or default @{Settings}.
+  --- Get the velocity in text, according the player or default @{Core.Settings}.
   -- @param #VELOCITY self
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable
   -- @param Core.Settings#SETTINGS Settings
-  -- @return #string The velocity in text according the player or default @{Settings}
+  -- @return #string The velocity in text according the player or default @{Core.Settings}
   function VELOCITY:ToString( VelocityGroup, Settings ) -- R2.3
     self:F( { Group = VelocityGroup and VelocityGroup:GetName() } )
     local Settings = Settings or ( VelocityGroup and _DATABASE:GetPlayerSettings( VelocityGroup:GetPlayerName() ) ) or _SETTINGS
@@ -134,7 +133,7 @@ do -- VELOCITY_POSITIONABLE
 
   --- # VELOCITY_POSITIONABLE class, extends @{Core.Base#BASE}
   -- 
-  -- VELOCITY_POSITIONABLE monitors the speed of an @{Positionable} in the simulation, which can be expressed in various formats according the Settings.
+  -- @{#VELOCITY_POSITIONABLE} monitors the speed of a @{Wrapper.Positionable#POSITIONABLE} in the simulation, which can be expressed in various formats according the Settings.
   -- 
   -- ## 1. VELOCITY_POSITIONABLE constructor
   --   
@@ -167,7 +166,7 @@ do -- VELOCITY_POSITIONABLE
   -- @param #VELOCITY_POSITIONABLE self
   -- @return #number The velocity in kilometers per hour. 
   function VELOCITY_POSITIONABLE:GetKmph()
-  
+
     return UTILS.MpsToKmph( self.Positionable:GetVelocityMPS() or 0)
   end
 
@@ -178,9 +177,9 @@ do -- VELOCITY_POSITIONABLE
     return UTILS.MpsToMiph( self.Positionable:GetVelocityMPS() or 0 )
   end
 
-  --- Get the velocity in text, according the player or default @{Settings}.
+  --- Get the velocity in text, according the player or default @{Core.Settings}.
   -- @param #VELOCITY_POSITIONABLE self
-  -- @return #string The velocity in text according the player or default @{Settings}
+  -- @return #string The velocity in text according the player or default @{Core.Settings}
   function VELOCITY_POSITIONABLE:ToString() -- R2.3
     self:F( { Group = self.Positionable and self.Positionable:GetName() } )
     local Settings = Settings or ( self.Positionable and _DATABASE:GetPlayerSettings( self.Positionable:GetPlayerName() ) ) or _SETTINGS

Moose Development/Moose/Core/Zone_Detection.lua

@@ -1,6 +1,8 @@
+--- **Core** - The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.
+-- @module Core.Zone_Detection
+-- @image MOOSE.JPG
 
---- The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.
--- @type ZONE_DETECTION
+--- @type ZONE_DETECTION
 -- @field DCS#Vec2 Vec2 The current location of the zone.
 -- @field DCS#Distance Radius The radius of the zone.
 -- @extends #ZONE_BASE
@@ -29,7 +31,7 @@ function ZONE_DETECTION:New( ZoneName, Detection, Radius )
 
   self.Detection = Detection
   self.Radius = Radius
-  
+
   return self
 end
 
@@ -48,15 +50,14 @@ function ZONE_DETECTION:BoundZone( Points, CountryID, UnBound )
 
   local Angle
   local RadialBase = math.pi*2
-  
-  --
+
   for Angle = 0, 360, (360 / Points ) do
     local Radial = Angle * RadialBase / 360
     Point.x = Vec2.x + math.cos( Radial ) * self:GetRadius()
     Point.y = Vec2.y + math.sin( Radial ) * self:GetRadius()
-    
+
     local CountryName = _DATABASE.COUNTRY_NAME[CountryID]
-    
+
     local Tire = {
         ["country"] = CountryName, 
         ["category"] = "Fortifications",

Moose Development/Moose/DCS.lua

@@ -1,4 +1,6 @@
---- **DCS API** Prototypes
+--- **DCS API** Prototypes.
+-- 
+-- ===
 -- 
 -- See the [Simulator Scripting Engine Documentation](https://wiki.hoggitworld.com/view/Simulator_Scripting_Engine_Documentation) on Hoggit for further explanation and examples.
 -- 
@@ -133,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
 
@@ -191,21 +209,29 @@ do -- land
   
   --- [Type of surface enumerator](https://wiki.hoggitworld.com/view/DCS_singleton_land)
   -- @type land.SurfaceType
-  -- @field LAND
-  -- @field SHALLOW_WATER
-  -- @field WATER
-  -- @field ROAD
-  -- @field RUNWAY
+  -- @field LAND Land=1
+  -- @field SHALLOW_WATER Shallow water=2
+  -- @field WATER Water=3
+  -- @field ROAD Road=4
+  -- @field RUNWAY Runway=5
   
-  --- Returns altitude MSL of the point.
+  --- Returns the distance from sea level (y-axis) of a given vec2 point.
   -- @function [parent=#land] getHeight
-  -- @param #Vec2 point point on the ground. 
-  -- @return #Distance
+  -- @param #Vec2 point Point on the ground. 
+  -- @return #number Height in meters.
+
+  --- Returns the surface height and depth of a point. Useful for checking if the path is deep enough to support a given ship. 
+  -- Both values are positive. When checked over water at sea level the first value is always zero. 
+  -- When checked over water at altitude, for example the reservoir of the Inguri Dam, the first value is the corresponding altitude the water level is at.
+  -- @function [parent=#land] getSurfaceHeightWithSeabed
+  -- @param #Vec2 point Position where to check.
+  -- @return #number Height in meters.
+  -- @return #number Depth in meters.
   
-  --- returns surface type at the given point.
+  --- Returns surface type at the given point.
   -- @function [parent=#land] getSurfaceType
   -- @param #Vec2 point Point on the land. 
-  -- @return #land.SurfaceType
+  -- @return #number Enumerator value from `land.SurfaceType` (LAND=1, SHALLOW_WATER=2, WATER=3, ROAD=4, RUNWAY=5)
   
   --- [DCS Singleton land](https://wiki.hoggitworld.com/view/DCS_singleton_land)
   land = {} --#land
@@ -306,6 +332,11 @@ do -- country
   -- @field Argentinia
   -- @field Cyprus
   -- @field Slovenia
+  -- @field BOLIVIA
+  -- @field GHANA
+  -- @field NIGERIA
+  -- @field PERU
+  -- @field ECUADOR
 
   country = {} --#country
 
@@ -314,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
 
@@ -334,9 +365,23 @@ do -- coalition
   -- @field RED
   -- @field BLUE
   
-  --- @function [parent=#coalition] getCountryCoalition
-  -- @param #number countryId
-  -- @return #number coalitionId
+  --- Get country coalition.
+  -- @function [parent=#coalition] getCountryCoalition
+  -- @param #number countryId Country ID.
+  -- @return #number coalitionId Coalition ID.
+
+  --- Dynamically spawns a group. See [hoggit](https://wiki.hoggitworld.com/view/DCS_func_addGroup)
+  -- @function [parent=#coalition] addGroup
+  -- @param #number countryId Id of the country.
+  -- @param #number groupCategory Group category. Set -1 for spawning FARPS.
+  -- @param #table groupData Group data table.
+  -- @return DCS#Group The spawned Group object.
+
+  --- Dynamically spawns a static object. See [hoggit](https://wiki.hoggitworld.com/view/DCS_func_addGroup)
+  -- @function [parent=#coalition] addStaticObject
+  -- @param #number countryId Id of the country.
+  -- @param #table groupData Group data table.
+  -- @return DCS#Static The spawned static object.
   
   coalition = {} -- #coalition
 
@@ -345,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.
@@ -406,8 +451,8 @@ do -- Types
   --- Vec3 type is a 3D-vector.
   -- DCS world has 3-dimensional coordinate system. DCS ground is an infinite plain.
   -- @type Vec3
-  -- @field #Distance x is directed to the north
-  -- @field #Distance z is directed to the east
+  -- @field #Distance x is directed to the North
+  -- @field #Distance z is directed to the East
   -- @field #Distance y is directed up
   
   --- Vec2 is a 2D-vector for the ground plane as a reference plane.
@@ -442,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).
@@ -460,7 +505,7 @@ do -- Types
   -- @field #string id
   -- @field #Task.param param
   
-  --- @type Task.param
+  -- @type Task.param
   
   --- List of @{#Task}
   -- @type TaskArray
@@ -507,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
@@ -658,10 +703,11 @@ do -- Weapon
 
   --- Weapon.Category enum that stores weapon categories.
   -- @type Weapon.Category
-  -- @field SHELL
-  -- @field MISSILE
-  -- @field ROCKET
-  -- @field BOMB
+  -- @field #number SHELL Shell.
+  -- @field #number MISSILE Missile
+  -- @field #number ROCKET Rocket.
+  -- @field #number BOMB Bomb.
+  -- @field #number TORPEDO Torpedo.
   
 
   --- Weapon.GuidanceType enum that stores guidance methods. Available only for guided weapon (Weapon.Category.MISSILE and some Weapon.Category.BOMB). 
@@ -763,11 +809,118 @@ do -- Airbase
   -- @function [parent=#Airbase] getDesc
   -- @param self
   -- @return #Airbase.Desc
-  
+
+  --- Returns the warehouse object associated with the airbase object. Can then be used to call the warehouse class functions to modify the contents of the warehouse.
+  -- @function [parent=#Airbase] getWarehouse
+  -- @param self
+  -- @return #Warehouse The DCS warehouse object of this airbase.
+
+  --- Enables or disables the airbase and FARP auto capture game mechanic where ownership of a base can change based on the presence of ground forces or the 
+  -- default setting assigned in the editor.
+  -- @function [parent=#Airbase] autoCapture
+  -- @param self
+  -- @param #boolean setting `true` : enables autoCapture behavior, `false` : disables autoCapture behavior
+
+  --- Returns the current autoCapture setting for the passed base.
+  -- @function [parent=#Airbase] autoCaptureIsOn
+  -- @param self
+  -- @return #boolean `true` if autoCapture behavior is enabled and `false` otherwise.
+
+  --- Changes the passed airbase object's coalition to the set value. Must be used with Airbase.autoCapture to disable auto capturing of the base, 
+  -- otherwise the base can revert back to a different coalition depending on the situation and built in game capture rules.
+  -- @function [parent=#Airbase] setCoalition
+  -- @param self
+  -- @param #number coa The new owner coalition: 0=neutra, 1=red, 2=blue.
+
+  --- Returns the wsType of every object that exists in DCS. A wsType is a table consisting of 4 entries indexed numerically. 
+  -- It can be used to broadly categorize object types. The table can be broken down as: {mainCategory, subCat1, subCat2, index}
+  -- @function [parent=#Airbase] getResourceMap
+  -- @param self
+  -- @return #table wsType of every object that exists in DCS.
+
   Airbase = {} --#Airbase
 
 end -- Airbase
 
+
+do -- Warehouse
+
+  --- [DCS Class Warehouse](https://wiki.hoggitworld.com/view/DCS_Class_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}
+  -- @function [parent=#Warehouse] addItem
+  -- @param self
+  -- @param #string itemName Name of the item.
+  -- @param #number count Number of items to add.
+
+  --- Returns the number of the passed type of item currently in a warehouse object.
+  -- @function [parent=#Warehouse] getItemCount
+  -- @param self
+  -- @param #string itemName Name of the item.
+
+  --- Sets the passed amount of a given item to the warehouse.
+  -- @function [parent=#Warehouse] setItem
+  -- @param self
+  -- @param #string itemName Name of the item.
+  -- @param #number count Number of items to add.
+
+  --- Removes the amount of the passed item from the warehouse.
+  -- @function [parent=#Warehouse] removeItem
+  -- @param self
+  -- @param #string itemName Name of the item.
+  -- @param #number count Number of items to be removed.
+
+  --- Adds the passed amount of a liquid fuel into the warehouse inventory.
+  -- @function [parent=#Warehouse] addLiquid
+  -- @param self
+  -- @param #number liquidType Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.
+  -- @param #number count Amount of liquid to add.
+
+  --- Returns the amount of the passed liquid type within a given warehouse.
+  -- @function [parent=#Warehouse] getLiquidAmount
+  -- @param self
+  -- @param #number liquidType Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.
+  -- @return #number Amount of liquid.
+
+  --- Sets the passed amount of a liquid fuel into the warehouse inventory.
+  -- @function [parent=#Warehouse] setLiquidAmount
+  -- @param self
+  -- @param #number liquidType Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.
+  -- @param #number count Amount of liquid.
+
+  --- Removes the set amount of liquid from the inventory in a warehouse.
+  -- @function [parent=#Warehouse] setLiquidAmount
+  -- @param self
+  -- @param #number liquidType Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.
+  -- @param #number count Amount of liquid.
+
+  --- Returns the airbase object associated with the warehouse object.
+  -- @function [parent=#Warehouse] getOwner
+  -- @param self
+  -- @return #Airbase The airbase object owning this warehouse.
+
+  --- Returns a full itemized list of everything currently in a warehouse. If a category is set to unlimited then the table will be returned empty.
+  -- Aircraft and weapons are indexed by strings. Liquids are indexed by number.
+  -- @function [parent=#Warehouse] getInventory
+  -- @param self
+  -- @param #string itemName Name of the item.
+  -- @return #table Itemized list of everything currently in a warehouse
+
+
+  Warehouse = {} --#Warehouse 
+
+end
+
 do -- Spot
 
   --- [DCS Class Spot](https://wiki.hoggitworld.com/view/DCS_Class_Spot)
@@ -830,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:
   -- 
@@ -948,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
@@ -980,8 +1133,8 @@ do -- Unit
   
   --- Enum that stores aircraft refueling system types.
   -- @type Unit.RefuelingSystem
-  -- @field BOOM_AND_RECEPTACLE
-  -- @field PROBE_AND_DROGUE
+  -- @field BOOM_AND_RECEPTACLE Tanker with a boom.
+  -- @field PROBE_AND_DROGUE Tanker with a probe.
   
   --- Enum that stores sensor types.
   -- @type Unit.SensorType
@@ -1063,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
   
@@ -1287,6 +1443,42 @@ do -- Group
 
 end -- Group
 
+do -- StaticObject
+
+  --- Represents a static object.
+  -- @type StaticObject
+  -- @extends DCS#Object
+
+  --- Returns the static object.
+  -- @function [parent=#StaticObject] getByName
+  -- @param #string name Name of the static object.
+  -- @return #StaticObject
+
+  StaticObject = {} --#StaticObject
+
+end
+
+do --Event
+
+  --- Event structure. Note that present fields depend on type of event.
+  -- @type Event
+  -- @field #number id Event ID.
+  -- @field #number time Mission time in seconds.
+  -- @field DCS#Unit initiator Unit initiating the event.
+  -- @field DCS#Unit target Target unit.
+  -- @field DCS#Airbase place Airbase.
+  -- @field number subPlace Subplace. Unknown and often just 0.
+  -- @field #string weapon_name Weapoin name.
+  -- @field #number idx Mark ID.
+  -- @field #number coalition Coalition ID.
+  -- @field #number groupID Group ID, *e.g.* of group that added mark point.
+  -- @field #string text Text, *e.g.* of mark point.
+  -- @field DCS#Vec3 pos Position vector, *e.g.* of mark point.
+  -- @field #string comment Comment, *e.g.* LSO score.
+
+  Event={} --#Event
+
+end
 
 do -- AI
 
@@ -1337,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
@@ -1362,25 +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
-  
-  --- @type AI.Option.Naval
+  -- @field #AI.Option.Ground.mid                   mid
+  -- @field #AI.Option.Ground.mval                  mval
+  -- 
+  -- @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
@@ -1397,101 +1598,119 @@ do -- AI
   -- @field PROHIBIT_AG
   -- @field MISSILE_ATTACK
   -- @field PROHIBIT_WP_PASS_REPORT
-  
-  --- @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
+  -- @field OPTION_RADIO_USAGE_CONTACT
+  -- @field OPTION_RADIO_USAGE_ENGAGE
+  -- @field OPTION_RADIO_USAGE_KILL
+  -- @field JETT_TANKS_IF_EMPTY
+  -- @field FORCED_ATTACK
 
-  
-  --- @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
   -- @field DISPERSE_ON_ATTACK true or false
   -- @field ALARM_STATE @{#AI.Option.Ground.val.ALARM_STATE}
   -- @field ENGAGE_AIR_WEAPONS
+  -- @field AC_ENGAGEMENT_RANGE_RESTRICTION
   
-  --- @type AI.Option.Ground.val
+  ---
+  -- @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
   -- @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.val.ALARM_STATE
+  ---
+  -- @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
+  -- @field ANY_TARGET -- 0
+  -- @field AIR_UNITS_ONLY -- 1
+  -- @field GROUND_UNITS_ONLY -- 2
+  
+  ---
+  -- @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/AICSAR.lua

@@ -1,980 +0,0 @@
---- **Functional** - AI CSAR system
---
--- ## Main Features:
---
---    * Send out helicopters to downed pilots
---    * Rescues players and AI alike
---    * Coalition specific
---    * Starting from a FARP or Airbase
---    * Dedicated MASH zone
---    * Some FSM functions to include in your mission scripts
---    * Limit number of available helos
---
--- ===
---
--- ## Example Missions:
--- 
--- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/CSR-001%20-%20Basics).
---       
--- ===
--- 
--- ### Author: **applevangelist**
--- Last Update April 2022
---
--- ===
--- @module Functional.AICSAR
--- @image MOOSE.JPG
-
-
-
---- AI CSAR class.
--- @type AICSAR
--- @field #string ClassName Name of this class.
--- @field #string version Versioning.
--- @field #string lid LID for log entries.
--- @field #number coalition Colition side.
--- @field #string template Template for pilot.
--- @field #string helotemplate Template for CSAR helo.
--- @field #string alias Alias Name.
--- @field Wrapper.Airbase#AIRBASE farp FARP object from where to start.
--- @field Core.Zone#ZONE farpzone MASH zone to drop rescued pilots.
--- @field #number maxdistance Max distance to go for a rescue.
--- @field #table pilotqueue Queue of pilots to rescue.
--- @field #number pilotindex Table index to bind pilot to helo.
--- @field #table helos Table of Ops.FlightGroup#FLIGHTGROUP objects
--- @field #boolean verbose Switch more output.
--- @field #number rescuezoneradius Radius around downed pilot for the helo to land in.
--- @field #table rescued Track number of rescued pilot.
--- @field #boolean autoonoff Only send a helo when no human heli pilots are available.
--- @field Core.Set#SET_CLIENT playerset Track if alive heli pilots are available.
--- @field #boolean limithelos limit available number of helos going on mission (defaults to true)
--- @field #number helonumber number of helos available (default: 3)
--- @extends Core.Fsm#FSM
-
-
---- *I once donated a pint of my finest red corpuscles to the great American Red Cross and the doctor opined my blood was very helpful; contained so much alcohol they could use it to sterilize their instruments.*    
---  W.C.Fields
---
--- ===
---
--- # AICSAR Concept
--- 
--- For an AI or human pilot landing with a parachute, a rescue mission will be spawned. The helicopter will fly to the pilot, pick him or her up,
--- and fly back to a designated MASH (medical) zone, drop the pilot and then return to base.
--- Operational maxdistance can be set as well as the landing radius around the downed pilot.
--- Keep in mind that AI helicopters cannot hover-load at the time of writing, so rescue operations over water or in the mountains might not
--- work.
--- Optionally, if you have a CSAR operation with human pilots in your mission, you can set AICSAR to ignore missions when human helicopter
--- pilots are around.
---
--- ## Setup
--- 
--- Setup is a one-liner:
---            
---            -- @param #string Alias Name of this instance.
---            -- @param #number Coalition Coalition as in coalition.side.BLUE, can also be passed as "blue", "red" or "neutral"
---            -- @param #string Pilottemplate Pilot template name.
---            -- @param #string Helotemplate Helicopter template name.
---            -- @param Wrapper.Airbase#AIRBASE FARP FARP object or Airbase from where to start.
---            -- @param Core.Zone#ZONE MASHZone Zone where to drop pilots after rescue.
---            local my_aicsar=AICSAR:New("Luftrettung",coalition.side.BLUE,"Downed Pilot","Rescue Helo",AIRBASE:FindByName("Test FARP"),ZONE:New("MASH"))
---
--- ## Options are
---  
---            my_aicsar.maxdistance -- maximum operational distance in meters. Defaults to 50NM or 92.6km
---            my_aicsar.rescuezoneradius -- landing zone around downed pilot. Defaults to 200m
---            my_aicsar.autoonoff -- stop operations when human helicopter pilots are around. Defaults to true.
---            my_aicsar.verbose -- text messages to own coalition about ongoing operations. Defaults to true.
---            my_aicsarlimithelos -- limit available number of helos going on mission (defaults to true)
---            my_aicsar.helonumber -- number of helos available (default: 3)
--- 
--- ## Radio options
--- 
--- Radio messages, soundfile names and (for SRS) lengths are defined in three enumerators, so you can customize, localize messages and soundfiles to your liking:
--- 
--- Defaults are:
--- 
---            AICSAR.Messages = {
---              EN = {
---              INITIALOK = "Roger, Pilot, we hear you. Stay where you are, a helo is on the way!",
---              INITIALNOTOK = "Sorry, Pilot. You're behind maximum operational distance! Good Luck!",
---              PILOTDOWN = "Pilot down at ", -- note that this will be appended with the position
---              PILOTKIA = "Pilot KIA!",
---              HELODOWN = "CSAR Helo Down!",
---              PILOTRESCUED = "Pilot rescued!",
---              PILOTINHELO = "Pilot picked up!",
---              },
---            }
--- 
--- Correspondingly, sound file names are defined as these defaults:
--- 
---            AICSAR.RadioMessages = {
---              EN = {
---              INITIALOK = "initialok.ogg",
---              INITIALNOTOK = "initialnotok.ogg",
---              PILOTDOWN = "pilotdown.ogg",
---              PILOTKIA = "pilotkia.ogg", 
---              HELODOWN = "helodown.ogg", 
---              PILOTRESCUED = "pilotrescued.ogg", 
---              PILOTINHELO = "pilotinhelo.ogg",
---              }, 
---            }
--- 
--- and these default transmission lengths in seconds:
--- 
---            AICSAR.RadioLength = {
---              EN = {
---              INITIALOK = 4.1,
---              INITIALNOTOK = 4.6, 
---              PILOTDOWN = 2.6,
---              PILOTKIA = 1.1,
---              HELODOWN = 2.1,
---              PILOTRESCUED = 3.5,
---              PILOTINHELO = 2.6,
---              },
---            }
---
--- The easiest way to add a soundfile to your mission is to use the "Sound to..." trigger in the mission editor. This will effectively 
--- save your sound file inside of the .miz mission file.
--- 
--- To customize or localize your texts and sounds, you can take e.g. the following approach to add a German language version:
--- 
---           -- parameters are: locale, ID, text, soundfilename, duration
---           my_aicsar.gettext:AddEntry("de","INITIALOK","Copy, Pilot, wir hören Sie. Bleiben Sie, wo Sie sind, ein Hubschrauber sammelt Sie auf!","okneu.ogg",5.0)
---           my_aicsar.locale = "de" -- plays and shows the defined German language texts and sound. Fallback is "en", if something is undefined.
---           
--- Switch on radio transmissions via **either** SRS **or** "normal" DCS radio e.g. like so:
--- 
---          my_aicsar:SetSRSRadio(true,"C:\\Program Files\\DCS-SimpleRadio-Standalone",270,radio.modulation.AM,5002)
---         
--- or         
---          
---          my_aicsar:SetDCSRadio(true,300,radio.modulation.AM,GROUP:FindByName("FARP-Radio"))
--- 
--- See the function documentation for parameter details.
---                    
--- ===
----
---
--- @field #AICSAR
-AICSAR = {
-  ClassName = "AICSAR",
-  version = "0.0.8",
-  lid = "",
-  coalition = coalition.side.BLUE,
-  template = "",
-  helotemplate = "",
-  alias = "",
-  farp = nil,
-  farpzone = nil,
-  maxdistance = UTILS.NMToMeters(50),
-  pilotqueue = {},
-  pilotindex = 0,
-  helos = {},
-  verbose = true,
-  rescuezoneradius = 200,
-  rescued = {},
-  autoonoff = true,
-  playerset = nil,
-  Messages = {},
-  SRS = nil,
-  SRSRadio = false,
-  SRSFrequency = 243,
-  SRSPath = "\\",
-  SRSModulation = radio.modulation.AM,
-  SRSSoundPath = nil, -- defaults to "l10n/DEFAULT/", i.e. add messages via "Sount to..." in the ME
-  SRSPort = 5002,
-  DCSRadio = false,
-  DCSFrequency = 243,
-  DCSModulation = radio.modulation.AM,
-  DCSRadioGroup = nil,
-  limithelos = true,
-  helonumber = 3,
-  gettext = nil,
-  locale ="en", -- default text language
-}
-
--- TODO Messages
---- Messages enum
--- @field Messages
-AICSAR.Messages = {
-  EN = {
-  INITIALOK = "Roger, Pilot, we hear you. Stay where you are, a helo is on the way!",
-  INITIALNOTOK = "Sorry, Pilot. You're behind maximum operational distance! Good Luck!",
-  PILOTDOWN = "Pilot down at ",
-  PILOTKIA = "Pilot KIA!",
-  HELODOWN = "CSAR Helo Down!",
-  PILOTRESCUED = "Pilot rescued!",
-  PILOTINHELO = "Pilot picked up!",
-  },
-  DE = {
-  INITIALOK = "Copy, Pilot, wir hören Sie. Bleiben Sie, wo Sie sind!\nEin Hubschrauber sammelt Sie auf!",
-  INITIALNOTOK = "Verstehe, Pilot. Sie sind zu weit weg von uns.\nViel Glück!",
-  PILOTDOWN = "Pilot abgestürzt: ",
-  PILOTKIA = "Pilot gefallen!",
-  HELODOWN = "CSAR Hubschrauber verloren!",
-  PILOTRESCUED = "Pilot gerettet!",
-  PILOTINHELO = "Pilot an Bord geholt!",
-  },
-}
-
--- TODO Radio Messages
---- Radio Messages enum for ogg files
--- @field RadioMessages
-AICSAR.RadioMessages = {
-  EN = {
-  INITIALOK = "initialok.ogg", -- 4.1 secs
-  INITIALNOTOK = "initialnotok.ogg", -- 4.6 secs
-  PILOTDOWN = "pilotdown.ogg", -- 2.6 secs
-  PILOTKIA = "pilotkia.ogg", -- 1.1 sec
-  HELODOWN = "helodown.ogg", -- 2.1 secs
-  PILOTRESCUED = "pilotrescued.ogg", -- 3.5 secs
-  PILOTINHELO = "pilotinhelo.ogg", -- 2.6 secs
-  },
-}
-
--- TODO Radio Messages
---- Radio Messages enum for ogg files length in secs
--- @field RadioLength
-AICSAR.RadioLength = {
-  EN = {
-  INITIALOK = 4.1,
-  INITIALNOTOK = 4.6, 
-  PILOTDOWN = 2.6,
-  PILOTKIA = 1.1,
-  HELODOWN = 2.1,
-  PILOTRESCUED = 3.5,
-  PILOTINHELO = 2.6,
-  },
-}
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Function to create a new AICSAR object
--- @param #AICSAR self
--- @param #string Alias Name of this instance.
--- @param #number Coalition Coalition as in coalition.side.BLUE, can also be passed as "blue", "red" or "neutral"
--- @param #string Pilottemplate Pilot template name.
--- @param #string Helotemplate Helicopter template name.
--- @param Wrapper.Airbase#AIRBASE FARP FARP object or Airbase from where to start.
--- @param Core.Zone#ZONE MASHZone Zone where to drop pilots after rescue.
--- @return #AICSAR self
-function AICSAR:New(Alias,Coalition,Pilottemplate,Helotemplate,FARP,MASHZone)
-  -- Inherit everything from FSM class.
-  local self=BASE:Inherit(self, FSM:New())
-  
-    --set Coalition
-  if Coalition and type(Coalition)=="string" then
-    if Coalition=="blue" then
-      self.coalition=coalition.side.BLUE
-      self.coalitiontxt = Coalition
-    elseif Coalition=="red" then
-      self.coalition=coalition.side.RED
-      self.coalitiontxt = Coalition
-    elseif Coalition=="neutral" then
-      self.coalition=coalition.side.NEUTRAL
-      self.coalitiontxt = Coalition
-    else
-      self:E("ERROR: Unknown coalition in AICSAR!")
-    end
-  else
-    self.coalition = Coalition
-    self.coalitiontxt = string.lower(UTILS.GetCoalitionName(self.coalition))
-  end
-  
-    -- Set alias.
-  if Alias then
-    self.alias=tostring(Alias)
-  else
-    self.alias="Red Cross"  
-    if self.coalition then
-      if self.coalition==coalition.side.RED then
-        self.alias="IFRC"
-      elseif self.coalition==coalition.side.BLUE then
-        self.alias="CSAR"
-      end
-    end
-  end
-  
-  self.template = Pilottemplate
-  self.helotemplate = Helotemplate
-  self.farp = FARP
-  self.farpzone = MASHZone
-  self.playerset = SET_CLIENT:New():FilterActive(true):FilterCategories("helicopter"):FilterStart()
-  
-  -- Radio
-  self.SRS = nil
-  self.SRSRadio = false
-  self.SRSFrequency = 243
-  self.SRSPath = "\\"
-  self.SRSModulation = radio.modulation.AM
-  self.SRSSoundPath = nil -- defaults to "l10n/DEFAULT/", i.e. add messages via "Sound to..." in the ME
-  self.SRSPort = 5002
-  
-  -- DCS Radio - add messages via "Sound to..." in the ME
-  self.DCSRadio = false
-  self.DCSFrequency = 243
-  self.DCSModulation = radio.modulation.AM
-  self.DCSRadioGroup = nil
-  self.DCSRadioQueue = nil
-  
-  self.MGRS_Accuracy = 2
-  
-  -- limit number of available helos at the same time
-  self.limithelos = true
-  self.helonumber = 3
-
-  -- localization
-  self:InitLocalization()
-  
-  -- Set some string id for output to DCS.log file.
-  self.lid=string.format("%s (%s) | ", self.alias, self.coalition and UTILS.GetCoalitionName(self.coalition) or "unknown")
-  
-  -- Start State.
-  self:SetStartState("Stopped")
-  
-    -- Add FSM transitions.
-  --                 From State  -->   Event        -->     To State
-  self:AddTransition("Stopped",       "Start",              "Running")     -- Start FSM.
-  self:AddTransition("*",             "Status",             "*")           -- CSAR status update.
-  self:AddTransition("*",             "PilotDown",          "*")           -- Pilot down
-  self:AddTransition("*",             "PilotPickedUp",      "*")           -- Pilot in helo
-  self:AddTransition("*",             "PilotRescued",       "*")           -- Pilot Rescued
-  self:AddTransition("*",             "PilotKIA",           "*")           -- Pilot dead
-  self:AddTransition("*",             "HeloDown",           "*")           -- Helo dead
-  self:AddTransition("*",             "Stop",               "Stopped")     -- Stop FSM.
-  
-  self:HandleEvent(EVENTS.LandingAfterEjection)
-  
-  self:__Start(math.random(2,5))
-  
-  local text = string.format("%sAICSAR Version %s Starting",self.lid,self.version)
-  
-  self:I(text)
-  
-  ------------------------
-  --- Pseudo Functions ---
-  ------------------------
-
-  --- Triggers the FSM event "Status".
-  -- @function [parent=#AICSAR] Status
-  -- @param #AICSAR self
-
-  --- Triggers the FSM event "Status" after a delay.
-  -- @function [parent=#AICSAR] __Status
-  -- @param #AICSAR self
-  -- @param #number delay Delay in seconds.
-
-  --- Triggers the FSM event "Stop".
-  -- @function [parent=#AICSAR] Stop
-  -- @param #AICSAR self
-
-  --- Triggers the FSM event "Stop" after a delay.
-  -- @function [parent=#AICSAR] __Stop
-  -- @param #AICSAR self
-  -- @param #number delay Delay in seconds.
-  
-  --- On after "PilotDown" event.
-  -- @function [parent=#AICSAR] OnAfterPilotDown
-  -- @param #AICSAR self
-  -- @param #string From From state.
-  -- @param #string Event Event.
-  -- @param #string To To state.
-  -- @param Core.Point#COORDINATE Coordinate Location of the pilot.
-  -- @param #boolean InReach True if in maxdistance else false. 
-  
-  --- On after "PilotPickedUp" event.
-  -- @function [parent=#AICSAR] OnAfterPilotPickedUp
-  -- @param #AICSAR self
-  -- @param #string From From state.
-  -- @param #string Event Event.
-  -- @param #string To To state.
-  -- @param Ops.FlightGroup#FLIGHTGROUP Helo
-  -- @param #table CargoTable of Ops.OpsGroup#OPSGROUP Cargo objects
-  -- @param #number Index  
-  
-  --- On after "PilotRescued" event.
-  -- @function [parent=#AICSAR] OnAfterPilotRescued
-  -- @param #AICSAR self
-  -- @param #string From From state.
-  -- @param #string Event Event.
-  -- @param #string To To state. 
-
-  --- On after "PilotKIA" event.
-  -- @function [parent=#AICSAR] OnAfterPilotKIA
-  -- @param #AICSAR self
-  -- @param #string From From state.
-  -- @param #string Event Event.
-  -- @param #string To To state. 
-
-  --- On after "HeloDown" event.
-  -- @function [parent=#AICSAR] OnAfterHeloDown
-  -- @param #AICSAR self
-  -- @param #string From From state.
-  -- @param #string Event Event.
-  -- @param #string To To state.
-  -- @param Ops.FlightGroup#FLIGHTGROUP Helo
-  -- @param #number Index
-  
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- [Internal] Create the Moose TextAndSoundEntries
--- @param #AICSAR self
--- @return #AICSAR self
-function AICSAR:InitLocalization()
-  self:T(self.lid .. "InitLocalization")
-  -- English standard localization
-  self.gettext=TEXTANDSOUND:New(self.ClassName, "en")
-  self.gettext:AddEntry("en","INITIALOK",AICSAR.Messages.EN.INITIALOK,AICSAR.RadioMessages.EN.INITIALOK,AICSAR.RadioLength.INITIALOK)
-  self.gettext:AddEntry("en","INITIALNOTOK",AICSAR.Messages.EN.INITIALNOTOK,AICSAR.RadioMessages.EN.INITIALNOTOK,AICSAR.RadioLength.EN.INITIALNOTOK)
-  self.gettext:AddEntry("en","HELODOWN",AICSAR.Messages.EN.HELODOWN,AICSAR.RadioMessages.EN.HELODOWN,AICSAR.RadioLength.EN.HELODOWN)
-  self.gettext:AddEntry("en","PILOTDOWN",AICSAR.Messages.EN.PILOTDOWN,AICSAR.RadioMessages.EN.PILOTDOWN,AICSAR.RadioLength.EN.PILOTDOWN)
-  self.gettext:AddEntry("en","PILOTINHELO",AICSAR.Messages.EN.PILOTINHELO,AICSAR.RadioMessages.EN.PILOTINHELO,AICSAR.RadioLength.EN.PILOTINHELO)
-  self.gettext:AddEntry("en","PILOTKIA",AICSAR.Messages.EN.PILOTKIA,AICSAR.RadioMessages.EN.PILOTKIA,AICSAR.RadioLength.EN.PILOTKIA)
-  self.gettext:AddEntry("en","PILOTRESCUED",AICSAR.Messages.EN.PILOTRESCUED,AICSAR.RadioMessages.EN.PILOTRESCUED,AICSAR.RadioLength.EN.PILOTRESCUED)
-  -- German localization - we keep the sound files English
-  self.gettext:AddEntry("de","INITIALOK",AICSAR.Messages.DE.INITIALOK,AICSAR.RadioMessages.EN.INITIALOK,AICSAR.RadioLength.INITIALOK)
-  self.gettext:AddEntry("de","INITIALNOTOK",AICSAR.Messages.DE.INITIALNOTOK,AICSAR.RadioMessages.EN.INITIALNOTOK,AICSAR.RadioLength.EN.INITIALNOTOK)
-  self.gettext:AddEntry("de","HELODOWN",AICSAR.Messages.DE.HELODOWN,AICSAR.RadioMessages.EN.HELODOWN,AICSAR.RadioLength.EN.HELODOWN)
-  self.gettext:AddEntry("de","PILOTDOWN",AICSAR.Messages.DE.PILOTDOWN,AICSAR.RadioMessages.EN.PILOTDOWN,AICSAR.RadioLength.EN.PILOTDOWN)
-  self.gettext:AddEntry("de","PILOTINHELO",AICSAR.Messages.DE.PILOTINHELO,AICSAR.RadioMessages.EN.PILOTINHELO,AICSAR.RadioLength.EN.PILOTINHELO)
-  self.gettext:AddEntry("de","PILOTKIA",AICSAR.Messages.DE.PILOTKIA,AICSAR.RadioMessages.EN.PILOTKIA,AICSAR.RadioLength.EN.PILOTKIA)
-  self.gettext:AddEntry("de","PILOTRESCUED",AICSAR.Messages.DE.PILOTRESCUED,AICSAR.RadioMessages.EN.PILOTRESCUED,AICSAR.RadioLength.EN.PILOTRESCUED)
-  self.locale = "en"
-  return self
-end
-
---- [User] Switch sound output on and use SRS
--- @param #AICSAR self
--- @param #boolean OnOff Switch on (true) or off (false).
--- @param #string Path Path to your SRS Server Component, e.g. "E:\\\\Program Files\\\\DCS-SimpleRadio-Standalone"
--- @param #number Frequency Defaults to 243 (guard)
--- @param #number Modulation Radio modulation. Defaults to radio.modulation.AM
--- @param #string SoundPath Where to find the audio files. Defaults to nil, i.e. add messages via "Sound to..." in the Mission Editor.
--- @param #number Port Port of the SRS, defaults to 5002.
--- @return #AICSAR self
-function AICSAR:SetSRSRadio(OnOff,Path,Frequency,Modulation,SoundPath,Port)
-  self:T(self.lid .. "SetSRSRadio")
-  self:T(self.lid .. "SetSRSRadio to "..tostring(OnOff))
-  self.SRSRadio = OnOff and true
-  self.SRSFrequency = Frequency or 243
-  self.SRSPath = Path or "c:\\"
-  self.SRSModulation = Modulation or radio.modulation.AM
-  local soundpath = os.getenv('TMP') .. "\\DCS\\Mission\\l10n\\DEFAULT" -- defaults to "l10n/DEFAULT/", i.e. add messages by "Sound to..." in the ME
-  self.SRSSoundPath = SoundPath or soundpath
-  self.SRSPort = Port or 5002
-  if OnOff then
-    self.SRS = MSRS:New(Path,Frequency,Modulation)
-    self.SRS:SetPort(self.SRSPort)
-  end
-  return self
-end
-
---- [User] Switch sound output on and use normale (DCS) radio
--- @param #AICSAR self
--- @param #boolean OnOff Switch on (true) or off (false).
--- @param #number Frequency Defaults to 243 (guard).
--- @param #number Modulation Radio modulation. Defaults to radio.modulation.AM.
--- @param Wrapper.Group#GROUP Group The group to use as sending station.
--- @return #AICSAR self
-function AICSAR:SetDCSRadio(OnOff,Frequency,Modulation,Group)
-  self:T(self.lid .. "SetDCSRadio")
-  self:T(self.lid .. "SetDCSRadio to "..tostring(OnOff))
-  self.DCSRadio = OnOff and true
-  self.DCSFrequency = Frequency or 243
-  self.DCSModulation = Modulation or radio.modulation.AM
-  self.DCSRadioGroup = Group
-  if self.DCSRadio then
-    self.DCSRadioQueue = RADIOQUEUE:New(Frequency,Modulation,"AI-CSAR")
-    self.DCSRadioQueue:Start(5,5)
-    self.DCSRadioQueue:SetRadioPower(1000)
-    self.DCSRadioQueue:SetSenderCoordinate(Group:GetCoordinate())
-  else
-    if self.DCSRadioQueue then
-      self.DCSRadioQueue:Stop()
-    end
-  end
-  return self
-end
-
---- [Internal] Sound output via non-SRS Radio. Add message files (.ogg) via "Sound to..." in the ME.
--- @param #AICSAR self
--- @param #string Soundfile Name of the soundfile
--- @param #number Duration Duration of the sound
--- @param #string Subtitle Text to display
--- @return #AICSAR self
-function AICSAR:DCSRadioBroadcast(Soundfile,Duration,Subtitle)
-  self:T(self.lid .. "DCSRadioBroadcast")
-  local radioqueue = self.DCSRadioQueue -- Sound.RadioQueue#RADIOQUEUE
-  radioqueue:NewTransmission(Soundfile,Duration,nil,2,nil,Subtitle,10)
-  return self
-end
-
---- [Internal] Catch the landing after ejection and spawn a pilot in situ.
--- @param #AICSAR self
--- @param Core.Event#EVENTDATA EventData
--- @return #AICSAR self
-function AICSAR:OnEventLandingAfterEjection(EventData)
-  self:T(self.lid .. "OnEventLandingAfterEjection ID=" .. EventData.id)
-  
-  -- autorescue on off?
-  if self.autoonoff then
-    if self.playerset:CountAlive() > 0 then
-      return self
-    end
-  end
-  
-  local _event = EventData -- Core.Event#EVENTDATA
-  -- get position and spawn in a template pilot
-  local _LandingPos = COORDINATE:NewFromVec3(_event.initiator:getPosition().p)
-  local _country = _event.initiator:getCountry()
-  local _coalition = coalition.getCountryCoalition( _country )
-  
-  -- DONE: add distance check
-  local distancetofarp = _LandingPos:Get2DDistance(self.farp:GetCoordinate())
-  
-  -- Mayday Message
-  local Text,Soundfile,Soundlength,Subtitle = self.gettext:GetEntry("PILOTDOWN",self.locale)
-  local text = ""
-  if _coalition == self.coalition then
-    if self.verbose then
-      local setting = {}
-      setting.MGRS_Accuracy = self.MGRS_Accuracy
-      local location = _LandingPos:ToStringMGRS(setting)
-      text = Text .. location .. "!"
-      MESSAGE:New(text,15,"AICSAR"):ToCoalition(self.coalition)
-    end
-    if self.SRSRadio then
-      local sound = SOUNDFILE:New(Soundfile,self.SRSSoundPath,Soundlength)
-      sound:SetPlayWithSRS(true)
-      self.SRS:PlaySoundFile(sound,2)
-    elseif self.DCSRadio then
-      self:DCSRadioBroadcast(Soundfile,Soundlength,text)
-    end   
-  end
-  
-  -- further processing
-  if _coalition == self.coalition and distancetofarp <= self.maxdistance then
-    -- in reach
-    self:T(self.lid .. "Spawning new Pilot")
-    self.pilotindex = self.pilotindex + 1
-    local newpilot = SPAWN:NewWithAlias(self.template,string.format("%s-AICSAR-%d",self.template, self.pilotindex))
-    newpilot:InitDelayOff()
-    newpilot:OnSpawnGroup(
-      function (grp)
-        self.pilotqueue[self.pilotindex] = grp
-      end
-    )
-    newpilot:SpawnFromCoordinate(_LandingPos) 
-    
-    Unit.destroy(_event.initiator) -- shagrat remove static Pilot model
-    self:__PilotDown(2,_LandingPos,true)
-  elseif _coalition == self.coalition and distancetofarp > self.maxdistance then
-    -- out of reach, apologies, too far off   
-    self:T(self.lid .. "Pilot out of reach")
-    self:__PilotDown(2,_LandingPos,false)
-  end 
-  return self
-end
-
---- [Internal] Get FlightGroup
--- @param #AICSAR self
--- @return Ops.FlightGroup#FLIGHTGROUP The FlightGroup
-function AICSAR:_GetFlight()
-  self:T(self.lid .. "_GetFlight")
-  -- Helo Carrier.
-  local newhelo = SPAWN:NewWithAlias(self.helotemplate,self.helotemplate..math.random(1,10000))
-    :InitDelayOff()
-    :InitUnControlled(true)
-    :Spawn()
-    
-  local nhelo=FLIGHTGROUP:New(newhelo)
-  nhelo:SetHomebase(self.farp)
-  nhelo:Activate()
-  return nhelo
-end
-
---- [Internal] Create a new rescue mission
--- @param #AICSAR self
--- @param Wrapper.Group#GROUP Pilot The pilot to be rescued.
--- @param #number Index Index number of this pilot
--- @return #AICSAR self
-function AICSAR:_InitMission(Pilot,Index)
-  self:T(self.lid .. "_InitMission")
-  
-  local pickupzone = ZONE_GROUP:New(Pilot:GetName(),Pilot,self.rescuezoneradius)
-  --local pilotset = SET_GROUP:New()
-  --pilotset:AddGroup(Pilot)
-  
-    -- Cargo transport assignment.
-  local opstransport=OPSTRANSPORT:New(Pilot, pickupzone, self.farpzone)
-  
-  local helo = self:_GetFlight()
-  -- inject reservation
-  helo.AICSARReserved = true
-  
-  -- Cargo transport assignment to first Huey group.
-  helo:AddOpsTransport(opstransport)
-  
-  -- callback functions
-  local function AICPickedUp(Helo,Cargo,Index)
-    self:__PilotPickedUp(2,Helo,Cargo,Index)   
-  end
-  
-  local function AICHeloDead(Helo,Index)
-    self:__HeloDown(2,Helo,Index)   
-  end
-  
-  function helo:OnAfterLoadingDone(From,Event,To)
-    AICPickedUp(helo,helo:GetCargoGroups(),Index)   
-  end
-  
-  function helo:OnAfterDead(From,Event,To)
-    AICHeloDead(helo,Index)
-  end
-  
-  self.helos[Index] = helo
-  
-  return self
-end
-
---- [Internal] Check if pilot arrived in rescue zone (MASH)
--- @param #AICSAR self
--- @param Wrapper.Group#GROUP Pilot The pilot to be rescued.
--- @return #boolean outcome
-function AICSAR:_CheckInMashZone(Pilot)
-  self:T(self.lid .. "_CheckQueue")
-  if Pilot:IsInZone(self.farpzone) then
-    return true
-  else
-    return false
-  end
-end
-
---- [Internal] Check helo queue 
--- @param #AICSAR self
--- @return #AICSAR self
-function AICSAR:_CheckHelos()
-  self:T(self.lid .. "_CheckHelos")
-  for _index,_helo in pairs(self.helos) do
-    local helo = _helo -- Ops.FlightGroup#FLIGHTGROUP
-    if helo and helo.ClassName == "FLIGHTGROUP" then
-      local state = helo:GetState()
-      local name = helo:GetName()
-      self:T("Helo group "..name.." in state "..state)
-      if state == "Arrived" then
-        helo:__Stop(5)
-        self.helos[_index] = nil
-      end
-    else
-      self.helos[_index] = nil
-    end
-  end
-  return self
-end
-
---- [Internal] Count helos queue 
--- @param #AICSAR self
--- @return #number Number of helos on mission
-function AICSAR:_CountHelos()
-  self:T(self.lid .. "_CountHelos")
-  local count = 0
-    for _index,_helo in pairs(self.helos) do
-      count = count + 1
-    end
-  return count
-end
-
---- [Internal] Check pilot queue for next mission
--- @param #AICSAR self
--- @return #AICSAR self
-function AICSAR:_CheckQueue()
-  self:T(self.lid .. "_CheckQueue")
-  for _index, _pilot in pairs(self.pilotqueue) do
-    local classname = _pilot.ClassName and _pilot.ClassName or "NONE"
-    local name = _pilot.GroupName and _pilot.GroupName or "NONE"
-    local helocount = self:_CountHelos()
-    --self:T("Looking at " .. classname .. " " .. name)
-    -- find one w/o mission
-    if _pilot and _pilot.ClassName and _pilot.ClassName == "GROUP" then
-     local flightgroup = self.helos[_index] -- Ops.FlightGroup#FLIGHTGROUP
-     -- rescued?
-     if self:_CheckInMashZone(_pilot) then
-      self:T("Pilot" .. _pilot.GroupName .. " rescued!") 
-      _pilot:Destroy(false)
-      self.pilotqueue[_index] = nil
-      self.rescued[_index] = true
-      self:__PilotRescued(2)
-      if flightgroup then
-        flightgroup.AICSARReserved = false
-      end
-     end -- end rescued
-      -- has no mission assigned?
-      if not _pilot.AICSAR then
-        -- helo available?
-        if self.limithelos and helocount >= self.helonumber then
-            -- none free
-            break
-        end -- end limit
-        _pilot.AICSAR = {}
-        _pilot.AICSAR.Status = "Initiated"
-        _pilot.AICSAR.Boarded = false
-        self:_InitMission(_pilot,_index)
-        break
-      else 
-       -- update status from OPSGROUP
-       if flightgroup then
-         local state = flightgroup:GetState()
-         _pilot.AICSAR.Status = state
-       end
-       --self:T("Flight for " .. _pilot.GroupName .. " in state " .. state)
-      end -- end has mission
-    end -- end if pilot
-  end -- end loop
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- FSM Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- [Internal] onafterStart
--- @param #AICSAR self
--- @param #string From 
--- @param #string Event
--- @param #string To
--- @return #AICSAR self
-function AICSAR:onafterStart(From, Event, To)
-  self:T({From, Event, To})
-  self:__Status(3)
-  return self
-end
-
---- [Internal] onafterStatus
--- @param #AICSAR self
--- @param #string From 
--- @param #string Event
--- @param #string To
--- @return #AICSAR self
-function AICSAR:onafterStatus(From, Event, To)
-  self:T({From, Event, To})
-  self:_CheckQueue()
-  self:_CheckHelos()
-  self:__Status(30)
-  return self
-end
-
---- [Internal] onafterStop
--- @param #AICSAR self
--- @param #string From 
--- @param #string Event
--- @param #string To
--- @return #AICSAR self
-function AICSAR:onafterStop(From, Event, To)
-  self:T({From, Event, To})
-  self:UnHandleEvent(EVENTS.LandingAfterEjection)
-  if self.DCSRadioQueue then
-    self.DCSRadioQueue:Stop()
-  end
-  return self
-end
-
---- [Internal] onafterPilotDown
--- @param #AICSAR self
--- @param #string From 
--- @param #string Event
--- @param #string To
--- @param Core.Point#COORDINATE Coordinate Location of the pilot.
--- @param #boolean InReach True if in maxdistance else false.
--- @return #AICSAR self
-function AICSAR:onafterPilotDown(From, Event, To, Coordinate, InReach)
-  self:T({From, Event, To})
-  local CoordinateText = Coordinate:ToStringMGRS()
-  local inreach = tostring(InReach)
-  --local text = string.format("Pilot down at %s. In reach = %s",CoordinateText,inreach)
-  if InReach then
-    local text,Soundfile,Soundlength,Subtitle = self.gettext:GetEntry("INITIALOK",self.locale)
-    --local text = AICSAR.Messages.EN.INITIALOK
-    self:T(text)
-    if self.verbose then
-      MESSAGE:New(text,15,"AICSAR"):ToCoalition(self.coalition)
-    end
-    if self.SRSRadio then
-      local sound = SOUNDFILE:New(Soundfile,self.SRSSoundPath,Soundlength)
-      sound:SetPlayWithSRS(true)
-      self.SRS:PlaySoundFile(sound,2)
-    elseif self.DCSRadio then
-      self:DCSRadioBroadcast(Soundfile,Soundlength,text)
-    end
-  else
-    local text,Soundfile,Soundlength,Subtitle = self.gettext:GetEntry("INITIALNOTOK",self.locale)
-    --local text = AICSAR.Messages.EN.INITIALNOTOK
-    self:T(text)
-    if self.verbose then
-      MESSAGE:New(text,15,"AICSAR"):ToCoalition(self.coalition)
-    end
-    if self.SRSRadio then
-      local sound = SOUNDFILE:New(Soundfile,self.SRSSoundPath,Soundlength)
-      sound:SetPlayWithSRS(true)
-      self.SRS:PlaySoundFile(sound,2)
-    elseif self.DCSRadio then
-      self:DCSRadioBroadcast(Soundfile,Soundlength,text)
-    end
-  end
-  return self
-end
-
---- [Internal] onafterPilotKIA
--- @param #AICSAR self
--- @param #string From 
--- @param #string Event
--- @param #string To
--- @return #AICSAR self
-function AICSAR:onafterPilotKIA(From, Event, To)
-  self:T({From, Event, To})
-  local text,Soundfile,Soundlength,Subtitle = self.gettext:GetEntry("PILOTKIA",self.locale)
-  if self.verbose then
-    MESSAGE:New(text,15,"AICSAR"):ToCoalition(self.coalition)
-  end
-  if self.SRSRadio then
-    local sound = SOUNDFILE:New(Soundfile,self.SRSSoundPath,Soundlength)
-    sound:SetPlayWithSRS(true)
-    self.SRS:PlaySoundFile(sound,2)
-  elseif self.DCSRadio then
-    self:DCSRadioBroadcast(Soundfile,Soundlength,text)
-  end
-  return self
-end
-
---- [Internal] onafterHeloDown
--- @param #AICSAR self
--- @param #string From 
--- @param #string Event
--- @param #string To
--- @param Ops.FlightGroup#FLIGHTGROUP Helo
--- @param #number Index
--- @return #AICSAR self
-function AICSAR:onafterHeloDown(From, Event, To, Helo, Index)
-  self:T({From, Event, To})
-  local text,Soundfile,Soundlength,Subtitle = self.gettext:GetEntry("HELODOWN",self.locale)
-  if self.verbose then
-    MESSAGE:New(text,15,"AICSAR"):ToCoalition(self.coalition)
-  end
-  if self.SRSRadio then
-    local sound = SOUNDFILE:New(Soundfile,self.SRSSoundPath,Soundlength)
-    sound:SetPlayWithSRS(true)
-    self.SRS:PlaySoundFile(sound,2)
-  elseif self.DCSRadio then
-    self:DCSRadioBroadcast(Soundfile,Soundlength,text)
-  end
-  local findex = 0
-  local fhname = Helo:GetName()
-  -- find index of Helo
-  if Index and Index > 0 then
-    findex=Index
-  else
-    for _index, _helo in pairs(self.helos) do
-      local helo = _helo -- Ops.FlightGroup#FLIGHTGROUP
-      local hname = helo:GetName()
-      if fhname == hname then
-        findex = _index
-        break
-      end
-    end
-  end
-  -- find pilot
-  if findex > 0  and not self.rescued[findex] then
-    local pilot = self.pilotqueue[findex]
-    self.helos[findex] = nil
-    if pilot.AICSAR.Boarded then
-      self:T("Helo Down: Found DEAD Pilot ID " .. findex .. " with name " .. pilot:GetName())
-      -- pilot also dead
-      self:__PilotKIA(2)
-      self.pilotqueue[findex] = nil
-    else
-      -- initiate new mission
-      self:T("Helo Down: Found ALIVE Pilot ID " .. findex .. " with name " .. pilot:GetName())
-      self:_InitMission(pilot,findex)
-    end
-  end
-  return self
-end
-
---- [Internal] onafterPilotRescued
--- @param #AICSAR self
--- @param #string From 
--- @param #string Event
--- @param #string To
--- @return #AICSAR self
-function AICSAR:onafterPilotRescued(From, Event, To)
-  self:T({From, Event, To})
-  local text,Soundfile,Soundlength,Subtitle = self.gettext:GetEntry("PILOTRESCUED",self.locale)
-  if self.verbose then
-    MESSAGE:New(text,15,"AICSAR"):ToCoalition(self.coalition)
-  end
-  if self.SRSRadio then
-    local sound = SOUNDFILE:New(Soundfile,self.SRSSoundPath,Soundlength)
-    sound:SetPlayWithSRS(true)
-    self.SRS:PlaySoundFile(sound,2)
-  elseif self.DCSRadio then
-    self:DCSRadioBroadcast(Soundfile,Soundlength,text)
-  end
-  return self
-end
-
---- [Internal] onafterPilotPickedUp
--- @param #AICSAR self
--- @param #string From 
--- @param #string Event
--- @param #string To
--- @param Ops.FlightGroup#FLIGHTGROUP Helo
--- @param #table CargoTable of Ops.OpsGroup#OPSGROUP Cargo objects
--- @param #number Index 
--- @return #AICSAR self
-function AICSAR:onafterPilotPickedUp(From, Event, To, Helo, CargoTable, Index)
-  self:T({From, Event, To})
-  local text,Soundfile,Soundlength,Subtitle = self.gettext:GetEntry("PILOTINHELO",self.locale)
-  if self.verbose then
-    MESSAGE:New(text,15,"AICSAR"):ToCoalition(self.coalition)
-  end
-  if self.SRSRadio then
-    local sound = SOUNDFILE:New(Soundfile,self.SRSSoundPath,Soundlength)
-    sound:SetPlayWithSRS(true)
-    self.SRS:PlaySoundFile(sound,2)
-  elseif self.DCSRadio then
-    self:DCSRadioBroadcast(Soundfile,Soundlength,text)
-  end
-  local findex = 0
-  local fhname = Helo:GetName()
-  if Index and Index > 0 then
-    findex = Index
-  else
-    -- find index of Helo
-    for _index, _helo in pairs(self.helos) do
-      local helo = _helo -- Ops.FlightGroup#FLIGHTGROUP
-      local hname = helo:GetName()
-      if fhname == hname then
-        findex = _index
-        break
-      end
-    end
-  end
-  -- find pilot
-  if findex > 0  then
-    local pilot = self.pilotqueue[findex]
-    self:T("Boarded: Found Pilot ID " .. findex .. " with name " .. pilot:GetName())
-    pilot.AICSAR.Boarded = true -- mark as boarded
-  end
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- END AICSAR
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Functional/Artillery.lua

@@ -25,12 +25,12 @@
 --
 -- ===
 --
--- ### 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.Arty
+-- @module Functional.Artillery
 -- @image Artillery.JPG
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -73,7 +73,7 @@
 -- @field Core.Point#COORDINATE RearmingPlaceCoord Coordinates of the rearming place. If the place is more than 100 m away from the ARTY group, the group will go there.
 -- @field #boolean RearmingArtyOnRoad If true, ARTY group will move to rearming place using mainly roads. Default false.
 -- @field Core.Point#COORDINATE InitialCoord Initial coordinates of the ARTY group.
--- @field #boolean report Arty group sends messages about their current state or target to its coaliton.
+-- @field #boolean report Arty group sends messages about their current state or target to its coalition.
 -- @field #table ammoshells Table holding names of the shell types which are included when counting the ammo. Default is {"weapons.shells"} which include most shells.
 -- @field #table ammorockets Table holding names of the rocket types which are included when counting the ammo. Default is {"weapons.nurs"} which includes most unguided rockets.
 -- @field #table ammomissiles Table holding names of the missile types which are included when counting the ammo. Default is {"weapons.missiles"} which includes some guided missiles.
@@ -103,12 +103,13 @@
 -- @field #number coalition The coalition of the arty group.
 -- @field #boolean respawnafterdeath Respawn arty group after all units are dead.
 -- @field #number respawndelay Respawn delay in seconds.
+-- @field #number dtTrack Time interval in seconds for weapon tracking.
 -- @extends Core.Fsm#FSM_CONTROLLABLE
 
 --- Enables mission designers easily to assign targets for artillery units. Since the implementation is based on a Finite State Model (FSM), the mission designer can
 -- interact with the process at certain events or states.
 --
--- A new ARTY object can be created with the @{#ARTY.New}(*group*) contructor.
+-- A new ARTY object can be created with the @{#ARTY.New}(*group*) constructor.
 -- The parameter *group* has to be a MOOSE Group object and defines ARTY group.
 --
 -- The ARTY FSM process can be started by the @{#ARTY.Start}() command.
@@ -146,7 +147,7 @@
 -- When a new target is assigned via the @{#ARTY.AssignTargetCoord}() function (see below), the **NewTarget** event is triggered.
 --
 -- ## Assigning Targets
--- Assigning targets is a central point of the ARTY class. Multiple targets can be assigned simultanioulsly and are put into a queue.
+-- Assigning targets is a central point of the ARTY class. Multiple targets can be assigned simultaneously and are put into a queue.
 -- Of course, targets can be added at any time during the mission. For example, once they are detected by a reconnaissance unit.
 --
 -- In order to add a target, the function @{#ARTY.AssignTargetCoord}(*coord*, *prio*, *radius*, *nshells*, *maxengage*, *time*, *weapontype*, *name*) has to be used.
@@ -161,7 +162,7 @@
 -- * *maxengage*: Number of times a target is engaged.
 -- * *time*: Time of day the engagement is schedule in the format "hh:mm:ss" for hh=hours, mm=minutes, ss=seconds.
 -- For example "10:15:35". In the case the attack will be executed at a quarter past ten in the morning at the day the mission started.
--- If the engagement should start on the following day the format can be specified as "10:15:35+1", where the +1 denots the following day.
+-- If the engagement should start on the following day the format can be specified as "10:15:35+1", where the +1 denotes the following day.
 -- This is useful for longer running missions or if the mission starts at 23:00 hours and the attack should be scheduled at 01:00 hours on the following day.
 -- Of course, later days are also possible by appending "+2", "+3", etc.
 -- **Note** that the time has to be given as a string. So the enclosing quotation marks "" are important.
@@ -179,7 +180,7 @@
 -- Let's first consider the case that none of the targets is scheduled to be executed at a certain time (*time*=nil).
 -- The ARTY group will first engage the target with higher priority (*prio*=10). After the engagement is finished, the target with lower priority is attacked.
 -- This is because the target with lower prio has been attacked one time less. After the attack on the lower priority task is finished and both targets
--- have been engaged equally often, the target with the higher priority is engaged again. This coninues until a target has engaged three times.
+-- have been engaged equally often, the target with the higher priority is engaged again. This continues until a target has engaged three times.
 -- Once the maximum number of engagements is reached, the target is deleted from the queue.
 --
 -- In other words, the queue is first sorted with respect to the number of engagements and targets with the same number of engagements are sorted with
@@ -190,7 +191,7 @@
 -- As mentioned above, targets can be engaged at a specific time of the day via the *time* parameter.
 --
 -- If the *time* parameter is specified for a target, the first engagement of that target will happen at that time of the day and not before.
--- This also applies when multiple engagements are requested via the *maxengage* parameter. The first attack will not happen before the specifed time.
+-- This also applies when multiple engagements are requested via the *maxengage* parameter. The first attack will not happen before the specified time.
 -- When that timed attack is finished, the *time* parameter is deleted and the remaining engagements are carried out in the same manner as for untimed targets (described above).
 --
 -- Of course, it can happen that a scheduled task should be executed at a time, when another target is already under attack.
@@ -201,7 +202,7 @@
 --
 -- ## Determining the Amount of Ammo
 --
--- In order to determin when a unit is out of ammo and possible initiate the rearming process it is necessary to know which types of weapons have to be counted.
+-- In order to determine when a unit is out of ammo and possible initiate the rearming process it is necessary to know which types of weapons have to be counted.
 -- For most artillery unit types, this is simple because they only have one type of weapon and hence ammunition.
 --
 -- However, there are more complex scenarios. For example, naval units carry a big arsenal of different ammunition types ranging from various cannon shell types
@@ -217,7 +218,7 @@
 -- **Note** that the default parameters "weapons.shells", "weapons.nurs", "weapons.missiles" **should in priciple** capture all the corresponding ammo types.
 -- However, the logic searches for the string "weapon.missies" in the ammo type. Especially for missiles, this string is often not contained in the ammo type descriptor.
 --
--- One way to determin which types of ammo the unit carries, one can use the debug mode of the arty class via @{#ARTY.SetDebugON}().
+-- One way to determine which types of ammo the unit carries, one can use the debug mode of the arty class via @{#ARTY.SetDebugON}().
 -- In debug mode, the all ammo types of the group are printed to the monitor as message and can be found in the DCS.log file.
 --
 -- ## Employing Selected Weapons
@@ -274,7 +275,7 @@
 --
 -- ## Simulated Weapons
 --
--- In addtion to the standard weapons a group has available some special weapon types that are not possible to use in the native DCS environment are simulated.
+-- In addition to the standard weapons a group has available some special weapon types that are not possible to use in the native DCS environment are simulated.
 --
 -- ### Tactical Nukes
 --
@@ -283,30 +284,30 @@
 --
 -- By default, they group does not have any nukes available. To give the group the ability the function @{#ARTY.SetTacNukeShells}(*n*) can be used.
 -- This supplies the group with *n* nuclear shells, where *n* is restricted to the number of conventional shells the group can carry.
--- Note that the group must always have convenctional shells left in order to fire a nuclear shell.
+-- Note that the group must always have conventional shells left in order to fire a nuclear shell.
 --
--- The default explostion strength is 0.075 kilo tons TNT. The can be changed with the @{#ARTY.SetTacNukeWarhead}(*strength*), where *strength* is given in kilo tons TNT.
+-- The default explosion strength is 0.075 kilo tons TNT. The can be changed with the @{#ARTY.SetTacNukeWarhead}(*strength*), where *strength* is given in kilo tons TNT.
 --
 -- ### 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
 --
--- In a similar way to illumination shells, ARTY groups can also employ smoke shells. The numer of smoke shells the group has available is set by the function
+-- In a similar way to illumination shells, ARTY groups can also employ smoke shells. The number of smoke shells the group has available is set by the function
 -- @{#ARTY.SetSmokeShells}(*n*, *color*), where *n* is the number of shells and *color* defines the smoke color. Default is SMOKECOLOR.Red.
 --
 -- The weapon type to be used in the @{#ARTY.AssignTargetCoord}() function is *ARTY.WeaponType.SmokeShells*.
 --
--- The explosive shell the group fired is destroyed shortly before its impact on the ground and smoke of the speficied color is triggered at that position.
+-- The explosive shell the group fired is destroyed shortly before its impact on the ground and smoke of the specified color is triggered at that position.
 --
 --
 -- ## Assignments via Markers on F10 Map
@@ -320,15 +321,15 @@
 -- ### Target Assignments
 -- A new target can be assigned by writing **arty engage** in the marker text.
 -- This is followed by a **comma separated list** of (optional) keywords and parameters.
--- First, it is important to address the ARTY group or groups that should engage. This can be done in numrous ways. The keywords are *battery*, *alias*, *cluster*.
+-- First, it is important to address the ARTY group or groups that should engage. This can be done in numerous ways. The keywords are *battery*, *alias*, *cluster*.
 -- It is also possible to address all ARTY groups by the keyword *everyone* or *allbatteries*. These two can be used synonymously.
 -- **Note that**, if no battery is assigned nothing will happen.
 --
 -- * *everyone* or *allbatteries* The target is assigned to all batteries.
 -- * *battery* Name of the ARTY group that the target is assigned to. Note that **the name is case sensitive** and has to be given in quotation marks. Default is all ARTY groups of the right coalition.
 -- * *alias* Alias of the ARTY group that the target is assigned to. The alias is **case sensitive** and needs to be in quotation marks.
--- * *cluster* The cluster of ARTY groups that is addessed. Clusters can be defined by the function @{#ARTY.AddToCluster}(*clusters*). Names are **case sensitive** and need to be in quotation marks.
--- * *key* A number to authorize the target assignment. Only specifing the correct number will trigger an engagement.
+-- * *cluster* The cluster of ARTY groups that is addressed. Clusters can be defined by the function @{#ARTY.AddToCluster}(*clusters*). Names are **case sensitive** and need to be in quotation marks.
+-- * *key* A number to authorize the target assignment. Only specifying the correct number will trigger an engagement.
 -- * *time* Time for which which the engagement is schedules, e.g. 08:42. Default is as soon as possible.
 -- * *prio*  Priority of the engagement as number between 1 (high prio) and 100 (low prio). Default is 50, i.e. medium priority.
 -- * *shots* Number of shots (shells, rockets or missiles) fired at each engagement. Default is 5.
@@ -353,8 +354,8 @@
 --      arty engage, battery "Paladin Alpha", weapon nukes, shots 1, time 20:15
 --      arty engage, battery "Horwitzer 1", lldms 41:51:00N 41:47:58E
 --
--- Note that the keywords and parameters are *case insensitve*. Only exception are the battery, alias and cluster names.
--- These must be exactly the same as the names of the goups defined in the mission editor or the aliases and cluster names defined in the script.
+-- Note that the keywords and parameters are *case insensitive*. Only exception are the battery, alias and cluster names.
+-- These must be exactly the same as the names of the groups defined in the mission editor or the aliases and cluster names defined in the script.
 --
 -- ### Relocation Assignments
 --
@@ -363,11 +364,11 @@
 -- * *time* Time for which which the relocation/move is schedules, e.g. 08:42. Default is as soon as possible.
 -- * *speed* The speed in km/h the group will drive at. Default is 70% of its max possible speed.
 -- * *on road* Group will use mainly roads. Default is off, i.e. it will go in a straight line from its current position to the assigned coordinate.
--- * *canceltarget* Group will cancel all running firing engagements and immidiately start to move. Default is that group will wait until is current assignment is over.
+-- * *canceltarget* Group will cancel all running firing engagements and immediately start to move. Default is that group will wait until is current assignment is over.
 -- * *battery* Name of the ARTY group that the relocation is assigned to.
 -- * *alias* Alias of the ARTY group that the target is assigned to. The alias is **case sensitive** and needs to be in quotation marks.
--- * *cluster* The cluster of ARTY groups that is addessed. Clusters can be defined by the function @{#ARTY.AddToCluster}(*clusters*). Names are **case sensitive** and need to be in quotation marks.
--- * *key* A number to authorize the target assignment. Only specifing the correct number will trigger an engagement.
+-- * *cluster* The cluster of ARTY groups that is addressed. Clusters can be defined by the function @{#ARTY.AddToCluster}(*clusters*). Names are **case sensitive** and need to be in quotation marks.
+-- * *key* A number to authorize the target assignment. Only specifying the correct number will trigger an engagement.
 -- * *lldms* Specify the coordinates in Lat/Long degrees, minutes and seconds format. The actual location of the marker is unimportant. The group will move to the coordinates given in the lldms keyword.
 -- Format is DD:MM:SS[N,S] DD:MM:SS[W,E]. See example below.
 -- * *readonly* Marker cannot be deleted by users any more. Hence, assignment cannot be cancelled by removing the marker.
@@ -410,12 +411,12 @@
 --
 -- A few options can be set by marks. The corresponding keyword is **arty set**. This can be used to define the rearming place and group for a battery.
 --
--- To set the reamring place of a group at the marker position type
+-- To set the rearming place of a group at the marker position type
 --      arty set, battery "Paladin Alpha", rearming place
 --
 -- Setting the rearming group is independent of the position of the mark. Just create one anywhere on the map and type
 --      arty set, battery "Mortar Bravo", rearming group "Ammo Truck M818"
--- Note that the name of the rearming group has to be given in quotation marks and spellt exactly as the group name defined in the mission editor.
+-- Note that the name of the rearming group has to be given in quotation marks and spelt exactly as the group name defined in the mission editor.
 --
 -- ## Transporting
 --
@@ -693,7 +694,7 @@ ARTY.db={
 
 --- Arty script version.
 -- @field #string version
-ARTY.version="1.2.0"
+ARTY.version="1.3.0"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
@@ -801,6 +802,9 @@ function ARTY:New(group, alias)
   else
     self.ismobile=false
   end
+  
+  -- Set track time interval.
+  self.dtTrack=0.2
 
   -- Set speed to 0.7 of maximum.
   self.Speed=self.SpeedMax * 0.7
@@ -1497,6 +1501,15 @@ function ARTY:SetStatusInterval(interval)
   return self
 end
 
+--- Set time interval for weapon tracking.
+-- @param #ARTY self
+-- @param #number interval Time interval in seconds. Default 0.2 seconds.
+-- @return self
+function ARTY:SetTrackInterval(interval)
+  self.dtTrack=interval or 0.2
+  return self
+end
+
 --- Set time how it is waited a unit the first shot event happens. If no shot is fired after this time, the task to fire is aborted and the target removed.
 -- @param #ARTY self
 -- @param #number waittime Time in seconds. Default 300 seconds.
@@ -2129,6 +2142,95 @@ end
 -- Event Handling
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
+--- Function called during tracking of weapon.
+-- @param Wrapper.Weapon#WEAPON weapon Weapon object.
+-- @param #ARTY self ARTY object.
+-- @param #ARTY.Target target Target of the weapon.
+function ARTY._FuncTrack(weapon, self, target)
+  
+  -- Coordinate and distance to target.
+  local _coord=weapon.coordinate
+  local _dist=_coord:Get2DDistance(target.coord)
+  local _destroyweapon=false
+  
+  -- Debug
+  self:T3(self.lid..string.format("ARTY %s weapon to target dist = %d m", self.groupname,_dist))
+  
+  if target.weapontype==ARTY.WeaponType.IlluminationShells then
+  
+    -- Check if within distace.
+    if _dist<target.radius then
+  
+      -- Get random coordinate within certain radius of the target.
+      local _cr=target.coord:GetRandomCoordinateInRadius(target.radius)
+  
+      -- Get random altitude over target.
+      local _alt=_cr:GetLandHeight()+math.random(self.illuMinalt, self.illuMaxalt)
+  
+      -- Adjust explosion height of coordinate.
+      local _ci=COORDINATE:New(_cr.x,_alt,_cr.z)
+  
+      -- Create illumination flare.
+      _ci:IlluminationBomb(self.illuPower)
+  
+      -- Destroy actual shell.
+      _destroyweapon=true
+    end
+  
+  elseif target.weapontype==ARTY.WeaponType.SmokeShells then
+  
+    if _dist<target.radius then
+  
+      -- Get random coordinate within a certain radius.
+      local _cr=_coord:GetRandomCoordinateInRadius(_data.target.radius)
+  
+      -- Fire smoke at this coordinate.
+      _cr:Smoke(self.smokeColor)
+  
+      -- Destroy actual shell.
+      _destroyweapon=true
+  
+    end
+  
+  end
+  
+  if _destroyweapon then
+  
+    self:T2(self.lid..string.format("ARTY %s destroying shell, stopping timer.", self.groupname))
+  
+    -- Destroy weapon and stop timer.
+    weapon:Destroy()
+    
+    -- No more tracking.
+    weapon.tracking=false
+
+  end
+
+end
+
+
+--- Function called after impact of weapon.
+-- @param Wrapper.Weapon#WEAPON weapon Weapon object.
+-- @param #ARTY self ARTY object.
+-- @param #ARTY.Target target Target of the weapon.
+function ARTY._FuncImpact(weapon, self, target)
+
+  -- Debug info.
+  self:I(self.lid..string.format("ARTY %s weapon NOT ALIVE any more.", self.groupname))
+
+  -- Get impact coordinate.
+  local _impactcoord=weapon:GetImpactCoordinate()
+    
+  -- Create a "nuclear" explosion and blast at the impact point.
+  if target.weapontype==ARTY.WeaponType.TacticalNukes then
+    self:T(self.lid..string.format("ARTY %s triggering nuclear explosion in one second.", self.groupname))
+    --SCHEDULER:New(nil, ARTY._NuclearBlast, {self,_impactcoord}, 1.0)
+    self:ScheduleOnce(1.0, ARTY._NuclearBlast, self, _impactcoord)
+  end
+
+end
+
+
 --- Eventhandler for shot event.
 -- @param #ARTY self
 -- @param Core.Event#EVENTDATA EventData
@@ -2162,128 +2264,32 @@ function ARTY:OnEventShot(EventData)
         self:T(self.lid..text)
         MESSAGE:New(text, 5):Clear():ToAllIf(self.report or self.Debug)
 
-        -- Last known position of the weapon fired.
-        local _lastpos={x=0, y=0, z=0}
-
-        --- Track the position of the weapon if it is supposed to model a tac nuke, illumination or smoke shell.
-        -- @param #table _weapon
-        local function _TrackWeapon(_data)
-
-          -- When the pcall status returns false the weapon has hit.
-          local _weaponalive,_currpos =  pcall(
-          function()
-            return _data.weapon:getPoint()
-          end)
-
-          -- Debug
-          self:T3(self.lid..string.format("ARTY %s: Weapon still in air: %s", self.groupname, tostring(_weaponalive)))
-
-          -- Destroy weapon before impact.
-          local _destroyweapon=false
-
-          if _weaponalive then
-
-            -- Update last position.
-            _lastpos={x=_currpos.x, y=_currpos.y, z=_currpos.z}
-
-            -- Coordinate and distance to target.
-            local _coord=COORDINATE:NewFromVec3(_lastpos)
-            local _dist=_coord:Get2DDistance(_data.target.coord)
-
-            -- Debug
-            self:T3(self.lid..string.format("ARTY %s weapon to target dist = %d m", self.groupname,_dist))
-
-            if _data.target.weapontype==ARTY.WeaponType.IlluminationShells then
-
-              -- Check if within distace.
-              if _dist<_data.target.radius then
-
-                -- Get random coordinate within certain radius of the target.
-                local _cr=_data.target.coord:GetRandomCoordinateInRadius(_data.target.radius)
-
-                -- Get random altitude over target.
-                local _alt=_cr:GetLandHeight()+math.random(self.illuMinalt, self.illuMaxalt)
-
-                -- Adjust explosion height of coordinate.
-                local _ci=COORDINATE:New(_cr.x,_alt,_cr.z)
-
-                -- Create illumination flare.
-                _ci:IlluminationBomb(self.illuPower)
-
-                -- Destroy actual shell.
-                _destroyweapon=true
-              end
-
-            elseif _data.target.weapontype==ARTY.WeaponType.SmokeShells then
-
-              if _dist<_data.target.radius then
-
-                -- Get random coordinate within a certain radius.
-                local _cr=_coord:GetRandomCoordinateInRadius(_data.target.radius)
-
-                -- Fire smoke at this coordinate.
-                _cr:Smoke(self.smokeColor)
-
-                -- Destroy actual shell.
-                _destroyweapon=true
-
-              end
-
-            end
-
-            if _destroyweapon then
-
-              self:T2(self.lid..string.format("ARTY %s destroying shell, stopping timer.", self.groupname))
-
-              -- Destroy weapon and stop timer.
-              _data.weapon:destroy()
-              return nil
-
-            else
-
-              -- TODO: Make dt input parameter.
-              local dt=0.02
-
-              self:T3(self.lid..string.format("ARTY %s tracking weapon again in %.3f seconds", self.groupname, dt))
-
-              -- Check again in 0.05 seconds.
-              return timer.getTime() + dt
-
-            end
-
-          else
-
-            -- Get impact coordinate.
-            local _impactcoord=COORDINATE:NewFromVec3(_lastpos)
-            
-            self:I(self.lid..string.format("ARTY %s weapon NOT ALIVE any more.", self.groupname))
-
-            -- Create a "nuclear" explosion and blast at the impact point.
-            if _data.target.weapontype==ARTY.WeaponType.TacticalNukes then
-              self:T(self.lid..string.format("ARTY %s triggering nuclear explosion in one second.", self.groupname))
-              SCHEDULER:New(nil, ARTY._NuclearBlast, {self,_impactcoord}, 1.0)
-            end
-
-            -- Stop timer.
-            return nil
-
-          end
-
-        end
-
         -- Start track the shell if we want to model a tactical nuke.
         local _tracknuke  = self.currentTarget.weapontype==ARTY.WeaponType.TacticalNukes and self.Nukes>0
         local _trackillu  = self.currentTarget.weapontype==ARTY.WeaponType.IlluminationShells and self.Nillu>0
         local _tracksmoke = self.currentTarget.weapontype==ARTY.WeaponType.SmokeShells and self.Nsmoke>0
+        
+        
         if _tracknuke or _trackillu or _tracksmoke then
 
-            self:T(self.lid..string.format("ARTY %s: Tracking of weapon starts in two seconds.", self.groupname))
-
-            local _peter={}
-            _peter.weapon=EventData.weapon
-            _peter.target=UTILS.DeepCopy(self.currentTarget)
-
-            timer.scheduleFunction(_TrackWeapon, _peter, timer.getTime() + 2.0)
+          -- Debug info.  
+          self:T(self.lid..string.format("ARTY %s: Tracking of weapon starts in two seconds.", self.groupname))
+            
+          -- Create a weapon object.
+          local weapon=WEAPON:New(EventData.weapon)
+          
+          -- Set time step for tracking.
+          weapon:SetTimeStepTrack(self.dtTrack)
+          
+          -- Copy target. We need a copy because it might already be overwritten with the next target during flight of weapon.
+          local target=UTILS.DeepCopy(self.currentTarget)
+          
+          -- Set callback functions.
+          weapon:SetFuncTrack(ARTY._FuncTrack, self, target)
+          weapon:SetFuncImpact(ARTY._FuncImpact, self, target)
+          
+          -- Start tracking in 2 sec (arty ammo should fly a bit).
+          weapon:StartTrack(2)
         end
 
         -- Get current ammo.
@@ -3422,7 +3428,7 @@ function ARTY:onafterMove(Controllable, From, Event, To, move)
   -- Set current move.
   self.currentMove=move
 
-  -- Route group to coodinate.
+  -- Route group to coordinate.
   self:_Move(self.Controllable, move.coord, move.speed, move.onroad)
 
 end
@@ -3931,9 +3937,10 @@ function ARTY:GetAmmo(display)
     return nammo, nshells, nrockets, nmissiles
   end
 
-  for _,unit in pairs(units) do
+  for _,_unit in pairs(units) do
+    local unit=_unit --Wrapper.Unit#UNIT
 
-    if unit and unit:IsAlive() then
+    if unit then
 
       -- Output.
       local text=string.format("ARTY group %s - unit %s:\n", self.groupname, unit:GetName())

Moose Development/Moose/Functional/Autolase.lua

@@ -1,961 +0,0 @@
---- **Functional** - Autolase targets in the field.
---
--- ===
--- 
--- **AUOTLASE** - Autolase targets in the field.
--- 
--- ===
--- 
--- ## Missions:
---
--- ### [Autolase](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/)
--- 
--- ===
--- 
--- **Main Features:**
---
---    * Detect and lase contacts automatically
---    * Targets are lased by threat priority order
---    * Use FSM events to link functionality into your scripts
---    * Easy setup
---
--- ===
--- 
---- Spot on!
--- 
--- ===
--- 
--- # 1 Autolase concept
--- 
--- * Detect and lase contacts automatically
--- * Targets are lased by threat priority order
--- * Use FSM events to link functionality into your scripts
--- * Set laser codes and smoke colors per Recce unit
--- * Easy set-up
--- 
--- # 2 Basic usage
--- 
--- ## 2.2 Set up a group of Recce Units:
--- 
---            local FoxSet = SET_GROUP:New():FilterPrefixes("Recce"):FilterCoalitions("blue"):FilterStart()
---            
--- ## 2.3 (Optional) Set up a group of pilots, this will drive who sees the F10 menu entry:
--- 
---            local Pilotset = SET_CLIENT:New():FilterCoalitions("blue"):FilterActive(true):FilterStart()
---            
--- ## 2.4 Set up and start Autolase:
--- 
---            local autolaser = AUTOLASE:New(FoxSet,coalition.side.BLUE,"Wolfpack",Pilotset)
---            
--- ## 2.5 Example - Using a fixed laser code and color for a specific Recce unit:
--- 
---            local recce = SPAWN:New("Reaper")
---              :InitDelayOff()
---              :OnSpawnGroup(
---                function (group)
---                  local unit = group:GetUnit(1)
---                  local name = unit:GetName()
---                  autolaser:SetRecceLaserCode(name,1688)
---                  autolaser:SetRecceSmokeColor(name,SMOKECOLOR.Red)
---                end
---              )
---              :InitCleanUp(60)
---              :InitLimit(1,0)
---              :SpawnScheduled(30,0.5)
---              
--- ## 2.6 Example - Inform pilots about events:
--- 
---            autolaser:SetNotifyPilots(true) -- defaults to true, also shown if debug == true
---            -- Note - message are shown to pilots in the #SET_CLIENT only if using the pilotset option, else to the coalition.
---
---
--- ### Author: **applevangelist**
--- @module Functional.Autolase
--- @image Designation.JPG
---
--- Date: 24 Oct 2021
---
---- Class AUTOLASE
--- @type AUTOLASE
--- @field #string ClassName
--- @field #string lid
--- @field #number verbose
--- @field #string alias
--- @field #boolean debug
--- @field #string version
--- @extends Ops.Intel#INTEL
-
----
--- @field #AUTOLASE
-AUTOLASE = {
-  ClassName = "AUTOLASE",
-  lid = "",
-  verbose = 0,
-  alias = "",
-  debug = false,
-}
-
---- Laser spot info
--- @type AUTOLASE.LaserSpot
--- @field Core.Spot#SPOT laserspot 
--- @field Wrapper.Unit#UNIT lasedunit
--- @field Wrapper.Unit#UNIT lasingunit
--- @field #number lasercode
--- @field #string location
--- @field #number timestamp
--- @field #string unitname
--- @field #string reccename
--- @field #string unittype
-
---- AUTOLASE class version.
--- @field #string version
-AUTOLASE.version = "0.0.11"
-
--------------------------------------------------------------------
--- Begin Functional.Autolase.lua
--------------------------------------------------------------------
-
---- Constructor for a new Autolase instance.
--- @param #AUTOLASE self
--- @param Core.Set#SET_GROUP RecceSet Set of detecting and lasing units
--- @param #number Coalition Coalition side. Can also be passed as a string "red", "blue" or "neutral".
--- @param #string Alias (Optional) An alias how this object is called in the logs etc.
--- @param Core.Set#SET_CLIENT PilotSet (Optional) Set of clients for precision bombing, steering menu creation. Leave nil for a coalition-wide F10 entry and display.
--- @return #AUTOLASE self 
-function AUTOLASE:New(RecceSet, Coalition, Alias, PilotSet)
-  BASE:T({RecceSet, Coalition, Alias, PilotSet})
-  
-  -- Inherit everything from BASE class.
-  local self=BASE:Inherit(self, BASE:New()) -- #AUTOLASE
-  
-  if Coalition and type(Coalition)=="string" then
-    if Coalition=="blue" then
-      self.coalition=coalition.side.BLUE
-    elseif Coalition=="red" then
-      self.coalition=coalition.side.RED
-    elseif Coalition=="neutral" then
-      self.coalition=coalition.side.NEUTRAL
-    else
-      self:E("ERROR: Unknown coalition in AUTOLASE!")
-    end
-  end
-  
-  -- Set alias.
-  if Alias then
-    self.alias=tostring(Alias)
-  else
-    self.alias="Lion"  
-    if self.coalition then
-      if self.coalition==coalition.side.RED then
-        self.alias="Wolf"
-      elseif self.coalition==coalition.side.BLUE then
-        self.alias="Fox"
-      end
-    end
-  end 
-  
-  -- inherit from INTEL
-  local self=BASE:Inherit(self, INTEL:New(RecceSet, Coalition, Alias)) -- #AUTOLASE
-  
-  self.RecceSet = RecceSet
-  self.DetectVisual = true
-  self.DetectOptical = true
-  self.DetectRadar = true
-  self.DetectIRST = true
-  self.DetectRWR = true
-  self.DetectDLINK = true
-  self.LaserCodes = UTILS.GenerateLaserCodes()
-  self.LaseDistance = 5000
-  self.LaseDuration = 300
-  self.GroupsByThreat = {}
-  self.UnitsByThreat = {}
-  self.RecceNames = {}
-  self.RecceLaserCode = {}
-  self.RecceSmokeColor = {}
-  self.RecceUnitNames= {}
-  self.maxlasing = 4
-  self.CurrentLasing = {}
-  self.lasingindex = 0
-  self.deadunitnotes = {}
-  self.usepilotset = false
-  self.reporttimeshort = 10
-  self.reporttimelong = 30
-  self.smoketargets = false
-  self.smokecolor = SMOKECOLOR.Red
-  self.notifypilots = true
-  self.targetsperrecce = {}
-  self.RecceUnits = {}
-  self.forcecooldown = true
-  self.cooldowntime = 60
-  self.useSRS = false
-  self.SRSPath = ""
-  self.SRSFreq = 251
-  self.SRSMod = radio.modulation.AM
-  
-  -- Set some string id for output to DCS.log file.
-  self.lid=string.format("AUTOLASE %s (%s) | ", self.alias, self.coalition and UTILS.GetCoalitionName(self.coalition) or "unknown")
-  
-  -- Add FSM transitions.
-  --                 From State  -->   Event        -->     To State
-  self:AddTransition("*",             "Monitor",              "*")     -- Start FSM
-  self:AddTransition("*",             "Lasing",               "*")     -- Lasing target
-  self:AddTransition("*",             "TargetLost",           "*")     -- Lost target
-  self:AddTransition("*",             "TargetDestroyed",      "*")     -- Target destroyed
-  self:AddTransition("*",             "RecceKIA",             "*")     -- Recce KIA
-  self:AddTransition("*",             "LaserTimeout",         "*")     -- Laser timed out
-  self:AddTransition("*",             "Cancel",               "*")     -- Stop Autolase
-  
-  -- Menu Entry
-  if not PilotSet then
-    self.Menu = MENU_COALITION_COMMAND:New(self.coalition,"Autolase",nil,self.ShowStatus,self)
-  else
-    self.usepilotset = true
-    self.pilotset = PilotSet
-    self:HandleEvent(EVENTS.PlayerEnterAircraft)
-    self:SetPilotMenu()
-  end
-  
-  self:SetClusterAnalysis(false, false)
-  
-  self:__Start(2)
-  self:__Monitor(math.random(5,10))
-  
-  return self
-  
-  ------------------------
-  --- Pseudo Functions ---
-  ------------------------
-  
-  --- Triggers the FSM event "Monitor".
-  -- @function [parent=#AUTOLASE] Status
-  -- @param #AUTOLASE self
-
-  --- Triggers the FSM event "Monitor" after a delay.
-  -- @function [parent=#AUTOLASE] __Status
-  -- @param #AUTOLASE self
-  -- @param #number delay Delay in seconds.
-  
-  --- Triggers the FSM event "Cancel".
-  -- @function [parent=#AUTOLASE] Cancel
-  -- @param #AUTOLASE self
-
-  --- Triggers the FSM event "Cancel" after a delay.
-  -- @function [parent=#AUTOLASE] __Cancel
-  -- @param #AUTOLASE self
-  -- @param #number delay Delay in seconds.
-  
-  --- On After "RecceKIA" event.
-  -- @function [parent=#AUTOLASE] OnAfterRecceKIA
-  -- @param #AUTOLASE self
-  -- @param #string From The from state
-  -- @param #string Event The event
-  -- @param #string To The to state
-  -- @param #string RecceName The lost Recce
-    
-  --- On After "TargetDestroyed" event.
-  -- @function [parent=#AUTOLASE] OnAfterTargetDestroyed
-  -- @param #AUTOLASE self
-  -- @param #string From The from state
-  -- @param #string Event The event
-  -- @param #string To The to state
-  -- @param #string UnitName The destroyed unit\'s name
-  -- @param #string RecceName The Recce name lasing
-  
-  --- On After "TargetLost" event.
-  -- @function [parent=#AUTOLASE] OnAfterTargetLost
-  -- @param #AUTOLASE self
-  -- @param #string From The from state
-  -- @param #string Event The event
-  -- @param #string To The to state
-  -- @param #string UnitName The lost unit\'s name
-  -- @param #string RecceName The Recce name lasing
-  
-  --- On After "LaserTimeout" event.
-  -- @function [parent=#AUTOLASE] OnAfterLaserTimeout
-  -- @param #AUTOLASE self
-  -- @param #string From The from state
-  -- @param #string Event The event
-  -- @param #string To The to state
-  -- @param #string UnitName The lost unit\'s name
-  -- @param #string RecceName The Recce name lasing
-  
-  --- On After "Lasing" event.
-  -- @function [parent=#AUTOLASE] OnAfterLasing
-  -- @param #AUTOLASE self
-  -- @param #string From The from state
-  -- @param #string Event The event
-  -- @param #string To The to state
-  -- @param Functional.Autolase#AUTOLASE.LaserSpot LaserSpot The LaserSpot data table
-  
-end
-
--------------------------------------------------------------------
--- Helper Functions
--------------------------------------------------------------------
-
---- (Internal) Function to set pilot menu.
--- @param #AUTOLASE self
--- @return #AUTOLASE self 
-function AUTOLASE:SetPilotMenu()
-  if self.usepilotset then
-    local pilottable = self.pilotset:GetSetObjects() or {}
-    for _,_unit in pairs (pilottable) do
-      local Unit = _unit -- Wrapper.Unit#UNIT
-      if Unit and Unit:IsAlive() then
-        local Group = Unit:GetGroup()
-        local lasemenu = MENU_GROUP_COMMAND:New(Group,"Autolase Status",nil,self.ShowStatus,self,Group)
-        lasemenu:Refresh()
-      end
-    end
-  end
-  return self
-end
-
---- (Internal) Event function for new pilots.
--- @param #AUTOLASE self
--- @param Core.Event#EVENTDATA EventData
--- @return #AUTOLASE self 
-function AUTOLASE:OnEventPlayerEnterAircraft(EventData)
-  self:SetPilotMenu()
-  return self
-end
-
---- (Internal) Function to get a laser code by recce name
--- @param #AUTOLASE self
--- @param #string RecceName Unit(!) name of the Recce
--- @return #AUTOLASE self 
-function AUTOLASE:GetLaserCode(RecceName)
-  local code = 1688
-  if self.RecceLaserCode[RecceName] == nil then
-    code = self.LaserCodes[math.random(#self.LaserCodes)]
-    self.RecceLaserCode[RecceName] = code
-  else
-    code = self.RecceLaserCode[RecceName]
-  end
-  return code
-end
-
---- (Internal) Function to get a smoke color by recce name
--- @param #AUTOLASE self
--- @param #string RecceName Unit(!) name of the Recce
--- @return #AUTOLASE self 
-function AUTOLASE:GetSmokeColor(RecceName)
-  local color = self.smokecolor
-  if self.RecceSmokeColor[RecceName] == nil then
-    self.RecceSmokeColor[RecceName] = color
-  else
-    color = self.RecceSmokeColor[RecceName]
-  end
-  return color
-end
-
---- (User) Function enable sending messages via SRS.
--- @param #AUTOLASE self
--- @param #boolean OnOff Switch usage on and off
--- @param #string Path Path to SRS directory, e.g. C:\\Program Files\\DCS-SimpleRadio-Standalon
--- @param #number Frequency Frequency to send, e.g. 243
--- @param #number Modulation Modulation i.e. radio.modulation.AM or radio.modulation.FM
--- @return #AUTOLASE self 
-function AUTOLASE:SetUsingSRS(OnOff,Path,Frequency,Modulation)
-  self.useSRS = OnOff or true
-  self.SRSPath = Path or "E:\\Program Files\\DCS-SimpleRadio-Standalone"
-  self.SRSFreq = Frequency or 271
-  self.SRSMod = Modulation or radio.modulation.AM
-  return self
-end
-
---- (User) Function set max lasing targets
--- @param #AUTOLASE self
--- @param #number Number Max number of targets to lase at once
--- @return #AUTOLASE self 
-function AUTOLASE:SetMaxLasingTargets(Number)
-  self.maxlasing = Number or 4
-  return self
-end
-
---- (Internal) Function set notify pilots on events
--- @param #AUTOLASE self
--- @param #boolean OnOff Switch messaging on (true) or off (false)
--- @return #AUTOLASE self 
-function AUTOLASE:SetNotifyPilots(OnOff)
-  self.notifypilots = OnOff and true
-  return self
-end
-
---- (User) Function to set a specific code to a Recce.
--- @param #AUTOLASE self
--- @param #string RecceName (Unit!) Name of the Recce
--- @param #number Code The lase code
--- @return #AUTOLASE self 
-function AUTOLASE:SetRecceLaserCode(RecceName, Code)
-  local code = Code or 1688
-  self.RecceLaserCode[RecceName] = code
-  return self
-end
-
---- (User) Function to set a specific smoke color for a Recce.
--- @param #AUTOLASE self
--- @param #string RecceName (Unit!) Name of the Recce
--- @param #number Color The color, e.g. SMOKECOLOR.Red, SMOKECOLOR.Green etc
--- @return #AUTOLASE self 
-function AUTOLASE:SetRecceSmokeColor(RecceName, Color)
-  local color = Color or self.smokecolor
-  self.RecceSmokeColor[RecceName] = color
-  return self
-end
-
---- (User) Function to force laser cooldown and cool down time
--- @param #AUTOLASE self
--- @param #boolean OnOff Switch cool down on (true) or off (false) - defaults to true
--- @param #number Seconds Number of seconds for cooldown - dafaults to 60 seconds
--- @return #AUTOLASE self 
-function AUTOLASE:SetLaserCoolDown(OnOff, Seconds)
-  self.forcecooldown = OnOff and true
-  self.cooldowntime = Seconds or 60
-  return self
-end
-  
---- (User) Function to set message show times.
--- @param #AUTOLASE self
--- @param #number long Longer show time
--- @param #number short Shorter show time
--- @return #AUTOLASE self 
-function AUTOLASE:SetReportingTimes(long, short)
-  self.reporttimeshort = short or 10
-  self.reporttimelong = long or 30
-  return self
-end
-
---- (User) Function to set lasing distance in meters and duration in seconds
--- @param #AUTOLASE self
--- @param #number Distance (Max) distance for lasing in meters - default 5000 meters
--- @param #number Duration (Max) duration for lasing in seconds - default 300 secs
--- @return #AUTOLASE self 
-function AUTOLASE:SetLasingParameters(Distance, Duration)
-  self.LaseDistance = Distance or 5000
-  self.LaseDuration = Duration or 300
-  return self
-end
-
---- (User) Function to set smoking of targets.
--- @param #AUTOLASE self
--- @param #boolean OnOff Switch smoking on or off
--- @param #number Color Smokecolor, e.g. SMOKECOLOR.Red
--- @return #AUTOLASE self 
-function AUTOLASE:SetSmokeTargets(OnOff,Color)
-  self.smoketargets = OnOff
-  self.smokecolor = Color or SMOKECOLOR.Red
-  return self
-end
-
---- (Internal) Function to calculate line of sight.
--- @param #AUTOLASE self
--- @param Wrapper.Unit#UNIT Unit 
--- @return #number LOS Line of sight in meters
-function AUTOLASE:GetLosFromUnit(Unit)
-  local lasedistance = self.LaseDistance
-  local unitheight = Unit:GetHeight()
-  local coord = Unit:GetCoordinate()
-  local landheight = coord:GetLandHeight()
-  local asl = unitheight - landheight
-  if asl > 100 then
-    local absquare = lasedistance^2+asl^2
-    lasedistance = math.sqrt(absquare)
-  end
-  return lasedistance
-end
-
---- (Internal) Function to check on lased targets.
--- @param #AUTOLASE self
--- @return #AUTOLASE self
-function AUTOLASE:CleanCurrentLasing()
-  local lasingtable = self.CurrentLasing
-  local newtable = {}
-  local newreccecount = {}
-  local lasing = 0
-  
-  for _ind,_entry in pairs(lasingtable) do
-    local entry = _entry -- #AUTOLASE.LaserSpot
-    if not newreccecount[entry.reccename] then
-      newreccecount[entry.reccename] = 0
-    end
-  end
-  
-  for _,_recce in pairs (self.RecceSet:GetSetObjects()) do
-    local recce = _recce --Wrapper.Group#GROUP
-    if recce and recce:IsAlive() then
-      local unit = recce:GetUnit(1)
-      local name = unit:GetName()
-      if not self.RecceUnits[name] then
-        self.RecceUnits[name] = { name=name, unit=unit, cooldown = false, timestamp = timer.getAbsTime() }
-      end
-    end
-  end
-  
-  for _ind,_entry in pairs(lasingtable) do
-    local entry = _entry -- #AUTOLASE.LaserSpot
-    local valid = 0
-    local reccedead = false
-    local unitdead = false
-    local lostsight = false
-    local timeout = false
-    local Tnow = timer.getAbsTime()
-    -- check recce dead
-    local recce = entry.lasingunit
-    if recce and recce:IsAlive() then
-      valid = valid + 1
-    else
-      reccedead = true
-      self:__RecceKIA(2,entry.reccename)
-    end
-    -- check entry dead
-    local unit = entry.lasedunit
-    if unit and unit:IsAlive() == true then
-      valid = valid + 1
-    else
-      unitdead = true
-      if not self.deadunitnotes[entry.unitname] then
-        self.deadunitnotes[entry.unitname] = true
-        self:__TargetDestroyed(2,entry.unitname,entry.reccename)
-      end
-    end
-    -- check entry out of sight
-    if not reccedead and not unitdead then
-      if self:CanLase(recce,unit) then
-        valid = valid + 1
-      else
-        lostsight = true
-        entry.laserspot:LaseOff()
-        self:__TargetLost(2,entry.unitname,entry.reccename)
-      end
-    end
-    -- check timed out
-    local timestamp = entry.timestamp
-    if Tnow - timestamp < self.LaseDuration and not lostsight then
-      valid = valid + 1
-    else
-      timeout = true
-      entry.laserspot:LaseOff()
-      
-      self.RecceUnits[entry.reccename].cooldown = true
-      self.RecceUnits[entry.reccename].timestamp = timer.getAbsTime()
-      
-      if not lostsight then
-        self:__LaserTimeout(2,entry.unitname,entry.reccename)
-      end
-    end
-    if valid == 4 then
-     self.lasingindex = self.lasingindex + 1
-     newtable[self.lasingindex] = entry
-     newreccecount[entry.reccename] = newreccecount[entry.reccename] + 1
-     lasing = lasing + 1
-    end
-  end
-  self.CurrentLasing = newtable
-  self.targetsperrecce = newreccecount
-  return lasing
-end
-
---- (Internal) Function to show status.
--- @param #AUTOLASE self
--- @param Wrapper.Group#GROUP Group (Optional) show to a certain group
--- @return #AUTOLASE self
-function AUTOLASE:ShowStatus(Group)
-  local report = REPORT:New("Autolase")
-  local reccetable = self.RecceSet:GetSetObjects()
-  for _,_recce in pairs(reccetable) do
-    if _recce and _recce:IsAlive() then
-      local unit = _recce:GetUnit(1)
-      local name = unit:GetName()
-      local code = self:GetLaserCode(name)
-      report:Add(string.format("Recce %s has code %d",name,code))
-    end
-  end
-  local lines = 0
-  for _ind,_entry in pairs(self.CurrentLasing) do
-    local entry = _entry -- #AUTOLASE.LaserSpot
-    local reccename = entry.reccename
-    local typename = entry.unittype
-    local code = entry.lasercode
-    local locationstring = entry.location
-    local text = string.format("%s lasing %s code %d\nat %s",reccename,typename,code,locationstring)
-    report:Add(text)
-    lines = lines + 1
-  end
-  if lines == 0 then
-    report:Add("No targets!")
-  end
-  local reporttime = self.reporttimelong
-  if lines == 0 then reporttime = self.reporttimeshort end
-  if Group and Group:IsAlive() then
-    local m = MESSAGE:New(report:Text(),reporttime,"Info"):ToGroup(Group)
-  else
-    local m = MESSAGE:New(report:Text(),reporttime,"Info"):ToCoalition(self.coalition)
-  end
-  return self
-end
-
---- (Internal) Function to show messages.
--- @param #AUTOLASE self
--- @param #string Message The message to be sent
--- @param #number Duration Duration in seconds
--- @return #AUTOLASE self
-function AUTOLASE:NotifyPilots(Message,Duration)
-  if self.usepilotset then
-    local pilotset = self.pilotset:GetSetObjects() --#table
-    for _,_pilot in pairs(pilotset) do
-      local pilot = _pilot -- Wrapper.Unit#UNIT
-      if pilot and pilot:IsAlive() then
-       local Group = pilot:GetGroup()
-       local m = MESSAGE:New(Message,Duration,"Autolase"):ToGroup(Group)
-      end
-    end
-  elseif not self.debug then
-    local m = MESSAGE:New(Message,Duration,"Autolase"):ToCoalition(self.coalition)
-  else
-    local m = MESSAGE:New(Message,Duration,"Autolase"):ToAll()
-  end
-  if self.debug then self:I(Message) end
-  return self
-end
-
---- (User) Send messages via SRS.
--- @param #AUTOLASE self
--- @param #string Message The (short!) message to be sent, e.g. "Lasing target!"
--- @return #AUTOLASE self
--- @usage Step 1 - set up the radio basics **once** with
---            my_autolase:SetUsingSRS(true,"C:\\path\\SRS-Folder",251,radio.modulation.AM)
--- Step 2 - send a message, e.g.
---            function my_autolase:OnAfterLasing(From, Event, To, LaserSpot)
---                my_autolase:NotifyPilotsWithSRS("Reaper lasing new target!")
---            end
-function AUTOLASE:NotifyPilotsWithSRS(Message)
-  if self.useSRS then
-   -- Create a SOUNDTEXT object.
-   if self.debug then
-     BASE:TraceOn()
-     BASE:TraceClass("SOUNDTEXT")
-     BASE:TraceClass("MSRS")
-   end
-   local path = self.SRSPath or "C:\\Program Files\\DCS-SimpleRadio-Standalone"
-   local freq = self.SRSFreq or 271
-   local mod = self.SRSMod or radio.modulation.AM
-   local text=SOUNDTEXT:New(Message)  
-   -- MOOSE SRS 
-   local msrs=MSRS:New(path, freq, mod)
-   -- Text-to speech with default voice after 2 seconds.
-   msrs:PlaySoundText(text, 2)
-  end
-  if self.debug then self:I(Message) end
-  return self
-end
-
---- (Internal) Function to check if a unit is already lased.
--- @param #AUTOLASE self
--- @param #string unitname Name of the unit to check
--- @return #boolean outcome True or false
-function AUTOLASE:CheckIsLased(unitname)
-  local outcome = false
-  for _,_laserspot in pairs(self.CurrentLasing) do
-    local spot = _laserspot -- #AUTOLASE.LaserSpot
-    if spot.unitname == unitname then
-      outcome = true
-      break
-    end
-  end
-  return outcome
-end
-
---- (Internal) Function to check if a unit can be lased.
--- @param #AUTOLASE self
--- @param Wrapper.Unit#UNIT Recce The Recce #UNIT
--- @param Wrapper.Unit#UNIT Unit The lased #UNIT
--- @return #boolean outcome True or false
-function AUTOLASE:CanLase(Recce,Unit)
-  local canlase = false
-  -- cooldown?
-  if Recce and Recce:IsAlive() == true then
-    local name = Recce:GetName()
-    local cooldown = self.RecceUnits[name].cooldown and self.forcecooldown
-    if cooldown then
-      local Tdiff = timer.getAbsTime() - self.RecceUnits[name].timestamp
-      if Tdiff < self.cooldowntime then
-        return false
-      else
-        self.RecceUnits[name].cooldown = false
-      end
-    end
-    -- calculate LOS
-    local reccecoord = Recce:GetCoordinate()
-    local unitcoord = Unit:GetCoordinate()
-    local islos = reccecoord:IsLOS(unitcoord,2.5)
-    -- calculate distance
-    local distance = math.floor(reccecoord:Get3DDistance(unitcoord))
-    local lasedistance = self:GetLosFromUnit(Recce)
-    if distance <= lasedistance and islos then
-      canlase = true
-    end
-  end
-  return canlase
-end
-
--------------------------------------------------------------------
--- FSM Functions
--------------------------------------------------------------------
-
---- (Internal) FSM Function for monitoring
--- @param #AUTOLASE self
--- @param #string From The from state
--- @param #string Event The event
--- @param #string To The to state
--- @return #AUTOLASE self
-function AUTOLASE:onbeforeMonitor(From, Event, To)
-  self:T({From, Event, To})
-  -- Check if group has detected any units.
-  self:UpdateIntel()
-  return self
-end
-
---- (Internal) FSM Function for monitoring
--- @param #AUTOLASE self
--- @param #string From The from state
--- @param #string Event The event
--- @param #string To The to state
--- @return #AUTOLASE self
-function AUTOLASE:onafterMonitor(From, Event, To)
-  self:T({From, Event, To})
-
-  -- Housekeeping
-  local countlases = self:CleanCurrentLasing()
-  
-  self:SetPilotMenu()
-  
-  local detecteditems = self.Contacts or {} -- #table of Ops.Intelligence#INTEL.Contact
-  local groupsbythreat = {}
-  local report = REPORT:New("Detections")
-  local lines = 0
-  for _,_contact in pairs(detecteditems) do
-    local contact = _contact -- Ops.Intelligence#INTEL.Contact
-    local grp = contact.group
-    local coord = contact.position
-    local reccename = contact.recce or "none"
-    local reccegrp = UNIT:FindByName(reccename)
-    if reccegrp then
-      local reccecoord = reccegrp:GetCoordinate()
-      local distance = math.floor(reccecoord:Get3DDistance(coord))
-      local text = string.format("%s of %s | Distance %d km | Threatlevel %d",contact.attribute, contact.groupname, math.floor(distance/1000), contact.threatlevel)
-      report:Add(text)
-      self:T(text)
-      if self.debug then self:I(text) end
-      lines = lines  +  1
-      -- sort out groups beyond sight
-      local lasedistance = self:GetLosFromUnit(reccegrp)
-      if grp:IsGround() and lasedistance >= distance then
-        table.insert(groupsbythreat,{contact.group,contact.threatlevel})
-        self.RecceNames[contact.groupname] = contact.recce
-      end
-    end
-  end
-  
-  self.GroupsByThreat = groupsbythreat
-  
-  if self.verbose > 2 and lines > 0 then
-    local m=MESSAGE:New(report:Text(),self.reporttimeshort,"Autolase"):ToAll()
-  end
-  
-  table.sort(self.GroupsByThreat, function(a,b)
-      local aNum = a[2] -- Coin value of a
-      local bNum = b[2] -- Coin value of b
-      return aNum > bNum -- Return their comparisons, < for ascending, > for descending
-    end)
-  
-  -- build table of Units
-  local unitsbythreat = {}
-  for _,_entry in pairs(self.GroupsByThreat) do
-    local group = _entry[1] -- Wrapper.Group#GROUP
-    if group and group:IsAlive() then
-      local units = group:GetUnits()
-      local reccename = self.RecceNames[group:GetName()]
-      for _,_unit in pairs(units) do
-        local unit = _unit -- Wrapper.Unit#UNIT
-        if unit and unit:IsAlive() then
-          local threat = unit:GetThreatLevel()
-          local coord = unit:GetCoordinate()
-          if threat > 0 then
-            local unitname = unit:GetName()
-            table.insert(unitsbythreat,{unit,threat})
-            self.RecceUnitNames[unitname] = reccename
-          end
-        end
-      end
-    end
-  end
-  
-  self.UnitsByThreat = unitsbythreat
-  
-  table.sort(self.UnitsByThreat, function(a,b)
-      local aNum = a[2] -- Coin value of a
-      local bNum = b[2] -- Coin value of b
-      return aNum > bNum -- Return their comparisons, < for ascending, > for descending
-    end)
-  
-  local unitreport = REPORT:New("Detected Units")
-  
-  local lines = 0 
-  for _,_entry in pairs(self.UnitsByThreat) do
-    local threat = _entry[2]
-    local unit = _entry[1]
-    local unitname = unit:GetName()
-    local text = string.format("Unit %s | Threatlevel %d | Detected by %s",unitname,threat,self.RecceUnitNames[unitname])
-    unitreport:Add(text)
-    lines = lines + 1
-    self:T(text)
-    if self.debug then self:I(text) end
-  end
-  
-  if self.verbose > 2 and lines > 0 then
-    local m=MESSAGE:New(unitreport:Text(),self.reporttimeshort,"Autolase"):ToAll()
-  end
-  
-  for _,_detectingunit in pairs(self.RecceUnits) do
-    
-    local reccename = _detectingunit.name
-    local recce = _detectingunit.unit
-    local reccecount = self.targetsperrecce[reccename] or 0
-    local targets = 0
-    for _,_entry in pairs(self.UnitsByThreat) do
-      local unit = _entry[1] -- Wrapper.Unit#UNIT
-      local unitname = unit:GetName()
-      local canlase = self:CanLase(recce,unit)
-      if targets+reccecount < self.maxlasing and not self:CheckIsLased(unitname) and unit:IsAlive() and canlase then
-        targets = targets + 1
-        local code = self:GetLaserCode(reccename)
-        local spot = SPOT:New(recce)
-        spot:LaseOn(unit,code,self.LaseDuration)
-        local locationstring = unit:GetCoordinate():ToStringLLDDM()
-        local laserspot = { -- #AUTOLASE.LaserSpot
-          laserspot = spot,
-          lasedunit = unit,
-          lasingunit = recce,
-          lasercode = code,
-          location = locationstring,
-          timestamp = timer.getAbsTime(),
-          unitname = unitname,
-          reccename = reccename,
-          unittype = unit:GetTypeName(),
-          }
-       if self.smoketargets then
-          local coord = unit:GetCoordinate()
-          local color = self:GetSmokeColor(reccename)
-          coord:Smoke(color)
-       end
-       self.lasingindex = self.lasingindex + 1 
-       self.CurrentLasing[self.lasingindex] = laserspot
-       self:__Lasing(2,laserspot)  
-      end
-    end
-  end
-  
-  self:__Monitor(-30)
-  return self
-end
-
---- (Internal) FSM Function onbeforeRecceKIA
--- @param #AUTOLASE self
--- @param #string From The from state
--- @param #string Event The event
--- @param #string To The to state
--- @param #string RecceName The lost Recce
--- @return #AUTOLASE self
-function AUTOLASE:onbeforeRecceKIA(From,Event,To,RecceName)
-  self:T({From, Event, To, RecceName})
-  if self.notifypilots or self.debug then
-    local text = string.format("Recce %s KIA!",RecceName)
-    self:NotifyPilots(text,self.reporttimeshort)
-  end
-  return self
-end
-
---- (Internal) FSM Function onbeforeTargetDestroyed
--- @param #AUTOLASE self
--- @param #string From The from state
--- @param #string Event The event
--- @param #string To The to state
--- @param #string UnitName The destroyed unit\'s name
--- @param #string RecceName The Recce name lasing
--- @return #AUTOLASE self
-function AUTOLASE:onbeforeTargetDestroyed(From,Event,To,UnitName,RecceName)
-  self:T({From, Event, To, UnitName, RecceName})
-  if self.notifypilots or self.debug then
-    local text = string.format("Unit %s destroyed! Good job!",UnitName)
-    self:NotifyPilots(text,self.reporttimeshort)
-  end
-  return self
-end
-
---- (Internal) FSM Function onbeforeTargetLost
--- @param #AUTOLASE self
--- @param #string From The from state
--- @param #string Event The event
--- @param #string To The to state
--- @param #string UnitName The lost unit\'s name
--- @param #string RecceName The Recce name lasing
--- @return #AUTOLASE self
-function AUTOLASE:onbeforeTargetLost(From,Event,To,UnitName,RecceName)
-  self:T({From, Event, To, UnitName,RecceName})
-  if self.notifypilots or self.debug then
-    local text = string.format("%s lost sight of unit %s.",RecceName,UnitName)
-    self:NotifyPilots(text,self.reporttimeshort)
-  end
-  return self
-end
-
---- (Internal) FSM Function onbeforeLaserTimeout
--- @param #AUTOLASE self
--- @param #string From The from state
--- @param #string Event The event
--- @param #string To The to state
--- @param #string UnitName The lost unit\'s name
--- @param #string RecceName The Recce name lasing
--- @return #AUTOLASE self
-function AUTOLASE:onbeforeLaserTimeout(From,Event,To,UnitName,RecceName)
-  self:T({From, Event, To, UnitName,RecceName})
-  if self.notifypilots or self.debug then
-    local text = string.format("%s laser timeout on unit %s.",RecceName,UnitName)
-    self:NotifyPilots(text,self.reporttimeshort)
-  end
-  return self
-end
-
---- (Internal) FSM Function onbeforeLasing
--- @param #AUTOLASE self
--- @param #string From The from state
--- @param #string Event The event
--- @param #string To The to state
--- @param Functional.Autolase#AUTOLASE.LaserSpot LaserSpot The LaserSpot data table
--- @return #AUTOLASE self
-function AUTOLASE:onbeforeLasing(From,Event,To,LaserSpot)
-  self:T({From, Event, To, LaserSpot.unittype})
-  if self.notifypilots or self.debug then
-    local laserspot = LaserSpot -- #AUTOLASE.LaserSpot
-    local text = string.format("%s is lasing %s code %d\nat %s",laserspot.reccename,laserspot.unittype,laserspot.lasercode,laserspot.location)
-    self:NotifyPilots(text,self.reporttimeshort+5)
-  end
-  return self
-end
-
---- (Internal) FSM Function onbeforeCancel
--- @param #AUTOLASE self
--- @param #string From The from state
--- @param #string Event The event
--- @param #string To The to state
--- @return #AUTOLASE self
-function AUTOLASE:onbeforeCancel(From,Event,To)
-  self:UnHandleEvent(EVENTS.PlayerEnterAircraft)
-  self:__Stop(2)
-  return self
-end
-
--------------------------------------------------------------------
--- End Functional.Autolase.lua
--------------------------------------------------------------------

Moose Development/Moose/Functional/CleanUp.lua

@@ -1,4 +1,4 @@
---- **Functional** -- Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
+--- **Functional** - Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
 --
 -- ===
 --

Moose Development/Moose/Functional/Designate.lua

@@ -1,4 +1,4 @@
---- **Functional** -- Management of target **Designation**. Lase, smoke and illuminate targets.
+--- **Functional** - Management of target **Designation**. Lase, smoke and illuminate targets.
 --
 -- ===
 --
@@ -48,7 +48,7 @@
 -- 
 -- ![Banner Image](..\Presentations\DESIGNATE\Dia3.JPG)
 -- 
--- A typical mission setup would require Recce (a @{Set} of Recce) to be detecting potential targets.
+-- A typical mission setup would require Recce (a @{Core.Set} of Recce) to be detecting potential targets.
 -- The DetectionObject will group the detected targets based on the detection method being used.
 -- Possible detection methods could be by Area, by Type or by Unit.
 -- Each grouping will result in a **TargetGroup**, for terminology and clarity we will use this term throughout the document.
@@ -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: 
 -- 
@@ -213,7 +213,7 @@ do -- DESIGNATE
   -- In order to prevent an overflow of designations due to many Detected Targets, there is a 
   -- Maximum Designations scope that is set in the DesignationObject.
   -- 
-  -- The method @{#DESIGNATE.SetMaximumDesignations}() will put a limit on the amount of designations put in scope of the DesignationObject.
+  -- The method @{#DESIGNATE.SetMaximumDesignations}() will put a limit on the amount of designations (target groups) put in scope of the DesignationObject.
   -- Using the menu system, the player can "forget" a designation, so that gradually a new designation can be put in scope when detected.
   -- 
   -- # 4. Laser codes
@@ -276,7 +276,7 @@ do -- DESIGNATE
   -- # 7. Designate Menu Location for a Mission
   -- 
   -- You can make DESIGNATE work for a @{Tasking.Mission#MISSION} object. In this way, the designate menu will not appear in the root of the radio menu, but in the menu of the Mission.
-  -- Use the method @{#DESIGNATE.SetMission}() to set the @{Mission} object for the designate function.
+  -- Use the method @{#DESIGNATE.SetMission}() to set the @{Tasking.Mission} object for the designate function.
   -- 
   -- # 8. Status Report
   -- 
@@ -562,7 +562,8 @@ do -- DESIGNATE
   end
 
 
-  --- Set the maximum amount of designations.
+  --- Set the maximum amount of designations (target groups). This will put a limit on the amount of designations in scope.
+  -- Using the menu system, the player can "forget" a designation, so that gradually a new designation can be put in scope when detected.
   -- @param #DESIGNATE self
   -- @param #number MaximumDesignations
   -- @return #DESIGNATE
@@ -602,7 +603,7 @@ do -- DESIGNATE
   end
   
   
-  --- Set the maximum amount of markings FACs will do, per designated target group.
+  --- Set the maximum amount of markings FACs will do, per designated target group. This will limit the number of parallelly marked units of a target group.
   -- @param #DESIGNATE self
   -- @param #number MaximumMarkings Maximum markings FACs will do, per designated target group.
   -- @return #DESIGNATE
@@ -911,8 +912,8 @@ do -- DESIGNATE
           for DesignateIndex, Designating in pairs( self.Designating ) do
             local DetectedItem = DetectedItems[DesignateIndex]
             if DetectedItem then
-              local Report = self.Detection:DetectedItemReportSummary( DetectedItem, AttackGroup ):Text( ", " )
-              DetectedReport:Add( string.rep( "-", 140 ) )
+              local Report = self.Detection:DetectedItemReportSummary( DetectedItem, AttackGroup, nil, true ):Text( ", " )
+              DetectedReport:Add( string.rep( "-", 40 ) )
               DetectedReport:Add( " - " .. Report )
               if string.find( Designating, "L" ) then
                 DetectedReport:Add( " - " .. "Lasing Targets" )
@@ -1192,8 +1193,8 @@ do -- DESIGNATE
 
     local MarkingCount = 0
     local MarkedTypes = {}
-    local ReportTypes = REPORT:New()
-    local ReportLaserCodes = REPORT:New()
+    --local ReportTypes = REPORT:New()
+    --local ReportLaserCodes = REPORT:New()
     
     TargetSetUnit:Flush( self )
 
@@ -1243,8 +1244,8 @@ do -- DESIGNATE
               if not Recce then
     
                 self:F( "Lasing..." )
-                self.RecceSet:Flush( self)
-    
+                --self.RecceSet:Flush( self)
+
                 for RecceGroupID, RecceGroup in pairs( self.RecceSet:GetSet() ) do
                   for UnitID, UnitData in pairs( RecceGroup:GetUnits() or {} ) do
     
@@ -1282,13 +1283,13 @@ do -- DESIGNATE
                           -- OK. We have assigned for the Recce a TargetUnit. We can exit the function.
                           MarkingCount = MarkingCount + 1
                           local TargetUnitType = TargetUnit:GetTypeName()
-                          --RecceUnit:MessageToSetGroup( "Marking " .. TargetUnit:GetTypeName() .. " with laser " .. RecceUnit:GetSpot().LaserCode .. " for " .. Duration .. "s.", 
-                          --                             5, self.AttackSet, DesignateName )
+                          RecceUnit:MessageToSetGroup( "Marking " .. TargetUnit:GetTypeName() .. " with laser " .. RecceUnit:GetSpot().LaserCode .. " for " .. Duration .. "s.", 
+                                                     10, self.AttackSet, DesignateName )
                           if not MarkedTypes[TargetUnitType] then
                             MarkedTypes[TargetUnitType] = true
-                            ReportTypes:Add(TargetUnitType)
+                            --ReportTypes:Add(TargetUnitType)
                           end
-                          ReportLaserCodes:Add(RecceUnit.LaserCode)
+                          --ReportLaserCodes:Add(RecceUnit.LaserCode)
                           return
                         end
                       else
@@ -1303,16 +1304,16 @@ do -- DESIGNATE
     
                         if Recce then
                           Recce:LaseOff()
-                          Recce:MessageToSetGroup( "Target " .. TargetUnit:GetTypeName() "out of LOS. Cancelling lase!", 5, self.AttackSet, self.DesignateName )
+                          Recce:MessageToSetGroup( "Target " .. TargetUnit:GetTypeName() "out of LOS. Cancelling lase!", 10, self.AttackSet, self.DesignateName )
                         end
                       else
                         --MarkingCount = MarkingCount + 1
                         local TargetUnitType = TargetUnit:GetTypeName()
                         if not MarkedTypes[TargetUnitType] then
                           MarkedTypes[TargetUnitType] = true
-                          ReportTypes:Add(TargetUnitType)
+                          --ReportTypes:Add(TargetUnitType)
                         end
-                        ReportLaserCodes:Add(RecceUnit.LaserCode)
+                        --ReportLaserCodes:Add(RecceUnit.LaserCode)
                       end  
                     end
                   end
@@ -1322,19 +1323,19 @@ do -- DESIGNATE
                 local TargetUnitType = TargetUnit:GetTypeName()
                 if not MarkedTypes[TargetUnitType] then
                   MarkedTypes[TargetUnitType] = true
-                  ReportTypes:Add(TargetUnitType)
+                  --ReportTypes:Add(TargetUnitType)
                 end
-                ReportLaserCodes:Add(Recce.LaserCode)
-                --Recce:MessageToSetGroup( self.DesignateName .. ": Marking " .. TargetUnit:GetTypeName() .. " with laser " .. Recce.LaserCode .. ".", 5, self.AttackSet )
+                --ReportLaserCodes:Add(Recce.LaserCode)
+                Recce:MessageToSetGroup( self.DesignateName .. ": Marking " .. TargetUnit:GetTypeName() .. " with laser " .. Recce.LaserCode .. ".", 10, self.AttackSet )
               end
             end
           end
         end
       )
 
-      local MarkedTypesText = ReportTypes:Text(', ')
-      local MarkedLaserCodesText = ReportLaserCodes:Text(', ')
-      self.CC:GetPositionable():MessageToSetGroup( "Marking " .. MarkingCount .. " x "  .. MarkedTypesText .. ", code " .. MarkedLaserCodesText .. ".", 5, self.AttackSet, self.DesignateName )
+      --local MarkedTypesText = ReportTypes:Text(', ')
+      --local MarkedLaserCodesText = ReportLaserCodes:Text(', ')
+      --self.CC:GetPositionable():MessageToSetGroup( "Marking " .. MarkingCount .. " x "  .. MarkedTypesText .. ", code " .. MarkedLaserCodesText .. ".", 5, self.AttackSet, self.DesignateName )
   
       self:__Lasing( -self.LaseDuration, Index, Duration, LaserCodeRequested )
       

Moose Development/Moose/Functional/DetectionZones.lua

@@ -1,8 +1,12 @@
+--- **Functional** - Captures the class DETECTION_ZONES.
+-- @module Functional.DetectionZones
+-- @image MOOSE.JPG
+
 do -- DETECTION_ZONES
 
   --- @type DETECTION_ZONES
   -- @field DCS#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target.
-  -- @field #DETECTION_BASE.DetectedItems DetectedItems A list of areas containing the set of @{Wrapper.Unit}s, @{Zone}s, the center @{Wrapper.Unit} within the zone, and ID of each area that was detected within a DetectionZoneRange.
+  -- @field #DETECTION_BASE.DetectedItems DetectedItems A list of areas containing the set of @{Wrapper.Unit}s, @{Core.Zone}s, the center @{Wrapper.Unit} within the zone, and ID of each area that was detected within a DetectionZoneRange.
   -- @extends Functional.Detection#DETECTION_BASE
 
   --- (old, to be revised ) Detect units within the battle zone for a list of @{Core.Zone}s detecting targets following (a) detection method(s), 
@@ -17,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.
   -- 
@@ -40,27 +44,27 @@ do -- DETECTION_ZONES
     ClassName = "DETECTION_ZONES",
     DetectionZoneRange = nil,
   }
-  
-  
+
+
   --- DETECTION_ZONES constructor.
   -- @param #DETECTION_ZONES self
-  -- @param Core.Set#SET_ZONE DetectionSetZone The @{Set} of ZONE_RADIUS.
+  -- @param Core.Set#SET_ZONE DetectionSetZone The @{Core.Set} of ZONE_RADIUS.
   -- @param DCS#Coalition.side DetectionCoalition The coalition of the detection.
   -- @return #DETECTION_ZONES
   function DETECTION_ZONES:New( DetectionSetZone, DetectionCoalition )
-  
+
     -- Inherits from DETECTION_BASE
     local self = BASE:Inherit( self, DETECTION_BASE:New( DetectionSetZone ) ) -- #DETECTION_ZONES
-  
+
     self.DetectionSetZone = DetectionSetZone  -- Core.Set#SET_ZONE
     self.DetectionCoalition = DetectionCoalition
-    
+
     self._SmokeDetectedUnits = false
     self._FlareDetectedUnits = false
     self._SmokeDetectedZones = false
     self._FlareDetectedZones = false
     self._BoundDetectedZones = false
-    
+
     return self
   end
 

Moose Development/Moose/Functional/Escort.lua

@@ -1,4 +1,4 @@
---- **Functional** -- Taking the lead of AI escorting your flight.
+--- **Functional** - Taking the lead of AI escorting your flight.
 -- 
 -- ===
 -- 
@@ -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/FlightModelData.lua

@@ -1,730 +0,0 @@
---- **Functional** - (R2.5) - Monitor and export flight model data.
--- 
--- Record flight data and export it to a csv file. 
--- 
--- ## Recorded Data:
---
---    * Time,
---    * Altitude,
---    * Temperature,
---    * Pressure,
---    * Velocity (total and x,y,z components),
---    * Acceleration (total and x,y,z components),
---    * AoA,
---    * Pitch and pitch rate,
---    * Roll and roll rate,
---    * Yaw and yaw rate,
---    * Turn rate.
---     
--- ===
---
--- ### Author: **funkyfranky**
--- @module Functional.FMData
--- @image Functional_Rat2.png
-
-
---- FMD class.
--- @type FMD
--- @field #string ClassName Name of the class.
--- @field #boolean Debug Debug mode. Messages to all about status.
--- @field #string lid Class id string for output to DCS log file.
--- @field #table players Player table.
--- @field #table menuadded Table of units where the F10 radio menu was added.
--- @field #string savepath Path to save data files.
--- @extends Core.Fsm#FSM
-
---- Be sure!
---
--- ===
---
--- ![Banner Image](..\Presentations\FMD\FMD_Main.png)
---
--- # The FMD Concept
--- 
--- This class can be used to record flight data such as velocity, acceleration, pitch, roll, yaw and turn rates. The output is written to a csv file for later analysis.
--- 
--- # Usage
--- 
--- The script is very easy to use. It only requires the line
--- 
---     fmd=FMD:New()
---     
--- This will automatically start the FMD script.
--- 
--- Each player will get an entry "FMD" in the F-10 radio menu. There he can start or stop the data recording.
--- 
--- **IMPORTANT**
--- Due to a DCS bug, it is necessary that (in single player mode), player/clients have to **hit ESC twice** before entering an aircraft client slot.
--- Otherwise, the script will not load and now menus will be created for the player.
--- 
--- # Output
--- 
--- After the data recording is completed, the data is written to a csv file. The file name starts with **FMD** and contains the employed airframe plus a running number.
--- 
--- However, one must desanitize the **io** and **lfs** lines the DCS root directory. Otherwise, DCS will not allow data to be written to file.
--- 
--- @field #FMD
-FMD = {
-  ClassName      = "FMD",
-  Debug          = false,
-  lid            = nil,
-  players        = {},
-  menuadded      = {},
-  savepath       = nil,
-}
-
---- Player data table.
--- @type FMD.PlayerData
--- @field Core.Scheduler#SCHEDULER scheduler Scheduler
--- @field Wrapper.Unit#UNIT unit Player unit.
--- @field #string unitname Name of the unit.
--- @field Wrapper.Client#CLIENT client Player client.
--- @field #string actype Aircraft type.
--- @field #string name Player name.
--- @field #number dt Time step for data recording in seconds. Default 0.01 sec ==> 100 data points per second!
--- @field #number rd Recording duration in seconds.
--- @field #boolean recording If true, recording started.
--- @field #table data Data table.
--- @field #number SID Scheduler ID.
-
---- Data point table.
--- @type FMD.DataPoint
--- @field #number time Abs mission time.
--- @field #number T Temperature in degrees Celsius.
--- @field #number P Pressure.
--- @field #number Alt Altitude ASL in meters.
--- @field #number AoA Angle of Attack in degrees.
--- @field #number Pitch Pitch angle in degrees.
--- @field #number Roll Roll angle in degrees.
--- @field #number Yaw Yaw angle in degrees.
--- @field #number Climbrate Climb rate in m/s.
--- @field #number Vtot Total velocity in m/s.
--- @field DCS#Vec3 v Velocity vector. Components x,y,z in m/s.
--- @field DCS#Vec3 o Orientation vector. Components x,y,z in meters.
--- @field #number omega Angle velocity in m/s.
--- @field #number Hdg Heading in degrees.
--- @field #number Atot Total acceleration m/s^2.
--- @field DCS#Vec3 a Acceleration vector.
--- @field #number DRoll Roll speed in degrees/second.
--- @field #number DPitch Pitch speed in degrees/second.
--- @field #number DYaw Yaw speed in degrees/second.
-
---- Main group level radio menu: F10 Other/FMD.
--- @field #table MenuF10
-FMD.MenuF10={}
-
---- FMD mission level F10 root menu.
--- @field #table MenuF10Root
-FMD.MenuF10Root=nil
-
---- FMD script version.
--- @field #string version
-FMD.version="0.1.0"
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Create a new FMD class object.
--- @param #FMD self
--- @return #FMD self.
-function FMD:New()
-
-  -- Inherit everthing from FSM class.
-  local self=BASE:Inherit(self, FSM:New()) -- #FMD
-  
-  -- Start State.
-  self:SetStartState("Stopped")
-  
-  -- Log string.
-  self.lid="FMD | "
-
-  -- Add FSM transitions.
-  --                 From State  -->   Event      -->     To State
-  self:AddTransition("Stopped",       "Start",           "Running")     -- Start FMD script.
-  self:AddTransition("*",             "Status",          "*")           -- Start FMD script.
-  
-  -- Start FMD.
-  self:Start()
-
-  return self
-end
-
---- On after Start event.
--- @param #FMD self
--- @param #string From From state.
--- @param #string Event Event.
--- @param #string To To state.
-function FMD:onafterStart(From, Event, To)
-
-  -- Short info.
-  local text=string.format("Starting Flight Model Data script version %s", FMD.version)
-  self:I(self.lid..text)  
-
-  -- Handle events.
-  self:HandleEvent(EVENTS.Birth)
-end
-
---- On after Stop event.
--- @param #FMD self
--- @param #string From From state.
--- @param #string Event Event.
--- @param #string To To state.
-function FMD:onafterStop(From, Event, To)
-
-  -- Short info.
-  local text=string.format("Stopping Flight Model Data script version %s", FMD.version)
-  self:I(self.lid..text)  
-
-  -- Handle events.
-  self:UnHandleEvent(EVENTS.Birth) 
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Event Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- FMD event handler for event birth.
--- @param #FMD self
--- @param Core.Event#EVENTDATA EventData
-function FMD:OnEventBirth(EventData)
-  self:F3({eventbirth = EventData})
-  
-  local _unitName=EventData.IniUnitName
-  local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
-  
-  self:T2(self.lid.."BIRTH: unit   = "..tostring(EventData.IniUnitName))
-  self:T2(self.lid.."BIRTH: group  = "..tostring(EventData.IniGroupName))
-  self:T2(self.lid.."BIRTH: player = "..tostring(_playername))
-      
-  if _unit and _playername then
-  
-    local _uid=_unit:GetID()
-    local _group=_unit:GetGroup()
-    local _callsign=_unit:GetCallsign()
-    
-    -- Debug output.
-    local text=string.format("Pilot %s, callsign %s entered unit %s of group %s.", _playername, _callsign, _unitName, _group:GetName())
-    self:T(self.lid..text)
-    MESSAGE:New(text, 5):ToAllIf(self.Debug)
-                
-    -- Add Menu commands.
-    self:_AddF10Commands(_unitName)
-
-    -- Player data.
-    self.players[_playername]={}
-    
-    local player=self.players[_playername] --#FMD.PlayerData
-    
-    player.scheduler=SCHEDULER:New()
-    player.unit=_unit
-    player.unitname=_unitName
-    player.name=_playername
-    player.client=CLIENT:FindByName(_unitName, nil, true)
-    player.actype=_unit:GetTypeName()
-    player.dt=0.01
-    player.rd=30
-    player.recording=false
-    player.data={}
-     
-  end 
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Data Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Get data of unit.
--- @param #FMD self
--- @param Wrapper.Unit#UNIT unit
--- @return #FMD.DataPoint Datapoint.
-function FMD:_GetDataPoint(unit)
-
-  if unit and unit:IsAlive() then
-  
-    -- Current coordinate.
-    local coord=unit:GetCoordinate()
-    
-    local dp={} --#FMD.DataPoint
-    
-    dp.a={}
-    dp.Alt=coord.y
-    dp.AoA=unit:GetAoA()
-    dp.Atot=nil
-    dp.P=coord:GetPressure()
-    dp.Pitch=unit:GetPitch()
-    dp.Roll=unit:GetRoll()
-    dp.time=timer.getAbsTime()
-    dp.T=coord:GetTemperature()
-    dp.v=unit:GetVelocityVec3()
-    dp.Vtot=UTILS.VecNorm(dp.v)
-    dp.Yaw=unit:GetYaw()
-    dp.o=unit:GetOrientationX()
-    dp.Hdg=unit:GetHeading()
-    
-    return dp
-  else
-    return nil
-  end
-end
-
---- Get data of unit.
--- @param #FMD self
--- @param #FMD.PlayerData playerData Player data.
--- @return #FMD.DataPoint Datapoint.
-function FMD:_Derivative(playerData)
-
-  local function numderiv(fpm,fpp,h)
-    return 0.5*(fpp-fpm)/h
-  end
-
-  local datapoints=playerData.data
-  --local dt=playerData.dt
-
-  for i=2,#datapoints-1 do
-  
-    local dpm=datapoints[i-1]  --#FMD.DataPoint
-    local dpp=datapoints[i+1]  --#FMD.DataPoint
-    local dpi=datapoints[i]    --#FMD.DataPoint
-    
-    -- Time step.
-    local dt=0.5*(dpp.time-dpm.time)
-    
-    dpi.Atot=numderiv(dpm.Vtot, dpp.Vtot, dt)
-
-    dpi.a.x=numderiv(dpm.v.x, dpp.v.x, dt)
-    dpi.a.y=numderiv(dpm.v.y, dpp.v.y, dt)    
-    dpi.a.z=numderiv(dpm.v.z, dpp.v.z, dt)
-    
-    dpi.DPitch=numderiv(dpm.Pitch, dpp.Pitch, dt)
-    --dpi.DRoll=numderiv(dpm.Roll, dpp.Roll, dt)
-    dpi.DYaw=numderiv(dpm.Yaw, dpp.Yaw, dt)
-    
-    -- Roll shortcuts.
-    local r1=dpm.Roll
-    local r2=dpp.Roll
-    
-    -- Put roll in [0,360)
-    if (r1<0) then
-      r1=r1+360
-    end 
-    if (r2<0) then
-      r2=r2+360
-    end
-
-    -- Handle case where 360 deg periodicity strikes.
-    if r1<90 and r2>270 then
-      r1=r1+360
-    end    
-    if r1>270 and r2<90 then
-      r2=r2+360
-    end
-    
-    --
-    dpi.DRoll=numderiv(r1, r2, dt)
-    
-    local ang=UTILS.VecAngle(dpm.o, dpp.o)
-    dpi.omega=numderiv(0, ang, dt)
-    
-  end
-  
-end
-
---- Record data
--- @param #FMD self
--- @param #FMD.PlayerData playerData Player data table.
-function FMD:_RecordData(playerData)
-
-  -- Check if we are recording already.
-  if not playerData.recording then
-  
-      -- Inform player.
-      local text=string.format("Data recording starts for %.1f sec.", playerData.rd)
-      MESSAGE:New(text, 3, "FMD"):ToClient(playerData.client)
-      
-      -- Activate recording switch.
-      playerData.recording=true    
-  end
-  
-  -- Check if unit is alive.
-  if playerData.unit and playerData.unit:IsAlive() then
-
-    -- Get data point.
-    local dp=self:_GetDataPoint(playerData.unit)
-    
-    -- Add data point to player table.
-    table.insert(playerData.data, dp)
-    
-  else
-    -- Stop recording if player unit is not alive.
-    self:_StopRecording(playerData.unitname)
-  end
-
-end
-
---- Save data.
--- @param #FMD self
--- @param #FMD.PlayerData playerData Player data table.
-function FMD:_SaveData(playerData)
-
-  -- Nothing to save.
-  if playerData==nil or #playerData.data==0 or not io then
-    return
-  end
-
-  --- Function that saves data to file
-  local function _savefile(filename, data)
-    local f = assert(io.open(filename, "wb"))
-    f:write(data)
-    f:close()
-  end
-  
-  -- Set path or default.
-  local path=self.savepath
-  if lfs then
-    path=path or lfs.writedir()
-  end
-
-  -- Create unused file name.
-  local filename=nil
-  for i=1,9999 do
-  
-    -- Create file name.
-    filename=string.format("FMD-%s_%s-%04d.csv", playerData.name, playerData.actype, i)
-
-    -- Set path.
-    if path~=nil then
-      filename=path.."\\"..filename
-    end
-    
-    -- Check if file exists.
-    local _exists=UTILS.FileExists(filename)
-    if not _exists then
-      break
-    end  
-  end
-  
-
-  -- Info
-  local text=string.format("Saving player %s flight data to file %s", playerData.name, filename)
-  self:I(self.lid..text)
-
-  -- Header line
-  local data="#Time,Altitude,Temperature,Pressure,Vtot,Vx,Vy,Vz,Atot,ax,ay,az,AoA,Pitch,dPitch/dt,Roll,dRoll/dt,Yaw,dYaw/dt,Turn Rate\n"
-  
-  local g0=playerData.data[1] --#FMD.DataPoint
-  local T0=g0.time
-  
-  -- Calculate derivatives.
-  self:_Derivative(playerData)
-
-  for i=2,#playerData.data-1 do
-  
-    local dp=playerData.data[i] --#FMD.DataPoint
-    
-    -- Conversion m/s == Mach. 
-    local ms2mach=0.00291545
-    
-    local t=(dp.time-T0) or 0
-    local a=dp.Alt or 0
-    local b=dp.T or 0
-    local c=dp.P or 0
-    local d=dp.Vtot or 0
-    local e=dp.v.x or 0
-    local f=dp.v.y or 0
-    local g=dp.v.z or 0
-    local h=dp.Atot or 0
-    local i=dp.a.x or 0
-    local j=dp.a.y or 0
-    local k=dp.a.z or 0
-    local l=dp.AoA or 0
-    local m=dp.Pitch or 0
-    local n=dp.DPitch or 0
-    local roll=dp.Roll or 0
-    if roll<0 then
-      roll=roll+360
-    end
-    local o=roll --dp.Roll or 0
-    local p=dp.DRoll or 0
-    local q=dp.Yaw or 0
-    local r=dp.DYaw or 0
-    local s=dp.omega or 0
-    
-    -- Debug output.
-    self:T3(t)
-    self:T3(a)
-    self:T3(b)
-    self:T3(c)
-    self:T3(d)
-    self:T3(e)
-    self:T3(f)
-    self:T3(g)
-    self:T3(h)
-    self:T3(i)
-    self:T3(j)
-    self:T3(k)
-    self:T3(l)
-    self:T3(m)
-    self:T3(n)
-    self:T3(o)
-    self:T3(p)
-    self:T3(q)
-    self:T3(r)
-    self:T3(s)
-    
-    --                         t    a    b    c    d    e    f    g    h    i    j    k    l    m    n    o    p    q    r    s
-    data=data..string.format("%.2f,%.2f,%.2f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f,%.3f\n",
-                               t,   a,   b,   c,   d,   e,   f,   g,   h,   i,   j,   k,   l,   m,   n,   o,   p,   q,   r,   s)
-
-  end
-  
-  -- Save file.
-  _savefile(filename, data)
-  
-  -- Clear data.
-  playerData.data={}
-end
-
------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- RADIO MENU Functions
------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Add menu commands for player.
--- @param #FMD self
--- @param #string _unitName Name of player unit.
-function FMD:_AddF10Commands(_unitName)
-  self:F(_unitName)
-  
-  -- Get player unit and name.
-  local _unit, playername = self:_GetPlayerUnitAndName(_unitName)
-  
-  -- Check for player unit.
-  if _unit and playername then
-
-    -- Get group and ID.
-    local group=_unit:GetGroup()
-    local gid=group:GetID()
-      
-    if group and gid then
-  
-      if not self.menuadded[gid] then
-      
-        -- Enable switch so we don't do this twice.
-        self.menuadded[gid]=true
-        
-        -- Set menu root path.
-        local _rootPath=nil
-        if FMD.MenuF10Root then
-          ------------------------
-          -- MISSON LEVEL MENUE --
-          ------------------------          
-
-          -- F10/FMD/...
-          _rootPath=FMD.MenuF10Root
-            
-        else
-          ------------------------
-          -- GROUP LEVEL MENUES --
-          ------------------------
-          
-          -- Main F10 menu: F10/FMD/
-          if FMD.MenuF10[gid]==nil then
-            FMD.MenuF10[gid]=missionCommands.addSubMenuForGroup(gid, "FMD")
-          end
-          
-          
-          -- F10/FMD/...
-          _rootPath=FMD.MenuF10[gid]
-          
-        end
-
-        --------------------------------        
-        -- F10/F<X> FMD/F1 Time Interval
-        --------------------------------
-        local _timePath=missionCommands.addSubMenuForGroup(gid, "Time Interval", _rootPath)
-        -- F10/FMD/F1 Time Interval/
-        missionCommands.addCommandForGroup(gid, "Delta t=0.01 s", _timePath, self._SetTimeInterval, self, _unitName, 0.01)
-        missionCommands.addCommandForGroup(gid, "Delta t=0.1 s",  _timePath, self._SetTimeInterval, self, _unitName, 0.1)
-        missionCommands.addCommandForGroup(gid, "Delta t=1.0 s",  _timePath, self._SetTimeInterval, self, _unitName, 1.0)
-        missionCommands.addCommandForGroup(gid, "Delta t=10 s",   _timePath, self._SetTimeInterval, self, _unitName, 10.0)
-        missionCommands.addCommandForGroup(gid, "Delta t=30 s",   _timePath, self._SetTimeInterval, self, _unitName, 30.0)
-        missionCommands.addCommandForGroup(gid, "Delta t=60 s",   _timePath, self._SetTimeInterval, self, _unitName, 60.0)
-
-        -------------------------------        
-        -- F10/F<X> FMD/F1 Rec Duration
-        -------------------------------
-        local _durPath=missionCommands.addSubMenuForGroup(gid, "Rec Duration", _rootPath)
-        -- F10/FMD/F1 Rec Duration/
-        missionCommands.addCommandForGroup(gid, "T=10 s",   _durPath, self._SetRecDuration, self, _unitName, 10)
-        missionCommands.addCommandForGroup(gid, "T=30 s",   _durPath, self._SetRecDuration, self, _unitName, 30)
-        missionCommands.addCommandForGroup(gid, "T=60 s",   _durPath, self._SetRecDuration, self, _unitName, 60)
-        missionCommands.addCommandForGroup(gid, "T=5 min",  _durPath, self._SetRecDuration, self, _unitName, 5*60)
-        missionCommands.addCommandForGroup(gid, "T=10 min", _durPath, self._SetRecDuration, self, _unitName, 10*60)
-        
-        --------------------------------        
-        -- F10/F<X> FMD/
-        --------------------------------
-        
-        -- F10/FMD/Start Recording
-        missionCommands.addCommandForGroup(gid, "Start Recording", _rootPath, self._StartRecording, self, _unitName)  -- F1
-        missionCommands.addCommandForGroup(gid, "Stop Recording",  _rootPath, self._StopRecording,  self, _unitName)  -- F2
-        
-      end
-    end
-  end
-end
-
-
---- Set recording duration.
--- @param #FMD self
--- @param #string _unitName Name of player unit.
--- @param #number rd Recording duration in sec.
-function FMD:_SetRecDuration(_unitName, rd)
-
-  -- Get player unit and name.
-  local _unit, _playername = self:_GetPlayerUnitAndName(_unitName)
-  
-  -- Check if we have a unit which is a player.
-  if _unit and _playername then
-    local playerData=self.players[_playername] --#FMD.PlayerData
-    
-    if playerData then
-    
-      -- Set dt.
-      playerData.rd=rd
-
-      -- Inform player.
-      local text=string.format("Data recording duration set to %.1f sec.", playerData.rd)
-      MESSAGE:New(text, 10, "FMD"):ToClient(playerData.client)
-    
-    end
-  end
-end
-
-
---- Set time interval for data recording.
--- @param #FMD self
--- @param #string _unitName Name of player unit.
--- @param #number dt Time interval in seconds.
-function FMD:_SetTimeInterval(_unitName, dt)
-
-  -- Get player unit and name.
-  local _unit, _playername = self:_GetPlayerUnitAndName(_unitName)
-  
-  -- Check if we have a unit which is a player.
-  if _unit and _playername then
-    local playerData=self.players[_playername] --#FMD.PlayerData
-    
-    if playerData then
-    
-      -- Set dt.
-      playerData.dt=dt
-
-      -- Inform player.
-      local text=string.format("Data recording time interval set to %.3f sec.", playerData.dt)
-      MESSAGE:New(text, 10, "FMD"):ToClient(playerData.client)    
-    
-    end
-  end
-end
-
---- Start data recording.
--- @param #FMD self
--- @param #string _unitName Name of player unit.
-function FMD:_StartRecording(_unitName)
-
-  -- Get player unit and name.
-  local _unit, _playername = self:_GetPlayerUnitAndName(_unitName)
-  
-  -- Check if we have a unit which is a player.
-  if _unit and _playername then
-    local playerData=self.players[_playername] --#FMD.PlayerData
-    
-    if playerData then
-    
-      -- Delay before recording starts.
-      local delay=3
-    
-      -- Inform player.
-      local text=string.format("Data recording will be started in %d seconds with %.3f sec timestep for %.1f sec.", delay, playerData.dt, playerData.rd)
-      MESSAGE:New(text, 3, "FMD"):ToClient(playerData.client)
-    
-      -- Start scheduler.
-      playerData.SID=playerData.scheduler:Schedule(nil, self._RecordData, {self, playerData}, delay, playerData.dt, 0.0)
-      
-      -- Stop scheduler once.
-      playerData.scheduler:ScheduleOnce(playerData.rd+delay, self._StopRecording, self,_unitName)
-    end
-  end
-
-end
-
---- Stop data recording.
--- @param #FMD self
--- @param #string _unitName Name of player unit.
-function FMD:_StopRecording(_unitName)
-
-  -- Get player unit and name.
-  local _unit, _playername = self:_GetPlayerUnitAndName(_unitName)
-  
-  -- Check if we have a unit which is a player.
-  if _unit and _playername then
-    local playerData=self.players[_playername] --#FMD.PlayerData
-    
-    if playerData then
-    
-      local ndata=#playerData.data
-    
-      -- Inform player.
-      local text=string.format("Data recording stopped. Data points recorded: %d", ndata)
-      MESSAGE:New(text, 10, "FMD"):ToClient(playerData.client)
-      
-      -- No recording switch.
-      playerData.recording=false
-    
-      -- Stop scheduler.
-      playerData.scheduler:Stop(playerData.SID)
-      
-      -- Save data.
-      self:_SaveData(playerData)
-      
-    end
-  end
-
-end
-
---- Returns the unit of a player and the player name. If the unit does not belong to a player, nil is returned. 
--- @param #FMD self
--- @param #string _unitName Name of the player unit.
--- @return Wrapper.Unit#UNIT Unit of player or nil.
--- @return #string Name of the player or nil.
-function FMD:_GetPlayerUnitAndName(_unitName)
-  self:F2(_unitName)
-
-  if _unitName ~= nil then
-  
-    -- Get DCS unit from its name.
-    local DCSunit=Unit.getByName(_unitName)
-    
-    if DCSunit then
-    
-      local playername=DCSunit:getPlayerName()
-      local unit=UNIT:Find(DCSunit)
-    
-      self:T2({DCSunit=DCSunit, unit=unit, playername=playername})
-      if DCSunit and unit and playername then
-        return unit, playername
-      end
-      
-    end
-    
-  end
-  
-  -- Return nil if we could not find a player.
-  return nil,nil
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-

Moose Development/Moose/Functional/Fox.lua

@@ -1,4 +1,4 @@
---- **Functional** - (R2.5) - Yet Another Missile Trainer.
+--- **Functional** - Yet Another Missile Trainer.
 -- 
 -- 
 -- Practice to evade missiles without being destroyed.
@@ -20,12 +20,13 @@
 -- ===
 --
 -- ### Author: **funkyfranky**
--- @module Functional.FOX
+-- @module Functional.Fox
 -- @image Functional_FOX.png
 
 --- FOX class.
 -- @type FOX
 -- @field #string ClassName Name of the class.
+-- @field #number verbose Verbosity level.
 -- @field #boolean Debug Debug mode. Messages to all about status.
 -- @field #string lid Class id string for output to DCS log file.
 -- @field #table menuadded Table of groups the menu was added for.
@@ -57,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
@@ -112,18 +113,14 @@
 --     -- 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 = {
   ClassName      = "FOX",
+  verbose        =    0,
   Debug          = false,
   lid            =   nil,
   menuadded      =    {},
@@ -168,7 +165,7 @@ FOX = {
 
 --- Missile data table.
 -- @type FOX.MissileData
--- @field Wrapper.Unit#UNIT weapon Missile weapon unit.
+-- @field DCS#Weapon weapon Missile weapon object.
 -- @field #boolean active If true the missile is active.
 -- @field #string missileType Type of missile.
 -- @field #string missileName Name of missile.
@@ -185,6 +182,8 @@ FOX = {
 -- @field #string targetName Name of the target unit or "unknown".
 -- @field #string targetOrig Name of the "original" target, i.e. the one right after launched.
 -- @field #FOX.PlayerData targetPlayer Player that was targeted or nil.
+-- @field Core.Point#COORDINATE missileCoord Missile coordinate during tracking.
+-- @field Wrapper.Weapon#WEAPON Weapon Weapon object.
 
 --- Main radio menu on group level.
 -- @field #table MenuF10 Root menu table on group level.
@@ -196,7 +195,7 @@ FOX.MenuF10Root=nil
 
 --- FOX class version.
 -- @field #string version
-FOX.version="0.6.1"
+FOX.version="0.8.0"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- ToDo list
@@ -492,7 +491,6 @@ end
 
 --- Disable F10 menu for all players.
 -- @param #FOX self
--- @param #boolean switch If true debug mode on. If false/nil debug mode off
 -- @return #FOX self
 function FOX:SetDisableF10Menu()
 
@@ -501,6 +499,26 @@ function FOX:SetDisableF10Menu()
   return self
 end
 
+
+--- Enable F10 menu for all players.
+-- @param #FOX self
+-- @return #FOX self
+function FOX:SetEnableF10Menu()
+
+  self.menudisabled=false
+
+  return self
+end
+
+--- Set verbosity level.
+-- @param #FOX self
+-- @param #number VerbosityLevel Level of output (higher=more). Default 0.
+-- @return #FOX self
+function FOX:SetVerbosity(VerbosityLevel)
+  self.verbose=VerbosityLevel or 0
+  return self
+end
+
 --- Set default player setting for missile destruction.
 -- @param #FOX self
 -- @param #boolean switch If true missiles are destroyed. If false/nil missiles are not destroyed.
@@ -596,7 +614,9 @@ function FOX:onafterStatus(From, Event, To)
   local clock=UTILS.SecondsToClock(time)
   
   -- Status.
-  self:I(self.lid..string.format("Missile trainer status %s: %s", clock, fsmstate))
+  if self.verbose>=1 then
+    self:I(self.lid..string.format("Missile trainer status %s: %s", clock, fsmstate))
+  end
   
   -- Check missile status.
   self:_CheckMissileStatus()
@@ -704,7 +724,9 @@ function FOX:_CheckMissileStatus()
   if #self.missiles==0 then
     text=text.." none"
   end
-  self:I(self.lid..text)
+  if self.verbose>=2 then
+    self:I(self.lid..text)
+  end
 
   -- Remove inactive missiles.  
   for i=#self.missiles,1,-1 do
@@ -734,7 +756,7 @@ function FOX:_IsProtected(targetunit)
     if targetgroup then
       local targetname=targetgroup:GetName()
       
-      for _,_group in pairs(self.protectedset:GetSetObjects()) do
+      for _,_group in pairs(self.protectedset:GetSet()) do
         local group=_group --Wrapper.Group#GROUP
         
         if group then
@@ -753,6 +775,277 @@ function FOX:_IsProtected(targetunit)
   return false
 end
 
+
+--- Function called from weapon tracking.
+-- @param Wrapper.Weapon#WEAPON weapon Weapon object.
+-- @param #FOX self FOX object.
+-- @param #FOX.MissileData missile Fired missile
+function FOX._FuncTrack(weapon, self, missile)
+
+  -- Missile coordinate.
+  local missileCoord= missile.missileCoord:UpdateFromVec3(weapon.vec3) --COORDINATE:NewFromVec3(_lastBombPos)
+  
+  -- Missile velocity in m/s.
+  local missileVelocity=weapon:GetSpeed() --UTILS.VecNorm(_ordnance:getVelocity())
+  
+  -- Update missile target if necessary.
+  self:GetMissileTarget(missile)
+  
+ -- Target unit of the missile.
+  local target=nil --Wrapper.Unit#UNIT  
+  
+  if missile.targetUnit then
+  
+    -----------------------------------
+    -- Missile has a specific target --
+    -----------------------------------
+  
+    if missile.targetPlayer then
+      -- Target is a player.
+      if missile.targetPlayer.destroy==true then
+        target=missile.targetUnit
+      end
+    else
+      -- Check if unit is protected.
+      if self:_IsProtected(missile.targetUnit) then
+        target=missile.targetUnit
+      end
+    end
+    
+  else
+  
+    ------------------------------------
+    -- Missile has NO specific target --
+    ------------------------------------   
+    
+    -- TODO: This might cause a problem with wingman. Even if the shooter itself is excluded from the check, it's wingmen are not.
+    --       That would trigger the distance check right after missile launch if things to wrong.
+    --
+    --       Possible solutions:
+    --       * Time check: enable this check after X seconds after missile was fired. What is X?
+    --       * Coalition check. But would not work in training situations where blue on blue is valid!
+    --       * At least enable it for surface-to-air missiles.
+    
+    local function _GetTarget(_unit)
+      local unit=_unit --Wrapper.Unit#UNIT
+  
+      -- Player position.
+      local playerCoord=unit:GetCoordinate()
+        
+      -- Distance.            
+      local dist=missileCoord:Get3DDistance(playerCoord)
+                    
+      -- Update mindist if necessary. Only include players in range of missile + 50% safety margin.
+      if dist<=self.explosiondist then
+        return unit
+      end          
+    end
+    
+    -- Distance to closest player.
+    local mindist=nil
+    
+    -- Loop over players.
+    for _,_player in pairs(self.players) do
+      local player=_player  --#FOX.PlayerData
+      
+      -- Check that player was not the one who launched the missile.
+      if player.unitname~=missile.shooterName then
+      
+        -- Player position.
+        local playerCoord=player.unit:GetCoordinate()
+        
+        -- Distance.            
+        local dist=missileCoord:Get3DDistance(playerCoord)
+        
+        -- Distance from shooter to player.
+        local Dshooter2player=playerCoord:Get3DDistance(missile.shotCoord)
+        
+        -- Update mindist if necessary. Only include players in range of missile + 50% safety margin.
+        if (mindist==nil or dist<mindist) and (Dshooter2player<=missile.missileRange*1.5 or dist<=self.explosiondist) then
+          mindist=dist
+          target=player.unit
+        end
+      end            
+    end
+    
+    if self.protectedset then
+    
+      -- Distance to closest protected unit.
+      mindist=nil
+    
+      for _,_group in pairs(self.protectedset:GetSet()) do
+        local group=_group --Wrapper.Group#GROUP
+        for _,_unit in pairs(group:GetUnits()) do
+          local unit=_unit --Wrapper.Unit#UNIT
+          
+          if unit and unit:IsAlive() then
+          
+            -- Check that player was not the one who launched the missile.
+            if unit:GetName()~=missile.shooterName then
+            
+              -- Player position.
+              local playerVec3=unit:GetVec3()
+              
+              -- Distance.
+              local dist=missileCoord:Get3DDistance(playerVec3)
+                            
+              -- Distance from shooter to player.
+              local Dshooter2player=missile.shotCoord:Get3DDistance(playerVec3)
+              
+              -- Update mindist if necessary. Only include players in range of missile + 50% safety margin.
+              if (mindist==nil or dist<mindist) and (Dshooter2player<=missile.missileRange*1.5 or dist<=self.explosiondist) then
+                mindist=dist
+                target=unit
+              end
+            end
+                                      
+          end              
+        end             
+      end
+    end
+    
+    if target then
+      self:T(self.lid..string.format("Missile %s with NO explicit target got closest unit to missile as target %s. Dist=%s m", missile.missileType, target:GetName(), tostring(mindist)))
+    end
+         
+  end
+  
+  -- Check if missile has a valid target.
+  if target then
+  
+    -- Target coordinate.
+    local targetVec3=target:GetVec3() --target:GetCoordinate()
+  
+    -- Distance from missile to target.
+    local distance=missileCoord:Get3DDistance(targetVec3)
+    
+    -- Distance missile to shooter.
+    local distShooter=nil
+    if missile.shooterUnit and missile.shooterUnit:IsAlive() then
+      distShooter=missileCoord:Get3DDistance(missile.shooterUnit:GetVec3())
+    end
+    
+    
+    -- Debug output.
+    if self.Debug then    
+      local bearing=missileCoord:HeadingTo(targetVec3)
+      local eta=distance/missileVelocity    
+      -- Debug distance check.
+      self:I(self.lid..string.format("Missile %s Target %s: Distance = %.1f m, v=%.1f m/s, bearing=%03d°, ETA=%.1f sec", missile.missileType, target:GetName(), distance, missileVelocity, bearing, eta))
+    end
+    
+    -- Distroy missile if it's getting too close.
+    local destroymissile=distance<=self.explosiondist
+    
+    -- Check BIG missiles.
+    if self.explosiondist2 and distance<=self.explosiondist2 and not destroymissile then
+       destroymissile=missile.explosive>=self.bigmissilemass
+    end
+  
+    -- If missile is 150 m from target ==> destroy missile if in safe zone.
+    if destroymissile and self:_CheckCoordSafe(targetVec3) then
+    
+      -- Destroy missile.
+      self:I(self.lid..string.format("Destroying missile %s(%s) fired by %s aimed at %s [player=%s] at distance %.1f m", 
+      missile.missileType, missile.missileName, missile.shooterName, target:GetName(), tostring(missile.targetPlayer~=nil), distance))
+      weapon:Destroy()
+      
+      -- Missile is not active any more.
+      missile.active=false
+      
+      -- Debug smoke.
+      if self.Debug then
+        missileCoord:SmokeRed()          
+      end
+      
+      -- Create event.
+      self:MissileDestroyed(missile)
+      
+      -- Little explosion for the visual effect.
+      if self.explosionpower>0 and distance>50 and (distShooter==nil or (distShooter and distShooter>50)) then
+        missileCoord:Explosion(self.explosionpower)
+      end
+                
+      -- Target was a player.
+      if missile.targetPlayer then
+      
+        -- Message to target.
+        local text=string.format("Destroying missile. %s", self:_DeadText())
+        MESSAGE:New(text, 10):ToGroup(target:GetGroup())
+                
+        -- Increase dead counter.
+        missile.targetPlayer.dead=missile.targetPlayer.dead+1
+      end
+
+      -- We could disable the tracking here but then the impact function would not be called.
+      --weapon.tracking=false
+      
+    else
+    
+      -- Time step.
+      local dt=1.0          
+      if distance>50000 then
+        -- > 50 km
+        dt=self.dt50 --=5.0
+      elseif distance>10000 then
+        -- 10-50 km
+        dt=self.dt10 --=1.0
+      elseif distance>5000 then
+        -- 5-10 km
+        dt=self.dt05 --0.5
+      elseif distance>1000 then
+        -- 1-5 km
+        dt=self.dt01 --0.1
+      else
+        -- < 1 km
+        dt=self.dt00 --0.01
+      end
+    
+      -- Set time step.
+      weapon:SetTimeStepTrack(dt)
+    end
+    
+  else
+  
+    -- No current target.
+    self:T(self.lid..string.format("Missile %s(%s) fired by %s has no current target. Checking back in 0.1 sec.",  missile.missileType, missile.missileName, missile.shooterName))
+    weapon:SetTimeStepTrack(0.1)
+    
+  end
+
+end
+
+--- Callback function on impact or destroy otherwise.
+-- @param Wrapper.Weapon#WEAPON weapon Weapon object.
+-- @param #FOX self FOX object.
+-- @param #FOX.MissileData missile Fired missile.
+function FOX._FuncImpact(weapon, self, missile)
+
+  if missile.targetPlayer then  
+  
+    -- Get human player.
+    local player=missile.targetPlayer
+    
+    -- Check for player and distance < 10 km.
+    if player and player.unit:IsAlive() then -- and missileCoord and player.unit:GetCoordinate():Get3DDistance(missileCoord)<10*1000 then
+      local text=string.format("Missile defeated. Well done, %s!", player.name)
+      MESSAGE:New(text, 10):ToClient(player.client)
+      
+      -- Increase defeated counter.
+      player.defeated=player.defeated+1
+    end
+    
+  end
+  
+  -- Missile is not active any more.
+  missile.active=false   
+          
+  --Terminate the timer.
+  self:T(FOX.lid..string.format("Terminating missile track timer."))
+  weapon.tracking=false
+
+end
+
 --- Missle launch event.
 -- @param #FOX self
 -- @param #string From From state.
@@ -792,7 +1085,7 @@ function FOX:onafterMissileLaunch(From, Event, To, missile)
           local text=string.format("Missile launch detected! Distance %.1f NM, bearing %03d°.", UTILS.MetersToNM(distance), bearing)
           
           -- Say notching headings.
-          BASE:ScheduleOnce(5, FOX._SayNotchingHeadings, self, player, missile.weapon)
+          self:ScheduleOnce(5, FOX._SayNotchingHeadings, self, player, missile.weapon)
                     
           --TODO: ALERT or INFO depending on whether this is a direct target.
           --TODO: lauchalertall option.
@@ -809,304 +1102,19 @@ function FOX:onafterMissileLaunch(From, Event, To, missile)
       end
         
     end
-  end              
+  end
   
-  -- Init missile position.
-  local _lastBombPos = {x=0,y=0,z=0}
+  -- Set callback function for tracking.
+  missile.Weapon:SetFuncTrack(FOX._FuncTrack, self, missile)
   
-  -- Missile coordinate.
-  local missileCoord = nil --Core.Point#COORDINATE
+  -- Set callback function for impact.
+  missile.Weapon:SetFuncImpact(FOX._FuncImpact, self, missile)
   
-  -- Target unit of the missile.
-  local target=nil --Wrapper.Unit#UNIT
-      
-  --- Function monitoring the position of a bomb until impact.
-  local function trackMissile(_ordnance)
-  
-    -- When the pcall returns a failure the weapon has hit.
-    local _status,_bombPos =  pcall(
-    function()
-      return _ordnance:getPoint()
-    end)
-  
-    -- Check if status is not nil. If so, we have a valid point.
-    if _status then
-    
-      ----------------------------------------------
-      -- Still in the air. Remember this position --
-      ----------------------------------------------
-      
-      -- Missile position.
-      _lastBombPos = {x=_bombPos.x, y=_bombPos.y, z=_bombPos.z}
-      
-      -- Missile coordinate.
-      missileCoord=COORDINATE:NewFromVec3(_lastBombPos)
-      
-      -- Missile velocity in m/s.
-      local missileVelocity=UTILS.VecNorm(_ordnance:getVelocity())
-      
-      -- Update missile target if necessary.
-      self:GetMissileTarget(missile)
-      
-      if missile.targetUnit then
-      
-        -----------------------------------
-        -- Missile has a specific target --
-        -----------------------------------
-      
-        if missile.targetPlayer then
-          -- Target is a player.
-          if missile.targetPlayer.destroy==true then
-            target=missile.targetUnit
-          end
-        else
-          -- Check if unit is protected.
-          if self:_IsProtected(missile.targetUnit) then
-            target=missile.targetUnit
-          end
-        end
-        
-      else
-      
-        ------------------------------------
-        -- Missile has NO specific target --
-        ------------------------------------   
-        
-        -- TODO: This might cause a problem with wingman. Even if the shooter itself is excluded from the check, it's wingmen are not.
-        --       That would trigger the distance check right after missile launch if things to wrong.
-        --
-        --       Possible solutions:
-        --       * Time check: enable this check after X seconds after missile was fired. What is X?
-        --       * Coalition check. But would not work in training situations where blue on blue is valid!
-        --       * At least enable it for surface-to-air missiles.
-        
-        local function _GetTarget(_unit)
-          local unit=_unit --Wrapper.Unit#UNIT
-
-          -- Player position.
-          local playerCoord=unit:GetCoordinate()
-            
-          -- Distance.            
-          local dist=missileCoord:Get3DDistance(playerCoord)
-                        
-          -- Update mindist if necessary. Only include players in range of missile + 50% safety margin.
-          if dist<=self.explosiondist then
-            return unit
-          end          
-        end
-        
-        -- Distance to closest player.
-        local mindist=nil
-        
-        -- Loop over players.
-        for _,_player in pairs(self.players) do
-          local player=_player  --#FOX.PlayerData
-          
-          -- Check that player was not the one who launched the missile.
-          if player.unitname~=missile.shooterName then
-          
-            -- Player position.
-            local playerCoord=player.unit:GetCoordinate()
-            
-            -- Distance.            
-            local dist=missileCoord:Get3DDistance(playerCoord)
-            
-            -- Distance from shooter to player.
-            local Dshooter2player=playerCoord:Get3DDistance(missile.shotCoord)
-            
-            -- Update mindist if necessary. Only include players in range of missile + 50% safety margin.
-            if (mindist==nil or dist<mindist) and (Dshooter2player<=missile.missileRange*1.5 or dist<=self.explosiondist) then
-              mindist=dist
-              target=player.unit
-            end
-          end            
-        end
-        
-        if self.protectedset then
-        
-          -- Distance to closest protected unit.
-          mindist=nil
-        
-          for _,_group in pairs(self.protectedset:GetSet()) do
-            local group=_group --Wrapper.Group#GROUP
-            for _,_unit in pairs(group:GetUnits()) do
-              local unit=_unit --Wrapper.Unit#UNIT
-              
-              if unit and unit:IsAlive() then
-              
-                -- Check that player was not the one who launched the missile.
-                if unit:GetName()~=missile.shooterName then
-                
-                  -- Player position.
-                  local playerCoord=unit:GetCoordinate()
-                  
-                  -- Distance.            
-                  local dist=missileCoord:Get3DDistance(playerCoord)
-                  
-                  -- Distance from shooter to player.
-                  local Dshooter2player=playerCoord:Get3DDistance(missile.shotCoord)
-                  
-                  -- Update mindist if necessary. Only include players in range of missile + 50% safety margin.
-                  if (mindist==nil or dist<mindist) and (Dshooter2player<=missile.missileRange*1.5 or dist<=self.explosiondist) then
-                    mindist=dist
-                    target=unit
-                  end
-                end
-                                          
-              end              
-            end             
-          end
-        end
-        
-        if target then
-          self:T(self.lid..string.format("Missile %s with NO explicit target got closest unit to missile as target %s. Dist=%s m", missile.missileType, target:GetName(), tostring(mindist)))
-        end
-             
-      end
-  
-      -- Check if missile has a valid target.
-      if target then
-      
-        -- Target coordinate.
-        local targetCoord=target:GetCoordinate()
-      
-        -- Distance from missile to target.
-        local distance=missileCoord:Get3DDistance(targetCoord)
-        
-        -- Distance missile to shooter.
-        local distShooter=nil
-        if missile.shooterUnit and missile.shooterUnit:IsAlive() then
-          distShooter=missileCoord:Get3DDistance(missile.shooterUnit:GetCoordinate())
-        end
-        
-        
-        -- Debug output.
-        if self.Debug then
-          local bearing=targetCoord:HeadingTo(missileCoord)
-          local eta=distance/missileVelocity
-        
-          -- Debug distance check.
-          self:I(self.lid..string.format("Missile %s Target %s: Distance = %.1f m, v=%.1f m/s, bearing=%03d°, ETA=%.1f sec", missile.missileType, target:GetName(), distance, missileVelocity, bearing, eta))
-        end
-        
-        -- Distroy missile if it's getting too close.
-        local destroymissile=distance<=self.explosiondist
-        
-        -- Check BIG missiles.
-        if self.explosiondist2 and distance<=self.explosiondist2 and not destroymissile then
-           destroymissile=missile.explosive>=self.bigmissilemass
-        end
-      
-        -- If missile is 150 m from target ==> destroy missile if in safe zone.
-        if destroymissile and self:_CheckCoordSafe(targetCoord) then
-        
-          -- Destroy missile.
-          self:I(self.lid..string.format("Destroying missile %s(%s) fired by %s aimed at %s [player=%s] at distance %.1f m", 
-          missile.missileType, missile.missileName, missile.shooterName, target:GetName(), tostring(missile.targetPlayer~=nil), distance))
-          _ordnance:destroy()
-          
-          -- Missile is not active any more.
-          missile.active=false
-          
-          -- Debug smoke.
-          if self.Debug then
-            missileCoord:SmokeRed()          
-            targetCoord:SmokeGreen()
-          end
-          
-          -- Create event.
-          self:MissileDestroyed(missile)
-          
-          -- Little explosion for the visual effect.
-          if self.explosionpower>0 and distance>50 and (distShooter==nil or (distShooter and distShooter>50)) then
-            missileCoord:Explosion(self.explosionpower)
-          end
-                    
-          -- Target was a player.
-          if missile.targetPlayer then
-          
-            -- Message to target.
-            local text=string.format("Destroying missile. %s", self:_DeadText())
-            MESSAGE:New(text, 10):ToGroup(target:GetGroup())
-                    
-            -- Increase dead counter.
-            missile.targetPlayer.dead=missile.targetPlayer.dead+1
-          end
-          
-          -- Terminate timer.
-          return nil
-          
-        else
-        
-          -- Time step.
-          local dt=1.0          
-          if distance>50000 then
-            -- > 50 km
-            dt=self.dt50 --=5.0
-          elseif distance>10000 then
-            -- 10-50 km
-            dt=self.dt10 --=1.0
-          elseif distance>5000 then
-            -- 5-10 km
-            dt=self.dt05 --0.5
-          elseif distance>1000 then
-            -- 1-5 km
-            dt=self.dt01 --0.1
-          else
-            -- < 1 km
-            dt=self.dt00 --0.01
-          end
-        
-          -- Check again in dt seconds.
-          return timer.getTime()+dt
-        end
-        
-      else
-      
-        -- Destroy missile.
-        self:T(self.lid..string.format("Missile %s(%s) fired by %s has no current target. Checking back in 0.1 sec.",  missile.missileType, missile.missileName, missile.shooterName))
-        return timer.getTime()+0.1
-      
-        -- No target ==> terminate timer.
-        --return nil
-      end
-      
-    else
-    
-      -------------------------------------
-      -- Missile does not exist any more --
-      -------------------------------------
-            
-      if target then  
-      
-        -- Get human player.
-        local player=self:_GetPlayerFromUnit(target)
-        
-        -- Check for player and distance < 10 km.
-        if player and player.unit:IsAlive() then -- and missileCoord and player.unit:GetCoordinate():Get3DDistance(missileCoord)<10*1000 then
-          local text=string.format("Missile defeated. Well done, %s!", player.name)
-          MESSAGE:New(text, 10):ToClient(player.client)
-          
-          -- Increase defeated counter.
-          player.defeated=player.defeated+1
-        end
-        
-      end
-      
-      -- Missile is not active any more.
-      missile.active=false   
-              
-      --Terminate the timer.
-      self:T(FOX.lid..string.format("Terminating missile track timer."))
-      return nil
-  
-    end -- _status check
-    
-  end -- end function trackBomb
   
   -- Weapon is not yet "alife" just yet. Start timer with a little delay.
   self:T(FOX.lid..string.format("Tracking of missile starts in 0.0001 seconds."))
-  timer.scheduleFunction(trackMissile, missile.weapon, timer.getTime()+0.0001)
+  --timer.scheduleFunction(trackMissile, missile.weapon, timer.getTime()+0.0001)
+  missile.Weapon:StartTrack(0.0001)
 
 end
 
@@ -1114,6 +1122,13 @@ end
 -- Event Functions
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
+--- FOX event handler for event birth.
+-- @param #FOX self
+-- @param Core.Event#EVENTDATA EventData
+function FOX:OnEventPlayerEnterAircraft(EventData)
+
+end
+
 --- FOX event handler for event birth.
 -- @param #FOX self
 -- @param Core.Event#EVENTDATA EventData
@@ -1155,7 +1170,7 @@ function FOX:OnEventBirth(EventData)
             
     -- Add F10 radio menu for player.
     if not self.menudisabled then
-      SCHEDULER:New(nil, self._AddF10Commands, {self,_unitName}, 0.1)
+      self:ScheduleOnce(0.1, self._AddF10Commands, self, _unitName)
     end
     
     -- Player data.
@@ -1230,30 +1245,29 @@ end
 -- @param Core.Event#EVENTDATA EventData
 function FOX:OnEventShot(EventData)
   self:T2({eventshot=EventData})
+
+  -- Nil checks.  
+  if EventData.Weapon==nil or EventData.IniDCSUnit==nil or EventData.weapon==nil then
+    return
+  end
   
-  if EventData.Weapon==nil then
-    return
-  end
-  if EventData.IniDCSUnit==nil then
-    return
-  end
+  -- Create a weapon object.
+  local weapon=WEAPON:New(EventData.weapon)
   
   -- Weapon data.
-  local _weapon     = EventData.WeaponName
+  local _weapon     = weapon:GetTypeName()
   local _target     = EventData.Weapon:getTarget()
   local _targetName = "unknown"
   local _targetUnit = nil --Wrapper.Unit#UNIT
   
   -- Weapon descriptor.
-  local desc=EventData.Weapon:getDesc()
+  local desc=weapon.desc
   self:T2({desc=desc})
   
-  -- Weapon category: 0=Shell, 1=Missile, 2=Rocket, 3=BOMB
-  local weaponcategory=desc.category
-  
   -- Missile category: 1=AAM, 2=SAM, 6=OTHER
   local missilecategory=desc.missileCategory
   
+  -- Missile range.
   local missilerange=nil
   if missilecategory then
     missilerange=desc.rangeMaxAltMax
@@ -1263,8 +1277,8 @@ function FOX:OnEventShot(EventData)
   self:T2(FOX.lid.."EVENT SHOT: FOX")
   self:T2(FOX.lid..string.format("EVENT SHOT: Ini unit     = %s", tostring(EventData.IniUnitName)))
   self:T2(FOX.lid..string.format("EVENT SHOT: Ini group    = %s", tostring(EventData.IniGroupName)))
-  self:T2(FOX.lid..string.format("EVENT SHOT: Weapon type  = %s", tostring(_weapon)))
-  self:T2(FOX.lid..string.format("EVENT SHOT: Weapon categ = %s", tostring(weaponcategory)))
+  self:T2(FOX.lid..string.format("EVENT SHOT: Weapon type  = %s", tostring(weapon:GetTypeName())))
+  self:T2(FOX.lid..string.format("EVENT SHOT: Weapon categ = %s", tostring(weapon:GetCategory())))
   self:T2(FOX.lid..string.format("EVENT SHOT: Missil categ = %s", tostring(missilecategory)))
   self:T2(FOX.lid..string.format("EVENT SHOT: Missil range = %s", tostring(missilerange)))
   
@@ -1276,7 +1290,7 @@ function FOX:OnEventShot(EventData)
   end
   
   -- Track missiles of type AAM=1, SAM=2 or OTHER=6
-  local _track = weaponcategory==1 and missilecategory and (missilecategory==1 or missilecategory==2 or missilecategory==6)
+  local _track = weapon:IsMissile() and missilecategory and (missilecategory==1 or missilecategory==2 or missilecategory==6)
   
   -- Only track missiles
   if _track then
@@ -1285,6 +1299,7 @@ function FOX:OnEventShot(EventData)
     
     missile.active=true
     missile.weapon=EventData.weapon
+    missile.Weapon=weapon
     missile.missileType=_weapon
     missile.missileRange=missilerange
     missile.missileName=EventData.weapon:getName()
@@ -1297,6 +1312,7 @@ function FOX:OnEventShot(EventData)
     missile.fuseDist=desc.fuseDist
     missile.explosive=desc.warhead.explosiveMass or desc.warhead.shapedExplosiveMass
     missile.targetOrig=missile.targetName
+    missile.missileCoord=COORDINATE:New(0,0,0)
     
     -- Set missile target name, unit and player.
     self:GetMissileTarget(missile)
@@ -1422,10 +1438,10 @@ function FOX:_AddF10Commands(_unitName)
         
       end
     else
-      self:E(self.lid..string.format("ERROR: Could not find group or group ID in AddF10Menu() function. Unit name: %s.", _unitName))
+      self:E(self.lid..string.format("ERROR: Could not find group or group ID in AddF10Menu() function. Unit name: %s.", _unitName or "unknown"))
     end
   else
-    self:E(self.lid..string.format("ERROR: Player unit does not exist in AddF10Menu() function. Unit name: %s.", _unitName))
+    self:E(self.lid..string.format("ERROR: Player unit does not exist in AddF10Menu() function. Unit name: %s.", _unitName or "unknown"))
   end
 
 end
@@ -1615,7 +1631,7 @@ end
 
 --- Check if a coordinate lies within a safe training zone.
 -- @param #FOX self
--- @param Core.Point#COORDINATE coord Coordinate to check.
+-- @param Core.Point#COORDINATE coord Coordinate to check. Can also be a DCS#Vec3.
 -- @return #boolean True if safe.
 function FOX:_CheckCoordSafe(coord)
 
@@ -1627,7 +1643,9 @@ function FOX:_CheckCoordSafe(coord)
   -- Loop over all zones.
   for _,_zone in pairs(self.safezones) do
     local zone=_zone --Core.Zone#ZONE
-    local inzone=zone:IsCoordinateInZone(coord)
+    local Vec2={x=coord.x, y=coord.z}
+    local inzone=zone:IsVec2InZone(Vec2)
+    --local inzone=zone:IsCoordinateInZone(coord)
     if inzone then
       return true
     end
@@ -1638,7 +1656,7 @@ end
 
 --- Check if a coordinate lies within a launch zone.
 -- @param #FOX self
--- @param Core.Point#COORDINATE coord Coordinate to check.
+-- @param Core.Point#COORDINATE coord Coordinate to check. Can also be a DCS#Vec2.
 -- @return #boolean True if in launch zone.
 function FOX:_CheckCoordLaunch(coord)
 
@@ -1650,7 +1668,9 @@ function FOX:_CheckCoordLaunch(coord)
   -- Loop over all zones.
   for _,_zone in pairs(self.launchzones) do
     local zone=_zone --Core.Zone#ZONE
-    local inzone=zone:IsCoordinateInZone(coord)
+    local Vec2={x=coord.x, y=coord.z}
+    local inzone=zone:IsVec2InZone(Vec2)
+    --local inzone=zone:IsCoordinateInZone(coord)
     if inzone then
       return true
     end

Moose Development/Moose/Functional/Mantis.lua

@@ -1,11 +1,13 @@
---- **Functional** -- Modular, Automatic and Network capable Targeting and Interception System for Air Defenses
+--- **Functional** - Modular, Automatic and Network capable Targeting and Interception System for Air Defenses.
 --
 -- ===
 --
--- **MANTIS** - Moose derived  Modular, Automatic and Network capable Targeting and Interception System
--- Controls a network of SAM sites. Uses detection to switch on the AA site closest to the enemy.   
--- Automatic mode (default since 0.8) can set-up your SAM site network automatically for you.   
--- Leverage evasiveness from SEAD, leverage attack range setting.   
+-- ## Features:
+--
+--  * Moose derived  Modular, Automatic and Network capable Targeting and Interception System.
+--  * Controls a network of SAM sites. Uses detection to switch on the AA site closest to the enemy.   
+--  * Automatic mode (default since 0.8) can set-up your SAM site network automatically for you.   
+--  * Leverage evasiveness from SEAD, leverage attack range setting.   
 --
 -- ===
 --
@@ -20,7 +22,7 @@
 -- @module Functional.Mantis
 -- @image Functional.Mantis.jpg
 --
--- Date: Dec 2021
+-- Last Update: Nov 2023
 
 -------------------------------------------------------------------------
 --- **MANTIS** class, extends Core.Base#BASE
@@ -61,10 +63,11 @@
 
 --- *The worst thing that can happen to a good cause is, not to be skillfully attacked, but to be ineptly defended.* - Frédéric Bastiat
 --
--- Simple Class for a more intelligent Air Defense System
+-- Moose class for a more intelligent Air Defense System
 --
--- #MANTIS
--- Moose derived  Modular, Automatic and Network capable Targeting and Interception System.
+-- # MANTIS
+-- 
+-- * Moose derived  Modular, Automatic and Network capable Targeting and Interception System.
 -- * Controls a network of SAM sites. Uses detection to switch on the SAM site closest to the enemy.
 -- * **Automatic mode** (default since 0.8) can set-up your SAM site network automatically for you
 -- * **Classic mode** behaves like before
@@ -100,9 +103,16 @@
 -- * 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
--- * and from HDS (see note below): SA-2, SA-3, SA-10B, SA-10C, SA-12, SA-17, SA-20A, SA-20B, SA-23, HQ-2
+-- * 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
 -- 
--- Following the example started above, an SA-6 site group name should start with "Red SAM SA-6" then, or a blue Patriot installation with e.g. "Blue SAM Patriot".   
+-- * From SMA: RBS98M, RBS70, RBS90, RBS90M, RBS103A, RBS103B, RBS103AM, RBS103BM, Lvkv9040M 
+-- **NOTE** If you are using the Swedish Military Assets (SMA), please note that the **group name** for RBS-SAM types also needs to contain the keyword "SMA"
+-- 
+-- * From CH: 2S38, PantsirS1, PantsirS2, PGL-625, HQ-17A, M903PAC2, M903PAC3, TorM2, TorM2K, TorM2M, NASAMS3-AMRAAMER, NASAMS3-AIM9X2, C-RAM, PGZ-09, S350-9M100, S350-9M96D
+-- **NOTE** If you are using the Military Assets by Currenthill (CH), please note that the **group name** for CH-SAM types also needs to contain the keyword "CHM"
+-- 
+-- Following the example started above, an SA-6 site group name should start with "Red SAM SA-6" then, or a blue Patriot installation with e.g. "Blue SAM Patriot". 
 -- **NOTE** If you are using the High-Digit-Sam Mod, please note that the **group name** for the following SAM types also needs to contain the keyword "HDS":
 -- 
 -- * SA-2 (with V759 missile, e.g. "Red SAM SA-2 HDS")
@@ -123,7 +133,7 @@
 -- Set up your SHORAD systems. They need to be **close** to (i.e. around) the SAM sites to be effective. Use **one** group per SAM location. SA-15 TOR systems offer a good missile defense.
 -- 
 -- [optional] Set up your HQ. Can be any group, e.g. a command vehicle.
--- 
+--
 -- # 1. Basic tactical considerations when setting up your SAM sites
 --
 -- ## 1.1 Radar systems and AWACS
@@ -147,7 +157,7 @@
 --   * overestimation how far units can "see" and
 --   * not taking into account that a SAM site will take (e.g for a SA-6) 30-40 seconds between switching on, acquiring the target and firing.
 --
--- An attacker doing 350knots will cover ca 180meters/second or thus more than 6km until the SA-6 fires. Use triggers zones and the ruler in the missione editor to understand distances and zones. Take into account that the ranges given by the circles
+-- An attacker doing 350knots will cover ca 180meters/second or thus more than 6km until the SA-6 fires. Use triggers zones and the ruler in the mission editor to understand distances and zones. Take into account that the ranges given by the circles
 -- in the mission editor are absolute maximum ranges; in-game this is rather 50-75% of that depending on the system. Fiddle with placement and options to see what works best for your scenario, and remember **everything in here is in meters**.
 --
 -- # 2. Start up your MANTIS with a basic setting
@@ -211,7 +221,7 @@
 --  * grouping = 5000 (meters) - Detection (EWR) will group enemy flights to areas of 5km for tracking - `MANTIS:SetEWRGrouping(radius)`
 --  * detectinterval = 30 (seconds) - MANTIS will decide every 30 seconds which SAM to activate - `MANTIS:SetDetectInterval(interval)`
 --  * engagerange = 95 (percent) - SAMs will only fire if flights are inside of a 95% radius of their max firerange - `MANTIS:SetSAMRange(range)`
---  * dynamic = false - Group filtering is set to once, i.e. newly added groups will not be part of the setup by default - `MANTIS:New(name,samprefix,ewrprefix,hq,coaltion,dynamic)`
+--  * dynamic = false - Group filtering is set to once, i.e. newly added groups will not be part of the setup by default - `MANTIS:New(name,samprefix,ewrprefix,hq,coalition,dynamic)`
 --  * autorelocate = false - HQ and (mobile) EWR system will not relocate in random intervals between 30mins and 1 hour - `MANTIS:SetAutoRelocate(hq, ewr)`
 --  * debug = false - Debugging reports on screen are set to off - `MANTIS:Debug(onoff)`
 --
@@ -364,6 +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" },
+  ["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
@@ -387,6 +400,60 @@ MANTIS.SamDataHDS = {
   ["HQ-2 HDS"] = { Range=50, Blindspot=6, Height=35, Type="Medium", Radar="HQ_2_Guideline_LN" },
 }
 
+--- SAM data SMA
+-- @type MANTIS.SamDataSMA
+-- @field #number Range Max firing range in km
+-- @field #number Blindspot no-firing range (green circle)
+-- @field #number Height Max firing height in km
+-- @field #string Type #MANTIS.SamType of SAM, i.e. SHORT, MEDIUM or LONG (range)
+-- @field #string Radar Radar typename on unit level (used as key)
+MANTIS.SamDataSMA = {
+  -- units from SMA Mod (Sweedish Military Assets)
+  -- https://forum.dcs.world/topic/295202-swedish-military-assets-for-dcs-by-currenthill/
+  -- group name MUST contain SMA to ID launcher type correctly!
+  ["RBS98M SMA"] = { Range=20, Blindspot=0, Height=8, Type="Short", Radar="RBS-98" },
+  ["RBS70 SMA"] = { Range=8, Blindspot=0, Height=5.5, Type="Short", Radar="RBS-70" },  
+  ["RBS70M SMA"] = { Range=8, Blindspot=0, Height=5.5, Type="Short", Radar="BV410_RBS70" }, 
+  ["RBS90 SMA"] = { Range=8, Blindspot=0, Height=5.5, Type="Short", Radar="RBS-90" }, 
+  ["RBS90M SMA"] = { Range=8, Blindspot=0, Height=5.5, Type="Short", Radar="BV410_RBS90" },  
+  ["RBS103A SMA"] = { Range=150, Blindspot=3, Height=24.5, Type="Long", Radar="LvS-103_Lavett103_Rb103A" },
+  ["RBS103B SMA"] = { Range=35, Blindspot=0, Height=36, Type="Medium", Radar="LvS-103_Lavett103_Rb103B" }, 
+  ["RBS103AM SMA"] = { Range=150, Blindspot=3, Height=24.5, Type="Long", Radar="LvS-103_Lavett103_HX_Rb103A" },
+  ["RBS103BM SMA"] = { Range=35, Blindspot=0, Height=36, Type="Medium", Radar="LvS-103_Lavett103_HX_Rb103B" },
+  ["Lvkv9040M SMA"] = { Range=4, Blindspot=0, Height=2.5, Type="Short", Radar="LvKv9040" },      
+}
+
+--- SAM data CH
+-- @type MANTIS.SamDataCH
+-- @field #number Range Max firing range in km
+-- @field #number Blindspot no-firing range (green circle)
+-- @field #number Height Max firing height in km
+-- @field #string Type #MANTIS.SamType of SAM, i.e. SHORT, MEDIUM or LONG (range)
+-- @field #string Radar Radar typename on unit level (used as key)
+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" },
+ ["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" }, 
+}
+
 -----------------------------------------------------------------------
 -- MANTIS System
 -----------------------------------------------------------------------
@@ -398,11 +465,12 @@ do
   --@param #string samprefix Prefixes for the SAM groups from the ME, e.g. all groups starting with "Red Sam..."
   --@param #string ewrprefix Prefixes for the EWR groups from the ME, e.g. all groups starting with "Red EWR..."
   --@param #string hq Group name of your HQ (optional)
-  --@param #string coaltion Coalition side of your setup, e.g. "blue", "red" or "neutral"
+  --@param #string coalition Coalition side of your setup, e.g. "blue", "red" or "neutral"
   --@param #boolean dynamic Use constant (true) filtering or just filter once (false, default) (optional)
   --@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
   --
@@ -421,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,coaltion,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
@@ -434,7 +506,7 @@ do
     self.SAM_Templates_Prefix = samprefix or "Red SAM"
     self.EWR_Templates_Prefix = ewrprefix or "Red EWR"
     self.HQ_Template_CC = hq or nil
-    self.Coalition = coaltion or "red"
+    self.Coalition = coalition or "red"
     self.SAM_Table = {}
     self.SAM_Table_Long = {}
     self.SAM_Table_Medium = {}
@@ -482,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
@@ -494,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)
 
@@ -531,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
@@ -550,7 +631,7 @@ do
     
     -- TODO Version
     -- @field #string version
-    self.version="0.8.8"
+    self.version="0.8.15"
     self:I(string.format("***** Starting MANTIS Version %s *****", self.version))
 
     --- FSM Functions ---
@@ -714,6 +795,23 @@ 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.
+  -- @param #boolean Random If true, use a random coordinate inside the next zone to scoot to.
+  -- @param #string Formation Formation to use, defaults to "Cone". See mission editor dropdown for options.
+  -- @return #MANTIS self
+  function MANTIS:AddScootZones(ZoneSet, Number, Random, Formation)
+    self:T(self.lid .. " AddScootZones")
+    self.SkateZones = ZoneSet
+    self.SkateNumber = Number or 3
+    self.shootandscoot = true
+    self.ScootRandom = Random
+    self.ScootFormation = Formation or "Cone"    
+    return self
+  end
+  
   --- Function to set accept and reject zones.
   -- @param #MANTIS self
   -- @param #table AcceptZones Table of @{Core.Zone#ZONE} objects
@@ -820,7 +918,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
@@ -856,7 +954,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
@@ -918,7 +1016,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
@@ -1270,11 +1368,13 @@ do
   -- @param #MANTIS self
   -- @param #string grpname Name of the group
   -- @param #boolean mod HDS mod flag
+  -- @param #boolean sma SMA mod flag
+  -- @param #boolean chm CH mod flag
   -- @return #number range Max firing range
   -- @return #number height Max firing height
   -- @return #string type Long, medium or short range
   -- @return #number blind "blind" spot
-  function MANTIS:_GetSAMDataFromUnits(grpname,mod)
+  function MANTIS:_GetSAMDataFromUnits(grpname,mod,sma,chm)
     self:T(self.lid.."_GetSAMRangeFromUnits")
     local found = false
     local range = self.checkradius
@@ -1287,8 +1387,12 @@ do
     local SAMData = self.SamData
     if mod then
       SAMData = self.SamDataHDS
+    elseif sma then
+      SAMData = self.SamDataSMA
+    elseif chm then
+      SAMData = self.SamDataCH
     end
-    --self:I("Looking to auto-match for "..grpname)
+    --self:T("Looking to auto-match for "..grpname)
     for _,_unit in pairs(units) do
       local unit = _unit -- Wrapper.Unit#UNIT
       local type = string.lower(unit:GetTypeName())
@@ -1332,8 +1436,14 @@ do
     local blind = 0
     local found = false
     local HDSmod = false
+    local SMAMod = false
+    local CHMod = false
     if string.find(grpname,"HDS",1,true) then
       HDSmod = true
+    elseif string.find(grpname,"SMA",1,true) then
+      SMAMod = true
+    elseif string.find(grpname,"CHM",1,true) then
+      CHMod = true
     end
     if self.automode then
       for idx,entry in pairs(self.SamData) do
@@ -1352,8 +1462,8 @@ do
       end
     end
     -- secondary filter if not found
-    if (not found and self.automode) or HDSmod then
-      range, height, type = self:_GetSAMDataFromUnits(grpname,HDSmod)
+    if (not found and self.automode) or HDSmod or SMAMod or CHMod then
+      range, height, type = self:_GetSAMDataFromUnits(grpname,HDSmod,SMAMod,CHMod)
     elseif not found then
       self:E(self.lid .. string.format("*****Could not match radar data for %s! Will default to midrange values!",grpname))
     end
@@ -1515,7 +1625,7 @@ do
   -- @param #table samset Table of SAM data
   -- @param #table detset Table of COORDINATES
   -- @param #boolean dlink Using DLINK
-  -- @param #limit limit of SAM sites to go active on a contact
+  -- @param #number limit of SAM sites to go active on a contact
   -- @return #MANTIS self
   function MANTIS:_CheckLoop(samset,detset,dlink,limit)
     self:T(self.lid .. "CheckLoop " .. #detset .. " Coordinates")
@@ -1701,6 +1811,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 and self.Shorad then
+      self.Shorad:AddScootZones(self.SkateZones,self.SkateNumber or 3,self.ScootRandom,self.ScootFormation)
     end
     self:__Status(-math.random(1,10))
     return self

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -1,4 +1,4 @@
---- **Functional** -- Train missile defence and deflection.
+--- **Functional** - Train missile defence and deflection.
 --
 -- ===
 --
@@ -28,14 +28,14 @@
 --     * **Messages Off**: Disable all messages.
 --  * **Tracking**: Menu to configure missile tracking messages.
 --     * **To All**: Shows missile tracking messages to all players.
---     * **To Target**: Shows missile tracking messages only to the player where the missile is targetted at.
+--     * **To Target**: Shows missile tracking messages only to the player where the missile is targeted at.
 --     * **Tracking On**: Show missile tracking messages.
 --     * **Tracking Off**: Disable missile tracking messages.
 --     * **Frequency Increase**: Increases the missile tracking message frequency with one second.
 --     * **Frequency Decrease**: Decreases the missile tracking message frequency with one second.
 --  * **Alerts**: Menu to configure alert messages.
 --     * **To All**: Shows alert messages to all players.
---     * **To Target**: Shows alert messages only to the player where the missile is (was) targetted at.
+--     * **To Target**: Shows alert messages only to the player where the missile is (was) targeted at.
 --     * **Hits On**: Show missile hit alert messages.
 --     * **Hits Off**: Disable missile hit alert messages.
 --     * **Launches On**: Show missile launch messages.
@@ -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.
 --
 -- ===
 --
@@ -68,7 +73,8 @@
 -- @image Missile_Trainer.JPG
 
 
---- @type MISSILETRAINER
+---
+-- @type MISSILETRAINER
 -- @field Core.Set#SET_CLIENT DBClients
 -- @extends Core.Base#BASE
 
@@ -88,7 +94,7 @@
 -- A MISSILETRAINER object will behave differently based on the usage of initialization methods:
 --
 --  * @{#MISSILETRAINER.InitMessagesOnOff}: Sets by default the display of any message to be ON or OFF.
---  * @{#MISSILETRAINER.InitTrackingToAll}: Sets by default the missile tracking report for all players or only for those missiles targetted to you.
+--  * @{#MISSILETRAINER.InitTrackingToAll}: Sets by default the missile tracking report for all players or only for those missiles targeted to you.
 --  * @{#MISSILETRAINER.InitTrackingOnOff}: Sets by default the display of missile tracking report to be ON or OFF.
 --  * @{#MISSILETRAINER.InitTrackingFrequency}: Increases, decreases the missile tracking message display frequency with the provided time interval in seconds.
 --  * @{#MISSILETRAINER.InitAlertsToAll}: Sets by default the display of alerts to be shown to all players or only to you.
@@ -97,6 +103,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 +216,7 @@ function MISSILETRAINER:New( Distance, Briefing )
 
 
 --  	self.DB:ForEachClient(
---  	 --- @param Wrapper.Client#CLIENT Client
+--  	 -- @param Wrapper.Client#CLIENT Client
 --  	 function( Client )
 --
 --        ... actions ...
@@ -256,7 +267,7 @@ function MISSILETRAINER:InitMessagesOnOff( MessagesOnOff )
   return self
 end
 
---- Sets by default the missile tracking report for all players or only for those missiles targetted to you.
+--- Sets by default the missile tracking report for all players or only for those missiles targeted to you.
 -- @param #MISSILETRAINER self
 -- @param #boolean TrackingToAll true or false
 -- @return #MISSILETRAINER self
@@ -555,7 +566,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

@@ -1,4 +1,4 @@
---- **Functional** -- Limit the movement of simulaneous moving ground vehicles.
+--- **Functional** - Limit the movement of simulaneous moving ground vehicles.
 -- 
 -- ===
 --  
@@ -10,7 +10,8 @@
 -- @module Functional.Movement
 -- @image MOOSE.JPG
 
---- @type MOVEMENT
+---
+-- @type MOVEMENT
 -- @extends Core.Base#BASE
 
 ---
@@ -30,23 +31,23 @@ MOVEMENT = {
 function MOVEMENT:New( MovePrefixes, MoveMaximum )
 	local self = BASE:Inherit( self, BASE:New() ) -- #MOVEMENT
 	self:F( { MovePrefixes, MoveMaximum } )
-  
+
 	if type( MovePrefixes ) == 'table' then
 		self.MovePrefixes = MovePrefixes
 	else
 		self.MovePrefixes = { MovePrefixes }
 	end
-	self.MoveCount = 0															-- The internal counter of the amount of Moveing the has happened since MoveStart.
-	self.MoveMaximum = MoveMaximum												-- Contains the Maximum amount of units that are allowed to move...
-	self.AliveUnits = 0														-- Contains the counter how many units are currently alive
-	self.MoveUnits = {}														-- Reflects if the Moving for this MovePrefixes is going to be scheduled or not.
-	
+	self.MoveCount = 0              -- The internal counter of the amount of Moving the has happened since MoveStart.
+	self.MoveMaximum = MoveMaximum  -- Contains the Maximum amount of units that are allowed to move.
+	self.AliveUnits = 0             -- Contains the counter how many units are currently alive.
+	self.MoveUnits = {}             -- Reflects if the Moving for this MovePrefixes is going to be scheduled or not.
+
 	self:HandleEvent( EVENTS.Birth )
-	
+
 --	self:AddEvent( world.event.S_EVENT_BIRTH, self.OnBirth )
 --	
 --	self:EnableEvents()
-	
+
 	self:ScheduleStart()
 
 	return self
@@ -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
 
@@ -67,7 +67,7 @@ function MOVEMENT:ScheduleStop()
 end
 
 --- Captures the birth events when new Units were spawned.
--- @todo This method should become obsolete. The new @{DATABASE} class will handle the collection administration.
+-- @todo This method should become obsolete. The global _DATABASE object (an instance of @{Core.Database#DATABASE}) will handle the collection administration.
 -- @param #MOVEMENT self
 -- @param Core.Event#EVENTDATA self
 function MOVEMENT:OnEventBirth( EventData )
@@ -86,14 +86,14 @@ function MOVEMENT:OnEventBirth( EventData )
 				end
 			end
 		end
-		
+	
 		EventData.IniUnit:HandleEvent( EVENTS.DEAD, self.OnDeadOrCrash )
 	end
 
 end
 
 --- Captures the Dead or Crash events when Units crash or are destroyed.
--- @todo This method should become obsolete. The new @{DATABASE} class will handle the collection administration.
+-- @todo This method should become obsolete. The global _DATABASE object (an instance of @{Core.Database#DATABASE}) will handle the collection administration.
 function MOVEMENT:OnDeadOrCrash( Event )
 	self:F( { Event } )
 

Moose Development/Moose/Functional/PseudoATC.lua

@@ -1,4 +1,4 @@
---- **Functional** - Rudimentary ATC.
+--- **Functional** - Basic ATC.
 --  
 -- ![Banner Image](..\Presentations\PSEUDOATC\PSEUDOATC_Main.jpg)
 -- 
@@ -26,9 +26,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, Applevangelist
 -- 
 -- ====
 -- @module Functional.PseudoATC
@@ -44,7 +44,8 @@
 -- @field #number mrefresh Interval in seconds after which the F10 menu is refreshed. E.g. by the closest airports. Default is 120 sec.
 -- @field #number talt Interval in seconds between reporting altitude until touchdown. Default 3 sec.
 -- @field #boolean chatty Display some messages on events like take-off and touchdown.
--- @field #boolean eventsmoose If true, events are handled by MOOSE. If false, events are handled directly by DCS eventhandler.
+-- @field #boolean eventsmoose [Deprecated] If true, events are handled by MOOSE. If false, events are handled directly by DCS eventhandler.
+-- @field #boolean reportplayername If true, use playername not callsign on callouts
 -- @extends Core.Base#BASE
 
 --- Adds some rudimentary ATC functionality via the radio menu.
@@ -88,6 +89,7 @@ PSEUDOATC={
   talt=3,
   chatty=true,
   eventsmoose=true,
+  reportplayername = false,
 }
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -98,13 +100,14 @@ PSEUDOATC.id="PseudoATC | "
 
 --- PSEUDOATC version.
 -- @field #number version
-PSEUDOATC.version="0.9.2"
+PSEUDOATC.version="0.10.5"
 
 -----------------------------------------------------------------------------------------------------------------------------------------
 
 -- TODO list
 -- DONE: Add takeoff event.
 -- DONE: Add user functions.
+-- DONE: Refactor to use Moose event handling only
 
 -----------------------------------------------------------------------------------------------------------------------------------------
 
@@ -129,23 +132,14 @@ function PSEUDOATC:Start()
   self:F()
   
   -- Debug info
-  self:E(PSEUDOATC.id.."Starting PseudoATC")
+  self:I(PSEUDOATC.id.."Starting PseudoATC")
   
   -- Handle events.
-  if self.eventsmoose then
-    self:T(PSEUDOATC.id.."Events are handled by MOOSE.")
-    self:HandleEvent(EVENTS.Birth,           self._OnBirth)
-    self:HandleEvent(EVENTS.Land,            self._PlayerLanded)
-    self:HandleEvent(EVENTS.Takeoff,         self._PlayerTakeOff)
-    self:HandleEvent(EVENTS.PlayerLeaveUnit, self._PlayerLeft)
-    self:HandleEvent(EVENTS.Crash,           self._PlayerLeft)
-    --self:HandleEvent(EVENTS.Ejection,        self._PlayerLeft)
-    --self:HandleEvent(EVENTS.PilotDead,       self._PlayerLeft)
-  else
-    self:T(PSEUDOATC.id.."Events are handled by DCS.")
-    -- Events are handled directly by DCS.
-    world.addEventHandler(self)
-  end
+  self:HandleEvent(EVENTS.Birth,           self._OnBirth)
+  self:HandleEvent(EVENTS.Land,            self._PlayerLanded)
+  self:HandleEvent(EVENTS.Takeoff,         self._PlayerTakeOff)
+  self:HandleEvent(EVENTS.PlayerLeaveUnit, self._PlayerLeft)
+  self:HandleEvent(EVENTS.Crash,           self._PlayerLeft)
   
 end
 
@@ -183,6 +177,13 @@ function PSEUDOATC:SetMessageDuration(duration)
   self.mdur=duration or 30
 end
 
+--- Use player name, not call sign, in callouts
+-- @param #PSEUDOATC self
+function PSEUDOATC:SetReportPlayername()
+  self.reportplayername = true
+  return self
+end
+
 --- Set time interval after which the F10 radio menu is refreshed.
 -- @param #PSEUDOATC self
 -- @param #number interval Interval in seconds. Default is every 120 sec.
@@ -190,7 +191,7 @@ function PSEUDOATC:SetMenuRefresh(interval)
   self.mrefresh=interval or 120
 end
 
---- Enable/disable event handling by MOOSE or DCS.
+--- [Deprecated] Enable/disable event handling by MOOSE or DCS.
 -- @param #PSEUDOATC self
 -- @param #boolean switch If true, events are handled by MOOSE (default). If false, events are handled directly by DCS.
 function PSEUDOATC:SetEventsMoose(switch)
@@ -207,84 +208,6 @@ end
 -----------------------------------------------------------------------------------------------------------------------------------------
 -- Event Handling
 
---- Event handler for suppressed groups.
---@param #PSEUDOATC self
---@param #table Event Event data table. Holds event.id, event.initiator and event.target etc.
-function PSEUDOATC:onEvent(Event)
-  if Event == nil or Event.initiator == nil or Unit.getByName(Event.initiator:getName()) == nil then
-    return true
-  end
-
-  local DCSiniunit  = Event.initiator
-  local DCSplace    = Event.place
-  local DCSsubplace = Event.subplace
-
-  local EventData={}
-  local _playerunit=nil
-  local _playername=nil
-  
-  if Event.initiator then
-    EventData.IniUnitName  = Event.initiator:getName()
-    EventData.IniDCSGroup  = Event.initiator:getGroup()
-    EventData.IniGroupName = Event.initiator:getGroup():getName()  
-    -- Get player unit and name. This returns nil,nil if the event was not fired by a player unit. And these are the only events we are interested in. 
-    _playerunit, _playername = self:_GetPlayerUnitAndName(EventData.IniUnitName)  
-  end
-
-  if Event.place then
-    EventData.Place=Event.place
-    EventData.PlaceName=Event.place:getName()
-  end
-  if Event.subplace then
-    EventData.SubPlace=Event.subplace
-    EventData.SubPlaceName=Event.subplace:getName()
-  end
-  
-  -- Event info.
-  self:T3(PSEUDOATC.id..string.format("EVENT: Event in onEvent with ID = %s", tostring(Event.id)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: Ini unit   = %s" , tostring(EventData.IniUnitName)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: Ini group  = %s" , tostring(EventData.IniGroupName)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: Ini player = %s" , tostring(_playername)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: Place      = %s" , tostring(EventData.PlaceName)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: SubPlace   = %s" , tostring(EventData.SubPlaceName)))
-  
-  -- Event birth.
-  if Event.id == world.event.S_EVENT_BIRTH and _playername then
-    self:_OnBirth(EventData)
-  end
-  
-  -- Event takeoff.
-  if Event.id == world.event.S_EVENT_TAKEOFF and _playername and EventData.Place then
-    self:_PlayerTakeOff(EventData)
-  end
-  
-  -- Event land.
-  if Event.id == world.event.S_EVENT_LAND and _playername and EventData.Place then
-    self:_PlayerLanded(EventData)
-  end
-  
-  -- Event player left unit
-  if Event.id == world.event.S_EVENT_PLAYER_LEAVE_UNIT and _playername then
-    self:_PlayerLeft(EventData)
-  end
-
-  -- Event crash ==> player left unit
-  if Event.id == world.event.S_EVENT_CRASH and _playername then
-    self:_PlayerLeft(EventData)
-  end
-
---[[
-  -- Event eject ==> player left unit
-  if Event.id == world.event.S_EVENT_EJECTION and _playername then
-    self:_PlayerLeft(EventData)
-  end
-
-  -- Event pilot dead ==> player left unit
-  if Event.id == world.event.S_EVENT_PILOT_DEAD and _playername then
-    self:_PlayerLeft(EventData)
-  end
-]]    
-end
 
 --- Function called my MOOSE event handler when a player enters a unit.
 -- @param #PSEUDOATC self
@@ -294,7 +217,9 @@ function PSEUDOATC:_OnBirth(EventData)
   
   -- Get unit and player.
   local _unitName=EventData.IniUnitName  
-  local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
+  --local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
+  local _unit = EventData.IniUnit
+  local _playername = EventData.IniPlayerName
   
   -- Check if a player entered.
   if _unit and _playername then
@@ -311,7 +236,10 @@ function PSEUDOATC:_PlayerLeft(EventData)
 
   -- Get unit and player.
   local _unitName=EventData.IniUnitName  
-  local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
+  --local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
+  
+  local _unit = EventData.IniUnit
+  local _playername = EventData.IniPlayerName
   
   -- Check if a player left.
   if _unit and _playername then
@@ -326,18 +254,16 @@ function PSEUDOATC:_PlayerLanded(EventData)
   self:F({EventData=EventData})
 
   -- Get unit, player and place.
-  local _unitName=EventData.IniUnitName  
-  local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
+  local _unitName=EventData.IniUnitName
+  local _unit = EventData.IniUnit
+  local _playername = EventData.IniPlayerName  
+  --local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
   local _base=nil
   local _baseName=nil
   if EventData.place then
     _base=EventData.place
     _baseName=EventData.place:getName()
   end
---  if EventData.subplace then
---    local _subPlace=EventData.subplace
---    local _subPlaceName=EventData.subplace:getName()
---  end
   
   -- Call landed function.
   if _unit and _playername and _base then
@@ -352,8 +278,10 @@ function PSEUDOATC:_PlayerTakeOff(EventData)
   self:F({EventData=EventData})
 
   -- Get unit, player and place.
-  local _unitName=EventData.IniUnitName  
-  local _unit,_playername=self:_GetPlayerUnitAndName(_unitName)
+  local _unitName=EventData.IniUnitName
+  local _unit = EventData.IniUnit
+  local _playername = EventData.IniPlayerName  
+  --local _unit,_playername=self:_GetPlayerUnitAndName(_unitName)
   local _base=nil
   local _baseName=nil
   if EventData.place then
@@ -441,14 +369,15 @@ function PSEUDOATC:PlayerLanded(unit, place)
   local group=unit:GetGroup()
   local GID=group:GetID()
   local UID=unit:GetDCSObject():getID()
-  local PlayerName=self.group[GID].player[UID].playername
-  local UnitName=self.group[GID].player[UID].unitname
-  local GroupName=self.group[GID].player[UID].groupname
-  
-  -- Debug message.
-  local text=string.format("Player %s in unit %s of group %s (id=%d) landed at %s.", PlayerName, UnitName, GroupName, GID, place)
-  self:T(PSEUDOATC.id..text)
-  MESSAGE:New(text, 30):ToAllIf(self.Debug)
+  local PlayerName = unit:GetPlayerName() or "Ghost"
+  local UnitName = unit:GetName() or "Ghostplane"
+  local GroupName = group:GetName() or "Ghostgroup"
+  if self.Debug then
+    -- Debug message.
+    local text=string.format("Player %s in unit %s of group %s landed at %s.", PlayerName, UnitName, GroupName, place)
+    self:T(PSEUDOATC.id..text)
+    MESSAGE:New(text, 30):ToAllIf(self.Debug)
+  end
   
   -- Stop altitude reporting timer if its activated.
   self:AltitudeTimerStop(GID,UID)
@@ -470,21 +399,22 @@ function PSEUDOATC:PlayerTakeOff(unit, place)
   
   -- Gather some information.
   local group=unit:GetGroup()
-  local GID=group:GetID()
-  local UID=unit:GetDCSObject():getID()
-  local PlayerName=self.group[GID].player[UID].playername
-  local CallSign=self.group[GID].player[UID].callsign
-  local UnitName=self.group[GID].player[UID].unitname
-  local GroupName=self.group[GID].player[UID].groupname
-  
-  -- Debug message.
-  local text=string.format("Player %s in unit %s of group %s (id=%d) took off at %s.", PlayerName, UnitName, GroupName, GID, place)
-  self:T(PSEUDOATC.id..text)
-  MESSAGE:New(text, 30):ToAllIf(self.Debug)
-    
+  local PlayerName = unit:GetPlayerName() or "Ghost"
+  local UnitName = unit:GetName() or "Ghostplane"
+  local GroupName = group:GetName() or "Ghostgroup"
+  local CallSign = unit:GetCallsign() or "Ghost11"
+  if self.Debug then
+    -- Debug message.
+    local text=string.format("Player %s in unit %s of group %s took off at %s.", PlayerName, UnitName, GroupName, place)
+    self:T(PSEUDOATC.id..text)
+    MESSAGE:New(text, 30):ToAllIf(self.Debug)
+  end
   -- Bye-Bye message.
   if place and self.chatty then
     local text=string.format("%s, %s, you are airborne. Have a safe trip!", place, CallSign)
+  if self.reportplayername then
+    text=string.format("%s, %s, you are airborne. Have a safe trip!", place, PlayerName)
+  end
     MESSAGE:New(text, self.mdur):ToGroup(group)
   end
 
@@ -501,7 +431,7 @@ function PSEUDOATC:PlayerLeft(unit)
   local GID=group:GetID()
   local UID=unit:GetDCSObject():getID()
   
-  if self.group[GID].player[UID] then
+  if self.group[GID] and self.group[GID].player and self.group[GID].player[UID] then
     local PlayerName=self.group[GID].player[UID].playername
     local CallSign=self.group[GID].player[UID].callsign
     local UnitName=self.group[GID].player[UID].unitname
@@ -687,7 +617,9 @@ function PSEUDOATC:MenuWaypoints(GID, UID)
       -- Position of Waypoint
       local pos=COORDINATE:New(wp.x, wp.alt, wp.y)
       local name=string.format("Waypoint %d", i-1)
-      
+      if wp.name and wp.name ~= "" then
+        name = string.format("Waypoint %s",wp.name)
+      end
       -- "F10/PseudoATC/Waypoints/Waypoint X"
       local submenu=missionCommands.addSubMenuForGroup(GID, name, self.group[GID].player[UID].menu_waypoints)
       
@@ -844,7 +776,8 @@ function PSEUDOATC:ReportHeight(GID, UID, dt, _clear)
     local position=unit:GetCoordinate()
     local height=get_AGL(position)
     local callsign=unit:GetCallsign()
-    
+    local PlayerName=self.group[GID].player[UID].playername
+  
     -- Settings.
     local settings=_DATABASE:GetPlayerSettings(self.group[GID].player[UID].playername) or _SETTINGS --Core.Settings#SETTINGS
     
@@ -856,7 +789,9 @@ function PSEUDOATC:ReportHeight(GID, UID, dt, _clear)
     
     -- Message text.
     local _text=string.format("%s, your altitude is %s AGL.", callsign, Hs)
-    
+    if self.reportplayername then
+    _text=string.format("%s, your altitude is %s AGL.", PlayerName, Hs)
+  end
     -- Append flight level.
     if _clear==false then
       _text=_text..string.format(" FL%03d.", position.y/30.48)
@@ -901,7 +836,7 @@ function PSEUDOATC:AltitudeTimeStart(GID, UID)
   self:T(PSEUDOATC.id..string.format("Starting altitude report timer for player ID %d.", UID))
   
   -- Start timer. Altitude is reported every ~3 seconds.
-  self.group[GID].player[UID].altimer, self.group[GID].player[UID].altimerid=SCHEDULER:New(nil, self.ReportHeight, {self, GID, UID, 0.1, true}, 1, 3)
+  self.group[GID].player[UID].altimer, self.group[GID].player[UID].altimerid=SCHEDULER:New(nil, self.ReportHeight, {self, GID, UID, 1, true}, 1, 3)
 end
 
 --- Stop/destroy DCS scheduler function for reporting altitude.
@@ -949,11 +884,14 @@ function PSEUDOATC:LocalAirports(GID, UID)
     for _,airbase in pairs(airports) do
     
       local name=airbase:getName()
-      local q=AIRBASE:FindByName(name):GetCoordinate()
-      local d=q:Get2DDistance(pos)
+      local a=AIRBASE:FindByName(name)
+      if a then
+        local q=a:GetCoordinate()
+        local d=q:Get2DDistance(pos)
       
-      -- Add to table.
-      table.insert(self.group[GID].player[UID].airports, {distance=d, name=name})
+        -- Add to table.
+        table.insert(self.group[GID].player[UID].airports, {distance=d, name=name})
+      end
       
     end
   end
@@ -1041,6 +979,3 @@ function PSEUDOATC:_myname(unitname)
   
   return string.format("%s (%s)", csign, pname)
 end
-
-
-

Moose Development/Moose/Functional/RAT.lua

@@ -46,12 +46,12 @@
 --
 -- ===
 --
--- ### 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
+-- @module Functional.RAT
 -- @image RAT.JPG
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -69,7 +69,7 @@
 -- @field #string category Category of aircarft: "plane" or "heli".
 -- @field #number groupsize Number of aircraft in group.
 -- @field #string friendly Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red.
--- @field #table ctable Table with the valid coalitons from choice self.friendly.
+-- @field #table ctable Table with the valid coalitions from choice self.friendly.
 -- @field #table aircraft Table which holds the basic aircraft properties (speed, range, ...).
 -- @field #number Vcruisemax Max cruise speed in m/s (250 m/s = 900 km/h = 486 kt) set by user.
 -- @field #number Vclimb Default climb rate in ft/min.
@@ -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.
 --
@@ -348,7 +348,7 @@ RAT={
   category = nil,           -- Category of aircarft: "plane" or "heli".
   groupsize=nil,            -- Number of aircraft in the group.
   friendly = "same",        -- Possible departure/destination airport: same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red, neutral.
-  ctable = {},              -- Table with the valid coalitons from choice self.friendly.
+  ctable = {},              -- Table with the valid coalitions from choice self.friendly.
   aircraft = {},            -- Table which holds the basic aircraft properties (speed, range, ...).
   Vcruisemax=nil,           -- Max cruise speed in set by user.
   Vclimb=1500,              -- Default climb rate in ft/min.
@@ -657,7 +657,7 @@ end
 -- @param #RAT self
 -- @param #number naircraft (Optional) Number of aircraft to spawn. Default is one aircraft.
 -- @return #boolean True if spawning was successful or nil if nothing was spawned.
--- @usage yak:Spawn(5) will spawn five aircraft. By default aircraft will spawn at neutral and red airports if the template group is part of the red coaliton.
+-- @usage yak:Spawn(5) will spawn five aircraft. By default aircraft will spawn at neutral and red airports if the template group is part of the red coalition.
 function RAT:Spawn(naircraft)
 
   -- Make sure that this function is only been called once per RAT object.
@@ -1289,7 +1289,7 @@ end
 
 --- Include all airports which lie in a zone as possible destinations.
 -- @param #RAT self
--- @param Core.Zone#ZONE zone Zone in which the departure airports lie. Has to be a MOOSE zone.
+-- @param Core.Zone#ZONE zone Zone in which the destination airports lie. Has to be a MOOSE zone.
 -- @return #RAT RAT self object.
 function RAT:SetDestinationsFromZone(zone)
   self:F2(zone)
@@ -1305,7 +1305,7 @@ end
 
 --- Include all airports which lie in a zone as possible destinations.
 -- @param #RAT self
--- @param Core.Zone#ZONE zone Zone in which the destination airports lie. Has to be a MOOSE zone.
+-- @param Core.Zone#ZONE zone Zone in which the departure airports lie. Has to be a MOOSE zone.
 -- @return #RAT RAT self object.
 function RAT:SetDeparturesFromZone(zone)
   self:F2(zone)
@@ -2049,9 +2049,15 @@ function RAT:_InitAircraft(DCSgroup)
   --self.aircraft.descriptors=DCSdesc
 
   -- aircraft dimensions
-  self.aircraft.length=DCSdesc.box.max.x
-  self.aircraft.height=DCSdesc.box.max.y
-  self.aircraft.width=DCSdesc.box.max.z
+  if DCSdesc.box then
+    self.aircraft.length=DCSdesc.box.max.x
+    self.aircraft.height=DCSdesc.box.max.y
+    self.aircraft.width=DCSdesc.box.max.z
+  elseif DCStype == "Mirage-F1CE" then
+    self.aircraft.length=16
+    self.aircraft.height=5
+    self.aircraft.width=9
+  end
   self.aircraft.box=math.max(self.aircraft.length,self.aircraft.width)
 
   -- info message
@@ -2468,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)
@@ -3477,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.
@@ -3485,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
+      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()
@@ -4596,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)
@@ -5437,7 +5446,7 @@ function RAT:_ModifySpawnTemplate(waypoints, livery, spawnplace, departure, take
           SpawnTemplate.units[UnitID]["onboard_num"] = string.format("%s%d%02d", self.onboardnum, (self.SpawnIndex-1)%10, (self.onboardnum0-1)+UnitID)
         end
 
-        -- Modify coaltion and country of template.
+        -- Modify coalition and country of template.
         SpawnTemplate.CoalitionID=self.coalition
         if self.country then
           SpawnTemplate.CountryID=self.country
@@ -5484,7 +5493,7 @@ function RAT:_ATCInit(airports_map)
   if not RAT.ATC.init then
     local text
     text="Starting RAT ATC.\nSimultanious = "..RAT.ATC.Nclearance.."\n".."Delay        = "..RAT.ATC.delay
-	  BASE:T(RAT.id..text)
+    BASE:T(RAT.id..text)
     RAT.ATC.init=true
     for _,ap in pairs(airports_map) do
       local name=ap:GetName()
@@ -5665,6 +5674,9 @@ function RAT:_ATCClearForLanding(airport, flight)
 
   -- Debug message.
   local text1=string.format("ATC %s: Flight %s cleared for landing (flag=%d).", airport, flight, flagvalue)
+  if string.find(flight,"#") then
+    flight =  string.match(flight,"^(.+)#")
+  end
   local text2=string.format("ATC %s: Flight %s you are cleared for landing.", airport, flight)
   BASE:T( RAT.id..text1)
   MESSAGE:New(text2, 10):ToAllIf(RAT.ATC.messages)
@@ -5707,6 +5719,9 @@ function RAT:_ATCFlightLanded(name)
     local text1=string.format("ATC %s: Flight %s landed. Tholding = %i:%02d, Tfinal = %i:%02d.", dest, name, Thold/60, Thold%60, Tfinal/60, Tfinal%60)
     local text2=string.format("ATC %s: Number of flights still on final %d.", dest, RAT.ATC.airport[dest].Nonfinal)
     local text3=string.format("ATC %s: Traffic report: Number of planes landed in total %d. Flights/hour = %3.2f.", dest, RAT.ATC.airport[dest].traffic, TrafficPerHour)
+  if string.find(name,"#") then
+    name =  string.match(name,"^(.+)#")
+  end
     local text4=string.format("ATC %s: Flight %s landed. Welcome to %s.", dest, name, dest)
     BASE:T(RAT.id..text1)
     BASE:T(RAT.id..text2)
@@ -5820,6 +5835,7 @@ RATMANAGER={
   rat={},
   name={},
   alive={},
+  planned={},
   min={},
   nrat=0,
   ntot=nil,
@@ -5868,6 +5884,7 @@ function RATMANAGER:Add(ratobject,min)
 
   self.rat[self.nrat]=ratobject
   self.alive[self.nrat]=0
+  self.planned[self.nrat]=0
   self.name[self.nrat]=ratobject.alias
   self.min[self.nrat]=min or 1
 
@@ -6008,11 +6025,25 @@ function RATMANAGER:_Manage()
   for i=1,self.nrat do
     for j=1,N[i] do
       time=time+self.dTspawn
-      SCHEDULER:New(nil, RAT._SpawnWithRoute, {self.rat[i]}, time)
+      self.planned[i]=self.planned[i]+1
+      SCHEDULER:New(nil, RATMANAGER._Spawn, {self, i}, time)
     end
   end
 end
 
+--- Instantly starts the RAT manager and spawns the initial random number RAT groups for each RAT object.
+-- @param #RATMANAGER self
+-- @param #RATMANAGER RATMANAGER self object.
+-- @param #number i Index.
+function RATMANAGER:_Spawn(i)
+
+  local rat=self.rat[i] --#RAT
+  
+  rat:_SpawnWithRoute()
+  self.planned[i]=self.planned[i]-1
+
+end
+
 --- Counts the number of alive RAT objects.
 -- @param #RATMANAGER self
 function RATMANAGER:_Count()
@@ -6041,7 +6072,7 @@ function RATMANAGER:_Count()
     ntotal=ntotal+n
 
     -- Debug output.
-    local text=string.format("Number of alive groups of %s = %d", self.name[i], n)
+    local text=string.format("Number of alive groups of %s = %d, planned=%d", self.name[i], n, self.planned[i])
     self:T(RATMANAGER.id..text)
   end
 
@@ -6071,9 +6102,10 @@ function RATMANAGER:_RollDice(nrat,ntot,min,alive)
   local M={}
   local P={}
   for i=1,nrat do
+    local a=alive[i]+self.planned[i]
     N[#N+1]=0
-    M[#M+1]=math.max(alive[i], min[i])
-    P[#P+1]=math.max(min[i]-alive[i],0)
+    M[#M+1]=math.max(a, min[i])
+    P[#P+1]=math.max(min[i]-a,0)
   end
 
   -- Min/max group arrays.
@@ -6090,7 +6122,7 @@ function RATMANAGER:_RollDice(nrat,ntot,min,alive)
   -- Number of new groups to be added.
   local nnew=ntot
   for i=1,nrat do
-    nnew=nnew-alive[i]
+    nnew=nnew-alive[i]-self.planned[i]
   end
 
   for i=1,nrat-1 do
@@ -6122,7 +6154,7 @@ function RATMANAGER:_RollDice(nrat,ntot,min,alive)
     end
 
     -- Debug info
-    self:T3(string.format("RATMANAGER: i=%d, alive=%d, min=%d, mini=%d, maxi=%d, add=%d, sumN=%d, sumP=%d", j, alive[j], min[j], mini[j], maxi[j], N[j],sN, sP))
+    self:T3(string.format("RATMANAGER: i=%d, alive=%d, planned=%d, min=%d, mini=%d, maxi=%d, add=%d, sumN=%d, sumP=%d", j, alive[j], self.planned[i], min[j], mini[j], maxi[j], N[j],sN, sP))
 
   end
 
@@ -6137,7 +6169,7 @@ function RATMANAGER:_RollDice(nrat,ntot,min,alive)
   -- Debug info
   local text=RATMANAGER.id.."\n"
   for i=1,nrat do
-    text=text..string.format("%s: i=%d, alive=%d, min=%d, mini=%d, maxi=%d, add=%d\n", self.name[i], i, alive[i], min[i], mini[i], maxi[i], N[i])
+    text=text..string.format("%s: i=%d, alive=%d, planned=%d, min=%d, mini=%d, maxi=%d, add=%d\n", self.name[i], i, alive[i], self.planned[i], min[i], mini[i], maxi[i], N[i])
   end
   text=text..string.format("Total # of groups to add = %d", sum(N, done))
   self:T(text)

Moose Development/Moose/Functional/RAT2.lua

@@ -1,855 +0,0 @@
---- **Ops** - (R2.5) - Random Air Traffic.
--- 
--- 
--- 
--- RAT2 creates random air traffic on the map.
--- 
--- 
---
--- **Main Features:**
---
---     * It's very random.
---     
--- ===
---
--- ### Author: **funkyfranky**
--- @module Functional.Rat2
--- @image Functional_Rat2.png
-
-
---- RAT2 class.
--- @type RAT2
--- @field #string ClassName Name of the class.
--- @field #boolean Debug Debug mode. Messages to all about status.
--- @field #string lid Class id string for output to DCS log file.
--- @field #table Qcraft Table of rat crafts.
--- @extends Core.Fsm#FSM
-
---- Be surprised!
---
--- ===
---
--- ![Banner Image](..\Presentations\RAT2\RAT2_Main.png)
---
--- # The RAT2 Concept
--- 
--- 
--- 
--- @field #RAT2
-RAT2 = {
-  ClassName      = "RAT2",
-  Debug          =  false,
-  lid            =    nil,
-  Qcraft         =     {},
-}
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Create a new RAT2 class object.
--- @param #RAT2 self
--- @return #RAT2 self.
-function RAT2:New()
-
-  -- Inherit everthing from FSM class.
-  local self=BASE:Inherit(self, FSM:New()) -- #RAT2
-  
-  -- Start State.
-  self:SetStartState("Stopped")
-  
-  self.lid="RAT2 | "
-
-  -- Add FSM transitions.
-  --                 From State  -->   Event      -->     To State
-  self:AddTransition("Stopped",       "Load",            "Stopped")     -- Load player scores from file.
-  self:AddTransition("Stopped",       "Start",           "Running")     -- Start RAT2 script.
-  self:AddTransition("*",             "Status",          "*")           -- Start RAT2 script.
-  self:AddTransition("*",             "Spawned",         "*")           -- A group was spawned.
-  
-  return self
-end
-
---- Create a new RAT2 class object.
--- @param #RAT2 self
--- @param #RATAC ratcraft The aircraft to add.
--- @return #RAT2 self.
-function RAT2:AddAircraft(ratcraft)
-
-  -- Add ratcraft to spawn queue.
-  table.insert(self.Qcraft, ratcraft)
-
-  return self
-end
-
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Status Functions
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Start random air traffic.
--- @param #RAT2 self
--- @param #string From From state.
--- @param #string Event Event.
--- @param #string To To state.
-function RAT2:onafterStart(From, Event, To)
-
-  self:__Status(-1)
-end
-
-
---- Check spawn queue and spawn aircraft if necessary.
--- @param #RAT2 self
--- @param #string From From state.
--- @param #string Event Event.
--- @param #string To To state.
-function RAT2:onafterStatus(From, Event, To)
-
-  self:I(string.format("RAT status %s", self:GetState()))
-
-  -- Check queue of aircraft to spawn.
-  self:_CheckQueueSpawn()
-  
-  self:__Status(-10)
-end
-
-
---- Check spawn queue and spawn aircraft if necessary.
--- @param #RAT2 self
-function RAT2:_CheckQueueSpawn()
-
-  self:I(string.format("Checking flights"))
-
-  -- Loop over all ratcraft.
-  for i,_ratcraft in pairs(self.Qcraft) do
-    local ratcraft=_ratcraft --Functional.RatCraft#RATCRAFT
-
-    -- Get number of alive groups.
-    local Nalive=ratcraft:_GetAliveGroups()
-    
-    for _,_flight in pairs(ratcraft.flights) do
-      local flight=_flight --Ops.FlightGroup#FLIGHTGROUP
-      
-      self:I(string.format("Checking flight group %s in status %s", flight.groupname, flight:GetState()))
-      
-      if flight:IsInUtero() or flight:IsArrived() or flight:IsDead() then
-      
-        self:I(string.format("Try Spawning new flight group %s in status %s", flight.groupname, flight:GetState()))
-          
-        -- Get departure and parking.
-        local departure, parking=ratcraft:GetDeparture()
-        
-        -- Get destination depending on departure.
-        local destination=ratcraft:GetDestination(departure)
-        
-        if departure and destination and parking then
-        
-          self:I(string.format("Spawning new flight group %s in status %s", flight.groupname, flight:GetState()))
-        
-          -- Try to spawn a ratcraft group.
-          local group=self:_SpawnRatcraft(ratcraft, flight, departure, destination, parking)
-          
-          -- Remove queue item and break loop.
-          if group then
-    
-            -- We add a little delay
-            self:__Spawned(0.1, group, flight, ratcraft)
-            
-            break
-          end -- if group
-          
-        end -- if departure        
-      end -- if spawn flight    
-    end -- for flights
-  end -- for ratcraft
-end
-
---- Check spawn queue and spawn aircraft if necessary.
--- @param #RAT2 self
-function RAT2:_CheckArrived()
-
-  for _,_ratcraft in pairs(self.Qcraft) do
-    local ratcraft=_ratcraft --Functional.RatCraft#RATCRAFT
-    for _,_flight in pairs(ratcraft.flights) do
-      local flight=_flight --Ops.FlightGroup#FLIGHTGROUP
-      
-      if flight:IsArrived() then
-        -- Destroy group and create a remove unit event.
-        flight.group:Destroy(nil)
-      end
-      
-    end
-  end
-  
-end
-
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- FSM functions
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Function called after a RAT group was spawned.
--- @param #RAT2 self
--- @param #string From From state.
--- @param #string Event Event.
--- @param #string To To state.
--- @param Wrapper.Group#GROUP group The spawned group.
--- @param Ops.FlightGroup#FLIGHTGROUP flight The flight group.
--- @param Functional.RatCraft#RATCRAFT ratcraft The ratcraft object.
-function RAT2:onafterSpawned(From, Event, To, group, flight, ratcraft)
-
-  group:SmokeGreen()
-
-end
-
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Spawn functions
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Spawn an aircraft asset (plane or helo) at the airbase associated with the warehouse.
--- @param #RAT2 self
--- @param Functional.RatCraft#RATCRAFT ratcraft Ratcraft to spawn.
--- @param Ops.FlightGroup#FLIGHTGROUP flight Flight group.
--- @param Functional.RatCraft#RATCRAFT.Departure departure Departure.
--- @param Functional.RatCraft#RATCRAFT.Departure destination Destination.
--- @param #table parking Parking data for this group.
--- @return Wrapper.Group#GROUP The spawned group or nil if the group could not be spawned.
-function RAT2:_SpawnRatcraft(ratcraft, flight, departure, destination, parking)
-
-  -- Prepare the spawn template.
-  local template=self:_SpawnAssetPrepareTemplate(ratcraft, flight.groupname)
-  
-    -- Get flight path if the group goes to another warehouse by itself.
-  template.route.points=self:_GetFlightplan(ratcraft, AIRBASE:FindByName(departure.name), AIRBASE:FindByName(destination.name))
-  
-  local airbase=AIRBASE:FindByName(departure.name) --self:_GetAirbase(departure)
-  
-  -- Get airbase ID and category.
-  local AirbaseID = airbase:GetID()
-  local AirbaseCategory = airbase:GetAirbaseCategory()
-  
-  -- Check enough parking spots.
-  if AirbaseCategory==Airbase.Category.HELIPAD or AirbaseCategory==Airbase.Category.SHIP then
-  
-    --TODO Figure out what's necessary in this case.
-  
-  else
-  
-    if #parking<#template.units then
-      local text=string.format("ERROR: Not enough parking! Free parking = %d < %d aircraft to be spawned.", #parking, #template.units)
-      self:_DebugMessage(text)
-      return nil
-    end
-  
-  end
-  
-  -- Position the units.
-  for i=1,#template.units do
-  
-    -- Unit template.
-    local unit = template.units[i]
-  
-    if AirbaseCategory == Airbase.Category.HELIPAD or AirbaseCategory == Airbase.Category.SHIP then
-  
-      -- Helipads we take the position of the airbase location, since the exact location of the spawn point does not make sense.
-      local coord=airbase:GetCoordinate()
-  
-      unit.x=coord.x
-      unit.y=coord.z
-      unit.alt=coord.y
-  
-      unit.parking_id = nil
-      unit.parking    = nil
-  
-    else
-  
-      local coord=parking[i].Coordinate    --Core.Point#COORDINATE
-      local terminal=parking[i].TerminalID --#number
-  
-      if self.Debug then
-        coord:MarkToAll(string.format("Spawnplace unit %s terminal %d.", unit.name, terminal))
-      end
-  
-      unit.x=coord.x
-      unit.y=coord.z
-      unit.alt=coord.y
-  
-      unit.parking_id = nil
-      unit.parking    = terminal
-  
-    end
-    
-    if destination.parking then
-      local spot=destination.parking[i] --Wrapper.Airbase#AIRBASE.ParkingSpot
-      unit.parking_landing=spot.TerminalID
-    end    
-    
-    if ratcraft.livery==nil and #ratcraft.liveries>0 then
-      ratcraft.livery=ratcraft.liveries[math.random(#ratcraft.liveries)]
-    end
-  
-    -- Set livery.
-    if ratcraft.livery then
-      unit.livery_id = ratcraft.livery
-    end
-    
-    -- Set skill.
-    if ratcraft.skill then
-      unit.skill= ratcraft.skill
-    end
-  
-  end
-  
-  -- And template position.
-  template.x = template.units[1].x
-  template.y = template.units[1].y
-  
-  -- Uncontrolled spawning.
-  template.uncontrolled=ratcraft.uncontrolled
-  
-  -- Debug info.
-  self:T2({airtemplate=template})
-  
-  -- Spawn group.
-  local group=_DATABASE:Spawn(template) --Wrapper.Group#GROUP
-  
-  return group
-end
-
-
---- Prepare a spawn template for the asset. Deep copy of asset template, adjusting template and unit names, nillifying group and unit ids.
--- @param #RAT2 self
--- @param Functional.RatCraft#RATCRAFT ratcraft Aircraft that will be spawned.
--- @param #string groupname Name for the group to be spawned.
--- @return #table Prepared new spawn template.
-function RAT2:_SpawnAssetPrepareTemplate(ratcraft, groupname)
-
-  -- Create an own copy of the template!
-  local template=UTILS.DeepCopy(ratcraft.template)
-
-  -- Set unique name.
-  template.name=groupname
-
-  -- Set current(!) coalition and country.
-  template.CoalitionID=ratcraft.coalition
-  template.CountryID=ratcraft.country
-
-  -- Nillify the group ID.
-  template.groupId=nil
-
-  -- No late activation.
-  template.lateActivation=false
-
-  -- Set and empty route.
-  template.route = {}
-  template.route.routeRelativeTOT=true
-  template.route.points = {}
-
-  -- Handle units.
-  for i=1,#template.units do
-
-    -- Unit template.
-    local unit=template.units[i]
-
-    -- Nillify the unit ID.
-    unit.unitId=nil
-
-    -- Set unit name: <alias>-01, <alias>-02, ...
-    unit.name=string.format("%s-%02d", template.name , i)
-
-  end
-
-  return template
-end
-
---@param #RCRAFT.Attribute _attribute Generlized attribute of unit.
-
---- Get the proper terminal type based on generalized attribute of the group.
---@param #RAT2 self
---@param #number _category Airbase category.
---@return Wrapper.Airbase#AIRBASE.TerminalType Terminal type for this group.
-function RAT2:_GetTerminal(_attribute, _category)
-
-  -- Default terminal is "large".
-  local _terminal=AIRBASE.TerminalType.OpenBig
-
-  if _attribute==RCRAFT.Attribute.FIGHTER then
-    -- Fighter ==> small.
-    _terminal=AIRBASE.TerminalType.FighterAircraft
-  elseif _attribute==RCRAFT.Attribute.BOMBER or _attribute==RCRAFT.Attribute.TRANSPORTPLANE or _attribute==RCRAFT.Attribute.TANKER or _attribute==RCRAFT.Attribute.AWACS then
-    -- Bigger aircraft.
-    _terminal=AIRBASE.TerminalType.OpenBig
-  elseif _attribute==RCRAFT.Attribute.TRANSPORTHELO or _attribute==RCRAFT.Attribute.ATTACKHELO then
-    -- Helicopter.
-    _terminal=AIRBASE.TerminalType.HelicopterUsable
-  else
-    --_terminal=AIRBASE.TerminalType.OpenMedOrBig
-  end
-
-  -- For ships, we allow medium spots for all fixed wing aircraft. There are smaller tankers and AWACS aircraft that can use a carrier.
-  if _category==Airbase.Category.SHIP then
-    if not (_attribute==RCRAFT.Attribute.TRANSPORTHELO or _attribute==RCRAFT.Attribute.ATTACKHELO) then
-      _terminal=AIRBASE.TerminalType.OpenMedOrBig
-    end
-  end
-
-  return _terminal
-end
-
-
---- Seach unoccupied parking spots at the airbase for a list of assets. For each asset group a list of parking spots is returned.
--- During the search also the not yet spawned asset aircraft are considered.
--- If not enough spots for all asset units could be found, the routine returns nil!
--- @param #RAT2 self
--- @param Wrapper.Airbase#AIRBASE airbase The airbase where we search for parking spots.
--- @param Functional.RatCraft#RATCRAFT ratcraft Ratcraft.
--- @return #table Table of coordinates and terminal IDs of free parking spots. Each table entry has the elements .Coordinate and .TerminalID.
-function RAT2:_FindParking(airbase, ratcraft)
-
-  -- Init default
-  local scanradius=50
-  local scanunits=true
-  local scanstatics=true
-  local scanscenery=false
-  local verysafe=false
-
-  -- Function calculating the overlap of two (square) objects.
-  local function _overlap(l1,l2,dist)
-    local safedist=(l1/2+l2/2)*1.05  -- 5% safety margine added to safe distance!
-    local safe = (dist > safedist)
-    self:T3(string.format("l1=%.1f l2=%.1f s=%.1f d=%.1f ==> safe=%s", l1,l2,safedist,dist,tostring(safe)))
-    return safe
-  end
-
-  -- Get parking spot data table. This contains all free and "non-free" spots.
-  local parkingdata=airbase:GetParkingSpotsTable()
-
-  -- List of obstacles.
-  local obstacles={}
-
-  -- Loop over all parking spots and get the currently present obstacles.
-  -- How long does this take on very large airbases, i.e. those with hundereds of parking spots? Seems to be okay!
-  for _,parkingspot in pairs(parkingdata) do
-
-    -- Coordinate of the parking spot.
-    local _spot=parkingspot.Coordinate   -- Core.Point#COORDINATE
-    local _termid=parkingspot.TerminalID
-
-    -- Scan a radius of 100 meters around the spot.
-    local _,_,_,_units,_statics,_sceneries=_spot:ScanObjects(scanradius, scanunits, scanstatics, scanscenery)
-
-    -- Check all units.
-    for _,_unit in pairs(_units) do
-      local unit=_unit --Wrapper.Unit#UNIT
-      local _coord=unit:GetCoordinate()
-      local _size=self:_GetObjectSize(unit:GetDCSObject())
-      local _name=unit:GetName()
-      table.insert(obstacles, {coord=_coord, size=_size, name=_name, type="unit"})
-    end
-
-    -- Check all statics.
-    for _,static in pairs(_statics) do
-      local _vec3=static:getPoint()
-      local _coord=COORDINATE:NewFromVec3(_vec3)
-      local _name=static:getName()
-      local _size=self:_GetObjectSize(static)
-      table.insert(obstacles, {coord=_coord, size=_size, name=_name, type="static"})
-    end
-
-    -- Check all scenery.
-    for _,scenery in pairs(_sceneries) do
-      local _vec3=scenery:getPoint()
-      local _coord=COORDINATE:NewFromVec3(_vec3)
-      local _name=scenery:getTypeName()
-      local _size=self:_GetObjectSize(scenery)
-      table.insert(obstacles,{coord=_coord, size=_size, name=_name, type="scenery"})
-    end
-    
-    -- TODO check clients. Clients cannot be spawned. So we can loop over them.
-
-  end
-
-  -- Parking data for all assets.
-  local parking={}
-
-  -- Get terminal type of this asset
-  local terminaltype=self:_GetTerminal(ratcraft.attribute, airbase:GetAirbaseCategory())
-  
-  local Nunits=#ratcraft.templategroup:GetUnits()
-
-  -- Loop over all units - each one needs a spot.
-  for i=1,Nunits do
-
-    -- Loop over all parking spots.
-    local gotit=false
-    for _,_parkingspot in pairs(parkingdata) do
-      local parkingspot=_parkingspot --Wrapper.Airbase#AIRBASE.ParkingSpot
-
-      -- Check correct terminal type for asset. We don't want helos in shelters etc.
-      if AIRBASE._CheckTerminalType(parkingspot.TerminalType, terminaltype) then
-
-        -- Coordinate of the parking spot.
-        local _spot=parkingspot.Coordinate   -- Core.Point#COORDINATE
-        local _termid=parkingspot.TerminalID
-        local _toac=parkingspot.TOAC
-
-        --env.info(string.format("FF asset=%s (id=%d): needs terminal type=%d, id=%d, #obstacles=%d", _asset.templatename, _asset.uid, terminaltype, _termid, #obstacles))
-
-        local free=true
-        local problem=nil
-
-        -- Safe parking using TO_AC from DCS result.
-        if self.safeparking and _toac then
-          free=false
-          self:T("Parking spot %d is occupied by other aircraft taking off or landing.", _termid)
-        end
-
-        -- Loop over all obstacles.
-        for _,obstacle in pairs(obstacles) do
-
-          -- Check if aircraft overlaps with any obstacle.
-          local dist=_spot:Get2DDistance(obstacle.coord)
-          local safe=_overlap(ratcraft.size, obstacle.size, dist)
-
-          -- Spot is blocked.
-          if not safe then
-            --env.info(string.format("FF asset=%s (id=%d): spot id=%d dist=%.1fm is NOT SAFE", _asset.templatename, _asset.uid, _termid, dist))
-            free=false
-            problem=obstacle
-            problem.dist=dist
-            break
-          else
-            --env.info(string.format("FF asset=%s (id=%d): spot id=%d dist=%.1fm is SAFE", _asset.templatename, _asset.uid, _termid, dist))
-          end
-
-        end
-
-        -- Check if spot is free
-        if free then
-
-          -- Add parkingspot for this asset unit.
-          table.insert(parking, parkingspot)
-
-          self:T(self.lid..string.format("Parking spot #%d is free for ratcraft unit id=%d!", _termid, i))
-
-          -- Add the unit as obstacle so that this spot will not be available for the next unit.
-          table.insert(obstacles, {coord=_spot, size=ratcraft.size, name=ratcraft.templatename, type="ratcraft"})
-
-          -- Break loop over parking spots.
-          gotit=true
-          break
-
-        else
-
-          -- Debug output for occupied spots.
-          self:T(self.lid..string.format("Parking spot #%d is occupied or not big enough!", _termid))
-          if self.Debug then
-            local coord=problem.coord --Core.Point#COORDINATE
-            local text=string.format("Obstacle blocking spot #%d is %s type %s with size=%.1f m and distance=%.1f m.", _termid, problem.name, problem.type, problem.size, problem.dist)
-            coord:MarkToAll(string.format(text))
-          end
-
-        end
-
-      end -- check terminal type
-    end -- loop over parking spots
-
-    -- No parking spot for at least one unit :(
-    if not gotit then
-      self:T(self.lid..string.format("WARNING: No free parking spot for ratcraft unit i=%d", i))
-      return nil
-    end
-    
-  end -- loop over units
-
-  return parking
-end
-
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Flightplan functions
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Calculate the maximum height an aircraft can reach for the given parameters.
--- @param #RAT2 self
--- @param #number D Total distance in meters from Departure to holding point at destination.
--- @param #number alphaC Climb angle in rad.
--- @param #number alphaD Descent angle in rad.
--- @param #number Hdep AGL altitude of departure point.
--- @param #number Hdest AGL altitude of destination point.
--- @param #number Deltahhold Relative altitude of holding point above destination.
--- @return #number Maximum height the aircraft can reach.
-function RAT2:_GetMaxHeight(D, alphaC, alphaD, Hdep, Hdest, Deltahhold)
-
-  local Hhold=Hdest+Deltahhold
-  local hdest=Hdest-Hdep
-  local hhold=hdest+Deltahhold
-
-  local Dp=math.sqrt(D^2 + hhold^2)
-
-  local alphaS=math.atan(hdest/D) -- slope angle
-  local alphaH=math.atan(hhold/D) -- angle to holding point (could be necative!)
-
-  local alphaCp=alphaC-alphaH  -- climb angle with slope
-  local alphaDp=alphaD+alphaH  -- descent angle with slope
-
-  -- ASA triangle.
-  local gammap=math.pi-alphaCp-alphaDp
-  local sCp=Dp*math.sin(alphaDp)/math.sin(gammap)
-  local sDp=Dp*math.sin(alphaCp)/math.sin(gammap)
-
-  -- Max height from departure.
-  local hmax=sCp*math.sin(alphaC)
-
-  return hmax
-end
-
-
---- Make a flight plan from a departure to a destination airport.
--- @param #RAT2 self
--- @param Functional.RatCraft#RATCRAFT ratcraft Ratcraft object.
--- @param Wrapper.Airbase#AIRBASE departure Departure airbase.
--- @param Wrapper.Airbase#AIRBASE destination Destination airbase.
--- @return #table Table of flightplan waypoints.
--- @return #table Table of flightplan coordinates.
-function RAT2:_GetFlightplan(ratcraft, departure, destination)
-
-  -- Parameters
-  local Vmax=ratcraft.speedmax
-  local Range=ratcraft.range
-  local category=ratcraft.category
-  local ceiling=ratcraft.DCSdesc.Hmax
-  local Vymax=ratcraft.DCSdesc.VyMax
-
-  -- Max cruise speed 90% of max speed.
-  local VxCruiseMax=0.90*Vmax
-
-  -- Min cruise speed 70% of max cruise or 600 km/h whichever is lower.
-  local VxCruiseMin = math.min(VxCruiseMax*0.75, 750)
-
-  -- Cruise speed (randomized). Expectation value at midpoint between min and max.
-  local VxCruise = UTILS.RandomGaussian((VxCruiseMax-VxCruiseMin)/2+VxCruiseMin, (VxCruiseMax-VxCruiseMax)/4, VxCruiseMin, VxCruiseMax)
-
-  -- Climb speed 90% ov Vmax but max 720 km/h.
-  local VxClimb = math.min(Vmax*0.90, 720)
-
-  -- Descent speed 60% of Vmax but max 500 km/h.
-  local VxDescent = math.min(Vmax*0.60, 500)
-
-  -- Holding speed is 90% of descent speed.
-  local VxHolding = VxDescent*0.9
-
-  -- Final leg is 90% of holding speed.
-  local VxFinal = VxHolding*0.9
-
-  -- Reasonably civil climb speed Vy=1500 ft/min = 7.6 m/s but max aircraft specific climb rate.
-  local VyClimb=math.min(7.6, Vymax)
-
-  -- Climb angle in rad.
-  local AlphaClimb=math.rad(4)
-
-  -- Descent angle in rad. Moderate 4 degrees.
-  local AlphaDescent=math.rad(4)
-
-  -- Expected cruise level (peak of Gaussian distribution)
-  local FLcruise_expect=150*RAT.unit.FL2m
-  if category==Group.Category.HELICOPTER then
-    FLcruise_expect=1000 -- 1000 m ASL
-  end
-
-  -------------------------
-  --- DEPARTURE AIRPORT ---
-  -------------------------
-
-  -- Coordinates of departure point.
-  local Pdeparture=departure:GetCoordinate()
-
-  -- Height ASL of departure point.
-  local H_departure=Pdeparture.y
-
-  ---------------------------
-  --- DESTINATION AIRPORT ---
-  ---------------------------
-
-  -- Position of destination airport.
-  local Pdestination=destination:GetCoordinate()
-
-  -- Height ASL of destination airport/zone.
-  local H_destination=Pdestination.y
-
-  -----------------------------
-  --- DESCENT/HOLDING POINT ---
-  -----------------------------
-
-  -- Get a random point between 5 and 10 km away from the destination.
-  local Rhmin=5000
-  local Rhmax=10000
-
-  -- For helos we set a distance between 500 to 1000 m.
-  if category==Group.Category.HELICOPTER then
-    Rhmin=500
-    Rhmax=1000
-  end
-
-  -- Coordinates of the holding point. y is the land height at that point.
-  local Pholding=Pdestination:GetRandomCoordinateInRadius(Rhmax, Rhmin)
-
-  -- Distance from holding point to final destination (not used).
-  local d_holding=Pholding:Get2DDistance(Pdestination)
-
-  -- AGL height of holding point.
-  local H_holding=Pholding.y
-
-  ---------------
-  --- GENERAL ---
-  ---------------
-
-  -- We go directly to the holding point not the destination airport. From there, planes are guided by DCS to final approach.
-  local heading=Pdeparture:HeadingTo(Pholding)
-  local d_total=Pdeparture:Get2DDistance(Pholding)
-
-  ------------------------------
-  --- Holding Point Altitude ---
-  ------------------------------
-
-  -- Holding point altitude. For planes between 1600 and 2400 m AGL. For helos 160 to 240 m AGL.
-  local h_holding=1200
-  if category==Group.Category.HELICOPTER then
-    h_holding=150
-  end
-  h_holding=UTILS.Randomize(h_holding, 0.2)
-
-  -- Max holding altitude.
-  local DeltaholdingMax=self:_GetMaxHeight(d_total, AlphaClimb, AlphaDescent, H_departure, H_holding, 0)
-
-  if h_holding>DeltaholdingMax then
-    h_holding=math.abs(DeltaholdingMax)
-  end
-
-  -- This is the height ASL of the holding point we want to fly to.
-  local Hh_holding=H_holding+h_holding
-
-  ---------------------------
-  --- Max Flight Altitude ---
-  ---------------------------
-
-  -- Get max flight altitude relative to H_departure.
-  local h_max=self:_GetMaxHeight(d_total, AlphaClimb, AlphaDescent, H_departure, H_holding, h_holding)
-
-  -- Max flight level ASL aircraft can reach for given angles and distance.
-  local FLmax = h_max+H_departure
-
-  --CRUISE
-  -- Min cruise alt is just above holding point at destination or departure height, whatever is larger.
-  local FLmin=math.max(H_departure, Hh_holding)
-
-  -- Ensure that FLmax not above its service ceiling.
-  FLmax=math.min(FLmax, ceiling)
-
-  -- If the route is very short we set FLmin a bit lower than FLmax.
-  if FLmin>FLmax then
-    FLmin=FLmax
-  end
-
-  -- Expected cruise altitude - peak of gaussian distribution.
-  if FLcruise_expect<FLmin then
-    FLcruise_expect=FLmin
-  end
-  if FLcruise_expect>FLmax then
-    FLcruise_expect=FLmax
-  end
-
-  -- Set cruise altitude. Selected from Gaussian distribution but limited to FLmin and FLmax.
-  local FLcruise=UTILS.RandomGaussian(FLcruise_expect, math.abs(FLmax-FLmin)/4, FLmin, FLmax)
-
-  -- Climb and descent heights.
-  local h_climb   = FLcruise - H_departure
-  local h_descent = FLcruise - Hh_holding
-
-  -- Get distances.
-  local d_climb   = h_climb/math.tan(AlphaClimb)
-  local d_descent = h_descent/math.tan(AlphaDescent)
-  local d_cruise  = d_total-d_climb-d_descent
-
-  -- Debug.
-  local text=string.format("Flight plan:\n")
-  text=text..string.format("Vx max        = %.2f km/h\n", Vmax)
-  text=text..string.format("Vx climb      = %.2f km/h\n", VxClimb*3.6)
-  text=text..string.format("Vx cruise     = %.2f km/h\n", VxCruise*3.6)
-  text=text..string.format("Vx descent    = %.2f km/h\n", VxDescent*3.6)
-  text=text..string.format("Vx holding    = %.2f km/h\n", VxHolding*3.6)
-  text=text..string.format("Vx final      = %.2f km/h\n", VxFinal*3.6)
-  text=text..string.format("Vy max        = %.2f m/s\n",  Vymax)
-  text=text..string.format("Vy climb      = %.2f m/s\n",  VyClimb)
-  text=text..string.format("Alpha Climb   = %.2f Deg\n",  math.deg(AlphaClimb))
-  text=text..string.format("Alpha Descent = %.2f Deg\n",  math.deg(AlphaDescent))
-  text=text..string.format("Dist climb    = %.3f km\n",   d_climb/1000)
-  text=text..string.format("Dist cruise   = %.3f km\n",   d_cruise/1000)
-  text=text..string.format("Dist descent  = %.3f km\n",   d_descent/1000)
-  text=text..string.format("Dist total    = %.3f km\n",   d_total/1000)
-  text=text..string.format("h_climb       = %.3f km\n",   h_climb/1000)
-  text=text..string.format("h_desc        = %.3f km\n",   h_descent/1000)
-  text=text..string.format("h_holding     = %.3f km\n",   h_holding/1000)
-  text=text..string.format("h_max         = %.3f km\n",   h_max/1000)
-  text=text..string.format("FL min        = %.3f km\n",   FLmin/1000)
-  text=text..string.format("FL expect     = %.3f km\n",   FLcruise_expect/1000)
-  text=text..string.format("FL cruise *   = %.3f km\n",   FLcruise/1000)
-  text=text..string.format("FL max        = %.3f km\n",   FLmax/1000)
-  text=text..string.format("Ceiling       = %.3f km\n",   ceiling/1000)
-  text=text..string.format("Max range     = %.3f km\n",   Range/1000)
-  self:T(self.lid..text)
-
-  -- Ensure that cruise distance is positve. Can be slightly negative in special cases. And we don't want to turn back.
-  if d_cruise<0 then
-    d_cruise=100
-  end
-
-  ------------------------
-  --- Create Waypoints ---
-  ------------------------
-
-  -- Waypoints and coordinates
-  local wp={}
-  local c={}
-
-  --- Departure/Take-off
-  c[#c+1]=Pdeparture
-  wp[#wp+1]=Pdeparture:WaypointAir("RADIO", COORDINATE.WaypointType.TakeOffParking, COORDINATE.WaypointAction.FromParkingArea, VxClimb, true, departure, nil, "Departure")
-
-  --- Begin of Cruise
-  local Pcruise=Pdeparture:Translate(d_climb, heading)
-  Pcruise.y=FLcruise
-  c[#c+1]=Pcruise
-  wp[#wp+1]=Pcruise:WaypointAir("BARO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, VxCruise, true, nil, nil, "Cruise")
-
-  --- Descent
-  local Pdescent=Pcruise:Translate(d_cruise, heading)
-  Pdescent.y=FLcruise
-  c[#c+1]=Pdescent
-  wp[#wp+1]=Pdescent:WaypointAir("BARO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, VxDescent, true, nil, nil, "Descent")
-
-  --- Holding point
-  Pholding.y=H_holding+h_holding
-  c[#c+1]=Pholding
-  wp[#wp+1]=Pholding:WaypointAir("BARO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, VxHolding, true, nil, nil, "Holding")
-
-  --- Final destination.
-  c[#c+1]=Pdestination
-  wp[#wp+1]=Pdestination:WaypointAir("RADIO", COORDINATE.WaypointType.Land, COORDINATE.WaypointAction.Landing, VxFinal, true,  destination, nil, "Final Destination")
-
-
-  -- Mark points at waypoints for debugging.
-  if self.Debug or true then
-    for i,coord in pairs(c) do
-      local coord=coord --Core.Point#COORDINATE
-      local dist=0
-      if i>1 then
-        dist=coord:Get2DDistance(c[i-1])
-      end
-      coord:MarkToAll(string.format("Waypoint %i, distance = %.2f km",i, dist/1000))
-    end
-  end
-
-  return wp,c
-end
-
-
-
-