Fixed the new events

- S_EVENT_MARK_ADDED
- S_EVENT_MARK_CHANGE
- S_EVENT_MARK_REMOVED

.appveyor/appveyor.yml

@@ -0,0 +1,85 @@
+version: 3.9.1.{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:
+# 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' )     
+       {
+         $apiUrl = 'https://ci.appveyor.com/api'
+         $token = 'qts80b5kpq0ooj4x6vvw'
+         $headers = @{
+           "Authorization" = "Bearer $token"
+           "Content-type" = "application/json"
+           }
+         $RequestBody = @{ accountName = 'FlightControl-Master'; projectSlug = 'moose-include'; branch = 'master'; environmentVariables = @{} } | ConvertTo-Json
+         # get project with last build details
+         $project = Invoke-RestMethod -method Post -Uri "$apiUrl/builds" -Headers $headers -Body $RequestBody
+       }
+   - ps: | 
+       if( $env:appveyor_repo_branch -eq 'master' )     
+       {
+         $apiUrl = 'https://ci.appveyor.com/api'
+         $token = 'qts80b5kpq0ooj4x6vvw'
+         $headers = @{
+           "Authorization" = "Bearer $token"
+           "Content-type" = "application/json"
+           }
+         $RequestBody = @{ accountName = 'FlightControl-Master'; projectSlug = 'moose-docs'; branch = 'master'; 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'))

.gitignore

@@ -5,7 +5,6 @@
 *.pydevproject
 .project
 .metadata
-bin/
 tmp/
 *.tmp
 *.bak
@@ -19,8 +18,6 @@ local.properties
 # External tool builders
 .externalToolBuilders/
 
-# Locally stored "Eclipse launch configurations"
-*.launch
 
 # CDT-specific
 .cproject
@@ -47,7 +44,6 @@ local.properties
 [Rr]elease/
 x64/
 build/
-[Bb]in/
 [Oo]bj/
 
 # MSTest test Results
@@ -224,3 +220,4 @@ _gsdata_/
 #GITHUB
 .gitattributes
 .gitignore
+Moose Test Missions/MOOSE_Test_Template.miz

LICENSE

@@ -0,0 +1,674 @@
+                   GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    {one line to give the program's name and a brief idea of what it does.}
+    Copyright (C) {year}  {name of author}
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    {project}  Copyright (C) {year}  {fullname}
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

Moose Development/Dcs/DCSTask.lua

@@ -1,10 +0,0 @@
---- @module DCSTask
-
-
---- @type Task
--- @field #string id
--- @field #Task.param param
-
---- @type Task.param
-
-env.info( "Task defined" )

Moose Development/Dcs/Moose_Test_WRAPPER.lua

@@ -1,8 +0,0 @@
-
-Include.File( "Group" )
-Include.File( "Unit" )
-
-local UnitAirPlaneAI = _DATABASE:FindUnit( "Airplane AI" )
-
-UnitAirPlaneAI:FlareRed()
-

Moose Development/Debugger/MissionScripting.lua

@@ -0,0 +1,37 @@
+--Initialization script for the Mission lua Environment (SSE)
+
+dofile('Scripts/ScriptingSystem.lua')
+
+-- Add LuaSocket to the LUAPATH, so that it can be found.
+package.path  = package.path..";.\\LuaSocket\\?.lua;"
+
+-- Connect to the debugger, first require it.
+local initconnection = require("debugger")
+
+-- Now make the connection..
+-- "127.0.0.1" is the localhost.
+-- 10000 is the port. If you wanna use another port in LDT, change this number too!
+-- "dcsserver" is the name of the server. If you wanna use another name, change the name here too!
+-- nil (is for transport protocol, but not using this)
+-- "win" don't touch. But is important to indicate that we are in a windows environment to the debugger script. 
+initconnection( "127.0.0.1", 10000, "dcsserver", nil, "win", "" )
+
+
+--Sanitize Mission Scripting environment
+--This makes unavailable some unsecure functions. 
+--Mission downloaded from server to client may contain potentialy harmful lua code that may use these functions.
+--You can remove the code below and make availble these functions at your own risk.
+
+local function sanitizeModule(name)
+	_G[name] = nil
+	package.loaded[name] = nil
+end
+
+
+do
+	sanitizeModule('os')
+	--sanitizeModule('io')
+	sanitizeModule('lfs')
+	require = nil
+	loadlib = nil
+end

Moose Development/Debugger/READ.ME

@@ -0,0 +1,56 @@
+
+-- If you want to use the debugger, add 3 lines of extra code into MissionScripting.lua of DCS world.
+-- De-sanitize the io module. The debugger needs it.
+
+
+---------------------------------------------------------------------------------------------------------------------------
+-- MissionScripting.lua modifications
+---------------------------------------------------------------------------------------------------------------------------
+
+--    --Initialization script for the Mission lua Environment (SSE)
+--
+--    dofile('Scripts/ScriptingSystem.lua')
+--
+--    package.path  = package.path..";.\\LuaSocket\\?.lua;"
+--    local initconnection = require("debugger")
+--    initconnection( "127.0.0.1", 10000, "dcsserver", nil, "win", "" )
+--    
+--    --Sanitize Mission Scripting environment
+--    --This makes unavailable some unsecure functions. 
+--    --Mission downloaded from server to client may contain potentialy harmful lua code that may use these functions.
+--    --You can remove the code below and make availble these functions at your own risk.
+--    
+--    local function sanitizeModule(name)
+--      _G[name] = nil
+--      package.loaded[name] = nil
+--    end
+--    
+--    do
+--      sanitizeModule('os')
+--      --sanitizeModule('io')
+--      sanitizeModule('lfs')
+--      require = nil
+--      loadlib = nil
+--    end
+
+---------------------------------------------------------------------------------------------------------------------------
+---------------------------------------------------------------------------------------------------------------------------
+
+
+
+-- So for clarity, these are the three lines of code that matter!
+
+-- Add LuaSocket to the LUAPATH, so that it can be found.
+package.path  = package.path..";.\\LuaSocket\\?.lua;"
+
+-- Connect to the debugger, first require it.
+local initconnection = require("debugger")
+
+-- Now make the connection..
+-- "127.0.0.1" is the localhost.
+-- 10000 is the port. If you wanna use another port in LDT, change this number too!
+-- "dcsserver" is the name of the server. Ensure the same name is used at the Debug Configuration panel!
+-- nil (is for transport protocol, but not using this)
+-- "win" don't touch. But is important to indicate that we are in a windows environment to the debugger script. 
+initconnection( "127.0.0.1", 10000, "dcsserver", nil, "win", "" )
+

Moose Development/Moose/AI/AI_A2A.lua

@@ -0,0 +1,737 @@
+--- **AI** -- (R2.2) - Models the process of air operations for airplanes.
+-- 
+-- This is a class used in the @{AI_A2A_Dispatcher}.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===
+-- 
+-- @module AI_A2A
+
+--BASE:TraceClass("AI_A2A")
+
+
+--- @type AI_A2A
+-- @extends Core.Fsm#FSM_CONTROLLABLE
+
+--- # AI_A2A class, extends @{Fsm#FSM_CONTROLLABLE}
+-- 
+-- The AI_A2A class implements the core functions to operate an AI @{Group} A2A tasking.
+-- 
+-- 
+-- ## AI_A2A constructor
+--   
+--   * @{#AI_A2A.New}(): Creates a new AI_A2A object.
+-- 
+-- ## 2. AI_A2A is a FSM
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia2.JPG)
+-- 
+-- ### 2.1. AI_A2A States
+-- 
+--   * **None** ( Group ): The process is not started yet.
+--   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
+--   * **Returning** ( Group ): The AI is returning to Base.
+--   * **Stopped** ( Group ): The process is stopped.
+--   * **Crashed** ( Group ): The AI has crashed or is dead.
+-- 
+-- ### 2.2. AI_A2A Events
+-- 
+--   * **Start** ( Group ): Start the process.
+--   * **Stop** ( Group ): Stop the process.
+--   * **Route** ( Group ): Route the AI to a new random 3D point within the Patrol Zone.
+--   * **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.
+--    
+-- ## 3. Set or Get the AI controllable
+-- 
+--   * @{#AI_A2A.SetControllable}(): Set the AIControllable.
+--   * @{#AI_A2A.GetControllable}(): Get the AIControllable.
+--
+-- @field #AI_A2A
+AI_A2A = {
+  ClassName = "AI_A2A",
+}
+
+--- Creates a new AI_A2A object
+-- @param #AI_A2A self
+-- @param Wrapper.Group#GROUP AIGroup The GROUP object to receive the A2A Process.
+-- @return #AI_A2A
+function AI_A2A:New( AIGroup )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- #AI_A2A
+  
+  self:SetControllable( AIGroup )
+  
+  self:SetFuelThreshold( .2, 60 )
+  self:SetDamageThreshold( 0.4 )
+  self:SetDisengageRadius( 70000 )
+
+  self:SetStartState( "Stopped" ) 
+  
+  self:AddTransition( "*", "Start", "Started" )
+  
+  --- Start Handler OnBefore for AI_A2A
+  -- @function [parent=#AI_A2A] OnBeforeStart
+  -- @param #AI_A2A self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @return #boolean
+  
+  --- Start Handler OnAfter for AI_A2A
+  -- @function [parent=#AI_A2A] OnAfterStart
+  -- @param #AI_A2A self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  
+  --- Start Trigger for AI_A2A
+  -- @function [parent=#AI_A2A] Start
+  -- @param #AI_A2A self
+  
+  --- Start Asynchronous Trigger for AI_A2A
+  -- @function [parent=#AI_A2A] __Start
+  -- @param #AI_A2A self
+  -- @param #number Delay
+
+  self:AddTransition( "*", "Stop", "Stopped" )
+
+--- OnLeave Transition Handler for State Stopped.
+-- @function [parent=#AI_A2A] OnLeaveStopped
+-- @param #AI_A2A 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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Stopped.
+-- @function [parent=#AI_A2A] OnEnterStopped
+-- @param #AI_A2A 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.
+
+--- OnBefore Transition Handler for Event Stop.
+-- @function [parent=#AI_A2A] OnBeforeStop
+-- @param #AI_A2A 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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Stop.
+-- @function [parent=#AI_A2A] OnAfterStop
+-- @param #AI_A2A 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.
+	
+--- Synchronous Event Trigger for Event Stop.
+-- @function [parent=#AI_A2A] Stop
+-- @param #AI_A2A self
+
+--- Asynchronous Event Trigger for Event Stop.
+-- @function [parent=#AI_A2A] __Stop
+-- @param #AI_A2A self
+-- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Status", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A.
+
+--- OnBefore Transition Handler for Event Status.
+-- @function [parent=#AI_A2A] OnBeforeStatus
+-- @param #AI_A2A 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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Status.
+-- @function [parent=#AI_A2A] OnAfterStatus
+-- @param #AI_A2A 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.
+	
+--- Synchronous Event Trigger for Event Status.
+-- @function [parent=#AI_A2A] Status
+-- @param #AI_A2A self
+
+--- Asynchronous Event Trigger for Event Status.
+-- @function [parent=#AI_A2A] __Status
+-- @param #AI_A2A self
+-- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "RTB", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A.
+
+--- OnBefore Transition Handler for Event RTB.
+-- @function [parent=#AI_A2A] OnBeforeRTB
+-- @param #AI_A2A 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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event RTB.
+-- @function [parent=#AI_A2A] OnAfterRTB
+-- @param #AI_A2A 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.
+	
+--- Synchronous Event Trigger for Event RTB.
+-- @function [parent=#AI_A2A] RTB
+-- @param #AI_A2A self
+
+--- Asynchronous Event Trigger for Event RTB.
+-- @function [parent=#AI_A2A] __RTB
+-- @param #AI_A2A self
+-- @param #number Delay The delay in seconds.
+
+--- OnLeave Transition Handler for State Returning.
+-- @function [parent=#AI_A2A] OnLeaveReturning
+-- @param #AI_A2A 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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Returning.
+-- @function [parent=#AI_A2A] OnEnterReturning
+-- @param #AI_A2A 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.
+
+  self:AddTransition( "Patrolling", "Refuel", "Refuelling" ) 
+
+  --- Refuel Handler OnBefore for AI_A2A
+  -- @function [parent=#AI_A2A] OnBeforeRefuel
+  -- @param #AI_A2A self
+  -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @return #boolean
+  
+  --- Refuel Handler OnAfter for AI_A2A
+  -- @function [parent=#AI_A2A] OnAfterRefuel
+  -- @param #AI_A2A self
+  -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  
+  --- Refuel Trigger for AI_A2A
+  -- @function [parent=#AI_A2A] Refuel
+  -- @param #AI_A2A self
+  
+  --- Refuel Asynchronous Trigger for AI_A2A
+  -- @function [parent=#AI_A2A] __Refuel
+  -- @param #AI_A2A self
+  -- @param #number Delay
+
+  self:AddTransition( "*", "Takeoff", "Airborne" )
+  self:AddTransition( "*", "Return", "Returning" )
+  self:AddTransition( "*", "Hold", "Holding" )
+  self:AddTransition( "*", "Home", "Home" )
+  self:AddTransition( "*", "LostControl", "LostControl" )
+  self:AddTransition( "*", "Fuel", "Fuel" )
+  self:AddTransition( "*", "Damaged", "Damaged" )
+  self:AddTransition( "*", "Eject", "*" )
+  self:AddTransition( "*", "Crash", "Crashed" )
+  self:AddTransition( "*", "PilotDead", "*" )
+  
+  self.IdleCount = 0
+  
+  return self
+end
+
+--- @param Wrapper.Group#GROUP self
+-- @param Core.Event#EVENTDATA EventData
+function GROUP:OnEventTakeoff( EventData, Fsm )
+  Fsm:Takeoff()
+  self:UnHandleEvent( EVENTS.Takeoff )
+end
+
+function AI_A2A:SetDispatcher( Dispatcher )
+  self.Dispatcher = Dispatcher
+end
+
+function AI_A2A:GetDispatcher()
+  return self.Dispatcher
+end
+
+function AI_A2A:SetTargetDistance( Coordinate )
+
+  local CurrentCoord = self.Controllable:GetCoordinate()
+  self.TargetDistance = CurrentCoord:Get2DDistance( Coordinate )
+
+  self.ClosestTargetDistance = ( not self.ClosestTargetDistance or self.ClosestTargetDistance > self.TargetDistance ) and self.TargetDistance or self.ClosestTargetDistance
+end
+
+
+function AI_A2A:ClearTargetDistance()
+
+  self.TargetDistance = nil
+  self.ClosestTargetDistance = nil
+end
+
+
+--- Sets (modifies) the minimum and maximum speed of the patrol.
+-- @param #AI_A2A self
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @return #AI_A2A self
+function AI_A2A:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
+  self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
+  
+  self.PatrolMinSpeed = PatrolMinSpeed
+  self.PatrolMaxSpeed = PatrolMaxSpeed
+end
+
+
+--- Sets the floor and ceiling altitude of the patrol.
+-- @param #AI_A2A self
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @return #AI_A2A self
+function AI_A2A:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
+  self:F2( { PatrolFloorAltitude, PatrolCeilingAltitude } )
+  
+  self.PatrolFloorAltitude = PatrolFloorAltitude
+  self.PatrolCeilingAltitude = PatrolCeilingAltitude
+end
+
+
+--- Sets the home airbase.
+-- @param #AI_A2A self
+-- @param Wrapper.Airbase#AIRBASE HomeAirbase
+-- @return #AI_A2A self
+function AI_A2A:SetHomeAirbase( HomeAirbase )
+  self:F2( { HomeAirbase } )
+  
+  self.HomeAirbase = HomeAirbase
+end
+
+--- Sets to refuel at the given tanker.
+-- @param #AI_A2A self
+-- @param Wrapper.Group#GROUP TankerName The group name of the tanker as defined within the Mission Editor or spawned.
+-- @return #AI_A2A self
+function AI_A2A:SetTanker( TankerName )
+  self:F2( { TankerName } )
+  
+  self.TankerName = TankerName
+end
+
+
+--- Sets the disengage range, that when engaging a target beyond the specified range, the engagement will be cancelled and the plane will RTB.
+-- @param #AI_A2A self
+-- @param #number DisengageRadius The disengage range.
+-- @return #AI_A2A self
+function AI_A2A:SetDisengageRadius( DisengageRadius )
+  self:F2( { DisengageRadius } )
+  
+  self.DisengageRadius = DisengageRadius
+end
+
+--- Set the status checking off.
+-- @param #AI_A2A self
+-- @return #AI_A2A self
+function AI_A2A:SetStatusOff()
+  self:F2()
+  
+  self.CheckStatus = false
+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_A2A.
+-- Once the time is finished, the old AI will return to the base.
+-- @param #AI_A2A self
+-- @param #number PatrolFuelThresholdPercentage The treshold 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_A2A self
+function AI_A2A:SetFuelThreshold( PatrolFuelThresholdPercentage, PatrolOutOfFuelOrbitTime )
+
+  self.PatrolManageFuel = true
+  self.PatrolFuelThresholdPercentage = PatrolFuelThresholdPercentage
+  self.PatrolOutOfFuelOrbitTime = PatrolOutOfFuelOrbitTime
+  
+  self.Controllable:OptionRTBBingoFuel( false )
+  
+  return self
+end
+
+--- When the AI is damaged beyond a certain treshold, 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, 
+-- 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.
+-- @param #AI_A2A self
+-- @param #number PatrolDamageThreshold The treshold in percentage (between 0 and 1) when the AI is considered to be damaged.
+-- @return #AI_A2A self
+function AI_A2A:SetDamageThreshold( PatrolDamageThreshold )
+
+  self.PatrolManageDamage = true
+  self.PatrolDamageThreshold = PatrolDamageThreshold
+  
+  return self
+end
+
+--- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+-- @param #AI_A2A self
+-- @return #AI_A2A 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.
+function AI_A2A:onafterStart( Controllable, From, Event, To )
+  self:F2()
+
+  self:__Status( 10 ) -- Check status status every 30 seconds.
+  
+  self:HandleEvent( EVENTS.PilotDead, self.OnPilotDead )
+  self:HandleEvent( EVENTS.Crash, self.OnCrash )
+  self:HandleEvent( EVENTS.Ejection, self.OnEjection )
+  
+  Controllable:OptionROEHoldFire()
+  Controllable:OptionROTVertical()
+end
+
+
+
+--- @param #AI_A2A self
+function AI_A2A:onbeforeStatus()
+
+  return self.CheckStatus
+end
+
+--- @param #AI_A2A self
+function AI_A2A:onafterStatus()
+
+  self:F( " Checking Status" )
+
+  if self.Controllable and self.Controllable:IsAlive() then
+  
+    local RTB = false
+    
+    local DistanceFromHomeBase = self.HomeAirbase:GetCoordinate():Get2DDistance( self.Controllable:GetCoordinate() )
+    
+    if not self:Is( "Holding" ) and not self:Is( "Returning" ) then
+      local DistanceFromHomeBase = self.HomeAirbase:GetCoordinate():Get2DDistance( self.Controllable:GetCoordinate() )
+      self:F({DistanceFromHomeBase=DistanceFromHomeBase})
+      
+      if DistanceFromHomeBase > self.DisengageRadius then
+        self:E( self.Controllable:GetName() .. " is too far from home base, RTB!" )
+        self:Hold( 300 )
+        RTB = false
+      end
+    end
+    
+    if self:Is( "Fuel" ) or self:Is( "Damaged" ) or self:Is( "LostControl" ) then
+      if DistanceFromHomeBase < 5000 then
+        self:E( self.Controllable:GetName() .. " is too far from home base, RTB!" )
+        self:Home( "Destroy" )
+      end
+    end
+    
+
+    if not self:Is( "Fuel" ) and not self:Is( "Home" ) then
+      local Fuel = self.Controllable:GetFuel()
+      self:F({Fuel=Fuel})
+      if Fuel < self.PatrolFuelThresholdPercentage then
+        if self.TankerName then
+          self:E( self.Controllable:GetName() .. " is out of fuel: " .. Fuel .. " ... Refuelling at Tanker!" )
+          self:Refuel()
+        else
+          self:E( 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.PatrolOutOfFuelOrbitTime,nil ) )
+          OldAIControllable:SetTask( TimedOrbitTask, 10 )
+    
+          self:Fuel()
+          RTB = true
+        end
+      else
+      end
+    end
+    
+    -- TODO: Check GROUP damage function.
+    local Damage = self.Controllable:GetLife()
+    local InitialLife = self.Controllable:GetLife0()
+    self:F( { Damage = Damage, InitialLife = InitialLife, DamageThreshold = self.PatrolDamageThreshold } )
+    if ( Damage / InitialLife ) < self.PatrolDamageThreshold then
+      self:E( self.Controllable:GetName() .. " is damaged: " .. Damage .. " ... RTB!" )
+      self:Damaged()
+      RTB = true
+      self:SetStatusOff()
+    end
+
+    -- Check if planes went RTB and are out of control.
+    if self.Controllable:HasTask() == false then
+      if not self:Is( "Started" ) and 
+         not self:Is( "Stopped" ) and
+         not self:Is( "Home" ) then
+        if self.IdleCount >= 2 then
+          if Damage ~= InitialLife then
+            self:Damaged()
+          else  
+            self:E( self.Controllable:GetName() .. " control lost! " )
+            self:LostControl()
+          end
+        else
+          self.IdleCount = self.IdleCount + 1
+        end
+      end
+    else
+      self.IdleCount = 0
+    end
+
+    if RTB == true then
+      self:__RTB( 0.5 )
+    end
+    
+    self:__Status( 10 )
+  end
+end
+
+
+--- @param Wrapper.Group#GROUP AIGroup
+function AI_A2A.RTBRoute( AIGroup, Fsm )
+
+  AIGroup:F( { "AI_A2A.RTBRoute:", AIGroup:GetName() } )
+  
+  if AIGroup:IsAlive() then
+    Fsm:__RTB( 0.5 )
+  end
+  
+end
+
+--- @param Wrapper.Group#GROUP AIGroup
+function AI_A2A.RTBHold( AIGroup, Fsm )
+
+  AIGroup:F( { "AI_A2A.RTBHold:", AIGroup:GetName() } )
+  if AIGroup:IsAlive() then
+    Fsm:__RTB( 0.5 )
+    Fsm:Return()
+    local Task = AIGroup:TaskOrbitCircle( 4000, 400 )
+    AIGroup:SetTask( Task )
+  end
+  
+end
+
+
+--- @param #AI_A2A self
+-- @param Wrapper.Group#GROUP AIGroup
+function AI_A2A:onafterRTB( AIGroup, From, Event, To )
+  self:F( { AIGroup, From, Event, To } )
+
+  
+  if AIGroup and AIGroup:IsAlive() then
+
+    self:E( "Group " .. AIGroup:GetName() .. " ... RTB! ( " .. self:GetState() .. " )" )
+    
+    self:ClearTargetDistance()
+    AIGroup:ClearTasks()
+
+    local EngageRoute = {}
+
+    --- Calculate the target route point.
+    
+    local CurrentCoord = AIGroup:GetCoordinate()
+    local ToTargetCoord = self.HomeAirbase:GetCoordinate()
+    local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
+    local ToAirbaseAngle = CurrentCoord:GetAngleDegrees( CurrentCoord:GetDirectionVec3( ToTargetCoord ) )
+
+    local Distance = CurrentCoord:Get2DDistance( ToTargetCoord )
+    
+    local ToAirbaseCoord = CurrentCoord:Translate( 5000, ToAirbaseAngle )
+    if Distance < 5000 then
+      self:E( "RTB and near the airbase!" )
+      self:Home()
+      return
+    end
+    --- Create a route point of type air.
+    local ToRTBRoutePoint = ToAirbaseCoord:WaypointAir( 
+      self.PatrolAltType, 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      ToTargetSpeed, 
+      true 
+    )
+
+    self:F( { Angle = ToAirbaseAngle, ToTargetSpeed = ToTargetSpeed } )
+    self:T2( { self.MinSpeed, self.MaxSpeed, ToTargetSpeed } )
+    
+    EngageRoute[#EngageRoute+1] = ToRTBRoutePoint
+    EngageRoute[#EngageRoute+1] = ToRTBRoutePoint
+    
+    AIGroup:OptionROEHoldFire()
+    AIGroup:OptionROTEvadeFire()
+
+    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
+    AIGroup:WayPointInitialize( EngageRoute )
+  
+    local Tasks = {}
+    Tasks[#Tasks+1] = AIGroup:TaskFunction( "AI_A2A.RTBRoute", self )
+    EngageRoute[#EngageRoute].task = AIGroup:TaskCombo( Tasks )
+
+    --- NOW ROUTE THE GROUP!
+    AIGroup:Route( EngageRoute, 0.5 )
+      
+  end
+    
+end
+
+--- @param #AI_A2A self
+-- @param Wrapper.Group#GROUP AIGroup
+function AI_A2A:onafterHome( AIGroup, From, Event, To )
+  self:F( { AIGroup, From, Event, To } )
+
+  self:E( "Group " .. self.Controllable:GetName() .. " ... Home! ( " .. self:GetState() .. " )" )
+  
+  if AIGroup and AIGroup:IsAlive() then
+  end
+
+end
+
+
+
+--- @param #AI_A2A self
+-- @param Wrapper.Group#GROUP AIGroup
+function AI_A2A:onafterHold( AIGroup, From, Event, To, HoldTime )
+  self:F( { AIGroup, From, Event, To } )
+
+  self:E( "Group " .. self.Controllable:GetName() .. " ... Holding! ( " .. self:GetState() .. " )" )
+  
+  if AIGroup and AIGroup:IsAlive() then
+    local OrbitTask = AIGroup:TaskOrbitCircle( math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude ), self.PatrolMinSpeed )
+    local TimedOrbitTask = AIGroup:TaskControlled( OrbitTask, AIGroup:TaskCondition( nil, nil, nil, nil, HoldTime , nil ) )
+    
+    local RTBTask = AIGroup:TaskFunction( "AI_A2A.RTBHold", self )
+    
+    local OrbitHoldTask = AIGroup:TaskOrbitCircle( 4000, self.PatrolMinSpeed )
+    
+    --AIGroup:SetState( AIGroup, "AI_A2A", self )
+    
+    AIGroup:SetTask( AIGroup:TaskCombo( { TimedOrbitTask, RTBTask, OrbitHoldTask } ), 1 )
+  end
+
+end
+
+--- @param Wrapper.Group#GROUP AIGroup
+function AI_A2A.Resume( AIGroup, Fsm )
+
+  AIGroup:F( { "AI_A2A.Resume:", AIGroup:GetName() } )
+  if AIGroup:IsAlive() then
+    Fsm:__RTB( 0.5 )
+  end
+  
+end
+
+--- @param #AI_A2A self
+-- @param Wrapper.Group#GROUP AIGroup
+function AI_A2A:onafterRefuel( AIGroup, From, Event, To )
+  self:F( { AIGroup, From, Event, To } )
+
+  self:E( "Group " .. self.Controllable:GetName() .. " ... Refuelling! ( " .. self:GetState() .. " )" )
+  
+  if AIGroup and AIGroup:IsAlive() then
+    local Tanker = GROUP:FindByName( self.TankerName )
+    if Tanker:IsAlive() and Tanker:IsAirPlane() then
+
+      local RefuelRoute = {}
+  
+      --- Calculate the target route point.
+      
+      local CurrentCoord = AIGroup:GetCoordinate()
+      local ToRefuelCoord = Tanker:GetCoordinate()
+      local ToRefuelSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
+      
+      --- Create a route point of type air.
+      local ToRefuelRoutePoint = ToRefuelCoord:WaypointAir( 
+        self.PatrolAltType, 
+        POINT_VEC3.RoutePointType.TurningPoint, 
+        POINT_VEC3.RoutePointAction.TurningPoint, 
+        ToRefuelSpeed, 
+        true 
+      )
+  
+      self:F( { ToRefuelSpeed = ToRefuelSpeed } )
+      
+      RefuelRoute[#RefuelRoute+1] = ToRefuelRoutePoint
+      RefuelRoute[#RefuelRoute+1] = ToRefuelRoutePoint
+      
+      AIGroup:OptionROEHoldFire()
+      AIGroup:OptionROTEvadeFire()
+  
+      local Tasks = {}
+      Tasks[#Tasks+1] = AIGroup:TaskRefueling()
+      Tasks[#Tasks+1] = AIGroup:TaskFunction( self:GetClassName() .. ".Resume", self )
+      RefuelRoute[#RefuelRoute].task = AIGroup:TaskCombo( Tasks )
+  
+      AIGroup:Route( RefuelRoute, 0.5 )
+    else
+      self:RTB()
+    end
+  end
+
+end
+    
+
+
+--- @param #AI_A2A self
+function AI_A2A:onafterDead()
+  self:SetStatusOff()
+end
+
+
+--- @param #AI_A2A self
+-- @param Core.Event#EVENTDATA EventData
+function AI_A2A:OnCrash( EventData )
+
+  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
+    self:E( self.Controllable:GetUnits() )
+    if #self.Controllable:GetUnits() == 1 then
+      self:__Crash( 1, EventData )
+    end
+  end
+end
+
+--- @param #AI_A2A self
+-- @param Core.Event#EVENTDATA EventData
+function AI_A2A:OnEjection( EventData )
+
+  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
+    self:__Eject( 1, EventData )
+  end
+end
+
+--- @param #AI_A2A self
+-- @param Core.Event#EVENTDATA EventData
+function AI_A2A:OnPilotDead( EventData )
+
+  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
+    self:__PilotDead( 1, EventData )
+  end
+end

Moose Development/Moose/AI/AI_A2A_Cap.lua

@@ -0,0 +1,492 @@
+--- **AI** -- (R2.2) - Models the process of Combat Air Patrol (CAP) for airplanes.
+--
+-- This is a class used in the @{AI_A2A_Dispatcher}.
+--
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI_A2A_Cap
+
+--BASE:TraceClass("AI_A2A_CAP")
+
+--- @type AI_A2A_CAP
+-- @extends AI.AI_A2A_Patrol#AI_A2A_PATROL
+
+
+--- # AI_A2A_CAP class, extends @{AI_CAP#AI_PATROL_ZONE}
+-- 
+-- The AI_A2A_CAP class implements the core functions to patrol a @{Zone} by an AI @{Group} or @{Group} 
+-- and automatically engage any airborne enemies that are within a certain range or within a certain zone.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia3.JPG)
+-- 
+-- The AI_A2A_CAP is assigned a @{Group} and this must be done before the AI_A2A_CAP process can be started using the **Start** event.
+-- 
+-- ![Process](..\Presentations\AI_CAP\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_CAP\Dia5.JPG)
+-- 
+-- This cycle will continue.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia6.JPG)
+-- 
+-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
+--
+-- ![Process](..\Presentations\AI_CAP\Dia9.JPG)
+-- 
+-- When enemies are detected, the AI will automatically engage the enemy.
+-- 
+-- ![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.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia13.JPG)
+-- 
+-- ## 1. AI_A2A_CAP constructor
+--   
+--   * @{#AI_A2A_CAP.New}(): Creates a new AI_A2A_CAP object.
+-- 
+-- ## 2. AI_A2A_CAP is a FSM
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia2.JPG)
+-- 
+-- ### 2.1 AI_A2A_CAP States
+-- 
+--   * **None** ( Group ): The process is not started yet.
+--   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
+--   * **Engaging** ( Group ): The AI is engaging the bogeys.
+--   * **Returning** ( Group ): The AI is returning to Base..
+-- 
+-- ### 2.2 AI_A2A_CAP Events
+-- 
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
+--   * **@{#AI_A2A_CAP.Engage}**: Let the AI engage the bogeys.
+--   * **@{#AI_A2A_CAP.Abort}**: Aborts the engagement and return patrolling in the patrol zone.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_A2A_CAP.Destroy}**: The AI has destroyed a bogey @{Unit}.
+--   * **@{#AI_A2A_CAP.Destroyed}**: The AI has destroyed all bogeys @{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.
+--
+-- ## 3. Set the Range of Engagement
+-- 
+-- ![Range](..\Presentations\AI_CAP\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_CAP#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, 
+-- that will define when the AI will engage with the detected airborne enemy targets.
+-- Use the method @{AI_Cap#AI_A2A_CAP.SetEngageZone}() to define that Zone.
+--  
+-- ===
+-- 
+-- @field #AI_A2A_CAP
+AI_A2A_CAP = {
+  ClassName = "AI_A2A_CAP",
+}
+
+--- 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 Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#Speed  EngageMinSpeed The minimum speed of the @{Group} in km/h when engaging a target.
+-- @param Dcs.DCSTypes#Speed  EngageMaxSpeed The maximum speed of the @{Group} in km/h when engaging a target.
+-- @param Dcs.DCSTypes#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_A2A_CAP
+function AI_A2A_CAP:New( AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageMinSpeed, EngageMaxSpeed, PatrolAltType )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, AI_A2A_PATROL:New( AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) ) -- #AI_A2A_CAP
+
+  self.Accomplished = false
+  self.Engaging = false
+  
+  self.EngageMinSpeed = EngageMinSpeed
+  self.EngageMaxSpeed = EngageMaxSpeed
+  
+  self:AddTransition( { "Patrolling", "Engaging", "Returning", "Airborne" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
+
+  --- OnBefore Transition Handler for Event Engage.
+  -- @function [parent=#AI_A2A_CAP] OnBeforeEngage
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Engage.
+  -- @function [parent=#AI_A2A_CAP] OnAfterEngage
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_A2A_CAP] Engage
+  -- @param #AI_A2A_CAP self
+  
+  --- Asynchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_A2A_CAP] __Engage
+  -- @param #AI_A2A_CAP self
+  -- @param #number Delay The delay in seconds.
+
+--- OnLeave Transition Handler for State Engaging.
+-- @function [parent=#AI_A2A_CAP] OnLeaveEngaging
+-- @param #AI_A2A_CAP self
+-- @param Wrapper.Group#GROUP AICap The Group 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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Engaging.
+-- @function [parent=#AI_A2A_CAP] OnEnterEngaging
+-- @param #AI_A2A_CAP self
+-- @param Wrapper.Group#GROUP AICap The Group 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.
+
+  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
+  
+  --- OnBefore Transition Handler for Event Fired.
+  -- @function [parent=#AI_A2A_CAP] OnBeforeFired
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Fired.
+  -- @function [parent=#AI_A2A_CAP] OnAfterFired
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_A2A_CAP] Fired
+  -- @param #AI_A2A_CAP self
+  
+  --- Asynchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_A2A_CAP] __Fired
+  -- @param #AI_A2A_CAP self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
+
+  --- OnBefore Transition Handler for Event Destroy.
+  -- @function [parent=#AI_A2A_CAP] OnBeforeDestroy
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Destroy.
+  -- @function [parent=#AI_A2A_CAP] OnAfterDestroy
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_A2A_CAP] Destroy
+  -- @param #AI_A2A_CAP self
+  
+  --- Asynchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_A2A_CAP] __Destroy
+  -- @param #AI_A2A_CAP self
+  -- @param #number Delay The delay in seconds.
+
+
+  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
+
+  --- OnBefore Transition Handler for Event Abort.
+  -- @function [parent=#AI_A2A_CAP] OnBeforeAbort
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Abort.
+  -- @function [parent=#AI_A2A_CAP] OnAfterAbort
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_A2A_CAP] Abort
+  -- @param #AI_A2A_CAP self
+  
+  --- Asynchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_A2A_CAP] __Abort
+  -- @param #AI_A2A_CAP self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
+
+  --- OnBefore Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_A2A_CAP] OnBeforeAccomplish
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_A2A_CAP] OnAfterAccomplish
+  -- @param #AI_A2A_CAP self
+  -- @param Wrapper.Group#GROUP AICap The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_A2A_CAP] Accomplish
+  -- @param #AI_A2A_CAP self
+  
+  --- Asynchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_A2A_CAP] __Accomplish
+  -- @param #AI_A2A_CAP self
+  -- @param #number Delay The delay in seconds.  
+
+  return self
+end
+
+--- onafter State Transition for Event Patrol.
+-- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AICap The AI Group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_A2A_CAP:onafterStart( AICap, From, Event, To )
+
+  AICap:HandleEvent( EVENTS.Takeoff, nil, self )
+
+end
+
+--- Set the Engage Zone which defines where the AI will engage bogies. 
+-- @param #AI_A2A_CAP self
+-- @param Core.Zone#ZONE EngageZone The zone where the AI is performing CAP.
+-- @return #AI_A2A_CAP self
+function AI_A2A_CAP:SetEngageZone( EngageZone )
+  self:F2()
+
+  if EngageZone then  
+    self.EngageZone = EngageZone
+  else
+    self.EngageZone = nil
+  end
+end
+
+--- Set the Engage Range when the AI will engage with airborne enemies. 
+-- @param #AI_A2A_CAP self
+-- @param #number EngageRange The Engage Range.
+-- @return #AI_A2A_CAP self
+function AI_A2A_CAP:SetEngageRange( EngageRange )
+  self:F2()
+
+  if EngageRange then  
+    self.EngageRange = EngageRange
+  else
+    self.EngageRange = nil
+  end
+end
+
+--- onafter State Transition for Event Patrol.
+-- @param #AI_A2A_CAP self
+-- @param Wrapper.Group#GROUP AICap The AI Group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_A2A_CAP:onafterPatrol( AICap, From, Event, To )
+
+  -- Call the parent Start event handler
+  self:GetParent(self).onafterPatrol( self, AICap, From, Event, To )
+  self:HandleEvent( EVENTS.Dead )
+
+end
+
+-- todo: need to fix this global function
+
+--- @param Wrapper.Group#GROUP AICap
+function AI_A2A_CAP.AttackRoute( AICap, Fsm )
+
+  AICap:F( { "AI_A2A_CAP.AttackRoute:", AICap:GetName() } )
+
+  if AICap:IsAlive() then
+    Fsm:__Engage( 0.5 )
+  end
+end
+
+--- @param #AI_A2A_CAP self
+-- @param Wrapper.Group#GROUP AICap The Group 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.
+function AI_A2A_CAP:onbeforeEngage( AICap, From, Event, To )
+  
+  if self.Accomplished == true then
+    return false
+  end
+end
+
+--- @param #AI_A2A_CAP self
+-- @param Wrapper.Group#GROUP AICap The AI Group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_A2A_CAP:onafterAbort( AICap, From, Event, To )
+  AICap:ClearTasks()
+  self:__Route( 0.5 )
+end
+
+
+--- @param #AI_A2A_CAP self
+-- @param Wrapper.Group#GROUP AICap The AICap 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.
+function AI_A2A_CAP:onafterEngage( AICap, From, Event, To, AttackSetUnit )
+
+  self:F( { AICap, From, Event, To, AttackSetUnit} )
+
+  self.AttackSetUnit = AttackSetUnit or self.AttackSetUnit -- Core.Set#SET_UNIT
+  
+  local FirstAttackUnit = self.AttackSetUnit:GetFirst() -- Wrapper.Unit#UNIT
+  
+  if FirstAttackUnit and FirstAttackUnit:IsAlive() then -- If there is no attacker anymore, stop the engagement.
+  
+    if AICap:IsAlive() then
+
+      local EngageRoute = {}
+
+      --- Calculate the target route point.
+      local CurrentCoord = AICap:GetCoordinate()
+      local ToTargetCoord = self.AttackSetUnit:GetFirst():GetCoordinate()
+      local ToTargetSpeed = math.random( self.EngageMinSpeed, self.EngageMaxSpeed )
+      local ToInterceptAngle = CurrentCoord:GetAngleDegrees( CurrentCoord:GetDirectionVec3( ToTargetCoord ) )
+      
+      --- Create a route point of type air.
+      local ToPatrolRoutePoint = CurrentCoord:Translate( 5000, ToInterceptAngle ):WaypointAir( 
+        self.PatrolAltType, 
+        POINT_VEC3.RoutePointType.TurningPoint, 
+        POINT_VEC3.RoutePointAction.TurningPoint, 
+        ToTargetSpeed, 
+        true 
+      )
+  
+      self:F( { Angle = ToInterceptAngle, ToTargetSpeed = ToTargetSpeed } )
+      self:T2( { self.MinSpeed, self.MaxSpeed, ToTargetSpeed } )
+      
+      EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
+      EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
+
+      local AttackTasks = {}
+  
+      for AttackUnitID, AttackUnit in pairs( self.AttackSetUnit:GetSet() ) do
+        local AttackUnit = AttackUnit -- Wrapper.Unit#UNIT
+        self:T( { "Attacking Unit:", AttackUnit:GetName(), AttackUnit:IsAlive(), AttackUnit:IsAir() } )
+        if AttackUnit:IsAlive() and AttackUnit:IsAir() then
+          AttackTasks[#AttackTasks+1] = AICap:TaskAttackUnit( AttackUnit )
+        end
+      end
+  
+      if #AttackTasks == 0 then
+        self:E("No targets found -> Going back to Patrolling")
+        self:__Abort( 0.5 )
+      else
+        AICap:OptionROEOpenFire()
+        AICap:OptionROTEvadeFire()
+
+        AttackTasks[#AttackTasks+1] = AICap:TaskFunction( "AI_A2A_CAP.AttackRoute", self )
+        EngageRoute[#EngageRoute].task = AICap:TaskCombo( AttackTasks )
+      end
+      
+      AICap:Route( EngageRoute, 0.5 )
+    end
+  else
+    self:E("No targets found -> Going back to Patrolling")
+    self:__Abort( 0.5 )
+  end
+end
+
+--- @param #AI_A2A_CAP self
+-- @param Wrapper.Group#GROUP AICap The Group 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.
+function AI_A2A_CAP:onafterAccomplish( AICap, From, Event, To )
+  self.Accomplished = true
+  self:SetDetectionOff()
+end
+
+--- @param #AI_A2A_CAP self
+-- @param Wrapper.Group#GROUP AICap The Group 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.
+-- @param Core.Event#EVENTDATA EventData
+function AI_A2A_CAP:onafterDestroy( AICap, From, Event, To, EventData )
+
+  if EventData.IniUnit then
+    self.AttackUnits[EventData.IniUnit] = nil
+  end
+end
+
+--- @param #AI_A2A_CAP self
+-- @param Core.Event#EVENTDATA EventData
+function AI_A2A_CAP:OnEventDead( EventData )
+  self:F( { "EventDead", EventData } )
+
+  if EventData.IniDCSUnit then
+    if self.AttackUnits and self.AttackUnits[EventData.IniUnit] then
+      self:__Destroy( 1, EventData )
+    end
+  end  
+end
+
+--- @param Wrapper.Group#GROUP AICap
+function AI_A2A_CAP.Resume( AICap )
+
+  AICap:F( { "AI_A2A_CAP.Resume:", AICap:GetName() } )
+  if AICap:IsAlive() then
+    local _AI_A2A = AICap:GetState( AICap, "AI_A2A" ) -- #AI_A2A
+      _AI_A2A:__Reset( 1 )
+      _AI_A2A:__Route( 5 )
+  end
+  
+end

Moose Development/Moose/AI/AI_A2A_Gci.lua

@@ -0,0 +1,462 @@
+--- **AI** -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.
+--
+-- This is a class used in the @{AI_A2A_Dispatcher}.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI_A2A_GCI
+
+
+
+--- @type AI_A2A_GCI
+-- @extends AI.AI_A2A#AI_A2A
+
+
+--- # AI_A2A_GCI class, extends @{AI_A2A#AI_A2A}
+-- 
+-- The AI_A2A_GCI class implements the core functions to intercept intruders. The Engage function will intercept intruders.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia3.JPG)
+-- 
+-- The AI_A2A_GCI is assigned a @{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)
+-- 
+-- ## 1. AI_A2A_GCI constructor
+--   
+--   * @{#AI_A2A_GCI.New}(): Creates a new AI_A2A_GCI object.
+-- 
+-- ## 2. AI_A2A_GCI is a FSM
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia2.JPG)
+-- 
+-- ### 2.1 AI_A2A_GCI States
+-- 
+--   * **None** ( Group ): The process is not started yet.
+--   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
+--   * **Engaging** ( Group ): The AI is engaging the bogeys.
+--   * **Returning** ( Group ): The AI is returning to Base..
+-- 
+-- ### 2.2 AI_A2A_GCI Events
+-- 
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
+--   * **@{#AI_A2A_GCI.Engage}**: Let the AI engage the bogeys.
+--   * **@{#AI_A2A_GCI.Abort}**: Aborts the engagement and return patrolling in the patrol zone.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_A2A_GCI.Destroy}**: The AI has destroyed a bogey @{Unit}.
+--   * **@{#AI_A2A_GCI.Destroyed}**: The AI has destroyed all bogeys @{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.
+--
+-- ## 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_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_Cap#AI_A2A_GCI.SetEngageZone}() to define that Zone.
+--  
+-- ===
+-- 
+-- @field #AI_A2A_GCI
+AI_A2A_GCI = {
+  ClassName = "AI_A2A_GCI",
+}
+
+
+
+--- Creates a new AI_A2A_GCI object
+-- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept
+-- @return #AI_A2A_GCI
+function AI_A2A_GCI:New( AIIntercept, EngageMinSpeed, EngageMaxSpeed )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, AI_A2A:New( AIIntercept ) ) -- #AI_A2A_GCI
+
+  self.Accomplished = false
+  self.Engaging = false
+  
+  self.EngageMinSpeed = EngageMinSpeed
+  self.EngageMaxSpeed = EngageMaxSpeed
+  self.PatrolMinSpeed = EngageMinSpeed
+  self.PatrolMaxSpeed = EngageMaxSpeed
+  
+  self.PatrolAltType = "RADIO"
+  
+  self:AddTransition( { "Started", "Engaging", "Returning", "Airborne" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
+
+  --- OnBefore Transition Handler for Event Engage.
+  -- @function [parent=#AI_A2A_GCI] OnBeforeEngage
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Engage.
+  -- @function [parent=#AI_A2A_GCI] OnAfterEngage
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_A2A_GCI] Engage
+  -- @param #AI_A2A_GCI self
+  
+  --- Asynchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_A2A_GCI] __Engage
+  -- @param #AI_A2A_GCI self
+  -- @param #number Delay The delay in seconds.
+
+--- OnLeave Transition Handler for State Engaging.
+-- @function [parent=#AI_A2A_GCI] OnLeaveEngaging
+-- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept The Group 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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Engaging.
+-- @function [parent=#AI_A2A_GCI] OnEnterEngaging
+-- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept The Group 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.
+
+  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
+  
+  --- OnBefore Transition Handler for Event Fired.
+  -- @function [parent=#AI_A2A_GCI] OnBeforeFired
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Fired.
+  -- @function [parent=#AI_A2A_GCI] OnAfterFired
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_A2A_GCI] Fired
+  -- @param #AI_A2A_GCI self
+  
+  --- Asynchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_A2A_GCI] __Fired
+  -- @param #AI_A2A_GCI self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
+
+  --- OnBefore Transition Handler for Event Destroy.
+  -- @function [parent=#AI_A2A_GCI] OnBeforeDestroy
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Destroy.
+  -- @function [parent=#AI_A2A_GCI] OnAfterDestroy
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_A2A_GCI] Destroy
+  -- @param #AI_A2A_GCI self
+  
+  --- Asynchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_A2A_GCI] __Destroy
+  -- @param #AI_A2A_GCI self
+  -- @param #number Delay The delay in seconds.
+
+
+  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
+
+  --- OnBefore Transition Handler for Event Abort.
+  -- @function [parent=#AI_A2A_GCI] OnBeforeAbort
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Abort.
+  -- @function [parent=#AI_A2A_GCI] OnAfterAbort
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_A2A_GCI] Abort
+  -- @param #AI_A2A_GCI self
+  
+  --- Asynchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_A2A_GCI] __Abort
+  -- @param #AI_A2A_GCI self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
+
+  --- OnBefore Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_A2A_GCI] OnBeforeAccomplish
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_A2A_GCI] OnAfterAccomplish
+  -- @param #AI_A2A_GCI self
+  -- @param Wrapper.Group#GROUP AIIntercept The Group 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.
+  	
+  --- Synchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_A2A_GCI] Accomplish
+  -- @param #AI_A2A_GCI self
+  
+  --- Asynchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_A2A_GCI] __Accomplish
+  -- @param #AI_A2A_GCI self
+  -- @param #number Delay The delay in seconds.  
+
+  return self
+end
+
+--- onafter State Transition for Event Patrol.
+-- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept The AI Group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_A2A_GCI:onafterStart( AIIntercept, From, Event, To )
+
+  AIIntercept:HandleEvent( EVENTS.Takeoff, nil, self )
+
+end
+
+
+
+--- onafter State Transition for Event Patrol.
+-- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept The AI Group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_A2A_GCI:onafterEngage( AIIntercept, From, Event, To )
+
+  self:HandleEvent( EVENTS.Dead )
+
+end
+
+-- todo: need to fix this global function
+
+--- @param Wrapper.Group#GROUP AIControllable
+function AI_A2A_GCI.InterceptRoute( AIIntercept, Fsm )
+
+  AIIntercept:F( { "AI_A2A_GCI.InterceptRoute:", AIIntercept:GetName() } )
+  
+  if AIIntercept:IsAlive() then
+    Fsm:__Engage( 0.5 )
+  
+    --local Task = AIIntercept:TaskOrbitCircle( 4000, 400 )
+    --AIIntercept:SetTask( Task )
+  end
+end
+
+--- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept The Group 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.
+function AI_A2A_GCI:onbeforeEngage( AIIntercept, From, Event, To )
+  
+  if self.Accomplished == true then
+    return false
+  end
+end
+
+--- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept The AI Group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_A2A_GCI:onafterAbort( AIIntercept, From, Event, To )
+  AIIntercept:ClearTasks()
+  self:Return()
+  self:__RTB( 0.5 )
+end
+
+
+--- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept The GroupGroup managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_A2A_GCI:onafterEngage( AIIntercept, From, Event, To, AttackSetUnit )
+
+  self:F( { AIIntercept, From, Event, To, AttackSetUnit} )
+
+  self.AttackSetUnit = AttackSetUnit or self.AttackSetUnit -- Core.Set#SET_UNIT
+  
+  local FirstAttackUnit = self.AttackSetUnit:GetFirst()
+  
+  if FirstAttackUnit and FirstAttackUnit:IsAlive() then
+
+    if AIIntercept:IsAlive() then
+  
+      local EngageRoute = {}
+      
+      local CurrentCoord = AIIntercept:GetCoordinate()
+  
+      --- Calculate the target route point.
+      
+      local CurrentCoord = AIIntercept:GetCoordinate()
+      
+      local ToTargetCoord = self.AttackSetUnit:GetFirst():GetCoordinate()
+      self:SetTargetDistance( ToTargetCoord ) -- For RTB status check
+      
+      local ToTargetSpeed = math.random( self.EngageMinSpeed, self.EngageMaxSpeed )
+      local ToInterceptAngle = CurrentCoord:GetAngleDegrees( CurrentCoord:GetDirectionVec3( ToTargetCoord ) )
+      
+      --- Create a route point of type air.
+      local ToPatrolRoutePoint = CurrentCoord:Translate( 15000, ToInterceptAngle ):WaypointAir( 
+        self.PatrolAltType, 
+        POINT_VEC3.RoutePointType.TurningPoint, 
+        POINT_VEC3.RoutePointAction.TurningPoint, 
+        ToTargetSpeed, 
+        true 
+      )
+  
+      self:F( { Angle = ToInterceptAngle, ToTargetSpeed = ToTargetSpeed } )
+      self:F( { self.EngageMinSpeed, self.EngageMaxSpeed, ToTargetSpeed } )
+      
+      EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
+      EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
+      
+      local AttackTasks = {}
+  
+      for AttackUnitID, AttackUnit in pairs( self.AttackSetUnit:GetSet() ) do
+        local AttackUnit = AttackUnit -- Wrapper.Unit#UNIT
+        if AttackUnit:IsAlive() and AttackUnit:IsAir() then
+          self:T( { "Intercepting Unit:", AttackUnit:GetName(), AttackUnit:IsAlive(), AttackUnit:IsAir() } )
+          AttackTasks[#AttackTasks+1] = AIIntercept:TaskAttackUnit( AttackUnit )
+        end
+      end
+        
+      if #AttackTasks == 0 then
+        self:E("No targets found -> Going RTB")
+        self:Return()
+        self:__RTB( 0.5 )
+      else
+        AIIntercept:OptionROEOpenFire()
+        AIIntercept:OptionROTEvadeFire()
+
+        AttackTasks[#AttackTasks+1] = AIIntercept:TaskFunction( "AI_A2A_GCI.InterceptRoute", self )
+        EngageRoute[#EngageRoute].task = AIIntercept:TaskCombo( AttackTasks )
+      end
+      
+      AIIntercept:Route( EngageRoute, 0.5 )
+    
+    end
+  else
+    self:E("No targets found -> Going RTB")
+    self:Return()
+    self:__RTB( 0.5 )
+  end
+end
+
+--- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept The Group 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.
+function AI_A2A_GCI:onafterAccomplish( AIIntercept, From, Event, To )
+  self.Accomplished = true
+  self:SetDetectionOff()
+end
+
+--- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept The Group 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.
+-- @param Core.Event#EVENTDATA EventData
+function AI_A2A_GCI:onafterDestroy( AIIntercept, From, Event, To, EventData )
+
+  if EventData.IniUnit then
+    self.AttackUnits[EventData.IniUnit] = nil
+  end
+end
+
+--- @param #AI_A2A_GCI self
+-- @param Core.Event#EVENTDATA EventData
+function AI_A2A_GCI:OnEventDead( EventData )
+  self:F( { "EventDead", EventData } )
+
+  if EventData.IniDCSUnit then
+    if self.AttackUnits and self.AttackUnits[EventData.IniUnit] then
+      self:__Destroy( 1, EventData )
+    end
+  end  
+end

Moose Development/Moose/AI/AI_A2A_Patrol.lua

@@ -0,0 +1,366 @@
+--- **AI** -- (R2.2) - Models the process of air patrol of airplanes.
+-- 
+-- This is a class used in the @{AI_A2A_Dispatcher}.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===
+-- 
+-- @module AI_A2A_Patrol
+
+
+--- @type AI_A2A_PATROL
+-- @extends AI.AI_A2A#AI_A2A
+
+--- # AI_A2A_PATROL class, extends @{Fsm#FSM_CONTROLLABLE}
+-- 
+-- The AI_A2A_PATROL class implements the core functions to patrol a @{Zone} by an AI @{Group} or @{Group}.
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia3.JPG)
+-- 
+-- The AI_A2A_PATROL is assigned a @{Group} and this must be done before the AI_A2A_PATROL process can be started using the **Start** event.
+-- 
+-- ![Process](..\Presentations\AI_PATROL\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_PATROL\Dia5.JPG)
+-- 
+-- This cycle will continue.
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia6.JPG)
+-- 
+-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
+--
+-- ![Process](..\Presentations\AI_PATROL\Dia9.JPG)
+-- 
+---- Note that the enemy is not engaged! To model enemy engagement, either tailor the **Detected** event, or
+-- use derived AI_ classes to model AI offensive or defensive behaviour.
+-- 
+-- ![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.
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia11.JPG)
+-- 
+-- ## 1. AI_A2A_PATROL constructor
+--   
+--   * @{#AI_A2A_PATROL.New}(): Creates a new AI_A2A_PATROL object.
+-- 
+-- ## 2. AI_A2A_PATROL is a FSM
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia2.JPG)
+-- 
+-- ### 2.1. AI_A2A_PATROL States
+-- 
+--   * **None** ( Group ): The process is not started yet.
+--   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
+--   * **Returning** ( Group ): The AI is returning to Base.
+--   * **Stopped** ( Group ): The process is stopped.
+--   * **Crashed** ( Group ): The AI has crashed or is dead.
+-- 
+-- ### 2.2. AI_A2A_PATROL Events
+-- 
+--   * **Start** ( Group ): Start the process.
+--   * **Stop** ( Group ): Stop the process.
+--   * **Route** ( Group ): Route the AI to a new random 3D point within the Patrol Zone.
+--   * **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.
+--    
+-- ## 3. Set or Get the AI controllable
+-- 
+--   * @{#AI_A2A_PATROL.SetControllable}(): Set the AIControllable.
+--   * @{#AI_A2A_PATROL.GetControllable}(): Get the AIControllable.
+--
+-- ## 4. Set the Speed and Altitude boundaries of the AI controllable
+--
+--   * @{#AI_A2A_PATROL.SetSpeed}(): Set the patrol speed boundaries of the AI, for the next patrol.
+--   * @{#AI_A2A_PATROL.SetAltitude}(): Set altitude boundaries of the AI, for the next patrol.
+-- 
+-- ## 5. Manage the detection process of the AI controllable
+-- 
+-- The detection process of the AI controllable can be manipulated.
+-- Detection requires an amount of CPU power, which has an impact on your mission performance.
+-- Only put detection on when absolutely necessary, and the frequency of the detection can also be set.
+-- 
+--   * @{#AI_A2A_PATROL.SetDetectionOn}(): Set the detection on. The AI will detect for targets.
+--   * @{#AI_A2A_PATROL.SetDetectionOff}(): Set the detection off, the AI will not detect for targets. The existing target list will NOT be erased.
+-- 
+-- The detection frequency can be set with @{#AI_A2A_PATROL.SetRefreshTimeInterval}( seconds ), where the amount of seconds specify how much seconds will be waited before the next detection.
+-- Use the method @{#AI_A2A_PATROL.GetDetectedUnits}() to obtain a list of the @{Unit}s detected by the AI.
+-- 
+-- The detection can be filtered to potential targets in a specific zone.
+-- Use the method @{#AI_A2A_PATROL.SetDetectionZone}() to set the zone where targets need to be detected.
+-- Note that when the zone is too far away, or the AI is not heading towards the zone, or the AI is too high, no targets may be detected
+-- according the weather conditions.
+-- 
+-- ## 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.
+-- 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).
+-- Use the method @{#AI_A2A_PATROL.ManageDamage}() to have this proces in place.
+-- 
+-- ===
+-- 
+-- @field #AI_A2A_PATROL
+AI_A2A_PATROL = {
+  ClassName = "AI_A2A_PATROL",
+}
+
+--- Creates a new AI_A2A_PATROL object
+-- @param #AI_A2A_PATROL self
+-- @param Wrapper.Group#GROUP AIPatrol
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_A2A_PATROL self
+-- @usage
+-- -- Define a new AI_A2A_PATROL Object. This PatrolArea will patrol a Group within PatrolZone between 3000 and 6000 meters, with a variying speed between 600 and 900 km/h.
+-- PatrolZone = ZONE:New( 'PatrolZone' )
+-- PatrolSpawn = SPAWN:New( 'Patrol Group' )
+-- PatrolArea = AI_A2A_PATROL:New( PatrolZone, 3000, 6000, 600, 900 )
+function AI_A2A_PATROL:New( AIPatrol, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, AI_A2A:New( AIPatrol ) ) -- #AI_A2A_PATROL
+  
+  self.PatrolZone = PatrolZone
+  self.PatrolFloorAltitude = PatrolFloorAltitude
+  self.PatrolCeilingAltitude = PatrolCeilingAltitude
+  self.PatrolMinSpeed = PatrolMinSpeed
+  self.PatrolMaxSpeed = PatrolMaxSpeed
+  
+  -- 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.
+-- @function [parent=#AI_A2A_PATROL] OnBeforePatrol
+-- @param #AI_A2A_PATROL self
+-- @param Wrapper.Group#GROUP AIPatrol The Group 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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Patrol.
+-- @function [parent=#AI_A2A_PATROL] OnAfterPatrol
+-- @param #AI_A2A_PATROL self
+-- @param Wrapper.Group#GROUP AIPatrol The Group 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.
+	
+--- Synchronous Event Trigger for Event Patrol.
+-- @function [parent=#AI_A2A_PATROL] Patrol
+-- @param #AI_A2A_PATROL self
+
+--- Asynchronous Event Trigger for Event Patrol.
+-- @function [parent=#AI_A2A_PATROL] __Patrol
+-- @param #AI_A2A_PATROL self
+-- @param #number Delay The delay in seconds.
+
+--- OnLeave Transition Handler for State Patrolling.
+-- @function [parent=#AI_A2A_PATROL] OnLeavePatrolling
+-- @param #AI_A2A_PATROL self
+-- @param Wrapper.Group#GROUP AIPatrol The Group 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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Patrolling.
+-- @function [parent=#AI_A2A_PATROL] OnEnterPatrolling
+-- @param #AI_A2A_PATROL self
+-- @param Wrapper.Group#GROUP AIPatrol The Group 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.
+
+  self:AddTransition( "Patrolling", "Route", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_PATROL.
+
+--- OnBefore Transition Handler for Event Route.
+-- @function [parent=#AI_A2A_PATROL] OnBeforeRoute
+-- @param #AI_A2A_PATROL self
+-- @param Wrapper.Group#GROUP AIPatrol The Group 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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Route.
+-- @function [parent=#AI_A2A_PATROL] OnAfterRoute
+-- @param #AI_A2A_PATROL self
+-- @param Wrapper.Group#GROUP AIPatrol The Group 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.
+	
+--- Synchronous Event Trigger for Event Route.
+-- @function [parent=#AI_A2A_PATROL] Route
+-- @param #AI_A2A_PATROL self
+
+--- Asynchronous Event Trigger for Event Route.
+-- @function [parent=#AI_A2A_PATROL] __Route
+-- @param #AI_A2A_PATROL self
+-- @param #number Delay The delay in seconds.
+
+
+
+  self:AddTransition( "*", "Reset", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_PATROL.
+  
+  return self
+end
+
+
+
+
+--- Sets (modifies) the minimum and maximum speed of the patrol.
+-- @param #AI_A2A_PATROL self
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Group} in km/h.
+-- @return #AI_A2A_PATROL self
+function AI_A2A_PATROL:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
+  self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
+  
+  self.PatrolMinSpeed = PatrolMinSpeed
+  self.PatrolMaxSpeed = PatrolMaxSpeed
+end
+
+
+
+--- Sets the floor and ceiling altitude of the patrol.
+-- @param #AI_A2A_PATROL self
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @return #AI_A2A_PATROL self
+function AI_A2A_PATROL:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
+  self:F2( { PatrolFloorAltitude, PatrolCeilingAltitude } )
+  
+  self.PatrolFloorAltitude = PatrolFloorAltitude
+  self.PatrolCeilingAltitude = PatrolCeilingAltitude
+end
+
+
+--- Defines a new patrol route using the @{Process_PatrolZone} 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.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_A2A_PATROL:onafterPatrol( AIPatrol, From, Event, To )
+  self:F2()
+
+  self:ClearTargetDistance()
+
+  self:__Route( 1 )
+  
+  AIPatrol:OnReSpawn(
+    function( PatrolGroup )
+      self:__Reset( 1 )
+      self:__Route( 5 )
+    end
+  )
+end
+
+
+
+--- @param Wrapper.Group#GROUP AIPatrol
+-- This statis method is called from the route path within the last task at the last waaypoint of the AIPatrol.
+-- Note that this method is required, as triggers the next route when patrolling for the AIPatrol.
+function AI_A2A_PATROL.PatrolRoute( AIPatrol, Fsm )
+
+  AIPatrol:F( { "AI_A2A_PATROL.PatrolRoute:", AIPatrol:GetName() } )
+
+  if AIPatrol:IsAlive() then
+    Fsm:Route()
+  end
+  
+end
+
+
+--- Defines a new patrol route using the @{Process_PatrolZone} 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.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_A2A_PATROL:onafterRoute( AIPatrol, From, Event, To )
+
+  self:F2()
+
+  -- When RTB, don't allow anymore the routing.
+  if From == "RTB" then
+    return
+  end
+
+  
+  if AIPatrol:IsAlive() then
+    
+    local PatrolRoute = {}
+
+    --- Calculate the target route point.
+    
+    local CurrentCoord = AIPatrol:GetCoordinate()
+    
+    local ToTargetCoord = self.PatrolZone:GetRandomPointVec2()
+    ToTargetCoord:SetAlt( math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude ) )
+    self:SetTargetDistance( ToTargetCoord ) -- For RTB status check
+    
+    local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
+    
+    --- Create a route point of type air.
+    local ToPatrolRoutePoint = ToTargetCoord:WaypointAir( 
+      self.PatrolAltType, 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      ToTargetSpeed, 
+      true 
+    )
+
+    PatrolRoute[#PatrolRoute+1] = ToPatrolRoutePoint
+    PatrolRoute[#PatrolRoute+1] = ToPatrolRoutePoint
+    
+    local Tasks = {}
+    Tasks[#Tasks+1] = AIPatrol:TaskFunction( "AI_A2A_PATROL.PatrolRoute", self )
+    PatrolRoute[#PatrolRoute].task = AIPatrol:TaskCombo( Tasks )
+    
+    AIPatrol:OptionROEReturnFire()
+    AIPatrol:OptionROTEvadeFire()
+
+    AIPatrol:Route( PatrolRoute, 0.5 )
+  end
+
+end
+
+--- @param Wrapper.Group#GROUP AIPatrol
+function AI_A2A_PATROL.Resume( AIPatrol )
+
+  AIPatrol:F( { "AI_A2A_PATROL.Resume:", AIPatrol:GetName() } )
+  if AIPatrol:IsAlive() then
+    local _AI_A2A = AIPatrol:GetState( AIPatrol, "AI_A2A" ) -- #AI_A2A
+      _AI_A2A:__Reset( 1 )
+      _AI_A2A:__Route( 5 )
+  end
+  
+end

Moose Development/Moose/AI/AI_BAI.lua

@@ -0,0 +1,644 @@
+--- **AI** -- (R2.1) - Manages the independent process of Battlefield Air Interdiction (bombing) for airplanes.
+--
+-- ===
+--
+-- ![Banner Image](..\Presentations\AI_BAI\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/BAI%20-%20Battlefield%20Air%20Interdiction)
+-- 
+-- ===
+-- 
+-- ### [YouTube Playlist]()
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- ### Contributions: 
+-- 
+--   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
+-- 
+-- ===
+--
+-- @module AI_Bai
+
+
+--- AI_BAI_ZONE class
+-- @type AI_BAI_ZONE
+-- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Controllable} patrolling.
+-- @field Core.Zone#ZONE_BASE TargetZone The @{Zone} where the patrol needs to be executed.
+-- @extends AI.AI_Patrol#AI_PATROL_ZONE
+
+--- # AI_BAI_ZONE class, extends @{AI_Patrol#AI_PATROL_ZONE}
+-- 
+-- AI_BAI_ZONE derives from the @{AI_Patrol#AI_PATROL_ZONE}, inheriting its methods and behaviour.
+--  
+-- The AI_BAI_ZONE class implements the core functions to provide BattleGround Air Interdiction in an Engage @{Zone} by an AIR @{Controllable} or @{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.
+-- 
+-- ![HoldAndEngage](..\Presentations\AI_BAI\Dia3.JPG)
+-- 
+-- The AI_BAI_ZONE is assigned a @{Group} and this must be done before the AI_BAI_ZONE process can be started through the **Start** event.
+--  
+-- ![Start Event](..\Presentations\AI_BAI\Dia4.JPG)
+-- 
+-- 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.
+-- 
+-- ![Route Event](..\Presentations\AI_BAI\Dia5.JPG)
+-- 
+-- When the AI is commanded to provide BattleGround Air Interdiction (through the event **Engage**), the AI will fly towards the Engage Zone.
+-- Any target that is detected in the Engage Zone will be reported and will be destroyed by the AI.
+-- 
+-- ![Engage Event](..\Presentations\AI_BAI\Dia6.JPG)
+-- 
+-- The AI will detect the targets and will only destroy the targets within the Engage Zone.
+-- 
+-- ![Engage Event](..\Presentations\AI_BAI\Dia7.JPG)
+-- 
+-- Every target that is destroyed, is reported< by the AI.
+-- 
+-- ![Engage Event](..\Presentations\AI_BAI\Dia8.JPG)
+-- 
+-- Note that the AI does not know when the Engage Zone is cleared, and therefore will keep circling in the zone. 
+--
+-- ![Engage Event](..\Presentations\AI_BAI\Dia9.JPG)
+-- 
+-- Until it is notified through the event **Accomplish**, which is to be triggered by an observing party:
+-- 
+--   * a FAC
+--   * a timed event
+--   * a menu option selected by a human
+--   * a condition
+--   * others ...
+-- 
+-- ![Engage Event](..\Presentations\AI_BAI\Dia10.JPG)
+-- 
+-- When the AI has accomplished the Bombing, it will fly back to the Patrol Zone.
+-- 
+-- ![Engage Event](..\Presentations\AI_BAI\Dia11.JPG)
+-- 
+-- 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.
+-- 
+-- ![Engage Event](..\Presentations\AI_BAI\Dia12.JPG)
+--
+-- # 1. AI_BAI_ZONE constructor
+--
+--   * @{#AI_BAI_ZONE.New}(): Creates a new AI_BAI_ZONE object.
+--
+-- ## 2. AI_BAI_ZONE is a FSM
+-- 
+-- ![Process](..\Presentations\AI_BAI\Dia2.JPG)
+-- 
+-- ### 2.1. AI_BAI_ZONE States
+-- 
+--   * **None** ( Group ): The process is not started yet.
+--   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
+--   * **Engaging** ( Group ): The AI is engaging the targets in the Engage Zone, executing BOMB.
+--   * **Returning** ( Group ): The AI is returning to Base..
+-- 
+-- ### 2.2. AI_BAI_ZONE Events
+-- 
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
+--   * **@{#AI_BAI_ZONE.Engage}**: Engage the AI to provide BOMB in the Engage Zone, destroying any target it finds.
+--   * **@{#AI_BAI_ZONE.Abort}**: Aborts the engagement and return patrolling in the patrol zone.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_BAI_ZONE.Destroy}**: The AI has destroyed a target @{Unit}.
+--   * **@{#AI_BAI_ZONE.Destroyed}**: The AI has destroyed all target @{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.
+-- 
+-- ## 3. Modify the Engage Zone behaviour to pinpoint a **map object** or **scenery object**
+-- 
+-- Use the method @{#AI_BAI_ZONE.SearchOff}() to specify that the EngageZone is not to be searched for potential targets (UNITs), but that the center of the zone
+-- is the point where a map object is to be destroyed (like a bridge).
+-- 
+-- Example:
+-- 
+--      -- Tell the BAI not to search for potential targets in the BAIEngagementZone, but rather use the center of the BAIEngagementZone as the bombing location.
+--      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.
+-- 
+-- ===
+-- 
+-- @field #AI_BAI_ZONE
+AI_BAI_ZONE = {
+  ClassName = "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 Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @param Core.Zone#ZONE_BASE EngageZone The zone where the engage will happen.
+-- @param Dcs.DCSTypes#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_BAI_ZONE self
+function AI_BAI_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageZone, PatrolAltType )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) ) -- #AI_BAI_ZONE
+
+  self.EngageZone = EngageZone
+  self.Accomplished = false
+  
+  self:SetDetectionZone( self.EngageZone )
+  self:SearchOn()
+
+  self:AddTransition( { "Patrolling", "Engaging" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
+
+  --- OnBefore Transition Handler for Event Engage.
+  -- @function [parent=#AI_BAI_ZONE] OnBeforeEngage
+  -- @param #AI_BAI_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Engage.
+  -- @function [parent=#AI_BAI_ZONE] OnAfterEngage
+  -- @param #AI_BAI_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.
+  	
+  --- Synchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_BAI_ZONE] Engage
+  -- @param #AI_BAI_ZONE self
+  -- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
+  -- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+  -- @param Dcs.DCSTypes#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. 
+  -- If parameter is not defined the unit / controllable will choose expend on its own discretion.
+  -- Use the structure @{DCSTypes#AI.Task.WeaponExpend} to define the amount of weapons to be release at each attack.
+  -- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
+  -- @param Dcs.DCSTypes#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+  
+  --- Asynchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_BAI_ZONE] __Engage
+  -- @param #AI_BAI_ZONE self
+  -- @param #number Delay The delay in seconds.
+  -- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
+  -- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+  -- @param Dcs.DCSTypes#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. 
+  -- If parameter is not defined the unit / controllable will choose expend on its own discretion.
+  -- Use the structure @{DCSTypes#AI.Task.WeaponExpend} to define the amount of weapons to be release at each attack.
+  -- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
+  -- @param Dcs.DCSTypes#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+
+--- OnLeave Transition Handler for State Engaging.
+-- @function [parent=#AI_BAI_ZONE] OnLeaveEngaging
+-- @param #AI_BAI_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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Engaging.
+-- @function [parent=#AI_BAI_ZONE] OnEnterEngaging
+-- @param #AI_BAI_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.
+
+  self:AddTransition( "Engaging", "Target", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
+
+  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
+  
+  --- OnBefore Transition Handler for Event Fired.
+  -- @function [parent=#AI_BAI_ZONE] OnBeforeFired
+  -- @param #AI_BAI_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Fired.
+  -- @function [parent=#AI_BAI_ZONE] OnAfterFired
+  -- @param #AI_BAI_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.
+  	
+  --- Synchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_BAI_ZONE] Fired
+  -- @param #AI_BAI_ZONE self
+  
+  --- Asynchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_BAI_ZONE] __Fired
+  -- @param #AI_BAI_ZONE self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
+
+  --- OnBefore Transition Handler for Event Destroy.
+  -- @function [parent=#AI_BAI_ZONE] OnBeforeDestroy
+  -- @param #AI_BAI_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Destroy.
+  -- @function [parent=#AI_BAI_ZONE] OnAfterDestroy
+  -- @param #AI_BAI_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.
+  	
+  --- Synchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_BAI_ZONE] Destroy
+  -- @param #AI_BAI_ZONE self
+  
+  --- Asynchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_BAI_ZONE] __Destroy
+  -- @param #AI_BAI_ZONE self
+  -- @param #number Delay The delay in seconds.
+
+
+  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
+
+  --- OnBefore Transition Handler for Event Abort.
+  -- @function [parent=#AI_BAI_ZONE] OnBeforeAbort
+  -- @param #AI_BAI_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Abort.
+  -- @function [parent=#AI_BAI_ZONE] OnAfterAbort
+  -- @param #AI_BAI_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.
+  	
+  --- Synchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_BAI_ZONE] Abort
+  -- @param #AI_BAI_ZONE self
+  
+  --- Asynchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_BAI_ZONE] __Abort
+  -- @param #AI_BAI_ZONE self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
+
+  --- OnBefore Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_BAI_ZONE] OnBeforeAccomplish
+  -- @param #AI_BAI_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_BAI_ZONE] OnAfterAccomplish
+  -- @param #AI_BAI_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.
+  	
+  --- Synchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_BAI_ZONE] Accomplish
+  -- @param #AI_BAI_ZONE self
+  
+  --- Asynchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_BAI_ZONE] __Accomplish
+  -- @param #AI_BAI_ZONE self
+  -- @param #number Delay The delay in seconds.  
+
+  return self
+end
+
+
+--- Set the Engage Zone where the AI is performing BOMB. Note that if the EngageZone is changed, the AI needs to re-detect targets.
+-- @param #AI_BAI_ZONE self
+-- @param Core.Zone#ZONE EngageZone The zone where the AI is performing BOMB.
+-- @return #AI_BAI_ZONE self
+function AI_BAI_ZONE:SetEngageZone( EngageZone )
+  self:F2()
+
+  if EngageZone then  
+    self.EngageZone = EngageZone
+  else
+    self.EngageZone = nil
+  end
+end
+
+
+--- Specifies whether to search for potential targets in the zone, or let the center of the zone be the bombing coordinate.
+-- AI_BAI_ZONE will search for potential targets by default.
+-- @param #AI_BAI_ZONE self
+-- @return #AI_BAI_ZONE
+function AI_BAI_ZONE:SearchOnOff( Search )
+
+  self.Search = Search
+  
+  return self
+end
+
+--- If Search is Off, the current zone coordinate will be the center of the bombing.
+-- @param #AI_BAI_ZONE self
+-- @return #AI_BAI_ZONE
+function AI_BAI_ZONE:SearchOff()
+
+  self:SearchOnOff( false )
+
+  return self
+end
+
+
+--- If Search is On, BAI will search for potential targets in the zone.
+-- @param #AI_BAI_ZONE self
+-- @return #AI_BAI_ZONE
+function AI_BAI_ZONE:SearchOn()
+
+  self:SearchOnOff( true )
+
+  return self
+end
+
+
+--- onafter State Transition for Event Start.
+-- @param #AI_BAI_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.
+function AI_BAI_ZONE:onafterStart( Controllable, From, Event, To )
+
+  -- Call the parent Start event handler
+  self:GetParent(self).onafterStart( self, Controllable, From, Event, To )
+  self:HandleEvent( EVENTS.Dead )
+  
+  self:SetDetectionDeactivated() -- When not engaging, set the detection off.
+end
+
+--- @param Wrapper.Controllable#CONTROLLABLE AIControllable
+function _NewEngageRoute( AIControllable )
+
+  AIControllable:T( "NewEngageRoute" )
+  local EngageZone = AIControllable:GetState( AIControllable, "EngageZone" ) -- AI.AI_BAI#AI_BAI_ZONE
+  EngageZone:__Engage( 1, EngageZone.EngageSpeed, EngageZone.EngageAltitude, EngageZone.EngageWeaponExpend, EngageZone.EngageAttackQty, EngageZone.EngageDirection )
+end
+
+
+--- @param #AI_BAI_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.
+function AI_BAI_ZONE:onbeforeEngage( Controllable, From, Event, To )
+  
+  if self.Accomplished == true then
+    return false
+  end
+end
+
+--- @param #AI_BAI_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.
+function AI_BAI_ZONE:onafterTarget( Controllable, From, Event, To )
+  self:F({"onafterTarget",self.Search,Controllable:IsAlive()})
+  
+  
+
+  if Controllable:IsAlive() then
+
+    local AttackTasks = {}
+
+    if self.Search == true then
+      for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
+        local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
+        if DetectedUnit:IsAlive() then
+          if DetectedUnit:IsInZone( self.EngageZone ) then
+            if Detected == true then
+              self:F( {"Target: ", DetectedUnit } )
+              self.DetectedUnits[DetectedUnit] = false
+              local AttackTask = Controllable:TaskAttackUnit( DetectedUnit, false, self.EngageWeaponExpend, self.EngageAttackQty, self.EngageDirection, self.EngageAltitude, nil )
+              self.Controllable:PushTask( AttackTask, 1 )
+            end
+          end
+        else
+          self.DetectedUnits[DetectedUnit] = nil
+        end
+      end
+    else
+      self:F("Attack zone")
+      local AttackTask = Controllable:TaskAttackMapObject( 
+        self.EngageZone:GetPointVec2():GetVec2(),
+        true, 
+        self.EngageWeaponExpend, 
+        self.EngageAttackQty, 
+        self.EngageDirection,
+        self.EngageAltitude
+      )
+      self.Controllable:PushTask( AttackTask, 1 )
+    end
+
+    self:__Target( -10 )
+
+  end
+end
+
+
+--- @param #AI_BAI_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.
+function AI_BAI_ZONE:onafterAbort( Controllable, From, Event, To )
+  Controllable:ClearTasks()
+  self:__Route( 1 )
+end
+
+--- @param #AI_BAI_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.
+-- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
+-- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+-- @param Dcs.DCSTypes#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.
+-- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
+-- @param Dcs.DCSTypes#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+function AI_BAI_ZONE:onafterEngage( Controllable, From, Event, To, 
+                                    EngageSpeed, 
+                                    EngageAltitude, 
+                                    EngageWeaponExpend, 
+                                    EngageAttackQty, 
+                                    EngageDirection )
+
+  self:F("onafterEngage")
+
+  self.EngageSpeed = EngageSpeed or 400
+  self.EngageAltitude = EngageAltitude or 2000
+  self.EngageWeaponExpend = EngageWeaponExpend
+  self.EngageAttackQty = EngageAttackQty
+  self.EngageDirection = EngageDirection
+
+  if Controllable:IsAlive() then
+
+    local EngageRoute = {}
+
+    --- Calculate the current route point.
+    local CurrentVec2 = self.Controllable:GetVec2()
+    
+    --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+    local CurrentAltitude = self.Controllable:GetUnit(1):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, 
+        self.EngageSpeed, 
+        true 
+      )
+    
+    EngageRoute[#EngageRoute+1] = CurrentRoutePoint
+
+    local AttackTasks = {}
+    
+    if self.Search == true then
+  
+      for DetectedUnitID, DetectedUnitData in pairs( self.DetectedUnits ) do
+        local DetectedUnit = DetectedUnitData -- Wrapper.Unit#UNIT
+        self:T( DetectedUnit )
+        if DetectedUnit:IsAlive() then
+          if DetectedUnit:IsInZone( self.EngageZone ) then
+            self:F( {"Engaging ", DetectedUnit } )
+            AttackTasks[#AttackTasks+1] = Controllable:TaskBombing( 
+              DetectedUnit:GetPointVec2():GetVec2(),
+              true, 
+              EngageWeaponExpend, 
+              EngageAttackQty, 
+              EngageDirection,
+              EngageAltitude 
+            )
+          end
+        else
+          self.DetectedUnits[DetectedUnit] = nil
+        end
+      end
+    else
+      self:F("Attack zone")
+      AttackTasks[#AttackTasks+1] = Controllable:TaskAttackMapObject( 
+        self.EngageZone:GetPointVec2():GetVec2(),
+        true, 
+        EngageWeaponExpend, 
+        EngageAttackQty, 
+        EngageDirection,
+        EngageAltitude 
+      )
+    end
+
+    EngageRoute[#EngageRoute].task = Controllable:TaskCombo( AttackTasks )
+
+    --- Define a random point in the @{Zone}. The AI will fly to that point within the zone.
+    
+      --- Find a random 2D point in EngageZone.
+    local ToTargetVec2 = self.EngageZone:GetRandomVec2()
+    self:T2( ToTargetVec2 )
+
+    --- Obtain a 3D @{Point} from the 2D point + altitude.
+    local ToTargetPointVec3 = POINT_VEC3:New( ToTargetVec2.x, self.EngageAltitude, ToTargetVec2.y )
+    
+    --- Create a route point of type air.
+    local ToTargetRoutePoint = ToTargetPointVec3:WaypointAir( 
+      self.PatrolAltType, 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      self.EngageSpeed, 
+      true 
+    )
+    
+    EngageRoute[#EngageRoute+1] = ToTargetRoutePoint
+
+    Controllable:OptionROEOpenFire()
+    Controllable:OptionROTVertical()
+
+    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
+    Controllable:WayPointInitialize( EngageRoute )
+    
+    --- Do a trick, link the NewEngageRoute function of the object to the AIControllable in a temporary variable ...
+    Controllable:SetState( Controllable, "EngageZone", self )
+
+    Controllable:WayPointFunction( #EngageRoute, 1, "_NewEngageRoute" )
+
+    --- NOW ROUTE THE GROUP!
+    Controllable:WayPointExecute( 1 )
+
+    self:SetRefreshTimeInterval( 2 )
+    self:SetDetectionActivated()
+    self:__Target( -2 ) -- Start Targetting
+  end
+end
+
+
+--- @param #AI_BAI_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.
+function AI_BAI_ZONE:onafterAccomplish( Controllable, From, Event, To )
+  self.Accomplished = true
+  self:SetDetectionDeactivated()
+end
+
+
+--- @param #AI_BAI_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.
+-- @param Core.Event#EVENTDATA EventData
+function AI_BAI_ZONE:onafterDestroy( Controllable, From, Event, To, EventData )
+
+  if EventData.IniUnit then
+    self.DetectedUnits[EventData.IniUnit] = nil
+  end
+end
+
+
+--- @param #AI_BAI_ZONE self
+-- @param Core.Event#EVENTDATA EventData
+function AI_BAI_ZONE:OnEventDead( EventData )
+  self:F( { "EventDead", EventData } )
+
+  if EventData.IniDCSUnit then
+    if self.DetectedUnits and self.DetectedUnits[EventData.IniUnit] then
+      self:__Destroy( 1, EventData )
+    end
+  end
+end
+
+

Moose Development/Moose/AI/AI_Balancer.lua

@@ -0,0 +1,298 @@
+--- **AI** -- (2.1) - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players. 
+-- 
+-- ===
+-- 
+-- ![Banner Image](..\Presentations\AI_Balancer\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/AIB%20-%20AI%20Balancing)
+-- 
+-- ===
+-- 
+-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl2CJVIrL1TdAumuVS8n64B7)
+-- 
+-- ===
+-- 
+-- ### 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 :-)
+-- 
+-- ===
+-- 
+-- @module AI_Balancer
+
+--- @type AI_BALANCER
+-- @field Core.Set#SET_CLIENT SetClient
+-- @field Core.Spawn#SPAWN SpawnAI
+-- @field Wrapper.Group#GROUP Test
+-- @extends Core.Fsm#FSM_SET
+
+
+--- # AI_BALANCER class, extends @{Fsm#FSM_SET}
+-- 
+-- The AI_BALANCER class monitors and manages as many replacement AI groups as there are
+-- CLIENTS in a SET_CLIENT collection, which are not occupied by human players. 
+-- In other words, use AI_BALANCER to simulate human behaviour by spawning in replacement AI in multi player missions.
+-- 
+-- The parent class @{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.
+-- 
+-- The mission designer can tailor the AI_BALANCER behaviour, by implementing a state or event handling method for the following:
+-- 
+--   * @{#AI_BALANCER.OnAfterSpawned}( AISet, From, Event, To, AIGroup ): Define to add extra logic when an AI is spawned.
+-- 
+-- ## 1. AI_BALANCER construction
+-- 
+-- Create a new AI_BALANCER object with the @{#AI_BALANCER.New}() method:
+-- 
+-- ## 2. AI_BALANCER is a FSM
+-- 
+-- ![Process](..\Presentations\AI_Balancer\Dia13.JPG)
+-- 
+-- ### 2.1. AI_BALANCER States
+-- 
+--   * **Monitoring** ( Set ): Monitoring the Set if all AI is spawned for the Clients.
+--   * **Spawning** ( Set, ClientName ): There is a new AI group spawned with ClientName as the name of reference.
+--   * **Spawned** ( Set, AIGroup ): A new AI has been spawned. You can handle this event to customize the AI behaviour with other AI FSMs or own processes.
+--   * **Destroying** ( Set, AIGroup ): The AI is being destroyed.
+--   * **Returning** ( Set, AIGroup ): The AI is returning to the airbase specified by the ReturnToAirbase methods. Handle this state to customize the return behaviour of the AI, if any.
+-- 
+-- ### 2.2. AI_BALANCER Events
+-- 
+--   * **Monitor** ( Set ): Every 10 seconds, the Monitor event is triggered to monitor the Set.
+--   * **Spawn** ( Set, ClientName ): Triggers when there is a new AI group to be spawned with ClientName as the name of reference.
+--   * **Spawned** ( Set, AIGroup ): Triggers when a new AI has been spawned. You can handle this event to customize the AI behaviour with other AI FSMs or own processes.
+--   * **Destroy** ( Set, AIGroup ): The AI is being destroyed.
+--   * **Return** ( Set, AIGroup ): The AI is returning to the airbase specified by the ReturnToAirbase methods.
+--    
+-- ## 3. AI_BALANCER spawn interval for replacement AI
+-- 
+-- Use the method @{#AI_BALANCER.InitSpawnInterval}() to set the earliest and latest interval in seconds that is waited until a new replacement AI is spawned.
+-- 
+-- ## 4. AI_BALANCER returns AI to Airbases
+-- 
+-- By default, When a human player joins a slot that is AI_BALANCED, the AI group will be destroyed by default. 
+-- However, there are 2 additional options that you can use to customize the destroy behaviour.
+-- When a human player joins a slot, you can configure to let the AI return to:
+-- 
+--    * @{#AI_BALANCER.ReturnToHomeAirbase}: Returns the AI to the **home** @{Airbase#AIRBASE}.
+--    * @{#AI_BALANCER.ReturnToNearestAirbases}: Returns the AI to the **nearest friendly** @{Airbase#AIRBASE}.
+-- 
+-- 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.
+-- 
+-- @field #AI_BALANCER
+AI_BALANCER = {
+  ClassName = "AI_BALANCER",
+  PatrolZones = {},
+  AIGroups = {},
+  Earliest = 5, -- Earliest a new AI can be spawned is in 5 seconds.
+  Latest = 60, -- Latest a new AI can be spawned is in 60 seconds.
+}
+
+
+
+--- Creates a new AI_BALANCER object
+-- @param #AI_BALANCER self
+-- @param Core.Set#SET_CLIENT SetClient A SET\_CLIENT object that will contain the CLIENT objects to be monitored if they are alive or not (joined by a player).
+-- @param Core.Spawn#SPAWN SpawnAI The default Spawn object to spawn new AI Groups when needed.
+-- @return #AI_BALANCER
+function AI_BALANCER:New( SetClient, SpawnAI )
+  
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, FSM_SET:New( SET_GROUP:New() ) ) -- AI.AI_Balancer#AI_BALANCER
+  
+  -- TODO: Define the OnAfterSpawned event
+  self:SetStartState( "None" )
+  self:AddTransition( "*", "Monitor", "Monitoring" )
+  self:AddTransition( "*", "Spawn", "Spawning" )
+  self:AddTransition( "Spawning", "Spawned", "Spawned" )
+  self:AddTransition( "*", "Destroy", "Destroying" )
+  self:AddTransition( "*", "Return", "Returning" )
+  
+  self.SetClient = SetClient
+  self.SetClient:FilterOnce()
+  self.SpawnAI = SpawnAI
+  
+  self.SpawnQueue = {}
+
+  self.ToNearestAirbase = false
+  self.ToHomeAirbase = false
+  
+  self:__Monitor( 1 )
+
+  return self
+end
+
+--- Sets the earliest to the latest interval in seconds how long AI_BALANCER will wait to spawn a new AI.
+-- Provide 2 identical seconds if the interval should be a fixed amount of seconds.
+-- @param #AI_BALANCER self
+-- @param #number Earliest The earliest a new AI can be spawned in seconds.
+-- @param #number Latest The latest a new AI can be spawned in seconds.
+-- @return self
+function AI_BALANCER:InitSpawnInterval( Earliest, Latest )
+
+  self.Earliest = Earliest
+  self.Latest = Latest
+  
+  return self
+end
+
+--- Returns the AI to the nearest friendly @{Airbase#AIRBASE}.
+-- @param #AI_BALANCER self
+-- @param Dcs.DCSTypes#Distance ReturnThresholdRange If there is an enemy @{Client#CLIENT} within the ReturnThresholdRange given in meters, the AI will not return to the nearest @{Airbase#AIRBASE}.
+-- @param Core.Set#SET_AIRBASE ReturnAirbaseSet The SET of @{Set#SET_AIRBASE}s to evaluate where to return to.
+function AI_BALANCER:ReturnToNearestAirbases( ReturnThresholdRange, ReturnAirbaseSet )
+
+  self.ToNearestAirbase = true
+  self.ReturnThresholdRange = ReturnThresholdRange
+  self.ReturnAirbaseSet = ReturnAirbaseSet
+end
+
+--- Returns the AI to the home @{Airbase#AIRBASE}.
+-- @param #AI_BALANCER self
+-- @param Dcs.DCSTypes#Distance ReturnThresholdRange If there is an enemy @{Client#CLIENT} within the ReturnThresholdRange given in meters, the AI will not return to the nearest @{Airbase#AIRBASE}.
+function AI_BALANCER:ReturnToHomeAirbase( ReturnThresholdRange )
+
+  self.ToHomeAirbase = true
+  self.ReturnThresholdRange = ReturnThresholdRange
+end
+
+--- @param #AI_BALANCER self
+-- @param Core.Set#SET_GROUP SetGroup
+-- @param #string ClientName
+-- @param Wrapper.Group#GROUP AIGroup
+function AI_BALANCER:onenterSpawning( SetGroup, From, Event, To, ClientName )
+
+  -- OK, Spawn a new group from the default SpawnAI object provided.
+  local AIGroup = self.SpawnAI:Spawn() -- Wrapper.Group#GROUP
+  if AIGroup then
+    AIGroup:T( { "Spawning new AIGroup", ClientName = ClientName } )
+    --TODO: need to rework UnitName thing ...
+    
+    SetGroup:Remove( ClientName ) -- Ensure that the previously allocated AIGroup to ClientName is removed in the Set.
+    SetGroup:Add( ClientName, AIGroup )
+    self.SpawnQueue[ClientName] = nil
+    
+    -- Fire the Spawned event. The first parameter is the AIGroup just Spawned.
+    -- Mission designers can catch this event to bind further actions to the AIGroup.
+    self:Spawned( AIGroup )
+  end
+end
+
+--- @param #AI_BALANCER self
+-- @param Core.Set#SET_GROUP SetGroup
+-- @param Wrapper.Group#GROUP AIGroup
+function AI_BALANCER:onenterDestroying( SetGroup, From, Event, To, ClientName, AIGroup )
+
+  AIGroup:Destroy()
+  SetGroup:Flush( self )
+  SetGroup:Remove( ClientName )
+  SetGroup:Flush( self )
+end
+
+--- @param #AI_BALANCER self
+-- @param Core.Set#SET_GROUP SetGroup
+-- @param Wrapper.Group#GROUP AIGroup
+function AI_BALANCER:onenterReturning( SetGroup, From, Event, To, AIGroup )
+
+    local AIGroupTemplate = AIGroup:GetTemplate()
+    if self.ToHomeAirbase == true then
+      local WayPointCount = #AIGroupTemplate.route.points
+      local SwitchWayPointCommand = AIGroup:CommandSwitchWayPoint( 1, WayPointCount, 1 )
+      AIGroup:SetCommand( SwitchWayPointCommand )
+      AIGroup:MessageToRed( "Returning to home base ...", 30 )
+    else
+      -- Okay, we need to send this Group back to the nearest base of the Coalition of the AI.
+      --TODO: i need to rework the POINT_VEC2 thing.
+      local PointVec2 = POINT_VEC2:New( AIGroup:GetVec2().x, AIGroup:GetVec2().y  )
+      local ClosestAirbase = self.ReturnAirbaseSet:FindNearestAirbaseFromPointVec2( PointVec2 )
+      self:T( ClosestAirbase.AirbaseName )
+      AIGroup:MessageToRed( "Returning to " .. ClosestAirbase:GetName().. " ...", 30 )
+      local RTBRoute = AIGroup:RouteReturnToAirbase( ClosestAirbase )
+      AIGroupTemplate.route = RTBRoute
+      AIGroup:Respawn( AIGroupTemplate )
+    end
+
+end
+
+
+--- @param #AI_BALANCER self
+function AI_BALANCER:onenterMonitoring( SetGroup )
+
+  self:T2( { self.SetClient:Count() } )
+  --self.SetClient:Flush()
+
+  self.SetClient:ForEachClient(
+    --- @param Wrapper.Client#CLIENT Client
+    function( Client )
+      self:T3(Client.ClientName)
+
+      local AIGroup = self.Set:Get( Client.UnitName ) -- Wrapper.Group#GROUP
+      if AIGroup then self:T( { AIGroup = AIGroup:GetName(), IsAlive = AIGroup:IsAlive() } ) end
+      if Client:IsAlive() == true then
+
+        if AIGroup and AIGroup:IsAlive() == true then
+
+          if self.ToNearestAirbase == false and self.ToHomeAirbase == false then
+            self:Destroy( Client.UnitName, AIGroup )
+          else
+            -- We test if there is no other CLIENT within the self.ReturnThresholdRange of the first unit of the AI group.
+            -- If there is a CLIENT, the AI stays engaged and will not return.
+            -- If there is no CLIENT within the self.ReturnThresholdRange, then the unit will return to the Airbase return method selected.
+
+            local PlayerInRange = { Value = false }          
+            local RangeZone = ZONE_RADIUS:New( 'RangeZone', AIGroup:GetVec2(), self.ReturnThresholdRange )
+            
+            self:T2( RangeZone )
+            
+            _DATABASE:ForEachPlayerUnit(
+              --- @param Wrapper.Unit#UNIT RangeTestUnit
+              function( RangeTestUnit, RangeZone, AIGroup, PlayerInRange )
+                self:T2( { PlayerInRange, RangeTestUnit.UnitName, RangeZone.ZoneName } )
+                if RangeTestUnit:IsInZone( RangeZone ) == true then
+                  self:T2( "in zone" )
+                  if RangeTestUnit:GetCoalition() ~= AIGroup:GetCoalition() then
+                    self:T2( "in range" )
+                    PlayerInRange.Value = true
+                  end
+                end
+              end,
+              
+              --- @param Core.Zone#ZONE_RADIUS RangeZone
+              -- @param Wrapper.Group#GROUP AIGroup
+              function( RangeZone, AIGroup, PlayerInRange )
+                if PlayerInRange.Value == false then
+                  self:Return( AIGroup )
+                end
+              end
+              , RangeZone, AIGroup, PlayerInRange
+            )
+            
+          end
+          self.Set:Remove( Client.UnitName )
+        end
+      else
+        if not AIGroup or not AIGroup:IsAlive() == true then
+          self:T( "Client " .. Client.UnitName .. " not alive." )
+          self:T( { Queue = self.SpawnQueue[Client.UnitName] } )
+          if not self.SpawnQueue[Client.UnitName] then
+            -- Spawn a new AI taking into account the spawn interval Earliest, Latest
+            self:__Spawn( math.random( self.Earliest, self.Latest ), Client.UnitName )
+            self.SpawnQueue[Client.UnitName] = true
+            self:T( "New AI Spawned for Client " .. Client.UnitName )
+          end
+        end
+      end
+      return true
+    end
+  )
+  
+  self:__Monitor( 10 )
+end
+
+
+

Moose Development/Moose/AI/AI_CAP.lua

@@ -0,0 +1,546 @@
+--- **AI** -- (R2.1) - Manages the independent process of Combat Air Patrol (CAP) for airplanes.
+--
+-- ===
+--
+-- ![Banner Image](..\Presentations\AI_CAP\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAP%20-%20Combat%20Air%20Patrol)
+-- 
+-- ===
+-- 
+-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl1YCyPxJgoZn-CfhwyeW65L)
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- ### Contributions: 
+--
+--   * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing.
+--   * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing.
+--   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
+--   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing.
+--   * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing. 
+-- 
+-- ===       
+--
+-- @module AI_Cap
+
+
+--- @type AI_CAP_ZONE
+-- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Controllable} patrolling.
+-- @field Core.Zone#ZONE_BASE TargetZone The @{Zone} where the patrol needs to be executed.
+-- @extends AI.AI_Patrol#AI_PATROL_ZONE
+
+
+--- # AI_CAP_ZONE class, extends @{AI_CAP#AI_PATROL_ZONE}
+-- 
+-- The AI_CAP_ZONE class implements the core functions to patrol a @{Zone} by an AI @{Controllable} or @{Group} 
+-- and automatically engage any airborne enemies that are within a certain range or within a certain zone.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia3.JPG)
+-- 
+-- The AI_CAP_ZONE is assigned a @{Group} and this must be done before the AI_CAP_ZONE process can be started using the **Start** event.
+-- 
+-- ![Process](..\Presentations\AI_CAP\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_CAP\Dia5.JPG)
+-- 
+-- This cycle will continue.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia6.JPG)
+-- 
+-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
+--
+-- ![Process](..\Presentations\AI_CAP\Dia9.JPG)
+-- 
+-- When enemies are detected, the AI will automatically engage the enemy.
+-- 
+-- ![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.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia13.JPG)
+-- 
+-- ## 1. AI_CAP_ZONE constructor
+--   
+--   * @{#AI_CAP_ZONE.New}(): Creates a new AI_CAP_ZONE object.
+-- 
+-- ## 2. AI_CAP_ZONE is a FSM
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia2.JPG)
+-- 
+-- ### 2.1 AI_CAP_ZONE States
+-- 
+--   * **None** ( Group ): The process is not started yet.
+--   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
+--   * **Engaging** ( Group ): The AI is engaging the bogeys.
+--   * **Returning** ( Group ): The AI is returning to Base..
+-- 
+-- ### 2.2 AI_CAP_ZONE Events
+-- 
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
+--   * **@{#AI_CAP_ZONE.Engage}**: Let the AI engage the bogeys.
+--   * **@{#AI_CAP_ZONE.Abort}**: Aborts the engagement and return patrolling in the patrol zone.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_CAP_ZONE.Destroy}**: The AI has destroyed a bogey @{Unit}.
+--   * **@{#AI_CAP_ZONE.Destroyed}**: The AI has destroyed all bogeys @{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.
+--
+-- ## 3. Set the Range of Engagement
+-- 
+-- ![Range](..\Presentations\AI_CAP\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_CAP#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, 
+-- that will define when the AI will engage with the detected airborne enemy targets.
+-- Use the method @{AI_Cap#AI_CAP_ZONE.SetEngageZone}() to define that Zone.
+--  
+-- ===
+-- 
+-- @field #AI_CAP_ZONE
+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 Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_CAP_ZONE self
+function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) ) -- #AI_CAP_ZONE
+
+  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.
+  -- @function [parent=#AI_CAP_ZONE] OnBeforeEngage
+  -- @param #AI_CAP_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Engage.
+  -- @function [parent=#AI_CAP_ZONE] OnAfterEngage
+  -- @param #AI_CAP_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.
+  	
+  --- 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
+  -- @param #number Delay The delay in seconds.
+
+--- OnLeave Transition Handler for State Engaging.
+-- @function [parent=#AI_CAP_ZONE] OnLeaveEngaging
+-- @param #AI_CAP_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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Engaging.
+-- @function [parent=#AI_CAP_ZONE] OnEnterEngaging
+-- @param #AI_CAP_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.
+
+  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
+  -- @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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Fired.
+  -- @function [parent=#AI_CAP_ZONE] OnAfterFired
+  -- @param #AI_CAP_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.
+  	
+  --- 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
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
+
+  --- OnBefore Transition Handler for Event Destroy.
+  -- @function [parent=#AI_CAP_ZONE] OnBeforeDestroy
+  -- @param #AI_CAP_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Destroy.
+  -- @function [parent=#AI_CAP_ZONE] OnAfterDestroy
+  -- @param #AI_CAP_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.
+  	
+  --- 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.
+  -- @function [parent=#AI_CAP_ZONE] OnBeforeAbort
+  -- @param #AI_CAP_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Abort.
+  -- @function [parent=#AI_CAP_ZONE] OnAfterAbort
+  -- @param #AI_CAP_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.
+  	
+  --- 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
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
+
+  --- OnBefore Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_CAP_ZONE] OnBeforeAccomplish
+  -- @param #AI_CAP_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_CAP_ZONE] OnAfterAccomplish
+  -- @param #AI_CAP_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.
+  	
+  --- 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
+  -- @param #number Delay The delay in seconds.  
+
+  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.
+-- @return #AI_CAP_ZONE self
+function AI_CAP_ZONE:SetEngageZone( EngageZone )
+  self:F2()
+
+  if EngageZone then  
+    self.EngageZone = EngageZone
+  else
+    self.EngageZone = nil
+  end
+end
+
+--- Set the Engage Range when the AI will engage with airborne enemies. 
+-- @param #AI_CAP_ZONE self
+-- @param #number EngageRange The Engage Range.
+-- @return #AI_CAP_ZONE self
+function AI_CAP_ZONE:SetEngageRange( EngageRange )
+  self:F2()
+
+  if EngageRange then  
+    self.EngageRange = EngageRange
+  else
+    self.EngageRange = nil
+  end
+end
+
+--- onafter State Transition for Event Start.
+-- @param #AI_CAP_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.
+function AI_CAP_ZONE:onafterStart( Controllable, From, Event, To )
+
+  -- Call the parent Start event handler
+  self:GetParent(self).onafterStart( self, Controllable, From, Event, To )
+  self:HandleEvent( EVENTS.Dead )
+
+end
+
+
+--- @param AI.AI_CAP#AI_CAP_ZONE 
+-- @param Wrapper.Group#GROUP EngageGroup
+function AI_CAP_ZONE.EngageRoute( EngageGroup, Fsm )
+
+  EngageGroup:F( { "AI_CAP_ZONE.EngageRoute:", EngageGroup:GetName() } )
+
+  if EngageGroup:IsAlive() then
+    Fsm:__Engage( 1 )
+  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.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_CAP_ZONE:onbeforeEngage( Controllable, From, Event, To )
+  
+  if self.Accomplished == true then
+    return false
+  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.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+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
+        Engage = true
+        break
+      end
+    end
+  
+    if Engage == true then
+      self:F( 'Detected -> Engaging' )
+      self:__Engage( 1 )
+    end
+  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.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_CAP_ZONE:onafterAbort( Controllable, From, Event, To )
+  Controllable:ClearTasks()
+  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.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To )
+
+  if Controllable:IsAlive() then
+
+    local EngageRoute = {}
+
+    --- Calculate the current route point.
+    local CurrentVec2 = self.Controllable:GetVec2()
+    
+    --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+    local CurrentAltitude = self.Controllable:GetUnit(1):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 
+      )
+    
+    EngageRoute[#EngageRoute+1] = CurrentRoutePoint
+
+    
+     --- Find a random 2D point in PatrolZone.
+    local ToTargetVec2 = self.PatrolZone:GetRandomVec2()
+    self:T2( ToTargetVec2 )
+
+    --- Define Speed and Altitude.
+    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 
+    )
+
+    EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
+
+    Controllable:OptionROEOpenFire()
+    Controllable:OptionROTEvadeFire()
+
+    local AttackTasks = {}
+
+    for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
+      local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
+      self:T( { DetectedUnit, DetectedUnit:IsAlive(), DetectedUnit:IsAir() } )
+      if DetectedUnit:IsAlive() and DetectedUnit:IsAir() then
+        if self.EngageZone then
+          if DetectedUnit:IsInZone( self.EngageZone ) then
+            self:F( {"Within Zone and Engaging ", DetectedUnit } )
+            AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit )
+          end
+        else        
+          if self.EngageRange then
+            if DetectedUnit:GetPointVec3():Get2DDistance(Controllable:GetPointVec3() ) <= self.EngageRange then
+              self:F( {"Within Range and Engaging", DetectedUnit } )
+              AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit )
+            end
+          else
+            AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit )
+          end
+        end
+      else
+        self.DetectedUnits[DetectedUnit] = nil
+      end
+    end
+
+    if #AttackTasks == 0 then
+      self:F("No targets found -> Going back to Patrolling")
+      self:__Abort( 1 )
+      self:__Route( 1 )
+      self:SetDetectionActivated()
+    else
+
+      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
+
+--- @param #AI_CAP_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.
+function AI_CAP_ZONE:onafterAccomplish( Controllable, From, Event, To )
+  self.Accomplished = true
+  self:SetDetectionOff()
+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.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+-- @param Core.Event#EVENTDATA EventData
+function AI_CAP_ZONE:onafterDestroy( Controllable, From, Event, To, EventData )
+
+  if EventData.IniUnit then
+    self.DetectedUnits[EventData.IniUnit] = nil
+  end
+end
+
+--- @param #AI_CAP_ZONE self
+-- @param Core.Event#EVENTDATA EventData
+function AI_CAP_ZONE:OnEventDead( EventData )
+  self:F( { "EventDead", EventData } )
+
+  if EventData.IniDCSUnit then
+    if self.DetectedUnits and self.DetectedUnits[EventData.IniUnit] then
+      self:__Destroy( 1, EventData )
+    end
+  end
+end

Moose Development/Moose/AI/AI_CAS.lua

@@ -0,0 +1,564 @@
+--- **AI** -- (R2.1) - Manages the independent process of Close Air Support for airplanes.
+--
+-- ===
+--
+-- ![Banner Image](..\Presentations\AI_CAS\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAS%20-%20Close%20Air%20Support)
+-- 
+-- ===
+-- 
+-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3JBO1WDqqpyYRRmIkR2ir2)
+-- 
+-- ===
+-- 
+-- ### 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.
+--
+-- ===
+--
+-- @module AI_Cas
+
+
+--- AI_CAS_ZONE class
+-- @type AI_CAS_ZONE
+-- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Controllable} patrolling.
+-- @field Core.Zone#ZONE_BASE TargetZone The @{Zone} where the patrol needs to be executed.
+-- @extends AI.AI_Patrol#AI_PATROL_ZONE
+
+--- # AI_CAS_ZONE class, extends @{AI_Patrol#AI_PATROL_ZONE}
+-- 
+-- AI_CAS_ZONE derives from the @{AI_Patrol#AI_PATROL_ZONE}, inheriting its methods and behaviour.
+--  
+-- The AI_CAS_ZONE class implements the core functions to provide Close Air Support in an Engage @{Zone} by an AIR @{Controllable} or @{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)
+-- 
+-- The AI_CAS_ZONE is assigned a @{Group} and this must be done before the AI_CAS_ZONE process can be started through the **Start** event.
+--  
+-- ![Start Event](..\Presentations\AI_CAS\Dia4.JPG)
+-- 
+-- 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.
+-- 
+-- ![Route Event](..\Presentations\AI_CAS\Dia5.JPG)
+-- 
+-- When the AI is commanded to provide Close Air Support (through the event **Engage**), the AI will fly towards the Engage Zone.
+-- Any target that is detected in the Engage Zone will be reported and will be destroyed by the AI.
+-- 
+-- ![Engage Event](..\Presentations\AI_CAS\Dia6.JPG)
+-- 
+-- The AI will detect the targets and will only destroy the targets within the Engage Zone.
+-- 
+-- ![Engage Event](..\Presentations\AI_CAS\Dia7.JPG)
+-- 
+-- Every target that is destroyed, is reported< by the AI.
+-- 
+-- ![Engage Event](..\Presentations\AI_CAS\Dia8.JPG)
+-- 
+-- Note that the AI does not know when the Engage Zone is cleared, and therefore will keep circling in the zone. 
+--
+-- ![Engage Event](..\Presentations\AI_CAS\Dia9.JPG)
+-- 
+-- Until it is notified through the event **Accomplish**, which is to be triggered by an observing party:
+-- 
+--   * a FAC
+--   * a timed event
+--   * a menu option selected by a human
+--   * a condition
+--   * others ...
+-- 
+-- ![Engage Event](..\Presentations\AI_CAS\Dia10.JPG)
+-- 
+-- When the AI has accomplished the CAS, it will fly back to the Patrol Zone.
+-- 
+-- ![Engage Event](..\Presentations\AI_CAS\Dia11.JPG)
+-- 
+-- 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.
+-- 
+-- ![Engage Event](..\Presentations\AI_CAS\Dia12.JPG)
+--
+-- ## AI_CAS_ZONE constructor
+--
+--   * @{#AI_CAS_ZONE.New}(): Creates a new AI_CAS_ZONE object.
+--
+-- ## AI_CAS_ZONE is a FSM
+-- 
+-- ![Process](..\Presentations\AI_CAS\Dia2.JPG)
+-- 
+-- ### 2.1. AI_CAS_ZONE States
+-- 
+--   * **None** ( Group ): The process is not started yet.
+--   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
+--   * **Engaging** ( Group ): The AI is engaging the targets in the Engage Zone, executing CAS.
+--   * **Returning** ( Group ): The AI is returning to Base..
+-- 
+-- ### 2.2. AI_CAS_ZONE Events
+-- 
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
+--   * **@{#AI_CAS_ZONE.Engage}**: Engage the AI to provide CAS in the Engage Zone, destroying any target it finds.
+--   * **@{#AI_CAS_ZONE.Abort}**: Aborts the engagement and return patrolling in the patrol zone.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_CAS_ZONE.Destroy}**: The AI has destroyed a target @{Unit}.
+--   * **@{#AI_CAS_ZONE.Destroyed}**: The AI has destroyed all target @{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.
+-- 
+-- ===
+-- 
+-- @field #AI_CAS_ZONE
+AI_CAS_ZONE = {
+  ClassName = "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 Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @param Core.Zone#ZONE_BASE EngageZone The zone where the engage will happen.
+-- @param Dcs.DCSTypes#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_CAS_ZONE self
+function AI_CAS_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageZone, PatrolAltType )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) ) -- #AI_CAS_ZONE
+
+  self.EngageZone = EngageZone
+  self.Accomplished = false
+  
+  self:SetDetectionZone( self.EngageZone )
+
+  self:AddTransition( { "Patrolling", "Engaging" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
+
+  --- OnBefore Transition Handler for Event Engage.
+  -- @function [parent=#AI_CAS_ZONE] OnBeforeEngage
+  -- @param #AI_CAS_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Engage.
+  -- @function [parent=#AI_CAS_ZONE] OnAfterEngage
+  -- @param #AI_CAS_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.
+  	
+  --- Synchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_CAS_ZONE] Engage
+  -- @param #AI_CAS_ZONE self
+  -- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
+  -- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+  -- @param Dcs.DCSTypes#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. 
+  -- If parameter is not defined the unit / controllable will choose expend on its own discretion.
+  -- Use the structure @{DCSTypes#AI.Task.WeaponExpend} to define the amount of weapons to be release at each attack.
+  -- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
+  -- @param Dcs.DCSTypes#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+  
+  --- Asynchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_CAS_ZONE] __Engage
+  -- @param #AI_CAS_ZONE self
+  -- @param #number Delay The delay in seconds.
+  -- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
+  -- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+  -- @param Dcs.DCSTypes#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. 
+  -- If parameter is not defined the unit / controllable will choose expend on its own discretion.
+  -- Use the structure @{DCSTypes#AI.Task.WeaponExpend} to define the amount of weapons to be release at each attack.
+  -- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
+  -- @param Dcs.DCSTypes#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+
+--- OnLeave Transition Handler for State Engaging.
+-- @function [parent=#AI_CAS_ZONE] OnLeaveEngaging
+-- @param #AI_CAS_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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Engaging.
+-- @function [parent=#AI_CAS_ZONE] OnEnterEngaging
+-- @param #AI_CAS_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.
+
+  self:AddTransition( "Engaging", "Target", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
+
+  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
+  
+  --- OnBefore Transition Handler for Event Fired.
+  -- @function [parent=#AI_CAS_ZONE] OnBeforeFired
+  -- @param #AI_CAS_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Fired.
+  -- @function [parent=#AI_CAS_ZONE] OnAfterFired
+  -- @param #AI_CAS_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.
+  	
+  --- Synchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_CAS_ZONE] Fired
+  -- @param #AI_CAS_ZONE self
+  
+  --- Asynchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_CAS_ZONE] __Fired
+  -- @param #AI_CAS_ZONE self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
+
+  --- OnBefore Transition Handler for Event Destroy.
+  -- @function [parent=#AI_CAS_ZONE] OnBeforeDestroy
+  -- @param #AI_CAS_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Destroy.
+  -- @function [parent=#AI_CAS_ZONE] OnAfterDestroy
+  -- @param #AI_CAS_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.
+  	
+  --- Synchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_CAS_ZONE] Destroy
+  -- @param #AI_CAS_ZONE self
+  
+  --- Asynchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_CAS_ZONE] __Destroy
+  -- @param #AI_CAS_ZONE self
+  -- @param #number Delay The delay in seconds.
+
+
+  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
+
+  --- OnBefore Transition Handler for Event Abort.
+  -- @function [parent=#AI_CAS_ZONE] OnBeforeAbort
+  -- @param #AI_CAS_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Abort.
+  -- @function [parent=#AI_CAS_ZONE] OnAfterAbort
+  -- @param #AI_CAS_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.
+  	
+  --- Synchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_CAS_ZONE] Abort
+  -- @param #AI_CAS_ZONE self
+  
+  --- Asynchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_CAS_ZONE] __Abort
+  -- @param #AI_CAS_ZONE self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
+
+  --- OnBefore Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_CAS_ZONE] OnBeforeAccomplish
+  -- @param #AI_CAS_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 #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_CAS_ZONE] OnAfterAccomplish
+  -- @param #AI_CAS_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.
+  	
+  --- Synchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_CAS_ZONE] Accomplish
+  -- @param #AI_CAS_ZONE self
+  
+  --- Asynchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_CAS_ZONE] __Accomplish
+  -- @param #AI_CAS_ZONE self
+  -- @param #number Delay The delay in seconds.  
+
+  return self
+end
+
+
+--- Set the Engage Zone where the AI is performing CAS. Note that if the EngageZone is changed, the AI needs to re-detect targets.
+-- @param #AI_CAS_ZONE self
+-- @param Core.Zone#ZONE EngageZone The zone where the AI is performing CAS.
+-- @return #AI_CAS_ZONE self
+function AI_CAS_ZONE:SetEngageZone( EngageZone )
+  self:F2()
+
+  if EngageZone then  
+    self.EngageZone = EngageZone
+  else
+    self.EngageZone = nil
+  end
+end
+
+
+
+--- onafter State Transition for Event Start.
+-- @param #AI_CAS_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.
+function AI_CAS_ZONE:onafterStart( Controllable, From, Event, To )
+
+  -- Call the parent Start event handler
+  self:GetParent(self).onafterStart( self, Controllable, From, Event, To )
+  self:HandleEvent( EVENTS.Dead )
+  
+  self:SetDetectionDeactivated() -- When not engaging, set the detection off.
+end
+
+--- @param AI.AI_CAS#AI_CAS_ZONE 
+-- @param Wrapper.Group#GROUP EngageGroup
+function AI_CAS_ZONE.EngageRoute( EngageGroup, Fsm )
+
+  EngageGroup:F( { "AI_CAS_ZONE.EngageRoute:", EngageGroup:GetName() } )
+
+  if EngageGroup:IsAlive() then
+    Fsm:__Engage( 1, Fsm.EngageSpeed, Fsm.EngageAltitude, Fsm.EngageWeaponExpend, Fsm.EngageAttackQty, Fsm.EngageDirection )
+  end
+end
+
+
+--- @param #AI_CAS_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.
+function AI_CAS_ZONE:onbeforeEngage( Controllable, From, Event, To )
+  
+  if self.Accomplished == true then
+    return false
+  end
+end
+
+--- @param #AI_CAS_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.
+function AI_CAS_ZONE:onafterTarget( Controllable, From, Event, To )
+
+  if Controllable:IsAlive() then
+
+    local AttackTasks = {}
+
+    for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
+      local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
+      if DetectedUnit:IsAlive() then
+        if DetectedUnit:IsInZone( self.EngageZone ) then
+          if Detected == true then
+            self:F( {"Target: ", DetectedUnit } )
+            self.DetectedUnits[DetectedUnit] = false
+            local AttackTask = Controllable:TaskAttackUnit( DetectedUnit, false, self.EngageWeaponExpend, self.EngageAttackQty, self.EngageDirection, self.EngageAltitude, nil )
+            self.Controllable:PushTask( AttackTask, 1 )
+          end
+        end
+      else
+        self.DetectedUnits[DetectedUnit] = nil
+      end
+    end
+
+    self:__Target( -10 )
+
+  end
+end
+
+
+--- @param #AI_CAS_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.
+function AI_CAS_ZONE:onafterAbort( Controllable, From, Event, To )
+  Controllable:ClearTasks()
+  self:__Route( 1 )
+end
+
+--- @param #AI_CAS_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.
+-- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
+-- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+-- @param Dcs.DCSTypes#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.
+-- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
+-- @param Dcs.DCSTypes#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
+function AI_CAS_ZONE:onafterEngage( Controllable, From, Event, To, 
+                                    EngageSpeed, 
+                                    EngageAltitude, 
+                                    EngageWeaponExpend, 
+                                    EngageAttackQty, 
+                                    EngageDirection )
+  self:F("onafterEngage")
+
+  self.EngageSpeed = EngageSpeed or 400
+  self.EngageAltitude = EngageAltitude or 2000
+  self.EngageWeaponExpend = EngageWeaponExpend
+  self.EngageAttackQty = EngageAttackQty
+  self.EngageDirection = EngageDirection
+
+  if Controllable:IsAlive() then
+
+    Controllable:OptionROEOpenFire()
+    Controllable:OptionROTVertical()
+
+    local EngageRoute = {}
+
+    --- Calculate the current route point.
+    local CurrentVec2 = self.Controllable:GetVec2()
+    
+    --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+    local CurrentAltitude = self.Controllable:GetUnit(1):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, 
+        self.EngageSpeed, 
+        true 
+      )
+    
+    EngageRoute[#EngageRoute+1] = CurrentRoutePoint
+
+    local AttackTasks = {}
+
+    for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
+      local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
+      self:T( DetectedUnit )
+      if DetectedUnit:IsAlive() then
+        if DetectedUnit:IsInZone( self.EngageZone ) then
+          self:F( {"Engaging ", DetectedUnit } )
+          AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit, 
+                                                                     true, 
+                                                                     EngageWeaponExpend, 
+                                                                     EngageAttackQty, 
+                                                                     EngageDirection 
+                                                                   )
+        end
+      else
+        self.DetectedUnits[DetectedUnit] = nil
+      end
+    end
+
+    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.
+    
+      --- Find a random 2D point in EngageZone.
+    local ToTargetVec2 = self.EngageZone:GetRandomVec2()
+    self:T2( ToTargetVec2 )
+
+    --- Obtain a 3D @{Point} from the 2D point + altitude.
+    local ToTargetPointVec3 = POINT_VEC3:New( ToTargetVec2.x, self.EngageAltitude, ToTargetVec2.y )
+    
+    --- Create a route point of type air.
+    local ToTargetRoutePoint = ToTargetPointVec3:WaypointAir( 
+      self.PatrolAltType, 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      self.EngageSpeed, 
+      true 
+    )
+    
+    EngageRoute[#EngageRoute+1] = ToTargetRoutePoint
+  
+    Controllable:Route( EngageRoute, 0.5 )
+    
+    self:SetRefreshTimeInterval( 2 )
+    self:SetDetectionActivated()
+    self:__Target( -2 ) -- Start Targetting
+  end
+end
+
+
+--- @param #AI_CAS_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.
+function AI_CAS_ZONE:onafterAccomplish( Controllable, From, Event, To )
+  self.Accomplished = true
+  self:SetDetectionDeactivated()
+end
+
+
+--- @param #AI_CAS_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.
+-- @param Core.Event#EVENTDATA EventData
+function AI_CAS_ZONE:onafterDestroy( Controllable, From, Event, To, EventData )
+
+  if EventData.IniUnit then
+    self.DetectedUnits[EventData.IniUnit] = nil
+  end
+end
+
+
+--- @param #AI_CAS_ZONE self
+-- @param Core.Event#EVENTDATA EventData
+function AI_CAS_ZONE:OnEventDead( EventData )
+  self:F( { "EventDead", EventData } )
+
+  if EventData.IniDCSUnit then
+    if self.DetectedUnits and self.DetectedUnits[EventData.IniUnit] then
+      self:__Destroy( 1, EventData )
+    end
+  end
+end
+
+

Moose Development/Moose/AI/AI_Patrol.lua

@@ -0,0 +1,927 @@
+--- **AI** -- (R2.1) - Manages the independent process of Air Patrol for airplanes.
+-- 
+-- ===
+-- 
+-- ![Banner Image](..\Presentations\AI_PATROL\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- AI PATROL classes makes AI Controllables execute an Patrol.
+-- 
+-- There are the following types of PATROL classes defined:
+-- 
+--   * @{#AI_PATROL_ZONE}: Perform a PATROL in a zone.
+--   
+-- ===
+-- 
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/PAT%20-%20Patrolling)
+-- 
+-- ===
+-- 
+-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl35HvYZKA6G22WMt7iI3zky)
+-- 
+-- ===
+-- 
+-- ### 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.
+-- 
+-- ===
+-- 
+-- @module AI_Patrol
+
+
+--- AI_PATROL_ZONE class
+-- @type AI_PATROL_ZONE
+-- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Controllable} patrolling.
+-- @field Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @field Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @field Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @field Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @field Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @field Core.Spawn#SPAWN CoordTest
+-- @extends Core.Fsm#FSM_CONTROLLABLE
+
+--- # AI_PATROL_ZONE class, extends @{Fsm#FSM_CONTROLLABLE}
+-- 
+-- The AI_PATROL_ZONE class implements the core functions to patrol a @{Zone} by an AI @{Controllable} or @{Group}.
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia3.JPG)
+-- 
+-- The AI_PATROL_ZONE is assigned a @{Group} and this must be done before the AI_PATROL_ZONE process can be started using the **Start** event.
+-- 
+-- ![Process](..\Presentations\AI_PATROL\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_PATROL\Dia5.JPG)
+-- 
+-- This cycle will continue.
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia6.JPG)
+-- 
+-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
+--
+-- ![Process](..\Presentations\AI_PATROL\Dia9.JPG)
+-- 
+---- Note that the enemy is not engaged! To model enemy engagement, either tailor the **Detected** event, or
+-- use derived AI_ classes to model AI offensive or defensive behaviour.
+-- 
+-- ![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.
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia11.JPG)
+-- 
+-- ## 1. AI_PATROL_ZONE constructor
+--   
+--   * @{#AI_PATROL_ZONE.New}(): Creates a new AI_PATROL_ZONE object.
+-- 
+-- ## 2. AI_PATROL_ZONE is a FSM
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia2.JPG)
+-- 
+-- ### 2.1. AI_PATROL_ZONE States
+-- 
+--   * **None** ( Group ): The process is not started yet.
+--   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
+--   * **Returning** ( Group ): The AI is returning to Base.
+--   * **Stopped** ( Group ): The process is stopped.
+--   * **Crashed** ( Group ): The AI has crashed or is dead.
+-- 
+-- ### 2.2. AI_PATROL_ZONE Events
+-- 
+--   * **Start** ( Group ): Start the process.
+--   * **Stop** ( Group ): Stop the process.
+--   * **Route** ( Group ): Route the AI to a new random 3D point within the Patrol Zone.
+--   * **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.
+--    
+-- ## 3. Set or Get the AI controllable
+-- 
+--   * @{#AI_PATROL_ZONE.SetControllable}(): Set the AIControllable.
+--   * @{#AI_PATROL_ZONE.GetControllable}(): Get the AIControllable.
+--
+-- ## 4. Set the Speed and Altitude boundaries of the AI controllable
+--
+--   * @{#AI_PATROL_ZONE.SetSpeed}(): Set the patrol speed boundaries of the AI, for the next patrol.
+--   * @{#AI_PATROL_ZONE.SetAltitude}(): Set altitude boundaries of the AI, for the next patrol.
+-- 
+-- ## 5. Manage the detection process of the AI controllable
+-- 
+-- The detection process of the AI controllable can be manipulated.
+-- Detection requires an amount of CPU power, which has an impact on your mission performance.
+-- Only put detection on when absolutely necessary, and the frequency of the detection can also be set.
+-- 
+--   * @{#AI_PATROL_ZONE.SetDetectionOn}(): Set the detection on. The AI will detect for targets.
+--   * @{#AI_PATROL_ZONE.SetDetectionOff}(): Set the detection off, the AI will not detect for targets. The existing target list will NOT be erased.
+-- 
+-- The detection frequency can be set with @{#AI_PATROL_ZONE.SetRefreshTimeInterval}( seconds ), where the amount of seconds specify how much seconds will be waited before the next detection.
+-- Use the method @{#AI_PATROL_ZONE.GetDetectedUnits}() to obtain a list of the @{Unit}s detected by the AI.
+-- 
+-- The detection can be filtered to potential targets in a specific zone.
+-- Use the method @{#AI_PATROL_ZONE.SetDetectionZone}() to set the zone where targets need to be detected.
+-- Note that when the zone is too far away, or the AI is not heading towards the zone, or the AI is too high, no targets may be detected
+-- according the weather conditions.
+-- 
+-- ## 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.
+-- 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.
+-- 
+-- ## 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.
+-- 
+-- ===
+-- 
+-- @field #AI_PATROL_ZONE
+AI_PATROL_ZONE = {
+  ClassName = "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 Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_PATROL_ZONE self
+-- @usage
+-- -- Define a new AI_PATROL_ZONE Object. This PatrolArea will patrol an AIControllable within PatrolZone between 3000 and 6000 meters, with a variying speed between 600 and 900 km/h.
+-- PatrolZone = ZONE:New( 'PatrolZone' )
+-- PatrolSpawn = SPAWN:New( 'Patrol Group' )
+-- PatrolArea = AI_PATROL_ZONE:New( PatrolZone, 3000, 6000, 600, 900 )
+function AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  -- 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 "RADIO" if not specified
+  self.PatrolAltType = PatrolAltType or "RADIO"
+  
+  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" )
+
+--- OnLeave Transition Handler for State Stopped.
+-- @function [parent=#AI_PATROL_ZONE] OnLeaveStopped
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Stopped.
+-- @function [parent=#AI_PATROL_ZONE] OnEnterStopped
+-- @param #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.
+
+--- OnBefore Transition Handler for Event Stop.
+-- @function [parent=#AI_PATROL_ZONE] OnBeforeStop
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Stop.
+-- @function [parent=#AI_PATROL_ZONE] OnAfterStop
+-- @param #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.
+	
+--- Synchronous Event Trigger for Event Stop.
+-- @function [parent=#AI_PATROL_ZONE] Stop
+-- @param #AI_PATROL_ZONE self
+
+--- Asynchronous Event Trigger for Event Stop.
+-- @function [parent=#AI_PATROL_ZONE] __Stop
+-- @param #AI_PATROL_ZONE self
+-- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "None", "Start", "Patrolling" )
+
+--- OnBefore Transition Handler for Event Start.
+-- @function [parent=#AI_PATROL_ZONE] OnBeforeStart
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Start.
+-- @function [parent=#AI_PATROL_ZONE] OnAfterStart
+-- @param #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.
+	
+--- Synchronous Event Trigger for Event Start.
+-- @function [parent=#AI_PATROL_ZONE] Start
+-- @param #AI_PATROL_ZONE self
+
+--- Asynchronous Event Trigger for Event Start.
+-- @function [parent=#AI_PATROL_ZONE] __Start
+-- @param #AI_PATROL_ZONE self
+-- @param #number Delay The delay in seconds.
+
+--- OnLeave Transition Handler for State Patrolling.
+-- @function [parent=#AI_PATROL_ZONE] OnLeavePatrolling
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Patrolling.
+-- @function [parent=#AI_PATROL_ZONE] OnEnterPatrolling
+-- @param #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.
+
+  self:AddTransition( "Patrolling", "Route", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
+
+--- OnBefore Transition Handler for Event Route.
+-- @function [parent=#AI_PATROL_ZONE] OnBeforeRoute
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Route.
+-- @function [parent=#AI_PATROL_ZONE] OnAfterRoute
+-- @param #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.
+	
+--- Synchronous Event Trigger for Event Route.
+-- @function [parent=#AI_PATROL_ZONE] Route
+-- @param #AI_PATROL_ZONE self
+
+--- Asynchronous Event Trigger for Event Route.
+-- @function [parent=#AI_PATROL_ZONE] __Route
+-- @param #AI_PATROL_ZONE self
+-- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Status", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
+
+--- OnBefore Transition Handler for Event Status.
+-- @function [parent=#AI_PATROL_ZONE] OnBeforeStatus
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Status.
+-- @function [parent=#AI_PATROL_ZONE] OnAfterStatus
+-- @param #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.
+	
+--- Synchronous Event Trigger for Event Status.
+-- @function [parent=#AI_PATROL_ZONE] Status
+-- @param #AI_PATROL_ZONE self
+
+--- Asynchronous Event Trigger for Event Status.
+-- @function [parent=#AI_PATROL_ZONE] __Status
+-- @param #AI_PATROL_ZONE self
+-- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Detect", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
+
+--- OnBefore Transition Handler for Event Detect.
+-- @function [parent=#AI_PATROL_ZONE] OnBeforeDetect
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Detect.
+-- @function [parent=#AI_PATROL_ZONE] OnAfterDetect
+-- @param #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.
+	
+--- Synchronous Event Trigger for Event Detect.
+-- @function [parent=#AI_PATROL_ZONE] Detect
+-- @param #AI_PATROL_ZONE self
+
+--- Asynchronous Event Trigger for Event Detect.
+-- @function [parent=#AI_PATROL_ZONE] __Detect
+-- @param #AI_PATROL_ZONE self
+-- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Detected", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
+
+--- OnBefore Transition Handler for Event Detected.
+-- @function [parent=#AI_PATROL_ZONE] OnBeforeDetected
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event Detected.
+-- @function [parent=#AI_PATROL_ZONE] OnAfterDetected
+-- @param #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.
+	
+--- Synchronous Event Trigger for Event Detected.
+-- @function [parent=#AI_PATROL_ZONE] Detected
+-- @param #AI_PATROL_ZONE self
+
+--- Asynchronous Event Trigger for Event Detected.
+-- @function [parent=#AI_PATROL_ZONE] __Detected
+-- @param #AI_PATROL_ZONE self
+-- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "RTB", "Returning" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
+
+--- OnBefore Transition Handler for Event RTB.
+-- @function [parent=#AI_PATROL_ZONE] OnBeforeRTB
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnAfter Transition Handler for Event RTB.
+-- @function [parent=#AI_PATROL_ZONE] OnAfterRTB
+-- @param #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.
+	
+--- Synchronous Event Trigger for Event RTB.
+-- @function [parent=#AI_PATROL_ZONE] RTB
+-- @param #AI_PATROL_ZONE self
+
+--- Asynchronous Event Trigger for Event RTB.
+-- @function [parent=#AI_PATROL_ZONE] __RTB
+-- @param #AI_PATROL_ZONE self
+-- @param #number Delay The delay in seconds.
+
+--- OnLeave Transition Handler for State Returning.
+-- @function [parent=#AI_PATROL_ZONE] OnLeaveReturning
+-- @param #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 #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Returning.
+-- @function [parent=#AI_PATROL_ZONE] OnEnterReturning
+-- @param #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.
+
+  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
+
+
+
+
+--- Sets (modifies) the minimum and maximum speed of the patrol.
+-- @param #AI_PATROL_ZONE self
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @return #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
+  self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
+  
+  self.PatrolMinSpeed = PatrolMinSpeed
+  self.PatrolMaxSpeed = PatrolMaxSpeed
+end
+
+
+
+--- Sets the floor and ceiling altitude of the patrol.
+-- @param #AI_PATROL_ZONE self
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @return #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
+  self:F2( { PatrolFloorAltitude, PatrolCeilingAltitude } )
+  
+  self.PatrolFloorAltitude = PatrolFloorAltitude
+  self.PatrolCeilingAltitude = PatrolCeilingAltitude
+end
+
+--   * @{#AI_PATROL_ZONE.SetDetectionOn}(): Set the detection on. The AI will detect for targets.
+--   * @{#AI_PATROL_ZONE.SetDetectionOff}(): Set the detection off, the AI will not detect for targets. The existing target list will NOT be erased.
+
+--- Set the detection on. The AI will detect for targets.
+-- @param #AI_PATROL_ZONE self
+-- @return #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:SetDetectionOn()
+  self:F2()
+
+  self.DetectOn = true
+end
+
+--- Set the detection off. The AI will NOT detect for targets.
+-- However, the list of already detected targets will be kept and can be enquired!
+-- @param #AI_PATROL_ZONE self
+-- @return #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:SetDetectionOff()
+  self:F2()
+
+  self.DetectOn = false
+end
+
+--- Set the status checking off.
+-- @param #AI_PATROL_ZONE self
+-- @return #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:SetStatusOff()
+  self:F2()
+  
+  self.CheckStatus = false
+end
+
+--- Activate the detection. The AI will detect for targets if the Detection is switched On.
+-- @param #AI_PATROL_ZONE self
+-- @return #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:SetDetectionActivated()
+  self:F2()
+  
+  self:ClearDetectedUnits()
+  self.DetectActivated = true
+  self:__Detect( -self.DetectInterval )
+end
+
+--- Deactivate the detection. The AI will NOT detect for targets.
+-- @param #AI_PATROL_ZONE self
+-- @return #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:SetDetectionDeactivated()
+  self:F2()
+  
+  self:ClearDetectedUnits()
+  self.DetectActivated = false
+end
+
+--- Set the interval in seconds between each detection executed by the AI.
+-- The list of already detected targets will be kept and updated.
+-- Newly detected targets will be added, but already detected targets that were 
+-- not detected in this cycle, will NOT be removed!
+-- The default interval is 30 seconds.
+-- @param #AI_PATROL_ZONE self
+-- @param #number Seconds The interval in seconds.
+-- @return #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:SetRefreshTimeInterval( Seconds )
+  self:F2()
+
+  if Seconds then  
+    self.DetectInterval = Seconds
+  else
+    self.DetectInterval = 30
+  end
+end
+
+--- Set the detection zone where the AI is detecting targets.
+-- @param #AI_PATROL_ZONE self
+-- @param Core.Zone#ZONE DetectionZone The zone where to detect targets.
+-- @return #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:SetDetectionZone( DetectionZone )
+  self:F2()
+
+  if DetectionZone then  
+    self.DetectZone = DetectionZone
+  else
+    self.DetectZone = nil
+  end
+end
+
+--- Gets a list of @{Unit#UNIT}s that were detected by the AI.
+-- No filtering is applied, so, ANY detected UNIT can be in this list.
+-- It is up to the mission designer to use the @{Unit} class and methods to filter the targets.
+-- @param #AI_PATROL_ZONE self
+-- @return #table The list of @{Unit#UNIT}s
+function AI_PATROL_ZONE:GetDetectedUnits()
+  self:F2()
+
+  return self.DetectedUnits 
+end
+
+--- Clears the list of @{Unit#UNIT}s that were detected by the AI.
+-- @param #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:ClearDetectedUnits()
+  self:F2()
+  self.DetectedUnits = {}
+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.
+-- 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 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.PatrolManageFuel = true
+  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.
+-- However, damage cannot be foreseen early on. 
+-- Therefore, when the damage treshold 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.
+-- @param #AI_PATROL_ZONE self
+-- @param #number PatrolDamageThreshold The treshold 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.
+-- @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.
+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()
+
+  self.Controllable:OnReSpawn(
+    function( PatrolGroup )
+      self:E( "ReSpawn" )
+      self:__Reset( 1 )
+      self:__Route( 5 )
+    end
+  )
+
+  self:SetDetectionOn()
+  
+end
+
+
+--- @param #AI_PATROL_ZONE self
+--- @param Wrapper.Controllable#CONTROLLABLE Controllable
+function AI_PATROL_ZONE:onbeforeDetect( Controllable, From, Event, To )
+
+  return self.DetectOn and self.DetectActivated
+end
+
+--- @param #AI_PATROL_ZONE self
+--- @param Wrapper.Controllable#CONTROLLABLE Controllable
+function AI_PATROL_ZONE:onafterDetect( Controllable, From, Event, To )
+
+  local Detected = false
+
+  local DetectedTargets = Controllable:GetDetectedTargets()
+  for TargetID, Target in pairs( DetectedTargets or {} ) do
+    local TargetObject = Target.object
+
+    if TargetObject and TargetObject:isExist() and TargetObject.id_ < 50000000 then
+
+      local TargetUnit = UNIT:Find( TargetObject )
+      local TargetUnitName = TargetUnit:GetName()
+      
+      if self.DetectionZone then
+        if TargetUnit:IsInZone( self.DetectionZone ) then
+          self:T( {"Detected ", TargetUnit } )
+          if self.DetectedUnits[TargetUnit] == nil then
+            self.DetectedUnits[TargetUnit] = true
+          end
+          Detected = true 
+        end
+      else       
+        if self.DetectedUnits[TargetUnit] == nil then
+          self.DetectedUnits[TargetUnit] = true
+        end
+        Detected = true
+      end
+    end
+  end
+
+  self:__Detect( -self.DetectInterval )
+  
+  if Detected == true then
+    self:__Detected( 1.5 )
+  end
+  
+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.
+-- Note that this method is required, as triggers the next route when patrolling for the Controllable.
+function AI_PATROL_ZONE:_NewPatrolRoute( AIControllable )
+
+  local PatrolZone = AIControllable:GetState( AIControllable, "PatrolZone" ) -- PatrolCore.Zone#AI_PATROL_ZONE
+  PatrolZone:__Route( 1 )
+end
+
+
+--- Defines a new patrol route using the @{Process_PatrolZone} 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.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_PATROL_ZONE:onafterRoute( Controllable, From, Event, To )
+
+  self:F2()
+
+  -- When RTB, don't allow anymore the routing.
+  if From == "RTB" then
+    return
+  end
+
+  
+  if self.Controllable:IsAlive() 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.
+    -- However, when the controllable is not in the air,
+    -- the controllable current waypoint is probably the airbase...
+    -- Thus, if we would take the current waypoint as the startpoint, upon take-off, the controllable flies
+    -- immediately back to the airbase, and this is not correct.
+    -- Therefore, when on a runway, get as the current route point a random point within the PatrolZone.
+    -- This will make the plane fly immediately to the patrol zone.
+    
+    if self.Controllable:InAir() == false then
+      self:E( "Not in the air, finding route path within PatrolZone" )
+      local CurrentVec2 = self.Controllable:GetVec2()
+      --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+      local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+      local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
+      local ToPatrolZoneSpeed = self.PatrolMaxSpeed
+      local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
+          self.PatrolAltType, 
+          POINT_VEC3.RoutePointType.TakeOffParking, 
+          POINT_VEC3.RoutePointAction.FromParkingArea, 
+          ToPatrolZoneSpeed, 
+          true 
+        )
+      PatrolRoute[#PatrolRoute+1] = CurrentRoutePoint
+    else
+      self:E( "In the air, finding route path within PatrolZone" )
+      local CurrentVec2 = self.Controllable:GetVec2()
+      --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+      local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+      local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
+      local ToPatrolZoneSpeed = self.PatrolMaxSpeed
+      local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
+          self.PatrolAltType, 
+          POINT_VEC3.RoutePointType.TurningPoint, 
+          POINT_VEC3.RoutePointAction.TurningPoint, 
+          ToPatrolZoneSpeed, 
+          true 
+        )
+      PatrolRoute[#PatrolRoute+1] = CurrentRoutePoint
+    end    
+    
+    
+    --- Define a random point in the @{Zone}. The AI will fly to that point within the zone.
+    
+      --- Find a random 2D point in PatrolZone.
+    local ToTargetVec2 = self.PatrolZone:GetRandomVec2()
+    self:T2( ToTargetVec2 )
+
+    --- Define Speed and Altitude.
+    local ToTargetAltitude = math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude )
+    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 ToTargetRoutePoint = ToTargetPointVec3:WaypointAir( 
+      self.PatrolAltType, 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      ToTargetSpeed, 
+      true 
+    )
+    
+    --self.CoordTest:SpawnFromVec3( ToTargetPointVec3:GetVec3() )
+    
+    --ToTargetPointVec3:SmokeRed()
+
+    PatrolRoute[#PatrolRoute+1] = ToTargetRoutePoint
+    
+    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
+    self.Controllable:WayPointInitialize( PatrolRoute )
+    
+    --- Do a trick, link the NewPatrolRoute function of the PATROLGROUP object to the AIControllable in a temporary variable ...
+    self.Controllable:SetState( self.Controllable, "PatrolZone", self )
+    self.Controllable:WayPointFunction( #PatrolRoute, 1, "AI_PATROL_ZONE:_NewPatrolRoute" )
+
+    --- NOW ROUTE THE GROUP!
+    self.Controllable:WayPointExecute( 1, 2 )
+  end
+
+end
+
+--- @param #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:onbeforeStatus()
+
+  return self.CheckStatus
+end
+
+--- @param #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:onafterStatus()
+  self:F2()
+
+  if self.Controllable and self.Controllable:IsAlive() then
+  
+    local RTB = false
+    
+    local Fuel = self.Controllable:GetUnit(1):GetFuel()
+    if Fuel < self.PatrolFuelThresholdPercentage then
+      self:E( 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.PatrolOutOfFuelOrbitTime,nil ) )
+      OldAIControllable:SetTask( TimedOrbitTask, 10 )
+
+      RTB = true
+    else
+    end
+    
+    -- TODO: Check GROUP damage function.
+    local Damage = self.Controllable:GetLife()
+    if Damage <= self.PatrolDamageThreshold then
+      self:E( self.Controllable:GetName() .. " is damaged:" .. Damage .. ", RTB!" )
+      RTB = true
+    end
+    
+    if RTB == true then
+      self:RTB()
+    else
+      self:__Status( 60 ) -- Execute the Patrol event after 30 seconds.
+    end
+  end
+end
+
+--- @param #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:onafterRTB()
+  self:F2()
+
+  if self.Controllable and self.Controllable:IsAlive() then
+
+    self:SetDetectionOff()
+    self.CheckStatus = false
+    
+    local PatrolRoute = {}
+  
+    --- Calculate the current route point.
+    local CurrentVec2 = self.Controllable:GetVec2()
+    
+    --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+    local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+    local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
+    local ToPatrolZoneSpeed = self.PatrolMaxSpeed
+    local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
+        self.PatrolAltType, 
+        POINT_VEC3.RoutePointType.TurningPoint, 
+        POINT_VEC3.RoutePointAction.TurningPoint, 
+        ToPatrolZoneSpeed, 
+        true 
+      )
+    
+    PatrolRoute[#PatrolRoute+1] = CurrentRoutePoint
+    
+    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
+    self.Controllable:WayPointInitialize( PatrolRoute )
+  
+    --- NOW ROUTE THE GROUP!
+    self.Controllable:WayPointExecute( 1, 1 )
+    
+  end
+    
+end
+
+--- @param #AI_PATROL_ZONE self
+function AI_PATROL_ZONE:onafterDead()
+  self:SetDetectionOff()
+  self:SetStatusOff()
+end
+
+--- @param #AI_PATROL_ZONE self
+-- @param Core.Event#EVENTDATA EventData
+function AI_PATROL_ZONE:OnCrash( EventData )
+
+  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
+    self:E( self.Controllable:GetUnits() )
+    if #self.Controllable:GetUnits() == 1 then
+      self:__Crash( 1, EventData )
+    end
+  end
+end
+
+--- @param #AI_PATROL_ZONE self
+-- @param Core.Event#EVENTDATA EventData
+function AI_PATROL_ZONE:OnEjection( EventData )
+
+  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
+    self:__Eject( 1, EventData )
+  end
+end
+
+--- @param #AI_PATROL_ZONE self
+-- @param Core.Event#EVENTDATA EventData
+function AI_PATROL_ZONE:OnPilotDead( EventData )
+
+  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
+    self:__PilotDead( 1, EventData )
+  end
+end

Moose Development/Moose/Actions/Act_Account.lua

@@ -0,0 +1,309 @@
+--- **Actions** - ACT_ACCOUNT_ classes **account for** (detect, count & report) various DCS events occuring on @{Unit}s.
+-- 
+-- ![Banner Image](..\Presentations\ACT_ACCOUNT\Dia1.JPG)
+-- 
+-- === 
+-- 
+-- @module Account
+
+
+do -- ACT_ACCOUNT
+  
+  --- # @{#ACT_ACCOUNT} FSM class, extends @{Fsm#FSM_PROCESS}
+  -- 
+  -- ## ACT_ACCOUNT state machine:  
+  -- 
+  -- This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
+  -- All derived classes from this class will start with the class name, followed by a \_. See the relevant derived class descriptions below.
+  -- Each derived class follows exactly the same process, using the same events and following the same state transitions, 
+  -- but will have **different implementation behaviour** upon each event or state transition.
+  -- 
+  -- ### ACT_ACCOUNT States  
+  -- 
+  --   * **Asigned**: The player is assigned.
+  --   * **Waiting**: Waiting for an event.
+  --   * **Report**: Reporting.
+  --   * **Account**: Account for an event.
+  --   * **Accounted**: All events have been accounted for, end of the process.
+  --   * **Failed**: Failed the process.
+  -- 
+  -- ### ACT_ACCOUNT Events  
+  -- 
+  --   * **Start**: Start the process.
+  --   * **Wait**: Wait for an event.
+  --   * **Report**: Report the status of the accounting.
+  --   * **Event**: An event happened, process the event.
+  --   * **More**: More targets.
+  --   * **NoMore (*)**: No more targets.
+  --   * **Fail (*)**: The action process has failed.
+  --   
+  -- (*) End states of the process.
+  --   
+  -- ### ACT_ACCOUNT state transition methods:
+  -- 
+  -- State transition functions can be set **by the mission designer** customizing or improving the behaviour of the state.
+  -- There are 2 moments when state transition methods will be called by the state machine:
+  -- 
+  --   * **Before** the state transition. 
+  --     The state transition method needs to start with the name **OnBefore + the name of the state**. 
+  --     If the state transition method returns false, then the processing of the state transition will not be done!
+  --     If you want to change the behaviour of the AIControllable at this event, return false, 
+  --     but then you'll need to specify your own logic using the AIControllable!
+  --   
+  --   * **After** the state transition. 
+  --     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.
+  --     
+  -- @type ACT_ACCOUNT
+  -- @field Set#SET_UNIT TargetSetUnit
+  -- @extends Core.Fsm#FSM_PROCESS
+  ACT_ACCOUNT = { 
+    ClassName = "ACT_ACCOUNT",
+    TargetSetUnit = nil,
+  }
+  
+  --- Creates a new DESTROY process.
+  -- @param #ACT_ACCOUNT self
+  -- @return #ACT_ACCOUNT
+  function ACT_ACCOUNT:New()
+
+    -- Inherits from BASE
+    local self = BASE:Inherit( self, FSM_PROCESS:New() ) -- Core.Fsm#FSM_PROCESS
+  
+    self:AddTransition( "Assigned", "Start", "Waiting" )
+    self:AddTransition( "*", "Wait", "Waiting" )
+    self:AddTransition( "*", "Report", "Report" )
+    self:AddTransition( "*", "Event", "Account" )
+    self:AddTransition( "Account", "Player", "AccountForPlayer" )
+    self:AddTransition( "Account", "Other", "AccountForOther" )
+    self:AddTransition( { "Account", "AccountForPlayer", "AccountForOther" }, "More", "Wait" )
+    self:AddTransition( { "Account", "AccountForPlayer", "AccountForOther" }, "NoMore", "Accounted" )
+    self:AddTransition( "*", "Fail", "Failed" )
+    
+    self:AddEndState( "Failed" )
+    
+    self:SetStartState( "Assigned" ) 
+    
+    return self
+  end
+
+  --- Process Events
+  
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ACCOUNT:onafterStart( ProcessUnit, From, Event, To )
+
+    self:HandleEvent( EVENTS.Dead, self.onfuncEventDead )
+    self:HandleEvent( EVENTS.Crash, self.onfuncEventCrash )
+    self:HandleEvent( EVENTS.Hit )
+
+    self:__Wait( 1 )
+  end
+
+  
+    --- StateMachine callback function
+    -- @param #ACT_ACCOUNT self
+    -- @param Wrapper.Unit#UNIT ProcessUnit
+    -- @param #string Event
+    -- @param #string From
+    -- @param #string To
+  function ACT_ACCOUNT:onenterWaiting( ProcessUnit, From, Event, To )
+  
+    if self.DisplayCount >= self.DisplayInterval then
+      self:Report()
+      self.DisplayCount = 1
+    else
+      self.DisplayCount = self.DisplayCount + 1
+    end
+    
+    return true -- Process always the event.
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ACCOUNT:onafterEvent( ProcessUnit, From, Event, To, Event )
+  
+    self:__NoMore( 1 )
+  end
+  
+end -- ACT_ACCOUNT
+
+do -- ACT_ACCOUNT_DEADS
+
+  --- # @{#ACT_ACCOUNT_DEADS} FSM class, extends @{Fsm.Account#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 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.
+  -- 
+  -- 
+  -- ## ACT_ACCOUNT_DEADS constructor:
+  -- 
+  --   * @{#ACT_ACCOUNT_DEADS.New}(): Creates a new ACT_ACCOUNT_DEADS object.
+  --   
+  -- @type ACT_ACCOUNT_DEADS
+  -- @field Set#SET_UNIT TargetSetUnit
+  -- @extends #ACT_ACCOUNT
+  ACT_ACCOUNT_DEADS = { 
+    ClassName = "ACT_ACCOUNT_DEADS",
+  }
+
+
+  --- Creates a new DESTROY process.
+  -- @param #ACT_ACCOUNT_DEADS self
+  -- @param Set#SET_UNIT TargetSetUnit
+  -- @param #string TaskName
+  function ACT_ACCOUNT_DEADS:New()
+    -- Inherits from BASE
+    local self = BASE:Inherit( self, ACT_ACCOUNT:New() ) -- #ACT_ACCOUNT_DEADS
+    
+    self.DisplayInterval = 30
+    self.DisplayCount = 30
+    self.DisplayMessage = true
+    self.DisplayTime = 10 -- 10 seconds is the default
+    self.DisplayCategory = "HQ" -- Targets is the default display category
+      
+    return self
+  end
+  
+  function ACT_ACCOUNT_DEADS:Init( FsmAccount )
+  
+    self.Task = self:GetTask() 
+    self.TaskName = self.Task:GetName()
+  end
+
+  --- Process Events
+  
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT_DEADS self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ACCOUNT_DEADS:onenterReport( ProcessUnit, Task, From, Event, To )
+  
+    local MessageText = "Your group with assigned " .. self.TaskName .. " task has " .. Task.TargetSetUnit:GetUnitTypesText() .. " targets left to be destroyed."
+    self:GetCommandCenter():MessageTypeToGroup( MessageText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
+  end
+  
+  
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT_DEADS self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param Tasking.Task#TASK Task
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Core.Event#EVENTDATA EventData
+  function ACT_ACCOUNT_DEADS:onafterEvent( ProcessUnit, Task, From, Event, To, EventData  )
+    self:T( { ProcessUnit:GetName(), Task:GetName(), From, Event, To, EventData } )
+    
+    if Task.TargetSetUnit:FindUnit( EventData.IniUnitName ) then
+      local PlayerName = ProcessUnit:GetPlayerName()
+      local PlayerHit = self.PlayerHits and self.PlayerHits[EventData.IniUnitName]
+      if PlayerHit == PlayerName then
+        self:Player( EventData )
+      else
+        self:Other( EventData )
+      end
+    end
+  end
+
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT_DEADS self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param Tasking.Task#TASK Task
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Core.Event#EVENTDATA EventData
+  function ACT_ACCOUNT_DEADS:onenterAccountForPlayer( ProcessUnit, Task, From, Event, To, EventData  )
+    self:T( { ProcessUnit:GetName(), Task:GetName(), From, Event, To, EventData } )
+    
+    local TaskGroup = ProcessUnit:GetGroup()
+
+    Task.TargetSetUnit:Remove( EventData.IniUnitName )
+    
+    local MessageText = "You have destroyed a target.\nYour group assigned with task " .. self.TaskName .. " has\n" .. Task.TargetSetUnit:Count() .. " targets ( " .. Task.TargetSetUnit:GetUnitTypesText() .. " ) left to be destroyed."
+    self:GetCommandCenter():MessageTypeToGroup( MessageText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
+    
+    local PlayerName = ProcessUnit:GetPlayerName()
+    Task:AddProgress( PlayerName, "Destroyed " .. EventData.IniTypeName, timer.getTime(), 1 )
+
+    if Task.TargetSetUnit:Count() > 0 then
+      self:__More( 1 )
+    else
+      self:__NoMore( 1 )
+    end
+  end
+
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT_DEADS self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param Tasking.Task#TASK Task
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Core.Event#EVENTDATA EventData
+  function ACT_ACCOUNT_DEADS:onenterAccountForOther( ProcessUnit, Task, From, Event, To, EventData  )
+    self:T( { ProcessUnit:GetName(), Task:GetName(), From, Event, To, EventData } )
+    
+    local TaskGroup = ProcessUnit:GetGroup()
+    Task.TargetSetUnit:Remove( EventData.IniUnitName )
+    
+    local MessageText = "One of the task targets has been destroyed.\nYour group assigned with task " .. self.TaskName .. " has\n" .. Task.TargetSetUnit:Count() .. " targets ( " .. Task.TargetSetUnit:GetUnitTypesText() .. " ) left to be destroyed."
+    self:GetCommandCenter():MessageTypeToGroup( MessageText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
+
+    if Task.TargetSetUnit:Count() > 0 then
+      self:__More( 1 )
+    else
+      self:__NoMore( 1 )
+    end
+  end
+
+  
+  --- DCS Events
+  
+  --- @param #ACT_ACCOUNT_DEADS self
+  -- @param Core.Event#EVENTDATA EventData
+  function ACT_ACCOUNT_DEADS:OnEventHit( EventData )
+    self:T( { "EventDead", EventData } )
+
+    if EventData.IniPlayerName and EventData.TgtDCSUnitName then
+      self.PlayerHits = self.PlayerHits or {}
+      self.PlayerHits[EventData.TgtDCSUnitName] = EventData.IniPlayerName
+    end
+  end  
+  
+  --- @param #ACT_ACCOUNT_DEADS self
+  -- @param Event#EVENTDATA EventData
+  function ACT_ACCOUNT_DEADS:onfuncEventDead( EventData )
+    self:T( { "EventDead", EventData } )
+
+    if EventData.IniDCSUnit then
+      self:Event( EventData )
+    end
+  end
+
+  --- DCS Events
+  
+  --- @param #ACT_ACCOUNT_DEADS self
+  -- @param Event#EVENTDATA EventData
+  function ACT_ACCOUNT_DEADS:onfuncEventCrash( EventData )
+    self:T( { "EventDead", EventData } )
+
+    if EventData.IniDCSUnit then
+      self:Event( EventData )
+    end
+  end
+
+end -- ACT_ACCOUNT DEADS

Moose Development/Moose/Actions/Act_Assign.lua

@@ -0,0 +1,288 @@
+--- (SP) (MP) (FSM) Accept or reject process for player (task) assignments.
+-- 
+-- ===
+-- 
+-- # @{#ACT_ASSIGN} FSM template class, extends @{Fsm#FSM_PROCESS}
+-- 
+-- ## ACT_ASSIGN state machine:
+-- 
+-- This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
+-- All derived classes from this class will start with the class name, followed by a \_. See the relevant derived class descriptions below.
+-- Each derived class follows exactly the same process, using the same events and following the same state transitions, 
+-- but will have **different implementation behaviour** upon each event or state transition.
+-- 
+-- ### ACT_ASSIGN **Events**:
+-- 
+-- These are the events defined in this class:
+-- 
+--   * **Start**:  Start the tasking acceptance process.
+--   * **Assign**:  Assign the task.
+--   * **Reject**:  Reject the task..
+-- 
+-- ### ACT_ASSIGN **Event methods**:
+-- 
+-- Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions occurring in the process.
+-- There are two types of event methods, which you can use to influence the normal mechanisms in the state machine:
+-- 
+--   * **Immediate**: The event method has exactly the name of the event.
+--   * **Delayed**: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed. 
+-- 
+-- ### ACT_ASSIGN **States**:
+-- 
+--   * **UnAssigned**: The player has not accepted the task.
+--   * **Assigned (*)**: The player has accepted the task.
+--   * **Rejected (*)**: The player has not accepted the task.
+--   * **Waiting**: The process is awaiting player feedback.
+--   * **Failed (*)**: The process has failed.
+--   
+-- (*) End states of the process.
+--   
+-- ### ACT_ASSIGN state transition methods:
+-- 
+-- State transition functions can be set **by the mission designer** customizing or improving the behaviour of the state.
+-- There are 2 moments when state transition methods will be called by the state machine:
+-- 
+--   * **Before** the state transition. 
+--     The state transition method needs to start with the name **OnBefore + the name of the state**. 
+--     If the state transition method returns false, then the processing of the state transition will not be done!
+--     If you want to change the behaviour of the AIControllable at this event, return false, 
+--     but then you'll need to specify your own logic using the AIControllable!
+--   
+--   * **After** the state transition. 
+--     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.
+-- 
+-- ===
+-- 
+-- # 1) @{#ACT_ASSIGN_ACCEPT} class, extends @{Fsm.Assign#ACT_ASSIGN}
+-- 
+-- The ACT_ASSIGN_ACCEPT class accepts by default a task for a player. No player intervention is allowed to reject the task.
+-- 
+-- ## 1.1) ACT_ASSIGN_ACCEPT constructor:
+--   
+--   * @{#ACT_ASSIGN_ACCEPT.New}(): Creates a new ACT_ASSIGN_ACCEPT object.
+-- 
+-- ===
+-- 
+-- # 2) @{#ACT_ASSIGN_MENU_ACCEPT} class, extends @{Fsm.Assign#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.
+-- The assignment type also allows to reject the task.
+-- 
+-- ## 2.1) ACT_ASSIGN_MENU_ACCEPT constructor:
+-- -----------------------------------------
+--   
+--   * @{#ACT_ASSIGN_MENU_ACCEPT.New}(): Creates a new ACT_ASSIGN_MENU_ACCEPT object.
+-- 
+-- ===
+-- 
+-- @module Assign
+
+
+do -- ACT_ASSIGN
+
+  --- ACT_ASSIGN class
+  -- @type ACT_ASSIGN
+  -- @field Tasking.Task#TASK Task
+  -- @field Wrapper.Unit#UNIT ProcessUnit
+  -- @field Core.Zone#ZONE_BASE TargetZone
+  -- @extends Core.Fsm#FSM_PROCESS
+  ACT_ASSIGN = { 
+    ClassName = "ACT_ASSIGN",
+  }
+  
+  
+  --- Creates a new task assignment state machine. The process will accept the task by default, no player intervention accepted.
+  -- @param #ACT_ASSIGN self
+  -- @return #ACT_ASSIGN The task acceptance process.
+  function ACT_ASSIGN:New()
+
+    -- Inherits from BASE
+    local self = BASE:Inherit( self, FSM_PROCESS:New( "ACT_ASSIGN" ) ) -- Core.Fsm#FSM_PROCESS
+
+    self:AddTransition( "UnAssigned", "Start", "Waiting" )
+    self:AddTransition( "Waiting",  "Assign", "Assigned" )
+    self:AddTransition( "Waiting", "Reject", "Rejected" )
+    self:AddTransition( "*", "Fail", "Failed" )
+    
+    self:AddEndState( "Assigned" )
+    self:AddEndState( "Rejected" )
+    self:AddEndState( "Failed" )
+    
+    self:SetStartState( "UnAssigned" )  
+    
+    return self
+  end
+  
+end -- ACT_ASSIGN
+
+
+
+do -- ACT_ASSIGN_ACCEPT
+
+  --- ACT_ASSIGN_ACCEPT class
+  -- @type ACT_ASSIGN_ACCEPT
+  -- @field Tasking.Task#TASK Task
+  -- @field Wrapper.Unit#UNIT ProcessUnit
+  -- @field Core.Zone#ZONE_BASE TargetZone
+  -- @extends #ACT_ASSIGN
+  ACT_ASSIGN_ACCEPT = { 
+    ClassName = "ACT_ASSIGN_ACCEPT",
+  }
+  
+  
+  --- Creates a new task assignment state machine. The process will accept the task by default, no player intervention accepted.
+  -- @param #ACT_ASSIGN_ACCEPT self
+  -- @param #string TaskBriefing
+  function ACT_ASSIGN_ACCEPT:New( TaskBriefing )
+    
+    local self = BASE:Inherit( self, ACT_ASSIGN:New() ) -- #ACT_ASSIGN_ACCEPT
+
+    self.TaskBriefing = TaskBriefing
+    
+    return self
+  end
+
+  function ACT_ASSIGN_ACCEPT:Init( FsmAssign )
+  
+    self.TaskBriefing = FsmAssign.TaskBriefing  
+  end
+
+  --- StateMachine callback function
+  -- @param #ACT_ASSIGN_ACCEPT self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIGN_ACCEPT:onafterStart( ProcessUnit, From, Event, To )
+    self:F( { ProcessUnit, From, Event, To } )
+  
+    self:__Assign( 1 )   
+  end
+
+  --- StateMachine callback function
+  -- @param #ACT_ASSIGN_ACCEPT self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIGN_ACCEPT:onenterAssigned( ProcessUnit, From, Event, To )
+    self:F( { ProcessUnit, From, Event, To } )
+  
+    local ProcessGroup = ProcessUnit:GetGroup()
+
+    self.Task:Assign( ProcessUnit, ProcessUnit:GetPlayerName() )
+  end
+  
+end -- ACT_ASSIGN_ACCEPT
+
+
+do -- ACT_ASSIGN_MENU_ACCEPT
+
+  --- ACT_ASSIGN_MENU_ACCEPT class
+  -- @type ACT_ASSIGN_MENU_ACCEPT
+  -- @field Tasking.Task#TASK Task
+  -- @field Wrapper.Unit#UNIT ProcessUnit
+  -- @field Core.Zone#ZONE_BASE TargetZone
+  -- @extends #ACT_ASSIGN
+  ACT_ASSIGN_MENU_ACCEPT = { 
+    ClassName = "ACT_ASSIGN_MENU_ACCEPT",
+  }
+
+  --- Init.
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  -- @param #string TaskName
+  -- @param #string TaskBriefing
+  -- @return #ACT_ASSIGN_MENU_ACCEPT self
+  function ACT_ASSIGN_MENU_ACCEPT:New( TaskName, TaskBriefing )
+
+    -- Inherits from BASE
+    local self = BASE:Inherit( self, ACT_ASSIGN:New() ) -- #ACT_ASSIGN_MENU_ACCEPT
+
+    self.TaskName = TaskName 
+    self.TaskBriefing = TaskBriefing
+    
+    return self
+  end
+
+  function ACT_ASSIGN_MENU_ACCEPT:Init( FsmAssign )
+  
+    self.TaskName = FsmAssign.TaskName 
+    self.TaskBriefing = FsmAssign.TaskBriefing  
+  end
+  
+  
+  --- Creates a new task assignment state machine. The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  -- @param #string TaskName
+  -- @param #string TaskBriefing
+  -- @return #ACT_ASSIGN_MENU_ACCEPT self
+  function ACT_ASSIGN_MENU_ACCEPT:Init( TaskName, TaskBriefing )
+  
+    self.TaskBriefing = TaskBriefing
+    self.TaskName = TaskName
+
+    return self
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIGN_MENU_ACCEPT:onafterStart( ProcessUnit, From, Event, To )
+    self:F( { ProcessUnit, From, Event, To } )
+
+    self:GetCommandCenter():MessageTypeToGroup( "Access the radio menu to accept the task. You have 30 seconds or the assignment will be cancelled.", ProcessUnit:GetGroup(), MESSAGE.Type.Information )
+   
+    local ProcessGroup = ProcessUnit:GetGroup() 
+    
+    self.Menu = MENU_GROUP:New( ProcessGroup, "Task " .. self.TaskName .. " acceptance" )
+    self.MenuAcceptTask = MENU_GROUP_COMMAND:New( ProcessGroup, "Accept task " .. self.TaskName, self.Menu, self.MenuAssign, self )
+    self.MenuRejectTask = MENU_GROUP_COMMAND:New( ProcessGroup, "Reject task " .. self.TaskName, self.Menu, self.MenuReject, self )
+  end
+  
+  --- Menu function.
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  function ACT_ASSIGN_MENU_ACCEPT:MenuAssign()
+  
+    self:__Assign( 1 )
+  end
+  
+  --- Menu function.
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  function ACT_ASSIGN_MENU_ACCEPT:MenuReject()
+  
+    self:__Reject( 1 )
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIGN_MENU_ACCEPT:onafterAssign( ProcessUnit, From, Event, To )
+    self:F( { ProcessUnit.UnitNameFrom, Event, To } )
+  
+    self.Menu:Remove()
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIGN_MENU_ACCEPT:onafterReject( ProcessUnit, From, Event, To )
+    self:F( { ProcessUnit.UnitName, From, Event, To } )
+  
+    self.Menu:Remove()
+    --TODO: need to resolve this problem ... it has to do with the events ...
+    --self.Task:UnAssignFromUnit( ProcessUnit )needs to become a callback funtion call upon the event
+    ProcessUnit:Destroy()
+  end
+
+end -- ACT_ASSIGN_MENU_ACCEPT

Moose Development/Moose/Actions/Act_Assist.lua

@@ -0,0 +1,216 @@
+--- (SP) (MP) (FSM) Route AI or players through waypoints or to zones.
+-- 
+-- ===
+-- 
+-- # @{#ACT_ASSIST} FSM class, extends @{Fsm#FSM_PROCESS}
+-- 
+-- ## ACT_ASSIST state machine:
+-- 
+-- This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
+-- All derived classes from this class will start with the class name, followed by a \_. See the relevant derived class descriptions below.
+-- Each derived class follows exactly the same process, using the same events and following the same state transitions, 
+-- but will have **different implementation behaviour** upon each event or state transition.
+-- 
+-- ### ACT_ASSIST **Events**:
+-- 
+-- These are the events defined in this class:
+-- 
+--   * **Start**:  The process is started.
+--   * **Next**: The process is smoking the targets in the given zone.
+-- 
+-- ### ACT_ASSIST **Event methods**:
+-- 
+-- Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions occurring in the process.
+-- There are two types of event methods, which you can use to influence the normal mechanisms in the state machine:
+-- 
+--   * **Immediate**: The event method has exactly the name of the event.
+--   * **Delayed**: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed. 
+-- 
+-- ### ACT_ASSIST **States**:
+-- 
+--   * **None**: The controllable did not receive route commands.
+--   * **AwaitSmoke (*)**: The process is awaiting to smoke the targets in the zone.
+--   * **Smoking (*)**: The process is smoking the targets in the zone.
+--   * **Failed (*)**: The process has failed.
+--   
+-- (*) End states of the process.
+--   
+-- ### ACT_ASSIST state transition methods:
+-- 
+-- State transition functions can be set **by the mission designer** customizing or improving the behaviour of the state.
+-- There are 2 moments when state transition methods will be called by the state machine:
+-- 
+--   * **Before** the state transition. 
+--     The state transition method needs to start with the name **OnBefore + the name of the state**. 
+--     If the state transition method returns false, then the processing of the state transition will not be done!
+--     If you want to change the behaviour of the AIControllable at this event, return false, 
+--     but then you'll need to specify your own logic using the AIControllable!
+--   
+--   * **After** the state transition. 
+--     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.
+-- 
+-- ===
+-- 
+-- # 1) @{#ACT_ASSIST_SMOKE_TARGETS_ZONE} class, extends @{Fsm.Route#ACT_ASSIST}
+-- 
+-- The ACT_ASSIST_SMOKE_TARGETS_ZONE class implements the core functions to smoke targets in a @{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.
+-- 
+-- # 1.1) ACT_ASSIST_SMOKE_TARGETS_ZONE constructor:
+--   
+--   * @{#ACT_ASSIST_SMOKE_TARGETS_ZONE.New}(): Creates a new ACT_ASSIST_SMOKE_TARGETS_ZONE object.
+-- 
+-- ===
+-- 
+-- @module Smoke
+
+do -- ACT_ASSIST
+
+  --- ACT_ASSIST class
+  -- @type ACT_ASSIST
+  -- @extends Core.Fsm#FSM_PROCESS
+  ACT_ASSIST = { 
+    ClassName = "ACT_ASSIST",
+  }
+
+  --- Creates a new target smoking state machine. The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.
+  -- @param #ACT_ASSIST self
+  -- @return #ACT_ASSIST
+  function ACT_ASSIST:New()
+
+    -- Inherits from BASE
+    local self = BASE:Inherit( self, FSM_PROCESS:New( "ACT_ASSIST" ) ) -- Core.Fsm#FSM_PROCESS
+
+    self:AddTransition( "None", "Start", "AwaitSmoke" )
+    self:AddTransition( "AwaitSmoke", "Next", "Smoking" )
+    self:AddTransition( "Smoking", "Next", "AwaitSmoke" )
+    self:AddTransition( "*", "Stop", "Success" )
+    self:AddTransition( "*", "Fail", "Failed" )
+    
+    self:AddEndState( "Failed" )
+    self:AddEndState( "Success" )
+    
+    self:SetStartState( "None" )  
+
+    return self
+  end
+  
+  --- Task Events
+
+  --- StateMachine callback function
+  -- @param #ACT_ASSIST self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIST:onafterStart( ProcessUnit, From, Event, To )
+  
+    local ProcessGroup = ProcessUnit:GetGroup()
+    local MissionMenu = self:GetMission():GetMenu( ProcessGroup )
+     
+    local function MenuSmoke( MenuParam )
+      local self = MenuParam.self
+      local SmokeColor = MenuParam.SmokeColor
+      self.SmokeColor = SmokeColor
+      self:__Next( 1 )
+    end
+     
+    self.Menu = MENU_GROUP:New( ProcessGroup, "Target acquisition", MissionMenu )
+    self.MenuSmokeBlue   = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop blue smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.Blue } )
+    self.MenuSmokeGreen  = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop green smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.Green } )
+    self.MenuSmokeOrange = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop Orange smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.Orange } )
+    self.MenuSmokeRed    = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop Red smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.Red } )
+    self.MenuSmokeWhite  = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop White smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.White } )
+  end
+
+  --- StateMachine callback function
+  -- @param #ACT_ASSIST self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIST:onafterStop( ProcessUnit, From, Event, To )
+     
+    self.Menu:Remove() -- When stopped, remove the menus
+  end
+  
+end
+
+do -- ACT_ASSIST_SMOKE_TARGETS_ZONE
+
+  --- ACT_ASSIST_SMOKE_TARGETS_ZONE class
+  -- @type ACT_ASSIST_SMOKE_TARGETS_ZONE
+  -- @field Set#SET_UNIT TargetSetUnit
+  -- @field Core.Zone#ZONE_BASE TargetZone
+  -- @extends #ACT_ASSIST
+  ACT_ASSIST_SMOKE_TARGETS_ZONE = { 
+    ClassName = "ACT_ASSIST_SMOKE_TARGETS_ZONE",
+  }
+  
+--  function ACT_ASSIST_SMOKE_TARGETS_ZONE:_Destructor()
+--    self:E("_Destructor")
+--  
+--    self.Menu:Remove()
+--    self:EventRemoveAll()
+--  end
+  
+  --- Creates a new target smoking state machine. The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.
+  -- @param #ACT_ASSIST_SMOKE_TARGETS_ZONE self
+  -- @param Set#SET_UNIT TargetSetUnit
+  -- @param Core.Zone#ZONE_BASE TargetZone
+  function ACT_ASSIST_SMOKE_TARGETS_ZONE:New( TargetSetUnit, TargetZone )
+    local self = BASE:Inherit( self, ACT_ASSIST:New() ) -- #ACT_ASSIST
+
+    self.TargetSetUnit = TargetSetUnit
+    self.TargetZone = TargetZone
+  
+    return self
+  end
+
+  function ACT_ASSIST_SMOKE_TARGETS_ZONE:Init( FsmSmoke )
+    
+    self.TargetSetUnit = FsmSmoke.TargetSetUnit
+    self.TargetZone = FsmSmoke.TargetZone
+  end
+  
+  --- Creates a new target smoking state machine. The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.
+  -- @param #ACT_ASSIST_SMOKE_TARGETS_ZONE self
+  -- @param Set#SET_UNIT TargetSetUnit
+  -- @param Core.Zone#ZONE_BASE TargetZone
+  -- @return #ACT_ASSIST_SMOKE_TARGETS_ZONE self
+  function ACT_ASSIST_SMOKE_TARGETS_ZONE:Init( TargetSetUnit, TargetZone )
+    
+    self.TargetSetUnit = TargetSetUnit
+    self.TargetZone = TargetZone
+    
+    return self
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ASSIST_SMOKE_TARGETS_ZONE self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIST_SMOKE_TARGETS_ZONE:onenterSmoking( ProcessUnit, From, Event, To )
+    
+    self.TargetSetUnit:ForEachUnit(
+      --- @param Wrapper.Unit#UNIT SmokeUnit
+      function( SmokeUnit )
+        if math.random( 1, ( 100 * self.TargetSetUnit:Count() ) / 4 ) <= 100 then
+          SCHEDULER:New( self,
+            function()
+              if SmokeUnit:IsAlive() then
+                SmokeUnit:Smoke( self.SmokeColor, 150 )
+              end
+            end, {}, math.random( 10, 60 ) 
+          )
+        end
+      end
+    )
+    
+  end
+  
+end

Moose Development/Moose/Actions/Act_JTAC.lua

@@ -0,0 +1,198 @@
+--- @module Process_JTAC
+
+--- PROCESS_JTAC class
+-- @type PROCESS_JTAC
+-- @field Wrapper.Unit#UNIT ProcessUnit
+-- @field Core.Set#SET_UNIT TargetSetUnit
+-- @extends Core.Fsm#FSM_PROCESS
+PROCESS_JTAC = { 
+  ClassName = "PROCESS_JTAC",
+  Fsm = {},
+  TargetSetUnit = nil,
+}
+
+
+--- Creates a new DESTROY process.
+-- @param #PROCESS_JTAC self
+-- @param Tasking.Task#TASK Task
+-- @param Wrapper.Unit#UNIT ProcessUnit
+-- @param Core.Set#SET_UNIT TargetSetUnit
+-- @param Wrapper.Unit#UNIT FACUnit
+-- @return #PROCESS_JTAC self
+function PROCESS_JTAC:New( Task, ProcessUnit, TargetSetUnit, FACUnit )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, PROCESS:New( "JTAC", Task, ProcessUnit ) ) -- #PROCESS_JTAC
+  
+  self.TargetSetUnit = TargetSetUnit
+  self.FACUnit = FACUnit
+
+  self.DisplayInterval = 60
+  self.DisplayCount = 30
+  self.DisplayMessage = true
+  self.DisplayTime = 10 -- 10 seconds is the default
+  self.DisplayCategory = "HQ" -- Targets is the default display category
+
+
+  self.Fsm = FSM_PROCESS:New( self, {
+    initial = 'Assigned',
+    events = {
+      { name = 'Start', from = 'Assigned', to = 'CreatedMenu'    },
+      { name = 'JTACMenuUpdate', from = 'CreatedMenu', to = 'AwaitingMenu'    },
+      { name = 'JTACMenuAwait', from = 'AwaitingMenu', to = 'AwaitingMenu'    },
+      { name = 'JTACMenuSpot', from = 'AwaitingMenu', to = 'AwaitingMenu'    },
+      { name = 'JTACMenuCancel', from = 'AwaitingMenu', to = 'AwaitingMenu'  },
+      { name = 'JTACStatus', from = 'AwaitingMenu', to = 'AwaitingMenu'  },
+      { name = 'Fail', from = 'AwaitingMenu', to = 'Failed' },
+      { name = 'Fail', from = 'CreatedMenu', to = 'Failed' },
+    },
+    callbacks = {
+      onStart =  self.OnStart,
+      onJTACMenuUpdate = self.OnJTACMenuUpdate,
+      onJTACMenuAwait =  self.OnJTACMenuAwait,
+      onJTACMenuSpot = self.OnJTACMenuSpot,
+      onJTACMenuCancel = self.OnJTACMenuCancel,
+    },
+    endstates = { 'Failed' }
+  } )
+
+  self:HandleEvent( EVENTS.Dead, self.EventDead )
+  
+  return self
+end
+
+--- Process Events
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_JTAC:OnStart( Fsm, From, Event, To )
+
+  self:NextEvent( Fsm.JTACMenuUpdate )
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_JTAC:OnJTACMenuUpdate( Fsm, From, Event, To )
+
+  local function JTACMenuSpot( MenuParam )
+    self:F( MenuParam.TargetUnit.UnitName )
+    local self = MenuParam.self
+    local TargetUnit = MenuParam.TargetUnit
+
+    self:NextEvent( self.Fsm.JTACMenuSpot, TargetUnit )
+  end
+
+  local function JTACMenuCancel( MenuParam )
+    self:F( MenuParam )
+    local self = MenuParam.self
+    local TargetUnit = MenuParam.TargetUnit
+ 
+    self:NextEvent( self.Fsm.JTACMenuCancel, TargetUnit )
+  end
+
+
+  -- Loop each unit in the target set, and determine the threat levels map table.
+  local UnitThreatLevels = self.TargetSetUnit:GetUnitThreatLevels()
+  
+  self:F( {"UnitThreadLevels", UnitThreatLevels } )
+  
+  local JTACMenu = self.ProcessGroup:GetState( self.ProcessGroup, "JTACMenu" )
+  
+  if not JTACMenu then
+    JTACMenu = MENU_GROUP:New( self.ProcessGroup, "JTAC", self.MissionMenu )
+    for ThreatLevel, ThreatLevelTable in pairs( UnitThreatLevels ) do
+      local JTACMenuThreatLevel = MENU_GROUP:New( self.ProcessGroup, ThreatLevelTable.UnitThreatLevelText, JTACMenu )
+      for ThreatUnitName, ThreatUnit in pairs( ThreatLevelTable.Units ) do
+        local JTACMenuUnit = MENU_GROUP:New( self.ProcessGroup, ThreatUnit:GetTypeName(), JTACMenuThreatLevel )
+        MENU_GROUP_COMMAND:New( self.ProcessGroup, "Lase Target", JTACMenuUnit, JTACMenuSpot, { self = self, TargetUnit = ThreatUnit } )
+        MENU_GROUP_COMMAND:New( self.ProcessGroup, "Cancel Target", JTACMenuUnit, JTACMenuCancel, { self = self, TargetUnit = ThreatUnit } )
+      end
+    end
+  end  
+  
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_JTAC:OnJTACMenuAwait( Fsm, From, Event, To )
+
+  if self.DisplayCount >= self.DisplayInterval then
+
+    local TaskJTAC = self.Task -- Tasking.Task#TASK_JTAC
+    TaskJTAC.Spots = TaskJTAC.Spots or {}
+    for TargetUnitName, SpotData in pairs( TaskJTAC.Spots) do
+      local TargetUnit = UNIT:FindByName( TargetUnitName )
+      self.FACUnit:MessageToGroup( "Lasing " .. TargetUnit:GetTypeName() .. " with laser code " .. SpotData:getCode(), 15, self.ProcessGroup )
+    end
+    self.DisplayCount = 1
+  else
+    self.DisplayCount = self.DisplayCount + 1
+  end
+  
+  self:NextEvent( Fsm.JTACMenuAwait )
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+-- @param Wrapper.Unit#UNIT TargetUnit
+function PROCESS_JTAC:OnJTACMenuSpot( Fsm, From, Event, To, TargetUnit )
+
+  local TargetUnitName = TargetUnit:GetName()
+  
+  local TaskJTAC = self.Task -- Tasking.Task#TASK_JTAC
+  
+  TaskJTAC.Spots = TaskJTAC.Spots or {}
+  TaskJTAC.Spots[TargetUnitName] = TaskJTAC.Spots[TargetUnitName] or {}
+
+  local DCSFACObject = self.FACUnit:GetDCSObject()
+  local TargetVec3 = TargetUnit:GetVec3()
+
+  TaskJTAC.Spots[TargetUnitName] = Spot.createInfraRed( self.FACUnit:GetDCSObject(), { x = 0, y = 1, z = 0 }, TargetUnit:GetVec3(), math.random( 1000, 9999 ) )
+  
+  local SpotData = TaskJTAC.Spots[TargetUnitName]
+  self.FACUnit:MessageToGroup( "Lasing " .. TargetUnit:GetTypeName() .. " with laser code " .. SpotData:getCode(), 15, self.ProcessGroup )
+
+  self:NextEvent( Fsm.JTACMenuAwait )
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+-- @param Wrapper.Unit#UNIT TargetUnit
+function PROCESS_JTAC:OnJTACMenuCancel( Fsm, From, Event, To, TargetUnit )
+
+  local TargetUnitName = TargetUnit:GetName()
+  
+  local TaskJTAC = self.Task -- Tasking.Task#TASK_JTAC
+  
+  TaskJTAC.Spots = TaskJTAC.Spots or {}
+  if TaskJTAC.Spots[TargetUnitName] then
+    TaskJTAC.Spots[TargetUnitName]:destroy() -- destroys the spot
+    TaskJTAC.Spots[TargetUnitName] = nil
+  end
+
+  self.FACUnit:MessageToGroup( "Stopped lasing " .. TargetUnit:GetTypeName(), 15, self.ProcessGroup )
+
+  self:NextEvent( Fsm.JTACMenuAwait )
+end
+
+

Moose Development/Moose/Actions/Act_Pickup.lua

@@ -0,0 +1,173 @@
+--- @module Process_Pickup
+
+--- PROCESS_PICKUP class
+-- @type PROCESS_PICKUP
+-- @field Wrapper.Unit#UNIT ProcessUnit
+-- @field Core.Set#SET_UNIT TargetSetUnit
+-- @extends Core.Fsm#FSM_PROCESS
+PROCESS_PICKUP = { 
+  ClassName = "PROCESS_PICKUP",
+  Fsm = {},
+  TargetSetUnit = nil,
+}
+
+
+--- Creates a new DESTROY process.
+-- @param #PROCESS_PICKUP self
+-- @param Tasking.Task#TASK Task
+-- @param Wrapper.Unit#UNIT ProcessUnit
+-- @param Core.Set#SET_UNIT TargetSetUnit
+-- @return #PROCESS_PICKUP self
+function PROCESS_PICKUP:New( Task, ProcessName, ProcessUnit )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, PROCESS:New( ProcessName, Task, ProcessUnit ) ) -- #PROCESS_PICKUP
+  
+  self.DisplayInterval = 30
+  self.DisplayCount = 30
+  self.DisplayMessage = true
+  self.DisplayTime = 10 -- 10 seconds is the default
+  self.DisplayCategory = "HQ" -- Targets is the default display category
+
+  self.Fsm = FSM_PROCESS:New( self, {
+    initial = 'Assigned',
+    events = {
+      { name = 'Start',     from = 'Assigned',        to = 'Navigating'    },
+      { name = 'Start',     from = 'Navigating',      to = 'Navigating'    },
+      { name = 'Nearby',    from = 'Navigating',      to = 'Preparing' },
+      { name = 'Pickup',    from = 'Preparing',       to = 'Loading'  },
+      { name = 'Load',      from = 'Loading',         to = 'Success'  },
+      { name = 'Fail',      from = 'Assigned',        to = 'Failed' },
+      { name = 'Fail',      from = 'Navigating',      to = 'Failed' },
+      { name = 'Fail',      from = 'Preparing',       to = 'Failed' },
+    },
+    callbacks = {
+      onStart =  self.OnStart,
+      onNearby = self.OnNearby,
+      onPickup =  self.OnPickup,
+      onLoad = self.OnLoad,
+    },
+    endstates = { 'Success', 'Failed' }
+  } )
+
+  return self
+end
+
+--- Process Events
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnStart( Fsm, From, Event, To )
+
+  self:NextEvent( Fsm.Start )
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnNavigating( Fsm, From, Event, To )
+
+  local TaskGroup = self.ProcessUnit:GetGroup()
+  if self.DisplayCount >= self.DisplayInterval then
+    MESSAGE:New( "Your group with assigned " .. self.Task:GetName() .. " task has " .. self.TargetSetUnit:GetUnitTypesText() .. " targets left to be destroyed.", 5, "HQ" ):ToGroup( TaskGroup )
+    self.DisplayCount = 1
+  else
+    self.DisplayCount = self.DisplayCount + 1
+  end
+  
+  return true -- Process always the event.
+  
+end
+
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+-- @param Core.Event#EVENTDATA Event
+function PROCESS_PICKUP:OnHitTarget( Fsm, From, Event, To, Event )
+
+
+  self.TargetSetUnit:Flush( self )
+  
+  if self.TargetSetUnit:FindUnit( Event.IniUnitName ) then
+    self.TargetSetUnit:RemoveUnitsByName( Event.IniUnitName )
+    local TaskGroup = self.ProcessUnit:GetGroup()
+    MESSAGE:New( "You hit a target. Your group with assigned " .. self.Task:GetName() .. " task has " .. self.TargetSetUnit:Count() .. " targets ( " .. self.TargetSetUnit:GetUnitTypesText() .. " ) left to be destroyed.", 15, "HQ" ):ToGroup( TaskGroup )
+  end
+
+  
+  if self.TargetSetUnit:Count() > 0 then
+    self:NextEvent( Fsm.MoreTargets )
+  else
+    self:NextEvent( Fsm.Destroyed )
+  end
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnMoreTargets( Fsm, From, Event, To )
+
+
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+-- @param Core.Event#EVENTDATA DCSEvent
+function PROCESS_PICKUP:OnKilled( Fsm, From, Event, To )
+
+  self:NextEvent( Fsm.Restart )
+
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnRestart( Fsm, From, Event, To )
+
+  self:NextEvent( Fsm.Menu )
+
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnDestroyed( Fsm, From, Event, To )
+
+end
+
+--- DCS Events
+
+--- @param #PROCESS_PICKUP self
+-- @param Core.Event#EVENTDATA Event
+function PROCESS_PICKUP:EventDead( Event )
+
+  if Event.IniDCSUnit then
+    self:NextEvent( self.Fsm.HitTarget, Event )
+  end
+end
+
+

Moose Development/Moose/Actions/Act_Route.lua

@@ -0,0 +1,474 @@
+--- (SP) (MP) (FSM) Route AI or players through waypoints or to zones.
+-- 
+-- ===
+-- 
+-- # @{#ACT_ROUTE} FSM class, extends @{Fsm#FSM_PROCESS}
+-- 
+-- ## ACT_ROUTE state machine:
+-- 
+-- This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
+-- All derived classes from this class will start with the class name, followed by a \_. See the relevant derived class descriptions below.
+-- Each derived class follows exactly the same process, using the same events and following the same state transitions, 
+-- but will have **different implementation behaviour** upon each event or state transition.
+-- 
+-- ### ACT_ROUTE **Events**:
+-- 
+-- These are the events defined in this class:
+-- 
+--   * **Start**:  The process is started. The process will go into the Report state.
+--   * **Report**: The process is reporting to the player the route to be followed.
+--   * **Route**: The process is routing the controllable.
+--   * **Pause**: The process is pausing the route of the controllable.
+--   * **Arrive**: The controllable has arrived at a route point.
+--   * **More**:  There are more route points that need to be followed. The process will go back into the Report state.
+--   * **NoMore**:  There are no more route points that need to be followed. The process will go into the Success state.
+-- 
+-- ### ACT_ROUTE **Event methods**:
+-- 
+-- Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions occurring in the process.
+-- There are two types of event methods, which you can use to influence the normal mechanisms in the state machine:
+-- 
+--   * **Immediate**: The event method has exactly the name of the event.
+--   * **Delayed**: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed. 
+-- 
+-- ### ACT_ROUTE **States**:
+-- 
+--   * **None**: The controllable did not receive route commands.
+--   * **Arrived (*)**: The controllable has arrived at a route point.
+--   * **Aborted (*)**: The controllable has aborted the route path.
+--   * **Routing**: The controllable is understay to the route point.
+--   * **Pausing**: The process is pausing the routing. AI air will go into hover, AI ground will stop moving. Players can fly around.
+--   * **Success (*)**: All route points were reached. 
+--   * **Failed (*)**: The process has failed.
+--   
+-- (*) End states of the process.
+--   
+-- ### ACT_ROUTE state transition methods:
+-- 
+-- State transition functions can be set **by the mission designer** customizing or improving the behaviour of the state.
+-- There are 2 moments when state transition methods will be called by the state machine:
+-- 
+--   * **Before** the state transition. 
+--     The state transition method needs to start with the name **OnBefore + the name of the state**. 
+--     If the state transition method returns false, then the processing of the state transition will not be done!
+--     If you want to change the behaviour of the AIControllable at this event, return false, 
+--     but then you'll need to specify your own logic using the AIControllable!
+--   
+--   * **After** the state transition. 
+--     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.
+-- 
+-- ===
+-- 
+-- # 1) @{#ACT_ROUTE_ZONE} class, extends @{Fsm.Route#ACT_ROUTE}
+-- 
+-- The ACT_ROUTE_ZONE class implements the core functions to route an AIR @{Controllable} player @{Unit} to a @{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.
+-- 
+-- # 1.1) ACT_ROUTE_ZONE constructor:
+--   
+--   * @{#ACT_ROUTE_ZONE.New}(): Creates a new ACT_ROUTE_ZONE object.
+-- 
+-- ===
+-- 
+-- @module Route
+
+
+do -- ACT_ROUTE
+
+  --- ACT_ROUTE class
+  -- @type ACT_ROUTE
+  -- @field Tasking.Task#TASK TASK
+  -- @field Wrapper.Unit#UNIT ProcessUnit
+  -- @field Core.Zone#ZONE_BASE Zone
+  -- @field Core.Point#COORDINATE Coordinate
+  -- @extends Core.Fsm#FSM_PROCESS
+  ACT_ROUTE = { 
+    ClassName = "ACT_ROUTE",
+  }
+  
+  
+  --- Creates a new routing state machine. The process will route a CLIENT to a ZONE until the CLIENT is within that ZONE.
+  -- @param #ACT_ROUTE self
+  -- @return #ACT_ROUTE self
+  function ACT_ROUTE:New()
+
+    -- Inherits from BASE
+    local self = BASE:Inherit( self, FSM_PROCESS:New( "ACT_ROUTE" ) ) -- Core.Fsm#FSM_PROCESS
+ 
+    self:AddTransition( "*", "Reset", "None" )
+    self:AddTransition( "None", "Start", "Routing" )
+    self:AddTransition( "*", "Report", "*" )
+    self:AddTransition( "Routing", "Route", "Routing" )
+    self:AddTransition( "Routing", "Pause", "Pausing" )
+    self:AddTransition( "Routing", "Arrive", "Arrived" )
+    self:AddTransition( "*", "Cancel", "Cancelled" )
+    self:AddTransition( "Arrived", "Success", "Success" )
+    self:AddTransition( "*", "Fail", "Failed" )
+    self:AddTransition( "", "", "" )
+    self:AddTransition( "", "", "" )
+ 
+    self:AddEndState( "Arrived" )
+    self:AddEndState( "Failed" )
+    self:AddEndState( "Cancelled" )
+    
+    self:SetStartState( "None" )
+    
+    self:SetRouteMode( "C" )  
+  
+    return self
+  end
+  
+  --- Set a Cancel Menu item.
+  -- @param #ACT_ROUTE self
+  -- @return #ACT_ROUTE
+  function ACT_ROUTE:SetMenuCancel( MenuGroup, MenuText, ParentMenu, MenuTime )
+    
+    MENU_GROUP_COMMAND:New(
+      MenuGroup,
+      MenuText,
+      ParentMenu,
+      self.MenuCancel,
+      self
+    ):SetTime(MenuTime)
+    
+    return self
+  end
+  
+  --- Set the route mode.
+  -- There are 2 route modes supported:
+  -- 
+  --   * SetRouteMode( "B" ): Route mode is Bearing and Range.
+  --   * SetRouteMode( "C" ): Route mode is LL or MGRS according coordinate system setup.
+  -- 
+  -- @param #ACT_ROUTE self
+  -- @return #ACT_ROUTE
+  function ACT_ROUTE:SetRouteMode( RouteMode )
+  
+    self.RouteMode = RouteMode
+
+    return self  
+  end
+  
+  --- Get the routing text to be displayed.
+  -- The route mode determines the text displayed.
+  -- @param #ACT_ROUTE self
+  -- @param Wrapper.Unit#UNIT Controllable
+  -- @return #string
+  function ACT_ROUTE:GetRouteText( Controllable )
+    
+    local RouteText = ""
+
+    local Coordinate = nil -- Core.Point#COORDINATE
+    
+    if self.Coordinate then
+      Coordinate = self.Coordinate
+    end
+    
+    if self.Zone then
+      Coordinate = self.Zone:GetPointVec3( self.Altitude )
+      Coordinate:SetHeading( self.Heading )
+    end
+    
+
+    local Task = self:GetTask() -- This is to dermine that the coordinates are for a specific task mode (A2A or A2G).
+    local CC = self:GetTask():GetMission():GetCommandCenter()
+    if CC then
+      if CC:IsModeWWII() then
+        -- Find closest reference point to the target.
+        local ShortestDistance = 0
+        local ShortestReferencePoint = nil
+        local ShortestReferenceName = ""
+        self:F( { CC.ReferencePoints } )
+        for ZoneName, Zone in pairs( CC.ReferencePoints ) do
+          self:F( { ZoneName = ZoneName } )
+          local Zone = Zone -- Core.Zone#ZONE
+          local ZoneCoord = Zone:GetCoordinate()
+          local ZoneDistance = ZoneCoord:Get2DDistance( self.Coordinate )
+          self:F( { ShortestDistance, ShortestReferenceName } )
+          if ShortestDistance == 0 or ZoneDistance < ShortestDistance then
+            ShortestDistance = ZoneDistance
+            ShortestReferencePoint = ZoneCoord
+            ShortestReferenceName = CC.ReferenceNames[ZoneName]
+          end
+        end
+        if ShortestReferencePoint then
+          RouteText = Coordinate:ToStringFromRP( ShortestReferencePoint, ShortestReferenceName, Controllable )
+        end
+      else
+        RouteText = Coordinate:ToString( Controllable, nil, Task )
+      end
+    end
+
+    return RouteText
+  end
+
+  
+  function ACT_ROUTE:MenuCancel()
+    self:Cancel()
+  end
+
+  --- Task Events
+
+  --- StateMachine callback function
+  -- @param #ACT_ROUTE self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ROUTE:onafterStart( ProcessUnit, From, Event, To )
+  
+
+    self:__Route( 1 )
+  end
+  
+  --- Check if the controllable has arrived.
+  -- @param #ACT_ROUTE self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @return #boolean
+  function ACT_ROUTE:onfuncHasArrived( ProcessUnit )
+    return false
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ROUTE self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ROUTE:onbeforeRoute( ProcessUnit, From, Event, To )
+    self:F( { "BeforeRoute 1", self.DisplayCount, self.DisplayInterval } )
+  
+    if ProcessUnit:IsAlive() then
+      self:F( "BeforeRoute 2" )
+      local HasArrived = self:onfuncHasArrived( ProcessUnit ) -- Polymorphic
+      if self.DisplayCount >= self.DisplayInterval then
+        self:T( { HasArrived = HasArrived } )
+        if not HasArrived then
+          self:Report()
+        end
+        self.DisplayCount = 1
+      else
+        self.DisplayCount = self.DisplayCount + 1
+      end
+      
+      self:T( { DisplayCount = self.DisplayCount } )
+      
+      if HasArrived then
+        self:__Arrive( 1 )
+      else
+        self:__Route( 1 )
+      end
+    
+      return HasArrived -- if false, then the event will not be executed...
+    end
+    
+    return false
+    
+  end
+
+end -- ACT_ROUTE
+
+
+do -- ACT_ROUTE_POINT
+
+  --- ACT_ROUTE_POINT class
+  -- @type ACT_ROUTE_POINT
+  -- @field Tasking.Task#TASK TASK
+  -- @extends #ACT_ROUTE
+  ACT_ROUTE_POINT = { 
+    ClassName = "ACT_ROUTE_POINT",
+  }
+
+
+  --- Creates a new routing state machine. 
+  -- The task will route a controllable to a Coordinate until the controllable is within the Range.
+  -- @param #ACT_ROUTE_POINT self
+  -- @param Core.Point#COORDINATE The Coordinate to Target.
+  -- @param #number Range The Distance to Target.
+  -- @param Core.Zone#ZONE_BASE Zone
+  function ACT_ROUTE_POINT:New( Coordinate, Range )
+    local self = BASE:Inherit( self, ACT_ROUTE:New() ) -- #ACT_ROUTE_POINT
+
+    self.Coordinate = Coordinate
+    self.Range = Range or 0
+    
+    self.DisplayInterval = 30
+    self.DisplayCount = 30
+    self.DisplayMessage = true
+    self.DisplayTime = 10 -- 10 seconds is the default
+    
+    return self
+  end
+  
+  --- Creates a new routing state machine. 
+  -- The task will route a controllable to a Coordinate until the controllable is within the Range.
+  -- @param #ACT_ROUTE_POINT self
+  function ACT_ROUTE_POINT:Init( FsmRoute )
+  
+    self.Coordinate = FsmRoute.Coordinate
+    self.Range = FsmRoute.Range or 0
+    
+    self.DisplayInterval = 30
+    self.DisplayCount = 30
+    self.DisplayMessage = true
+    self.DisplayTime = 10 -- 10 seconds is the default
+    self:SetStartState("None")
+  end  
+
+  --- Set Coordinate
+  -- @param #ACT_ROUTE_POINT self
+  -- @param Core.Point#COORDINATE Coordinate The Coordinate to route to.
+  function ACT_ROUTE_POINT:SetCoordinate( Coordinate )
+    self:F2( { Coordinate } )
+    self.Coordinate = Coordinate
+  end  
+
+  --- Get Coordinate
+  -- @param #ACT_ROUTE_POINT self
+  -- @return Core.Point#COORDINATE Coordinate The Coordinate to route to.
+  function ACT_ROUTE_POINT:GetCoordinate()
+    self:F2( { self.Coordinate } )
+    return self.Coordinate
+  end  
+
+  --- Set Range around Coordinate
+  -- @param #ACT_ROUTE_POINT self
+  -- @param #number Range The Range to consider the arrival. Default is 10000 meters.
+  function ACT_ROUTE_POINT:SetRange( Range )
+    self:F2( { self.Range } )
+    self.Range = Range or 10000
+  end  
+  
+  --- Get Range around Coordinate
+  -- @param #ACT_ROUTE_POINT self
+  -- @return #number The Range to consider the arrival. Default is 10000 meters.
+  function ACT_ROUTE_POINT:GetRange()
+    return self.Range
+  end  
+  
+  --- Method override to check if the controllable has arrived.
+  -- @param #ACT_ROUTE_POINT self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @return #boolean
+  function ACT_ROUTE_POINT:onfuncHasArrived( ProcessUnit )
+
+    if ProcessUnit:IsAlive() then
+      local Distance = self.Coordinate:Get2DDistance( ProcessUnit:GetCoordinate() )
+      
+      if Distance <= self.Range then
+        local RouteText = "You have arrived."
+        self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
+        return true
+      end
+    end
+
+    return false
+  end
+  
+  --- Task Events
+  
+  --- StateMachine callback function
+  -- @param #ACT_ROUTE_POINT self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ROUTE_POINT:onafterReport( ProcessUnit, From, Event, To )
+  
+    local RouteText = self:GetRouteText( ProcessUnit )
+    
+    self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Update )
+  end
+
+end -- ACT_ROUTE_POINT
+
+
+do -- ACT_ROUTE_ZONE
+
+  --- ACT_ROUTE_ZONE class
+  -- @type ACT_ROUTE_ZONE
+  -- @field Tasking.Task#TASK TASK
+  -- @field Wrapper.Unit#UNIT ProcessUnit
+  -- @field Core.Zone#ZONE_BASE Zone
+  -- @extends #ACT_ROUTE
+  ACT_ROUTE_ZONE = { 
+    ClassName = "ACT_ROUTE_ZONE",
+  }
+
+
+  --- Creates a new routing state machine. The task will route a controllable to a ZONE until the controllable is within that ZONE.
+  -- @param #ACT_ROUTE_ZONE self
+  -- @param Core.Zone#ZONE_BASE Zone
+  function ACT_ROUTE_ZONE:New( Zone )
+    local self = BASE:Inherit( self, ACT_ROUTE:New() ) -- #ACT_ROUTE_ZONE
+
+    self.Zone = Zone
+    
+    self.DisplayInterval = 30
+    self.DisplayCount = 30
+    self.DisplayMessage = true
+    self.DisplayTime = 10 -- 10 seconds is the default
+    
+    return self
+  end
+  
+  function ACT_ROUTE_ZONE:Init( FsmRoute )
+  
+    self.Zone = FsmRoute.Zone
+    
+    self.DisplayInterval = 30
+    self.DisplayCount = 30
+    self.DisplayMessage = true
+    self.DisplayTime = 10 -- 10 seconds is the default
+  end  
+  
+  --- Set Zone
+  -- @param #ACT_ROUTE_ZONE self
+  -- @param Core.Zone#ZONE_BASE Zone The Zone object where to route to.
+  -- @param #number Altitude
+  -- @param #number Heading
+  function ACT_ROUTE_ZONE:SetZone( Zone, Altitude, Heading ) -- R2.2 Added altitude and heading
+    self.Zone = Zone
+    self.Altitude = Altitude
+    self.Heading = Heading
+  end  
+
+  --- Get Zone
+  -- @param #ACT_ROUTE_ZONE self
+  -- @return Core.Zone#ZONE_BASE Zone The Zone object where to route to.
+  function ACT_ROUTE_ZONE:GetZone()
+    return self.Zone 
+  end  
+
+  --- Method override to check if the controllable has arrived.
+  -- @param #ACT_ROUTE self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @return #boolean
+  function ACT_ROUTE_ZONE:onfuncHasArrived( ProcessUnit )
+
+    if ProcessUnit:IsInZone( self.Zone ) then
+      local RouteText = "You have arrived within the zone."
+      self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
+    end
+
+    return ProcessUnit:IsInZone( self.Zone )
+  end
+  
+  --- Task Events
+  
+  --- StateMachine callback function
+  -- @param #ACT_ROUTE_ZONE self
+  -- @param Wrapper.Unit#UNIT ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ROUTE_ZONE:onafterReport( ProcessUnit, From, Event, To )
+    self:F( { ProcessUnit = ProcessUnit } )
+  
+    local RouteText = self:GetRouteText( ProcessUnit )
+    self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Update )
+  end
+
+end -- ACT_ROUTE_ZONE

Moose Development/Moose/Base.lua

@@ -1,497 +0,0 @@
---- BASE classes.
--- 
--- @{#BASE} class
--- ==============
--- The @{#BASE} class is the super class for most of the classes defined within MOOSE.
--- 
--- It handles:
--- 
---   * The construction and inheritance of child classes.
---   * The tracing of objects during mission execution within the DCS.log file (under saved games folder).
--- 
--- Note: Normally you would not use the BASE class unless you are extending the MOOSE framework with new classes.
--- 
--- BASE Trace functionality
--- ========================
--- The BASE class contains trace methods to trace progress within a mission execution of a certain object.
--- Note that these trace methods are inherited by each MOOSE class interiting BASE.
--- As such, each object created from derived class from BASE can use the tracing functions to trace its execution.
--- 
--- Trace a function call
--- ---------------------
--- There are basically 3 types of tracing methods available within BASE:
--- 
---   * @{#BASE.F}: Trace the beginning of a function and its given parameters.
---   * @{#BASE.T}: Trace further logic within a function giving optional variables or parameters.
---   * @{#BASE.E}: Trace an execption within a function giving optional variables or parameters. An exception will always be traced.
--- 
--- Tracing levels
--- --------------
--- There are 3 tracing levels within MOOSE.  
--- These tracing levels were defined to avoid bulks of tracing to be generated by lots of objects.
--- 
--- As such, the F and T methods have additional variants to trace level 2 and 3 respectively:
---
---   * @{#BASE.F2}: Trace the beginning of a function and its given parameters with tracing level 2.
---   * @{#BASE.F3}: Trace the beginning of a function and its given parameters with tracing level 3.
---   * @{#BASE.T2}: Trace further logic within a function giving optional variables or parameters with tracing level 2.
---   * @{#BASE.T3}: Trace further logic within a function giving optional variables or parameters with tracing level 3.
--- 
--- BASE Inheritance support
--- ========================
--- The following methods are available to support inheritance:
--- 
---   * @{#BASE.Inherit}: Inherits from a class.
---   * @{#BASE.Inherited}: Returns the parent class from the class.
--- 
--- Future
--- ======
--- Further methods may be added to BASE whenever there is a need to make "overall" functions available within MOOSE.
--- 
--- ====
--- 
--- @module Base
--- @author FlightControl
-
-Include.File( "Routines" )
-
-local _TraceOn = true
-local _TraceLevel = 1
-local _TraceClass = {
-	--DATABASE = true,
-	--SEAD = true,
-	--DESTROYBASETASK = true,
-	--MOVEMENT = true,
-	--SPAWN = true,
-	--STAGE = true,
-	--ZONE = true,
-	--GROUP = true,
-	--UNIT = true,
-  --CLIENT = true,
-	--CARGO = true,
-	--CARGO_GROUP = true,
-	--CARGO_PACKAGE = true,
-	--CARGO_SLINGLOAD = true,
-	--CARGO_ZONE = true,
-	--CLEANUP = true,
-	--MENU_CLIENT = true,
-	--MENU_CLIENT_COMMAND = true,
-	--ESCORT = true,
-	}
-local _TraceClassMethod = {}
-
---- The BASE Class
--- @type BASE
--- @field ClassName The name of the class.
--- @field ClassID The ID number of the class.
-BASE = {
-  ClassName = "BASE",
-  ClassID = 0,
-  Events = {}
-}
-
---- The Formation Class
--- @type FORMATION
--- @field Cone A cone formation.
-FORMATION = {
-  Cone = "Cone" 
-}
-
-
-
---- The base constructor. This is the top top class of all classed defined within the MOOSE.
--- Any new class needs to be derived from this class for proper inheritance.
--- @param #BASE self
--- @return #BASE The new instance of the BASE class.
--- @usage
--- function TASK:New()
---
---     local self = BASE:Inherit( self, BASE:New() )
--- 
---     -- assign Task default values during construction
---     self.TaskBriefing = "Task: No Task."
---     self.Time = timer.getTime()
---     self.ExecuteStage = _TransportExecuteStage.NONE
--- 
---     return self
--- end
--- @todo need to investigate if the deepCopy is really needed... Don't think so.
-
-function BASE:New()
-	local Child = routines.utils.deepCopy( self )
-	local Parent = {}
-	setmetatable( Child, Parent )
-	Child.__index = Child
-	self.ClassID = self.ClassID + 1
-	Child.ClassID = self.ClassID
-	--Child.AddEvent( Child, S_EVENT_BIRTH, Child.EventBirth )
-	return Child
-end
-
---- This is the worker method to inherit from a parent class.
--- @param #BASE self
--- @param Child is the Child class that inherits.
--- @param #BASE Parent is the Parent class that the Child inherits from.
--- @return #BASE Child
-function BASE:Inherit( Child, Parent )
-	local Child = routines.utils.deepCopy( Child )
-	local Parent = routines.utils.deepCopy( Parent )
-	if Child ~= nil then
-		setmetatable( Child, Parent )
-		Child.__index = Child
-	end
-	--Child.ClassName = Child.ClassName .. '.' .. Child.ClassID
-	self:T( 'Inherited from ' .. Parent.ClassName ) 
-	return Child
-end
-
---- This is the worker method to retrieve the Parent class.
--- @param #BASE self
--- @param #BASE Child is the Child class from which the Parent class needs to be retrieved.
--- @return #BASE
-function BASE:Inherited( Child )
-	local Parent = getmetatable( Child )
---	env.info('Inherited class of ' .. Child.ClassName .. ' is ' .. Parent.ClassName )
-	return Parent
-end
-
---- Get the ClassName + ClassID of the class instance.
--- The ClassName + ClassID is formatted as '%s#%09d'. 
--- @param #BASE self
--- @return #string The ClassName + ClassID of the class instance.
-function BASE:GetClassNameAndID()
-  return string.format( '%s#%09d', self:GetClassName(), self:GetClassID() )
-end
-
---- Get the ClassName of the class instance.
--- @param #BASE self
--- @return #string The ClassName of the class instance.
-function BASE:GetClassName()
-  return self.ClassName
-end
-
---- Get the ClassID of the class instance.
--- @param #BASE self
--- @return #string The ClassID of the class instance.
-function BASE:GetClassID()
-  return self.ClassID
-end
-
---- Set a new listener for the class.
--- @param self
--- @param DCSTypes#Event Event
--- @param #function EventFunction
--- @return #BASE
-function BASE:AddEvent( Event, EventFunction )
-	self:F( Event )
-
-	self.Events[#self.Events+1] = {}
-	self.Events[#self.Events].Event = Event
-	self.Events[#self.Events].EventFunction = EventFunction
-	self.Events[#self.Events].EventEnabled = false
-
-	return self
-end
-
---- Returns the event dispatcher
--- @param #BASE self
--- @return Event#EVENT
-function BASE:Event()
-
-  return _EVENTDISPATCHER
-end
-
-
-
-
-
---- Enable the event listeners for the class.
--- @param #BASE self
--- @return #BASE
-function BASE:EnableEvents()
-	self:F( #self.Events )
-
-	for EventID, Event in pairs( self.Events ) do
-		Event.Self = self
-		Event.EventEnabled = true
-	end
-	self.Events.Handler = world.addEventHandler( self )
-
-	return self
-end
-
-
---- Disable the event listeners for the class.
--- @param #BASE self
--- @return #BASE
-function BASE:DisableEvents()
-	self:F()
-  
-	world.removeEventHandler( self )
-	for EventID, Event in pairs( self.Events ) do
-		Event.Self = nil
-		Event.EventEnabled = false
-	end
-
-	return self
-end
-
-
-local BaseEventCodes = {
-   "S_EVENT_SHOT",
-   "S_EVENT_HIT",
-   "S_EVENT_TAKEOFF",
-   "S_EVENT_LAND",
-   "S_EVENT_CRASH",
-   "S_EVENT_EJECTION",
-   "S_EVENT_REFUELING",
-   "S_EVENT_DEAD",
-   "S_EVENT_PILOT_DEAD",
-   "S_EVENT_BASE_CAPTURED",
-   "S_EVENT_MISSION_START",
-   "S_EVENT_MISSION_END",
-   "S_EVENT_TOOK_CONTROL",
-   "S_EVENT_REFUELING_STOP",
-   "S_EVENT_BIRTH",
-   "S_EVENT_HUMAN_FAILURE",
-   "S_EVENT_ENGINE_STARTUP",
-   "S_EVENT_ENGINE_SHUTDOWN",
-   "S_EVENT_PLAYER_ENTER_UNIT",
-   "S_EVENT_PLAYER_LEAVE_UNIT",
-   "S_EVENT_PLAYER_COMMENT",
-   "S_EVENT_SHOOTING_START",
-   "S_EVENT_SHOOTING_END",
-   "S_EVENT_MAX",
-}
- 
---onEvent( {[1]="S_EVENT_BIRTH",[2]={["subPlace"]=5,["time"]=0,["initiator"]={["id_"]=16884480,},["place"]={["id_"]=5000040,},["id"]=15,["IniUnitName"]="US F-15C@RAMP-Air Support Mountains#001-01",},}
--- Event = {
---   id = enum world.event,
---   time = Time,
---   initiator = Unit,
---   target = Unit,
---   place = Unit,
---   subPlace = enum world.BirthPlace,
---   weapon = Weapon
--- }
-
---- Creation of a Birth Event.
--- @param #BASE self
--- @param DCSTypes#Time EventTime The time stamp of the event.
--- @param DCSObject#Object Initiator The initiating object of the event.
--- @param #string IniUnitName The initiating unit name.
--- @param place
--- @param subplace
-function BASE:CreateEventBirth( EventTime, Initiator, IniUnitName, place, subplace )
-	self:F( { EventTime, Initiator, IniUnitName, place, subplace } )
-
-	local Event = {
-		id = world.event.S_EVENT_BIRTH,
-		time = EventTime,
-		initiator = Initiator,
-		IniUnitName = IniUnitName,
-		place = place,
-		subplace = subplace
-		}
-
-	world.onEvent( Event )
-end
-
---- Creation of a Crash Event.
--- @param #BASE self
--- @param DCSTypes#Time EventTime The time stamp of the event.
--- @param DCSObject#Object Initiator The initiating object of the event.
-function BASE:CreateEventCrash( EventTime, Initiator )
-	self:F( { EventTime, Initiator } )
-
-	local Event = {
-		id = world.event.S_EVENT_CRASH,
-		time = EventTime,
-		initiator = Initiator,
-		}
-
-	world.onEvent( Event )
-end
-
--- TODO: Complete DCSTypes#Event structure.                       
---- The main event handling function... This function captures all events generated for the class.
--- @param #BASE self
--- @param DCSTypes#Event event
-function BASE:onEvent(event)
-  --self:F( { BaseEventCodes[event.id], event } )
-
-	if self then
-		for EventID, EventObject in pairs( self.Events ) do
-			if EventObject.EventEnabled then
-				--env.info( 'onEvent Table EventObject.Self = ' .. tostring(EventObject.Self) )
-				--env.info( 'onEvent event.id = ' .. tostring(event.id) )
-				--env.info( 'onEvent EventObject.Event = ' .. tostring(EventObject.Event) )
-				if event.id == EventObject.Event then
-					if self == EventObject.Self then
-						if event.initiator and event.initiator:isExist() then
-							event.IniUnitName = event.initiator:getName()
-						end
-						if event.target and event.target:isExist() then
-							event.TgtUnitName = event.target:getName()
-						end
-						--self:T( { BaseEventCodes[event.id], event } )
-						--EventObject.EventFunction( self, event )
-					end
-				end
-			end
-		end
-	end
-end
-
--- Trace section
-
--- Log a trace (only shown when trace is on)
--- TODO: Make trace function using variable parameters.
-
---- Set trace level
--- @param #BASE self
--- @param #number Level
-function BASE:TraceLevel( Level )
-  _TraceLevel = Level
-  self:E( "Tracing level " .. Level )
-end
-
---- Set tracing for a class
--- @param #BASE self
--- @param #string Class
-function BASE:TraceClass( Class )
-  _TraceClass[Class] = true
-  _TraceClassMethod[Class] = {}
-  self:E( "Tracing class " .. Class )
-end
-
---- Set tracing for a specific method of  class
--- @param #BASE self
--- @param #string Class
--- @param #string Method
-function BASE:TraceClassMethod( Class, Method )
-  if not _TraceClassMethod[Class] then
-    _TraceClassMethod[Class] = {}
-    _TraceClassMethod[Class].Method = {}
-  end
-  _TraceClassMethod[Class].Method[Method] = true
-  self:E( "Tracing method " .. Method .. " of class " .. Class )
-end
-
---- Trace a function call. Must be at the beginning of the function logic.
--- @param #BASE self
--- @param Arguments A #table or any field.
-function BASE:F( Arguments )
-
-  if _TraceOn and ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
-
-    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = debug.getinfo( 3, "l" )
-    
-    local Function = "function"
-    if DebugInfoCurrent.name then
-      Function = DebugInfoCurrent.name
-    end
-    
-    if _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName].Method[Function] then
-      local LineCurrent = DebugInfoCurrent.currentline
-      local LineFrom = 0
-      if DebugInfoFrom then
-        LineFrom = DebugInfoFrom.currentline
-      end
-      env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s(%s)" , LineCurrent, LineFrom, "F", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
-    end
-  end
-end
-
---- Trace a function call level 2. Must be at the beginning of the function logic.
--- @param #BASE self
--- @param Arguments A #table or any field.
-function BASE:F2( Arguments )
-
-  if _TraceLevel >= 2 then
-    self:F( Arguments )
-  end
-  
-end
-
---- Trace a function call level 3. Must be at the beginning of the function logic.
--- @param #BASE self
--- @param Arguments A #table or any field.
-function BASE:F3( Arguments )
-
-  if _TraceLevel >= 3 then
-    self:F( Arguments )
-  end
-  
-end
-
---- Trace a function logic. Can be anywhere within the function logic.
--- @param #BASE self
--- @param Arguments A #table or any field.
-function BASE:T( Arguments )
-
-	if _TraceOn and ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
-
-		local DebugInfoCurrent = debug.getinfo( 2, "nl" )
-		local DebugInfoFrom = debug.getinfo( 3, "l" )
-		
-		local Function = "function"
-		if DebugInfoCurrent.name then
-			Function = DebugInfoCurrent.name
-		end
-
-    if _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName].Method[Function] then
-  		local LineCurrent = DebugInfoCurrent.currentline
-  		local LineFrom = 0
-  		if DebugInfoFrom then
-  		  LineFrom = DebugInfoFrom.currentline
-  	  end
-  		env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s" , LineCurrent, LineFrom, "T", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
-    end
-	end
-end
-
---- Trace a function logic level 2. Can be anywhere within the function logic.
--- @param #BASE self
--- @param Arguments A #table or any field.
-function BASE:T2( Arguments )
-
-  if _TraceLevel >= 2 then
-    self:T( Arguments )
-  end
-  
-end
-
---- Trace a function logic level 3. Can be anywhere within the function logic.
--- @param #BASE self
--- @param Arguments A #table or any field.
-function BASE:T3( Arguments )
-
-  if _TraceLevel >= 3 then
-    self:T( Arguments )
-  end
-  
-end
-
---- Log an exception which will be traced always. Can be anywhere within the function logic.
--- @param #BASE self
--- @param Arguments A #table or any field.
-function BASE:E( Arguments )
-
-	local DebugInfoCurrent = debug.getinfo( 2, "nl" )
-	local DebugInfoFrom = debug.getinfo( 3, "l" )
-	
-	local Function = "function"
-	if DebugInfoCurrent.name then
-		Function = DebugInfoCurrent.name
-	end
-
-	local LineCurrent = DebugInfoCurrent.currentline
-	local LineFrom = DebugInfoFrom.currentline
-
-	env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s(%s)" , LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
-end
-
-
-

Moose Development/Moose/CleanUp.lua

@@ -1,323 +0,0 @@
---- The CLEANUP class keeps an area clean of crashing or colliding airplanes. It also prevents airplanes from firing within this area.
--- @module CleanUp
--- @author Flightcontrol
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Mission" )
-Include.File( "Client" )
-Include.File( "Task" )
-
---- The CLEANUP class.
--- @type CLEANUP
--- @extends Base#BASE
-CLEANUP = {
-	ClassName = "CLEANUP",
-	ZoneNames = {},
-	TimeInterval = 300,
-	CleanUpList = {},
-}
-
---- Creates the main object which is handling the cleaning of the debris within the given Zone Names.
--- @param #CLEANUP self
--- @param #table ZoneNames Is a table of zone names where the debris should be cleaned. Also a single string can be passed with one zone name.
--- @param #number TimeInterval The interval in seconds when the clean activity takes place. The default is 300 seconds, thus every 5 minutes.
--- @return #CLEANUP
--- @usage
---  -- Clean these Zones.
--- CleanUpAirports = CLEANUP:New( { 'CLEAN Tbilisi', 'CLEAN Kutaisi' }, 150 )
--- or
--- CleanUpTbilisi = CLEANUP:New( 'CLEAN Tbilisi', 150 )
--- CleanUpKutaisi = CLEANUP:New( 'CLEAN Kutaisi', 600 )
-function CLEANUP:New( ZoneNames, TimeInterval )	local self = BASE:Inherit( self, BASE:New() )
-	self:F( { ZoneNames, TimeInterval } )
-	
-	if type( ZoneNames ) == 'table' then
-		self.ZoneNames = ZoneNames
-	else
-		self.ZoneNames = { ZoneNames }
-	end
-	if TimeInterval then
-		self.TimeInterval = TimeInterval
-	end
-	
-	_EVENTDISPATCHER:OnBirth( self._OnEventBirth, self )
-	
-	self.CleanUpScheduler = routines.scheduleFunction( self._CleanUpScheduler, { self }, timer.getTime() + 1, TimeInterval )
-	
-	return self
-end
-
-
---- Destroys a group from the simulator, but checks first if it is still existing!
--- @param #CLEANUP self
--- @param DCSGroup#Group GroupObject The object to be destroyed.
--- @param #string CleanUpGroupName The groupname...
-function CLEANUP:_DestroyGroup( GroupObject, CleanUpGroupName )
-	self:F( { GroupObject, CleanUpGroupName } )
-
-	if GroupObject then -- and GroupObject:isExist() then
-		--MESSAGE:New( "Destroy Group " .. CleanUpGroupName, CleanUpGroupName, 1, CleanUpGroupName ):ToAll()
-		trigger.action.deactivateGroup(GroupObject)
-		self:T( { "GroupObject Destroyed", GroupObject } )
-	end
-end
-
---- Destroys a @{DCSUnit#Unit} from the simulator, but checks first if it is still existing!
--- @param #CLEANUP self
--- @param DCSUnit#Unit CleanUpUnit The object to be destroyed.
--- @param #string CleanUpUnitName The Unit name ...
-function CLEANUP:_DestroyUnit( CleanUpUnit, CleanUpUnitName )
-	self:F( { CleanUpUnit, CleanUpUnitName } )
-
-	if CleanUpUnit then
-		--MESSAGE:New( "Destroy " .. CleanUpUnitName, CleanUpUnitName, 1, CleanUpUnitName ):ToAll()
-		local CleanUpGroup = Unit.getGroup(CleanUpUnit)
-    -- TODO Client bug in 1.5.3
-		if CleanUpGroup and CleanUpGroup:isExist() then
-			local CleanUpGroupUnits = CleanUpGroup:getUnits()
-			if #CleanUpGroupUnits == 1 then
-				local CleanUpGroupName = CleanUpGroup:getName()
-				--self:CreateEventCrash( timer.getTime(), CleanUpUnit )
-				CleanUpGroup:destroy()
-				self:T( { "Destroyed Group:", CleanUpGroupName } )
-			else
-				CleanUpUnit:destroy()
-				self:T( { "Destroyed Unit:", CleanUpUnitName } )
-			end
-			self.CleanUpList[CleanUpUnitName] = nil -- Cleaning from the list
-			CleanUpUnit = nil
-		end
-	end
-end
-
--- TODO check DCSTypes#Weapon
---- Destroys a missile from the simulator, but checks first if it is still existing!
--- @param #CLEANUP self
--- @param DCSTypes#Weapon MissileObject
-function CLEANUP:_DestroyMissile( MissileObject )
-	self:F( { MissileObject } )
-
-	if MissileObject and MissileObject:isExist() then
-		MissileObject:destroy()
-		self:T( "MissileObject Destroyed")
-	end
-end
-
-function CLEANUP:_OnEventBirth( Event )
-  self:F( { Event } )
-  
-  self.CleanUpList[Event.IniDCSUnitName] = {}
-  self.CleanUpList[Event.IniDCSUnitName].CleanUpUnit = Event.IniDCSUnit
-  self.CleanUpList[Event.IniDCSUnitName].CleanUpGroup = Event.IniDCSGroup
-  self.CleanUpList[Event.IniDCSUnitName].CleanUpGroupName = Event.IniDCSGroupName
-  self.CleanUpList[Event.IniDCSUnitName].CleanUpUnitName = Event.IniDCSUnitName
-
-  _EVENTDISPATCHER:OnEngineShutDownForUnit( Event.IniDCSUnitName, self._EventAddForCleanUp, self )
-  _EVENTDISPATCHER:OnEngineStartUpForUnit( Event.IniDCSUnitName, self._EventAddForCleanUp, self )
-  _EVENTDISPATCHER:OnHitForUnit( Event.IniDCSUnitName, self._EventAddForCleanUp, self )
-  _EVENTDISPATCHER:OnPilotDeadForUnit( Event.IniDCSUnitName, self._EventCrash, self )
-  _EVENTDISPATCHER:OnDeadForUnit( Event.IniDCSUnitName, self._EventCrash,  self )
-  _EVENTDISPATCHER:OnCrashForUnit( Event.IniDCSUnitName, self._EventCrash,  self )
-  _EVENTDISPATCHER:OnShotForUnit( Event.IniDCSUnitName, self._EventShot, self )
-
-  --self:AddEvent( world.event.S_EVENT_ENGINE_SHUTDOWN, self._EventAddForCleanUp )
-  --self:AddEvent( world.event.S_EVENT_ENGINE_STARTUP, self._EventAddForCleanUp )
---  self:AddEvent( world.event.S_EVENT_HIT, self._EventAddForCleanUp ) -- , self._EventHitCleanUp )
---  self:AddEvent( world.event.S_EVENT_CRASH, self._EventCrash ) -- , self._EventHitCleanUp )
---  --self:AddEvent( world.event.S_EVENT_DEAD, self._EventCrash )
---  self:AddEvent( world.event.S_EVENT_SHOT, self._EventShot )
---  
---  self:EnableEvents()
-
-
-end
-
---- Detects if a crash event occurs.
--- Crashed units go into a CleanUpList for removal.
--- @param #CLEANUP self
--- @param DCSTypes#Event event
-function CLEANUP:_EventCrash( Event )
-	self:F( { Event } )
-
-  --TODO: This stuff is not working due to a DCS bug. Burning units cannot be destroyed.
-	--MESSAGE:New( "Crash ", "Crash", 10, "Crash" ):ToAll()
-	-- self:T("before getGroup")
-	-- local _grp = Unit.getGroup(event.initiator)-- Identify the group that fired 
-	-- self:T("after getGroup")
-	-- _grp:destroy()
-	-- self:T("after deactivateGroup")
-	-- event.initiator:destroy()
-
-  self.CleanUpList[Event.IniDCSUnitName] = {}
-  self.CleanUpList[Event.IniDCSUnitName].CleanUpUnit = Event.IniDCSUnit
-  self.CleanUpList[Event.IniDCSUnitName].CleanUpGroup = Event.IniDCSGroup
-  self.CleanUpList[Event.IniDCSUnitName].CleanUpGroupName = Event.IniDCSGroupName
-  self.CleanUpList[Event.IniDCSUnitName].CleanUpUnitName = Event.IniDCSUnitName
-  
-end
-
---- Detects if a unit shoots a missile.
--- If this occurs within one of the zones, then the weapon used must be destroyed.
--- @param #CLEANUP self
--- @param DCSTypes#Event event
-function CLEANUP:_EventShot( Event )
-	self:F( { Event } )
-
-	-- Test if the missile was fired within one of the CLEANUP.ZoneNames.
-	local CurrentLandingZoneID = 0
-	CurrentLandingZoneID  = routines.IsUnitInZones( Event.IniDCSUnit, self.ZoneNames )
-	if  ( CurrentLandingZoneID ) then
-		-- Okay, the missile was fired within the CLEANUP.ZoneNames, destroy the fired weapon.
-		--_SEADmissile:destroy()
-		routines.scheduleFunction( CLEANUP._DestroyMissile, { self, Event.Weapon }, timer.getTime() + 0.1)
-	end
-end
-
-
---- Detects if the Unit has an S_EVENT_HIT within the given ZoneNames. If this is the case, destroy the unit.
--- @param #CLEANUP self
--- @param DCSTypes#Event event
-function CLEANUP:_EventHitCleanUp( Event )
-	self:F( { Event } )
-
-	if Event.IniDCSUnit then
-		if routines.IsUnitInZones( Event.IniDCSUnit, self.ZoneNames ) ~= nil then
-			self:T( { "Life: ", Event.IniDCSUnitName, ' = ',  Event.IniDCSUnit:getLife(), "/", Event.IniDCSUnit:getLife0() } )
-			if Event.IniDCSUnit:getLife() < Event.IniDCSUnit:getLife0() then
-				self:T( "CleanUp: Destroy: " .. Event.IniDCSUnitName )
-				routines.scheduleFunction( CLEANUP._DestroyUnit, { self, Event.IniDCSUnit }, timer.getTime() + 0.1)
-			end
-		end
-	end
-
-	if Event.TgtDCSUnit then
-		if routines.IsUnitInZones( Event.TgtDCSUnit, self.ZoneNames ) ~= nil then
-			self:T( { "Life: ", Event.TgtDCSUnitName, ' = ', Event.TgtDCSUnit:getLife(), "/", Event.TgtDCSUnit:getLife0() } )
-			if Event.TgtDCSUnit:getLife() < Event.TgtDCSUnit:getLife0() then
-				self:T( "CleanUp: Destroy: " .. Event.TgtDCSUnitName )
-				routines.scheduleFunction( CLEANUP._DestroyUnit, { self, Event.TgtDCSUnit }, timer.getTime() + 0.1 )
-			end
-		end
-	end
-end
-
---- Add the @{DCSUnit#Unit} to the CleanUpList for CleanUp.
-function CLEANUP:_AddForCleanUp( CleanUpUnit, CleanUpUnitName )
-	self:F( { CleanUpUnit, CleanUpUnitName } )
-
-	self.CleanUpList[CleanUpUnitName] = {}
-	self.CleanUpList[CleanUpUnitName].CleanUpUnit = CleanUpUnit
-	self.CleanUpList[CleanUpUnitName].CleanUpUnitName = CleanUpUnitName
-	self.CleanUpList[CleanUpUnitName].CleanUpGroup = Unit.getGroup(CleanUpUnit)
-	self.CleanUpList[CleanUpUnitName].CleanUpGroupName = Unit.getGroup(CleanUpUnit):getName()
-	self.CleanUpList[CleanUpUnitName].CleanUpTime = timer.getTime()
-	self.CleanUpList[CleanUpUnitName].CleanUpMoved = false
-
-	self:T( { "CleanUp: Add to CleanUpList: ", Unit.getGroup(CleanUpUnit):getName(), CleanUpUnitName } )
-	
-end
-
---- Detects if the Unit has an S_EVENT_ENGINE_SHUTDOWN or an S_EVENT_HIT within the given ZoneNames. If this is the case, add the Group to the CLEANUP List.
--- @param #CLEANUP self
--- @param DCSTypes#Event event
-function CLEANUP:_EventAddForCleanUp( Event )
-
-	if Event.IniDCSUnit then
-		if self.CleanUpList[Event.IniDCSUnitName] == nil then
-			if routines.IsUnitInZones( Event.IniDCSUnit, self.ZoneNames ) ~= nil then
-				self:_AddForCleanUp( Event.IniDCSUnit, Event.IniDCSUnitName )
-			end
-		end
-	end
-
-	if Event.TgtDCSUnit then
-		if self.CleanUpList[Event.TgtDCSUnitName] == nil then
-			if routines.IsUnitInZones( Event.TgtDCSUnit, self.ZoneNames ) ~= nil then
-				self:_AddForCleanUp( Event.TgtDCSUnit, Event.TgtDCSUnitName )
-			end
-		end
-	end
-	
-end
-
-local CleanUpSurfaceTypeText = {
-   "LAND",
-   "SHALLOW_WATER",
-   "WATER",
-   "ROAD",
-   "RUNWAY"
- }
-
---- At the defined time interval, CleanUp the Groups within the CleanUpList.
--- @param #CLEANUP self
-function CLEANUP:_CleanUpScheduler()
-	self:F( { "CleanUp Scheduler" } )
-
-  local CleanUpCount = 0
-	for CleanUpUnitName, UnitData in pairs( self.CleanUpList ) do
-	  CleanUpCount = CleanUpCount + 1
-	
-		self:T( { CleanUpUnitName, UnitData } )
-		local CleanUpUnit = Unit.getByName(UnitData.CleanUpUnitName)
-		local CleanUpGroupName = UnitData.CleanUpGroupName
-		local CleanUpUnitName = UnitData.CleanUpUnitName
-		if CleanUpUnit then
-			self:T( { "CleanUp Scheduler", "Checking:", CleanUpUnitName } )
-			if _DATABASE:GetStatusGroup( CleanUpGroupName ) ~= "ReSpawn" then
-				local CleanUpUnitVec3 = CleanUpUnit:getPoint()
-				--self:T( CleanUpUnitVec3 )
-				local CleanUpUnitVec2 = {}
-				CleanUpUnitVec2.x = CleanUpUnitVec3.x
-				CleanUpUnitVec2.y = CleanUpUnitVec3.z
-				--self:T( CleanUpUnitVec2 )
-				local CleanUpSurfaceType = land.getSurfaceType(CleanUpUnitVec2)
-				--self:T( CleanUpSurfaceType )
-				--MESSAGE:New( "Surface " .. CleanUpUnitName .. " = " .. CleanUpSurfaceTypeText[CleanUpSurfaceType], CleanUpUnitName, 10, CleanUpUnitName ):ToAll()
-				
-				if CleanUpUnit and CleanUpUnit:getLife() <= CleanUpUnit:getLife0() * 0.95 then
-					if CleanUpSurfaceType == land.SurfaceType.RUNWAY then
-						if CleanUpUnit:inAir() then
-							local CleanUpLandHeight = land.getHeight(CleanUpUnitVec2)
-							local CleanUpUnitHeight = CleanUpUnitVec3.y - CleanUpLandHeight
-							self:T( { "CleanUp Scheduler", "Height = " .. CleanUpUnitHeight } )
-							if CleanUpUnitHeight < 30 then
-								self:T( { "CleanUp Scheduler", "Destroy " .. CleanUpUnitName .. " because below safe height and damaged." } )
-								self:_DestroyUnit(CleanUpUnit, CleanUpUnitName)
-							end
-						else
-							self:T( { "CleanUp Scheduler", "Destroy " .. CleanUpUnitName .. " because on runway and damaged." } )
-							self:_DestroyUnit(CleanUpUnit, CleanUpUnitName)
-						end
-					end
-				end
-				-- Clean Units which are waiting for a very long time in the CleanUpZone.
-				if CleanUpUnit then
-					local CleanUpUnitVelocity = CleanUpUnit:getVelocity()
-					local CleanUpUnitVelocityTotal = math.abs(CleanUpUnitVelocity.x) + math.abs(CleanUpUnitVelocity.y) + math.abs(CleanUpUnitVelocity.z)
-					if CleanUpUnitVelocityTotal < 1 then
-						if UnitData.CleanUpMoved then
-							if UnitData.CleanUpTime + 180 <= timer.getTime() then
-								self:T( { "CleanUp Scheduler", "Destroy due to not moving anymore " .. CleanUpUnitName } )
-								self:_DestroyUnit(CleanUpUnit, CleanUpUnitName)
-							end
-						end
-					else
-						UnitData.CleanUpTime = timer.getTime()
-						UnitData.CleanUpMoved = true
-						--MESSAGE:New( "Moved " .. CleanUpUnitName, CleanUpUnitName, 10, CleanUpUnitName ):ToAll()
-					end
-				end
-				
-			else
-				-- Do nothing ...
-				self.CleanUpList[CleanUpUnitName] = nil -- Not anymore in the DCSRTE
-			end
-		else
-			self:T( "CleanUp: Group " .. CleanUpUnitName .. " cannot be found in DCS RTE, removing ..." )
-			self.CleanUpList[CleanUpUnitName] = nil -- Not anymore in the DCSRTE
-		end
-	end
-	self:T(CleanUpCount)
-end
-

Moose Development/Moose/Core/Goal.lua

@@ -0,0 +1,146 @@
+--- **Core (WIP)** -- Base class to allow the modeling of processes to achieve Goals.
+--
+-- ===
+-- 
+-- GOAL models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===
+-- 
+-- @module Goal
+
+do -- Goal
+
+  --- @type GOAL
+  -- @extends Core.Fsm#FSM
+
+
+  --- # GOAL class, extends @{Fsm#FSM}
+  -- 
+  -- GOAL 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.
+  -- 
+  -- @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( {} )
+
+    --- Achieved State for GOAL
+    -- @field GOAL.Achieved
+
+    --- Achieved State Handler OnLeave for GOAL
+    -- @function [parent=#GOAL] OnLeaveAchieved
+    -- @param #GOAL self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+
+    --- Achieved State Handler OnEnter for GOAL
+    -- @function [parent=#GOAL] OnEnterAchieved
+    -- @param #GOAL self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    
+    self:SetStartState( "Pending" )
+    self:AddTransition( "*",  "Achieved", "Achieved" )
+    
+    --- Achieved Handler OnBefore for GOAL
+    -- @function [parent=#GOAL] OnBeforeAchieved
+    -- @param #GOAL self
+    -- @param #string From
+    -- @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
+  
+  
+  --- @param #GOAL self
+  -- @param #string PlayerName
+  function GOAL:AddPlayerContribution( 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 
+  end
+
+  
+  --- @param #GOAL self
+  function GOAL:GetPlayerContributions()
+    return self.Players or {}
+  end
+
+  
+  --- @param #GOAL self
+  function GOAL:GetTotalContributions()
+    return self.TotalContributions or 0
+  end
+  
+  
+  
+  --- @param #GOAL self
+  -- @return #boolean true if the goal is Achieved
+  function GOAL:IsAchieved()
+    return self:Is( "Achieved" )
+  end
+
+end

Moose Development/Moose/Core/Message.lua

@@ -0,0 +1,328 @@
+--- **Core** -- MESSAGE class takes are of the **real-time notifications** and **messages to players** during a simulation.
+-- 
+-- ![Banner Image](..\Presentations\MESSAGE\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- @module Message
+
+--- The MESSAGE class
+-- @type MESSAGE
+-- @extends Core.Base#BASE
+
+--- # MESSAGE class, extends @{Base#BASE}
+-- 
+-- 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#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#MESSAGE.ToClient}().
+--   * To a @{Group} using @{Message#MESSAGE.ToGroup}()
+--   * To a coalition using @{Message#MESSAGE.ToCoalition}().
+--   * To the red coalition using @{Message#MESSAGE.ToRed}().
+--   * To the blue coalition using @{Message#MESSAGE.ToBlue}().
+--   * To all Players using @{Message#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#MESSAGE.ToAllIf}().
+--   * To a coalition using @{Message#MESSAGE.ToCoalitionIf}().
+-- 
+-- ===
+--  
+-- ### Author: **FlightControl**
+-- ### Contributions: 
+-- 
+-- ===
+-- 
+-- @field #MESSAGE
+MESSAGE = {
+	ClassName = "MESSAGE", 
+	MessageCategory = 0,
+	MessageID = 0,
+}
+
+--- Message Types
+-- @type MESSAGE.Type
+MESSAGE.Type = {
+  Update = "Update",
+  Information = "Information",
+  Briefing = "Briefing Report",
+  Overview = "Overview 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.
+-- @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.
+-- @param #string MessageCategory (optional) is a string expressing the "category" of the Message. The category will be shown as the first text in the message followed by a ": ".
+-- @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")
+function MESSAGE:New( 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
+      self.MessageCategory = MessageCategory .. ": "
+    else
+      self.MessageCategory = MessageCategory:sub( 1, -2 ) .. ":\n" 
+    end
+  else
+    self.MessageCategory = ""
+  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
+
+	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.
+-- @param self
+-- @param #string MessageText is the text of the Message.
+-- @param #MESSAGE.Type MessageType The type of the message.
+-- @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 )
+
+  local self = BASE:Inherit( self, BASE:New() )
+  self:F( { MessageText } )
+  
+  self.MessageType = MessageType
+
+  self.MessageTime = timer.getTime()
+  self.MessageText = MessageText:gsub("^\n","",1):gsub("\n$","",1)
+  
+  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.
+-- @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 )
+function MESSAGE:ToClient( Client, Settings )
+	self:F( Client )
+
+	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
+      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( ClientGroupID, self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration )
+		end
+	end
+	
+	return self
+end
+
+--- Sends a MESSAGE to a Group. 
+-- @param #MESSAGE self
+-- @param Wrapper.Group#GROUP Group is the Group.
+-- @return #MESSAGE
+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 )
+    end
+  end
+  
+  return self
+end
+--- Sends a MESSAGE to the Blue coalition.
+-- @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()
+function MESSAGE:ToBlue()
+	self:F()
+
+	self:ToCoalition( coalition.side.BLUE )
+	
+	return self
+end
+
+--- 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()
+
+	self:ToCoalition( coalition.side.RED )
+	
+	return self
+end
+
+--- Sends a MESSAGE to a Coalition. 
+-- @param #MESSAGE self
+-- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}. 
+-- @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" ):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 )
+function MESSAGE:ToCoalition( CoalitionSide, Settings )
+	self:F( CoalitionSide )
+
+  if self.MessageType then
+    local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
+    self.MessageDuration = Settings:GetMessageTime( self.MessageType )
+    self.MessageCategory = "" -- self.MessageType .. ": "
+  end
+
+	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 )
+    end
+	end
+	
+	return self
+end
+
+--- Sends a MESSAGE to a Coalition if the given Condition is true. 
+-- @param #MESSAGE self
+-- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}. 
+-- @return #MESSAGE
+function MESSAGE:ToCoalitionIf( CoalitionSide, Condition )
+  self:F( CoalitionSide )
+
+  if Condition and Condition == true then
+    self:ToCoalition( CoalitionSide )
+  end
+  
+  return self
+end
+
+--- Sends a MESSAGE to all players. 
+-- @param #MESSAGE self
+-- @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()
+  self:F()
+
+  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.outText( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration )
+  end
+
+  return self
+end
+
+
+--- Sends a MESSAGE to all players if the given Condition is true.
+-- @param #MESSAGE self
+-- @return #MESSAGE
+function MESSAGE:ToAllIf( Condition )
+
+  if Condition and Condition == true then
+    self:ToAll()
+  end
+
+	return self
+end

Moose Development/Moose/Core/Radio.lua

@@ -0,0 +1,588 @@
+--- **Core** -- The RADIO Module is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions...
+-- 
+-- ![Banner Image](..\Presentations\RADIO\Dia1.JPG)
+-- 
+-- ===
+--
+-- The Radio contains 2 classes : RADIO and BEACON
+--  
+-- What are radio communications in DCS ?
+-- 
+--   * Radio transmissions consist of **sound files** that are broadcasted on a specific **frequency** (e.g. 115MHz) and **modulation** (e.g. AM),
+--   * They can be **subtitled** for a specific **duration**, the **power** in Watts of the transmiter's antenna can be set, and the transmission can be **looped**.
+-- 
+-- How to supply DCS my own Sound Files ?
+--   
+--   * Your sound files need to be encoded in **.ogg** or .wav,
+--   * Your sound files should be **as tiny as possible**. It is suggested you encode in .ogg with low bitrate and sampling settings,
+--   * They need to be added in .\l10n\DEFAULT\ in you .miz file (wich can be decompressed like a .zip file),
+--   * For simplicty sake, you can **let DCS' Mission Editor add the file** itself, by creating a new Trigger with the action "Sound to Country", and choosing your sound file and a country you don't use in your mission.
+--   
+-- Due to weird DCS quirks, **radio communications behave differently** if sent by a @{Unit#UNIT} or a @{Group#GROUP} or by any other @{Positionable#POSITIONABLE}
+-- 
+--   * If the transmitter is a @{Unit#UNIT} or a @{Group#GROUP}, DCS will set the power of the transmission  automatically,
+--   * If the transmitter is any other @{Positionable#POSITIONABLE}, the transmisison can't be subtitled or looped.
+--   
+-- Note that obviously, the **frequency** and the **modulation** of the transmission are important only if the players are piloting an **Advanced System Modelling** enabled aircraft,
+-- like the A10C or the Mirage 2000C. They will **hear the transmission** if they are tuned on the **right frequency and modulation** (and if they are close enough - more on that below).
+-- If a FC3 airacraft is used, it will **hear every communication, whatever the frequency and the modulation** is set to. The same is true for TACAN beacons. If your aircaft isn't compatible,
+-- you won't hear/be able to use the TACAN beacon informations.
+--
+-- ===
+--
+-- ### Author: Hugues "Grey_Echo" Bousquet
+--
+-- @module Radio
+
+
+--- # RADIO class, extends @{Base#BASE}
+-- 
+-- ## RADIO usage
+-- 
+-- There are 3 steps to a successful radio transmission.
+-- 
+--   * First, you need to **"add a @{#RADIO} object** to your @{Positionable#POSITIONABLE}. This is done using the @{Positionable#POSITIONABLE.GetRadio}() function,
+--   * Then, you will **set the relevant parameters** to the transmission (see below),
+--   * When done, you can actually **broadcast the transmission** (i.e. play the sound) with the @{RADIO.Broadcast}() function.
+--   
+-- Methods to set relevant parameters for both a @{Unit#UNIT} or a @{Group#GROUP} or any other @{Positionable#POSITIONABLE}
+-- 
+--   * @{#RADIO.SetFileName}() : Sets the file name of your sound file (e.g. "Noise.ogg"),
+--   * @{#RADIO.SetFrequency}() : Sets the frequency of your transmission.
+--   * @{#RADIO.SetModulation}() : Sets the modulation of your transmission.
+--   * @{#RADIO.SetLoop}() : Choose if you want the transmission to be looped. If you need your transmission to be looped, you might need a @{#BEACON} instead...
+-- 
+-- Additional Methods to set relevant parameters if the transmiter is a @{Unit#UNIT} or a @{Group#GROUP}
+-- 
+--   * @{#RADIO.SetSubtitle}() : Set both the subtitle and its duration,
+--   * @{#RADIO.NewUnitTransmission}() : Shortcut to set all the relevant parameters in one method call
+-- 
+-- Additional Methods to set relevant parameters if the transmiter is any other @{Positionable#POSITIONABLE}
+-- 
+--   * @{#RADIO.SetPower}() : Sets the power of the antenna in Watts
+--   * @{#RADIO.NewGenericTransmission}() : Shortcut to set all the relevant parameters in one method call
+-- 
+-- What is this power thing ?
+-- 
+--   * If your transmission is sent by a @{Positionable#POSITIONABLE} other than a @{Unit#UNIT} or a @{Group#GROUP}, you can set the power of the antenna,
+--   * Otherwise, DCS sets it automatically, depending on what's available on your Unit,
+--   * If the player gets **too far** from the transmiter, or if the antenna is **too weak**, the transmission will **fade** and **become noisyer**,
+--   * This an automated DCS calculation you have no say on,
+--   * For reference, a standard VOR station has a 100W antenna, a standard AA TACAN has a 120W antenna, and civilian ATC's antenna usually range between 300 and 500W,
+--   * Note that if the transmission has a subtitle, it will be readable, regardless of the quality of the transmission. 
+--   
+-- @type RADIO
+-- @field Positionable#POSITIONABLE Positionable The transmiter
+-- @field #string FileName Name of the sound file
+-- @field #number Frequency Frequency of the transmission in Hz
+-- @field #number Modulation Modulation of the transmission (either radio.modulation.AM or radio.modulation.FM)
+-- @field #string Subtitle Subtitle of the transmission
+-- @field #number SubtitleDuration Duration of the Subtitle in seconds
+-- @field #number Power Power of the antenna is Watts
+-- @field #boolean Loop (default true)
+-- @extends Core.Base#BASE
+RADIO = {
+  ClassName = "RADIO",
+  FileName = "",
+  Frequency = 0,
+  Modulation = radio.modulation.AM,
+  Subtitle = "",
+  SubtitleDuration = 0,
+  Power = 100,
+  Loop = true,
+}
+
+--- Create a new RADIO Object. This doesn't broadcast a transmission, though, use @{#RADIO.Broadcast} to actually broadcast
+-- If you want to create a RADIO, you probably should use @{Positionable#POSITIONABLE.GetRadio}() instead
+-- @param #RADIO self
+-- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
+-- @return #RADIO Radio
+-- @return #nil If Positionable is invalid
+function RADIO:New(Positionable)
+  local self = BASE:Inherit( self, BASE:New() ) -- Core.Radio#RADIO
+  
+  self.Loop = true        -- default Loop to true (not sure the above RADIO definition actually is working)
+  self:F(Positionable)
+  
+  if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
+    self.Positionable = Positionable
+    return self
+  end
+  
+  self:E({"The passed positionable is invalid, no RADIO created", Positionable})
+  return nil
+end
+
+--- Check validity of the filename passed and sets RADIO.FileName
+-- @param #RADIO self
+-- @param #string FileName File name of the sound file (i.e. "Noise.ogg")
+-- @return #RADIO self
+function RADIO:SetFileName(FileName)
+  self:F2(FileName)
+  
+  if type(FileName) == "string" then
+    if FileName:find(".ogg") or FileName:find(".wav") then
+      if not FileName:find("l10n/DEFAULT/") then
+        FileName = "l10n/DEFAULT/" .. FileName
+      end
+      self.FileName = FileName
+      return self
+    end
+  end
+  
+  self:E({"File name invalid. Maybe something wrong with the extension ?", self.FileName})
+  return self
+end
+
+--- Check validity of the frequency passed and sets RADIO.Frequency
+-- @param #RADIO self
+-- @param #number Frequency in MHz (Ranges allowed for radio transmissions in DCS : 30-88 / 108-152 / 225-400MHz)
+-- @return #RADIO self
+function RADIO:SetFrequency(Frequency)
+  self:F2(Frequency)
+  if type(Frequency) == "number" then
+    -- If frequency is in range
+    if (Frequency >= 30 and Frequency < 88) or (Frequency >= 108 and Frequency < 152) or (Frequency >= 225 and Frequency < 400) then
+      self.Frequency = Frequency * 1000000 -- Conversion in Hz
+      -- If the RADIO is attached to a UNIT or a GROUP, we need to send the DCS Command "SetFrequency" to change the UNIT or GROUP frequency
+      if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
+        self.Positionable:SetCommand({
+          id = "SetFrequency",
+          params = {
+            frequency = self.Frequency,
+            modulation = self.Modulation,
+          }
+        })
+      end
+      return self
+    end
+  end
+  self:E({"Frequency is outside of DCS Frequency ranges (30-80, 108-152, 225-400). Frequency unchanged.", self.Frequency})
+  return self
+end
+
+--- Check validity of the frequency passed and sets RADIO.Modulation
+-- @param #RADIO self
+-- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
+-- @return #RADIO self
+function RADIO:SetModulation(Modulation)
+  self:F2(Modulation)
+  if type(Modulation) == "number" then
+    if Modulation == radio.modulation.AM or Modulation == radio.modulation.FM then --TODO Maybe make this future proof if ED decides to add an other modulation ?
+      self.Modulation = Modulation
+      return self
+    end
+  end
+  self:E({"Modulation is invalid. Use DCS's enum radio.modulation. Modulation unchanged.", self.Modulation})
+  return self
+end
+
+--- Check validity of the power passed and sets RADIO.Power
+-- @param #RADIO self
+-- @param #number Power in W
+-- @return #RADIO self
+function RADIO:SetPower(Power)
+  self:F2(Power)
+  if type(Power) == "number" then
+    self.Power = math.floor(math.abs(Power)) --TODO Find what is the maximum power allowed by DCS and limit power to that
+    return self
+  end
+  self:E({"Power is invalid. Power unchanged.", self.Power})
+  return self
+end
+
+--- Check validity of the loop passed and sets RADIO.Loop
+-- @param #RADIO self
+-- @param #boolean Loop
+-- @return #RADIO self
+-- @usage
+function RADIO:SetLoop(Loop)
+  self:F2(Loop)
+  if type(Loop) == "boolean" then
+    self.Loop = Loop
+    return self
+  end
+  self:E({"Loop is invalid. Loop unchanged.", self.Loop})
+  return self
+end
+
+--- Check validity of the subtitle and the subtitleDuration  passed and sets RADIO.subtitle and RADIO.subtitleDuration
+-- Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration
+-- @param #RADIO self
+-- @param #string Subtitle
+-- @param #number SubtitleDuration in s
+-- @return #RADIO self
+-- @usage
+-- -- create the broadcaster and attaches it a RADIO
+-- local MyUnit = UNIT:FindByName("MyUnit")
+-- local MyUnitRadio = MyUnit:GetRadio()
+-- 
+-- -- add a subtitle for the next transmission, which will be up for 10s
+-- MyUnitRadio:SetSubtitle("My Subtitle, 10)
+function RADIO:SetSubtitle(Subtitle, SubtitleDuration)
+  self:F2({Subtitle, SubtitleDuration})
+  if type(Subtitle) == "string" then
+    self.Subtitle = Subtitle
+  else
+    self.Subtitle = ""
+    self:E({"Subtitle is invalid. Subtitle reset.", self.Subtitle})
+  end
+  if type(SubtitleDuration) == "number" then
+    if math.floor(math.abs(SubtitleDuration)) == SubtitleDuration then
+      self.SubtitleDuration = SubtitleDuration
+      return self
+    end
+  end
+  self.SubtitleDuration = 0
+  self:E({"SubtitleDuration is invalid. SubtitleDuration reset.", self.SubtitleDuration})
+end
+
+--- Create a new transmission, that is to say, populate the RADIO with relevant data
+-- In this function the data is especially relevant if the broadcaster is anything but a UNIT or a GROUP,
+-- but it will work with a UNIT or a GROUP anyway. 
+-- Only the #RADIO and the Filename are mandatory
+-- @param #RADIO self
+-- @param #string FileName
+-- @param #number Frequency in MHz
+-- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
+-- @param #number Power in W
+-- @return #RADIO self
+function RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power, Loop)
+  self:F({FileName, Frequency, Modulation, Power})
+  
+  self:SetFileName(FileName)
+  if Frequency then self:SetFrequency(Frequency) end
+  if Modulation then self:SetModulation(Modulation) end
+  if Power then self:SetPower(Power) end
+  if Loop then self:SetLoop(Loop) end
+  
+  return self
+end
+
+
+--- Create a new transmission, that is to say, populate the RADIO with relevant data
+-- In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP,
+-- but it will work for any @{Positionable#POSITIONABLE}. 
+-- Only the RADIO and the Filename are mandatory.
+-- @param #RADIO self
+-- @param #string FileName
+-- @param #string Subtitle
+-- @param #number SubtitleDuration in s
+-- @param #number Frequency in MHz
+-- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
+-- @param #boolean Loop
+-- @return #RADIO self
+function RADIO:NewUnitTransmission(FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop)
+  self:F({FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop})
+
+  self:SetFileName(FileName)
+  if Subtitle then self:SetSubtitle(Subtitle) end
+  if SubtitleDuration then self:SetSubtitleDuration(SubtitleDuration) end
+  if Frequency then self:SetFrequency(Frequency) end
+  if Modulation then self:SetModulation(Modulation) end
+  if Loop then self:SetLoop(Loop) end
+  
+  return self
+end
+
+--- Actually Broadcast the transmission
+-- * The Radio has to be populated with the new transmission before broadcasting.
+-- * Please use RADIO setters or either @{Radio#RADIO.NewGenericTransmission} or @{Radio#RADIO.NewUnitTransmission}
+-- * This class is in fact pretty smart, it determines the right DCS function to use depending on the type of POSITIONABLE
+-- * If the POSITIONABLE is not a UNIT or a GROUP, we use the generic (but limited) trigger.action.radioTransmission()
+-- * If the POSITIONABLE is a UNIT or a GROUP, we use the "TransmitMessage" Command
+-- * If your POSITIONABLE is a UNIT or a GROUP, the Power is ignored.
+-- * If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration are ignored
+-- @param #RADIO self
+-- @return #RADIO self
+function RADIO:Broadcast()
+  self:F()
+  
+  -- If the POSITIONABLE is actually a UNIT or a GROUP, use the more complicated DCS command system
+  if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
+    self:T2("Broadcasting from a UNIT or a GROUP")
+    self.Positionable:SetCommand({
+      id = "TransmitMessage",
+      params = {
+        file = self.FileName,
+        duration = self.SubtitleDuration,
+        subtitle = self.Subtitle,
+        loop = self.Loop,
+      }
+    })
+  else
+    -- If the POSITIONABLE is anything else, we revert to the general singleton function
+    -- I need to give it a unique name, so that the transmission can be stopped later. I use the class ID
+    self:T2("Broadcasting from a POSITIONABLE")
+    trigger.action.radioTransmission(self.FileName, self.Positionable:GetPositionVec3(), self.Modulation, self.Loop, self.Frequency, self.Power, tostring(self.ID))
+  end
+  return self
+end
+
+--- Stops a transmission
+-- This function is especially usefull to stop the broadcast of looped transmissions
+-- @param #RADIO self
+-- @return #RADIO self
+function RADIO:StopBroadcast()
+  self:F()
+  -- If the POSITIONABLE is a UNIT or a GROUP, stop the transmission with the DCS "StopTransmission" command 
+  if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
+    self.Positionable:SetCommand({
+      id = "StopTransmission",
+      params = {}
+    })
+  else
+    -- Else, we use the appropriate singleton funciton
+    trigger.action.stopRadioTransmission(tostring(self.ID))
+  end
+  return self
+end
+
+
+--- # BEACON class, extends @{Base#BASE}
+-- 
+-- After attaching a @{#BEACON} to your @{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. 
+-- 
+-- ## AA TACAN Beacon usage
+-- 
+-- This beacon only works with airborne @{Unit#UNIT} or a @{Group#GROUP}. Use @{#BEACON:AATACAN}() to set the beacon parameters and start the beacon.
+-- Use @#BEACON:StopAATACAN}() to stop it.
+-- 
+-- ## General Purpose Radio Beacon usage
+-- 
+-- This beacon will work with any @{Positionable#POSITIONABLE}, but **it won't follow the @{Positionable#POSITIONABLE}** ! This means that you should only use it with
+-- @{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
+-- @extends Core.Base#BASE
+BEACON = {
+  ClassName = "BEACON",
+}
+
+--- Create a new BEACON Object. This doesn't activate the beacon, though, use @{#BEACON.AATACAN} or @{#BEACON.Generic}
+-- If you want to create a BEACON, you probably should use @{Positionable#POSITIONABLE.GetBeacon}() instead.
+-- @param #BEACON self
+-- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
+-- @return #BEACON Beacon
+-- @return #nil If Positionable is invalid
+function BEACON:New(Positionable)
+  local self = BASE:Inherit(self, BASE:New())
+  
+  self:F(Positionable)
+  
+  if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
+    self.Positionable = Positionable
+    return self
+  end
+  
+  self:E({"The passed positionable is invalid, no BEACON created", Positionable})
+  return nil
+end
+
+
+--- Converts a TACAN Channel/Mode couple into a frequency in Hz
+-- @param #BEACON self
+-- @param #number TACANChannel
+-- @param #string TACANMode
+-- @return #number Frequecy
+-- @return #nil if parameters are invalid
+function BEACON:_TACANToFrequency(TACANChannel, TACANMode)
+  self:F3({TACANChannel, TACANMode})
+
+  if type(TACANChannel) ~= "number" then
+      if TACANMode ~= "X" and TACANMode ~= "Y" then
+        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
+      A = 1088
+    end
+  else -- 'X'
+    if TACANChannel < 64 then
+      A = 962
+    end
+  end
+  
+  return (A + TACANChannel - B) * 1000000
+end
+
+
+--- 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
+-- @param #boolean Bearing Can the BEACON be homed on ?
+-- @param #number BeaconDuration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+-- @usage
+-- -- Let's create a TACAN Beacon for a tanker
+-- local myUnit = UNIT:FindByName("MyUnit") 
+-- local myBeacon = myUnit:GetBeacon() -- Creates the beacon
+-- 
+-- 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
+    System = 5
+  else
+    System = 14
+  end
+  
+  if IsValid then -- Starts the BEACON
+    self:T2({"AA TACAN BEACON started !"})
+    self.Positionable:SetCommand({
+      id = "ActivateBeacon",
+      params = {
+        type = 4,
+        system = System,
+        callsign = Message,
+        frequency = Frequency,
+        }
+      })
+      
+    if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
+      SCHEDULER:New( nil, 
+      function()
+        self:StopAATACAN()
+      end, {}, BeaconDuration)
+    end
+  end
+  
+  return self
+end
+
+--- Stops the AA TACAN BEACON
+-- @param #BEACON self
+-- @return #BEACON self
+function BEACON:StopAATACAN()
+  self:F()
+  if not self.Positionable then
+    self:E({"Start the beacon first before stoping it !"})
+  else
+    self.Positionable:SetCommand({
+      id = 'DeactivateBeacon', 
+        params = { 
+      } 
+    })
+  end
+end
+
+
+--- Activates a general pupose 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 : 
+-- * **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
+-- * ARK9 -> 150-1300KHz
+-- * **Huey**
+-- * AN/ARC-131 -> 30-76 Mhz FM
+-- @param #BEACON self
+-- @param #string FileName The name of the audio file
+-- @param #number Frequency in MHz
+-- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
+-- @param #number Power in W
+-- @param #number BeaconDuration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+-- @usage
+-- -- Let's create a beacon for a unit in distress.
+-- -- Frequency will be 40MHz FM (home-able by a Huey's AN/ARC-131)
+-- -- The beacon they use is battery-powered, and only lasts for 5 min
+-- local UnitInDistress = UNIT:FindByName("Unit1")
+-- local UnitBeacon = UnitInDistress:GetBeacon()
+-- 
+-- -- Set the beacon and start it
+-- UnitBeacon:RadioBeacon("MySoundFileSOS.ogg", 40, radio.modulation.FM, 20, 5*60)
+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
+      if not FileName:find("l10n/DEFAULT/") then
+        FileName = "l10n/DEFAULT/" .. FileName
+      end
+      IsValid = true
+    end
+  end
+  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()
+           self:StopRadioBeacon()
+         end, {}, BeaconDuration)
+     end
+  end 
+end
+
+--- Stops the AA TACAN BEACON
+-- @param #BEACON self
+-- @return #BEACON self
+function BEACON:StopRadioBeacon()
+  self:F()
+  -- The unique name of the transmission is the class ID
+  trigger.action.stopRadioTransmission(tostring(self.ID))
+end

Moose Development/Moose/Core/Report.lua

@@ -0,0 +1,86 @@
+--- The REPORT class
+-- @type REPORT
+-- @extends Core.Base#BASE
+REPORT = {
+  ClassName = "REPORT",
+  Title = "",
+}
+
+--- Create a new REPORT.
+-- @param #REPORT self
+-- @param #string Title
+-- @return #REPORT
+function REPORT:New( Title )
+
+  local self = BASE:Inherit( self, BASE:New() ) -- #REPORT
+
+  self.Report = {}
+
+  self:SetTitle( Title or "" )  
+  self:SetIndent( 3 )
+
+  return self
+end
+
+--- Has the REPORT Text?
+-- @param #REPORT self
+-- @return #boolean
+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
+  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
+  return self
+end
+
+--- Add a new line to a REPORT.
+-- @param #REPORT self
+-- @param #string Text
+-- @return #REPORT
+function REPORT:AddIndent( Text, Separator ) --R2.1
+  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.
+-- @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 ""
+  return ReportText
+end
+
+--- Sets the title of the report.
+-- @param #REPORT self
+-- @param #string Title The title of the report.
+-- @return #REPORT
+function REPORT:SetTitle( Title )
+  self.Title = Title  
+  return self
+end
+
+--- Gets the amount of report items contained in the report.
+-- @param #REPORT self
+-- @return #number Returns the number of report items contained in the report. 0 is returned if no report items are contained in the report. The title is not counted for.
+function REPORT:GetCount()
+  return #self.Report
+end

Moose Development/Moose/Core/ScheduleDispatcher.lua

@@ -0,0 +1,232 @@
+--- **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 thorought 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,  
+-- 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 @{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 ScheduleDispatcher
+
+--- The SCHEDULEDISPATCHER structure
+-- @type SCHEDULEDISPATCHER
+SCHEDULEDISPATCHER = {
+  ClassName = "SCHEDULEDISPATCHER",
+  CallID = 0,
+}
+
+function SCHEDULEDISPATCHER:New()
+  local self = BASE:Inherit( self, BASE:New() )
+  self:F3()
+  return self
+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.
+-- Nothing of this code should be modified without testing it thoroughly.
+-- @param #SCHEDULEDISPATCHER self
+-- @param Core.Scheduler#SCHEDULER Scheduler
+function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleArguments, Start, Repeat, Randomize, Stop )
+  self:F2( { Scheduler, ScheduleFunction, ScheduleArguments, Start, Repeat, Randomize, Stop } )
+
+  self.CallID = self.CallID + 1
+  local CallID = self.CallID .. "#" .. ( Scheduler.MasterObject and Scheduler.MasterObject.GetClassNameAndID and Scheduler.MasterObject:GetClassNameAndID() or "" ) 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.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" } ) 
+  
+  if Scheduler.MasterObject then
+    self.ObjectSchedulers[CallID] = Scheduler
+    self:F3( { CallID = CallID, ObjectScheduler = tostring(self.ObjectSchedulers[CallID]), MasterObject = tostring(Scheduler.MasterObject) } )
+  else
+    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] = {}
+  self.Schedule[Scheduler][CallID].Function = ScheduleFunction
+  self.Schedule[Scheduler][CallID].Arguments = ScheduleArguments
+  self.Schedule[Scheduler][CallID].StartTime = timer.getTime() + ( Start or 0 )
+  self.Schedule[Scheduler][CallID].Start = Start + .1
+  self.Schedule[Scheduler][CallID].Repeat = Repeat or 0
+  self.Schedule[Scheduler][CallID].Randomize = Randomize or 0
+  self.Schedule[Scheduler][CallID].Stop = Stop
+
+  self:T3( self.Schedule[Scheduler][CallID] )
+
+  self.Schedule[Scheduler][CallID].CallHandler = function( CallID )
+    --self:E( CallID )
+
+    local ErrorHandler = function( errmsg )
+      env.info( "Error in timer function: " .. errmsg )
+      if BASE.Debug ~= nil then
+        env.info( BASE.Debug.traceback() )
+      end
+      return errmsg
+    end
+    
+    local Scheduler = self.ObjectSchedulers[CallID]
+    if not Scheduler then
+      Scheduler = self.PersistentSchedulers[CallID]
+    end
+    
+    --self:T3( { Scheduler = Scheduler } )
+    
+    if Scheduler then
+
+      local MasterObject = tostring(Scheduler.MasterObject) 
+      local Schedule = self.Schedule[Scheduler][CallID]
+      
+      --self:T3( { Schedule = Schedule } )
+
+      local SchedulerObject = Scheduler.SchedulerObject
+      --local ScheduleObjectName = Scheduler.SchedulerObject:GetNameAndClassID()
+      local ScheduleFunction = Schedule.Function
+      local ScheduleArguments = Schedule.Arguments
+      local Start = Schedule.Start
+      local Repeat = Schedule.Repeat or 0
+      local Randomize = Schedule.Randomize or 0
+      local Stop = Schedule.Stop or 0
+      local ScheduleID = Schedule.ScheduleID
+      
+      local Status, Result
+      --self:E( { SchedulerObject = SchedulerObject } )
+      if SchedulerObject then
+        local function Timer()
+          return ScheduleFunction( SchedulerObject, unpack( ScheduleArguments ) ) 
+        end
+        Status, Result = xpcall( Timer, ErrorHandler )
+      else
+        local function Timer()
+          return ScheduleFunction( unpack( ScheduleArguments ) ) 
+        end
+        Status, Result = xpcall( Timer, ErrorHandler )
+      end
+      
+      local CurrentTime = timer.getTime()
+      local StartTime = Schedule.StartTime
+
+      self:F3( { 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.01
+          --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:E( "Scheduled obsolete call for CallID: " .. CallID )
+    end
+    
+    return nil
+  end
+  
+  self:Start( Scheduler, CallID )
+  
+  return CallID
+end
+
+function SCHEDULEDISPATCHER:RemoveSchedule( Scheduler, CallID )
+  self:F2( { Remove = CallID, Scheduler = Scheduler } )
+
+  if CallID then
+    self:Stop( Scheduler, CallID )
+    self.Schedule[Scheduler][CallID] = nil
+  end
+end
+
+function SCHEDULEDISPATCHER:Start( Scheduler, CallID )
+  self:F2( { Start = CallID, Scheduler = Scheduler } )
+
+  if CallID then
+    local Schedule = self.Schedule[Scheduler]
+    -- Only start when there is no ScheduleID defined!
+    -- This prevents to "Start" the scheduler twice with the same CallID...
+    if not Schedule[CallID].ScheduleID then
+      Schedule[CallID].StartTime = timer.getTime()  -- Set the StartTime field to indicate when the scheduler started.
+      Schedule[CallID].ScheduleID = timer.scheduleFunction( 
+        Schedule[CallID].CallHandler, 
+        CallID, 
+        timer.getTime() + Schedule[CallID].Start 
+      )
+    end
+  else
+    for CallID, Schedule in pairs( self.Schedule[Scheduler] or {} ) do
+      self:Start( Scheduler, CallID ) -- Recursive
+    end
+  end
+end
+
+function SCHEDULEDISPATCHER:Stop( Scheduler, CallID )
+  self:F2( { Stop = CallID, Scheduler = Scheduler } )
+
+  if CallID then
+    local Schedule = self.Schedule[Scheduler]
+    -- Only stop when there is a ScheduleID defined for the CallID.
+    -- So, when the scheduler was stopped before, do nothing.
+    if Schedule[CallID].ScheduleID then
+      timer.removeFunction( Schedule[CallID].ScheduleID )
+      Schedule[CallID].ScheduleID = nil
+    end
+  else
+    for CallID, Schedule in pairs( self.Schedule[Scheduler] or {} ) do
+      self:Stop( Scheduler, CallID ) -- Recursive
+    end
+  end
+end
+
+function SCHEDULEDISPATCHER:Clear( Scheduler )
+  self:F2( { Scheduler = Scheduler } )
+
+  for CallID, Schedule in pairs( self.Schedule[Scheduler] or {} ) do
+    self:Stop( Scheduler, CallID ) -- Recursive
+  end
+end
+
+
+

Moose Development/Moose/Core/Scheduler.lua

@@ -0,0 +1,317 @@
+--- **Core** -- SCHEDULER prepares and handles the **execution of functions over scheduled time (intervals)**.
+--
+-- ![Banner Image](..\Presentations\SCHEDULER\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- SCHEDULER manages the **scheduling of functions**:
+-- 
+--    * 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, 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: 
+-- 
+--   * FlightControl : Concept & Testing
+-- 
+-- ### Authors: 
+-- 
+--   * FlightControl : Design & Programming
+-- 
+-- ===
+--
+-- @module Scheduler
+
+
+--- The SCHEDULER class
+-- @type SCHEDULER
+-- @field #number ScheduleID the ID of the scheduler.
+-- @extends Core.Base#BASE
+
+
+--- # SCHEDULER class, extends @{Base#BASE}
+-- 
+-- The SCHEDULER class creates schedule.
+-- 
+-- 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}(),
+-- 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.
+-- 
+--     SchedulerObject = SCHEDULER:New()
+--     SchedulerID = SchedulerObject:Schedule( nil, ScheduleFunction, {} )
+-- 
+-- The above example creates a new SchedulerObject, but does not schedule anything.
+-- A separate schedule is created by using the SchedulerObject 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.
+-- 
+--     ZoneObject = ZONE:New( "ZoneName" )
+--     SchedulerObject = SCHEDULER:New( ZoneObject )
+--     SchedulerID = SchedulerObject:Schedule( ZoneObject, ScheduleFunction, {} )
+--     ...
+--     ZoneObject = nil
+--     garbagecollect()
+-- 
+-- The above example creates a new SchedulerObject, 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 SchedulerObject 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 ScheduleObject 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.
+--   
+--     SchedulerObject, SchedulerID = SCHEDULER:New( nil, ScheduleFunction, {} )
+--     
+-- The above example creates a new SchedulerObject, and does schedule the first schedule as part of the call.
+-- Note that 2 variables are returned here: SchedulerObject, 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" )
+--     SchedulerObject, SchedulerID = SCHEDULER:New( ZoneObject, ScheduleFunction, {} )
+--     SchedulerID = SchedulerObject:Schedule( ZoneObject, ScheduleFunction, {} )
+--     ...
+--     ZoneObject = nil
+--     garbagecollect()
+--     
+-- The above example creates a new SchedulerObject, and schedules a method call (ScheduleFunction), 
+-- and is bound to the existence of ZoneObject, which is a ZONE object (ZoneObject).
+-- Both a ScheduleObject and a SchedulerID variable are returned.
+-- Later in the logic, the ZoneObject is put to nil, and garbage is collected.
+-- As a result, the ScheduleObject will cancel the planned schedule.
+--  
+-- ## SCHEDULER timer stopping and (re-)starting.
+--
+-- The SCHEDULER can be stopped and restarted with the following methods:
+--
+--  * @{#SCHEDULER.Start}(): (Re-)Start the schedules within the SCHEDULER object. If a CallID is provided to :Start(), only the schedule referenced by CallID will be (re-)started.
+--  * @{#SCHEDULER.Stop}(): Stop the schedules within the SCHEDULER object. If a CallID is provided to :Stop(), then only the schedule referenced by CallID will be stopped.
+--
+--     ZoneObject = ZONE:New( "ZoneName" )
+--     SchedulerObject, SchedulerID = SCHEDULER:New( ZoneObject, ScheduleFunction, {} )
+--     SchedulerID = SchedulerObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 10 )
+--     ...
+--     SchedulerObject:Stop( SchedulerID )
+--     ...
+--     SchedulerObject:Start( SchedulerID )
+--     
+-- The above example creates a new SchedulerObject, and does schedule the first schedule as part of the call.
+-- Note that 2 variables are returned here: SchedulerObject, 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. 
+-- 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" )
+--     SchedulerObject = SCHEDULER:New( ZoneObject )
+-- 
+-- Several parameters can be specified that influence the behaviour of a Schedule.
+-- 
+-- ### A single schedule, immediately executed
+-- 
+--     SchedulerID = SchedulerObject:Schedule( ZoneObject, ScheduleFunction, {} )
+-- 
+-- The above example schedules a new ScheduleFunction call to be executed asynchronously, within milleseconds ...
+-- 
+-- ### A single schedule, planned over time
+-- 
+--     SchedulerID = SchedulerObject: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 = SchedulerObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60 )
+--     
+-- 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 = SchedulerObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5 )
+--     
+-- 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, 
+-- 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 = SchedulerObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5, 300 )
+--     
+-- 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, 
+-- which is in this example between **30** and **90** seconds.
+-- The schedule will stop after **300** seconds.
+-- 
+-- @field #SCHEDULER
+SCHEDULER = {
+  ClassName = "SCHEDULER",
+  Schedules = {},
+}
+
+--- SCHEDULER constructor.
+-- @param #SCHEDULER self
+-- @param #table SchedulerObject Specified for which Moose object the timer is setup. If a value of nil is provided, a scheduler will be setup without an object reference.
+-- @param #function SchedulerFunction The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
+-- @param #table SchedulerArguments Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
+-- @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 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 Specifies the amount of seconds when the scheduler will be stopped.
+-- @return #SCHEDULER self.
+-- @return #number The ScheduleID of the planned schedule.
+function SCHEDULER:New( SchedulerObject, 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 = SchedulerObject
+  
+  if SchedulerFunction then
+    ScheduleID = self:Schedule( SchedulerObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop )
+  end
+
+  return self, ScheduleID
+end
+
+--function SCHEDULER:_Destructor()
+--  --self:E("_Destructor")
+--
+--  _SCHEDULEDISPATCHER:RemoveSchedule( self.CallID )
+--end
+
+--- Schedule a new time event. Note that the schedule will only take place if the scheduler is *started*. Even for a single schedule event, the scheduler needs to be started also.
+-- @param #SCHEDULER self
+-- @param #table SchedulerObject Specified for which Moose object the timer is setup. If a value of nil is provided, a scheduler will be setup without an object reference.
+-- @param #function SchedulerFunction The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
+-- @param #table SchedulerArguments Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
+-- @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 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 Specifies the amount of seconds when the scheduler will be stopped.
+-- @return #number The ScheduleID of the planned schedule.
+function SCHEDULER:Schedule( SchedulerObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop )
+  self:F2( { Start, Repeat, RandomizeFactor, Stop } )
+  self:T3( { SchedulerArguments } )
+
+  local ObjectName = "-"
+  if SchedulerObject and SchedulerObject.ClassName and SchedulerObject.ClassID then 
+    ObjectName = SchedulerObject.ClassName .. SchedulerObject.ClassID
+  end
+  self:F3( { "Schedule :", ObjectName, tostring( SchedulerObject ),  Start, Repeat, RandomizeFactor, Stop } )
+  self.SchedulerObject = SchedulerObject
+  
+  local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule( 
+    self, 
+    SchedulerFunction,
+    SchedulerArguments,
+    Start,
+    Repeat,
+    RandomizeFactor,
+    Stop
+  )
+  
+  self.Schedules[#self.Schedules+1] = ScheduleID
+
+  return ScheduleID
+end
+
+--- (Re-)Starts the schedules or a specific schedule if a valid ScheduleID is provided.
+-- @param #SCHEDULER self
+-- @param #number ScheduleID (optional) The ScheduleID of the planned (repeating) schedule.
+function SCHEDULER:Start( ScheduleID )
+  self:F3( { ScheduleID } )
+
+  _SCHEDULEDISPATCHER:Start( self, ScheduleID )
+end
+
+--- Stops the schedules or a specific schedule if a valid ScheduleID is provided.
+-- @param #SCHEDULER self
+-- @param #number ScheduleID (optional) The ScheduleID of the planned (repeating) schedule.
+function SCHEDULER:Stop( ScheduleID )
+  self:F3( { ScheduleID } )
+
+  _SCHEDULEDISPATCHER:Stop( self, ScheduleID )
+end
+
+--- Removes a specific schedule if a valid ScheduleID is provided.
+-- @param #SCHEDULER self
+-- @param #number ScheduleID (optional) The ScheduleID of the planned (repeating) schedule.
+function SCHEDULER:Remove( ScheduleID )
+  self:F3( { ScheduleID } )
+
+  _SCHEDULEDISPATCHER:Remove( self, ScheduleID )
+end
+
+--- Clears all pending schedules.
+-- @param #SCHEDULER self
+function SCHEDULER:Clear()
+  self:F3( )
+
+  _SCHEDULEDISPATCHER:Clear( self )
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+

Moose Development/Moose/Core/Settings.lua

@@ -0,0 +1,839 @@
+--- **Core** -- Manages various settings for MOOSE classes.
+--
+-- ![Banner Image](..\Presentations\SETTINGS\Dia1.JPG)
+--
+-- ===
+-- 
+-- The documentation of the SETTINGS class can be found further in this document.
+-- 
+-- ===
+-- 
+-- # **AUTHORS and CONTRIBUTIONS**
+-- 
+-- ### Contributions: 
+-- 
+-- ### Authors: 
+-- 
+--   * **FlightControl**: Design & Programming
+--
+-- @module Settings
+
+
+--- @type SETTINGS
+-- @extends Core.Base#BASE
+
+--- # SETTINGS class, extends @{Base#BASE}
+-- The SETTINGS class takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
+-- 
+-- ===
+-- 
+-- ![Banner Image](..\Presentations\SETTINGS\Dia1.JPG)
+--
+-- ===
+-- 
+-- The SETTINGS class takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
+-- SETTINGS can work on 2 levels:
+-- 
+--   - **Default settings**: A running mission has **Default settings**. 
+--   - **Player settings**: For each player its own **Player settings** can be defined, overriding the **Default settings**.
+-- 
+-- So, when there isn't any **Player setting** defined for a player for a specific setting, or, the player cannot be identified, the **Default setting** will be used instead.
+-- 
+-- ## 1. \_SETTINGS object
+-- 
+-- MOOSE defines by default a singleton object called **\_SETTINGS**. Use this object to modify all the **Default settings** for a running mission.
+-- For each player, MOOSE will automatically allocate also a **player settings** object, and will expose a radio menu to allow the player to adapt the settings to his own preferences.
+-- 
+-- ## 2. SETTINGS Menu
+-- 
+-- Settings can be adapted by the Players and by the Mission Administrator through **radio menus, which are automatically available in the mission**.
+-- These menus can be found **on level F10 under "Settings"**. There are two kinds of menus generated by the system.
+-- 
+-- ### 2.1. Default settings menu
+-- 
+-- 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.
+-- 
+-- ### 2.2. Player settings menu
+-- 
+-- A menu is created automatically per Player Slot (group) that allows to modify the **Player** settings.
+-- So, when joining a slot, a menu wil be available that allows to change the settings parameters **FOR THE PLAYER ONLY**!
+-- Note that when a player has not chosen a specific setting, the **Default settings** will be used.
+-- 
+-- ### 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**.
+-- 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. 
+-- 
+-- Example:
+-- 
+--      _SETTINGS:SetPlayerMenuOff() -- will disable the player menus.
+--      _SETTINGS:SetPlayerMenuOn() -- will enable the player menus.
+--      -- But only when a player exits and reenters the slot these settings will have effect!
+-- 
+-- 
+-- ## 3. Settings
+-- 
+-- There are different settings that are managed and applied within the MOOSE framework.
+-- See below a comprehensive description of each.
+-- 
+-- ### 3.1. **A2G coordinates** display formatting
+-- 
+-- #### 3.1.1. A2G coordinates setting **types**
+-- 
+-- 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 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.
+-- 
+-- #### 3.1.2. A2G coordinates setting **menu**
+-- 
+-- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
+-- 
+-- #### 3.1.3. A2G coordinates setting **methods**
+--   
+-- 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.
+-- 
+-- #### 3.1.4. A2G coordinates setting - additional notes
+-- 
+-- One additional note on BR. In a situation when a BR coordinate should be given, 
+-- but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied!
+-- 
+-- ### 3.2. **A2A coordinates** formatting
+--   
+-- #### 3.2.1. A2A coordinates setting **types**
+-- 
+-- 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 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.
+--   - A2A BULLS: [Bullseye](http://falcon4.wikidot.com/concepts:bullseye).
+--   
+-- #### 3.2.2. A2A coordinates setting **menu**
+-- 
+-- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
+-- 
+-- #### 3.2.3. A2A coordinates setting **methods**
+--   
+-- 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_BULLS}(): Enable the BULLSeye display formatting by default.
+-- 
+-- #### 3.2.4. A2A coordinates settings - additional notes
+-- 
+-- One additional note on BRAA. In a situation when a BRAA coordinate should be given, 
+-- but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied!
+-- 
+-- ### 3.3. **Measurements** formatting
+-- 
+-- #### 3.3.1. Measurements setting **types**
+-- 
+-- Will customize the measurements system being used as part as part of the Command Center communications.
+-- 
+--   - **Metrics** system: Applies the [Metrics system](https://en.wikipedia.org/wiki/Metric_system) ...
+--   - **Imperial** system: Applies the [Imperial system](https://en.wikipedia.org/wiki/Imperial_units) ...  
+-- 
+-- #### 3.3.2. Measurements setting **menu**
+-- 
+-- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
+-- 
+-- #### 3.3.3. Measurements setting **methods**
+--   
+-- There are different methods that can be used to change the **Default settings** using the \_SETTINGS object.
+-- 
+--   - @{#SETTINGS.SetMetric}(): Enable the Metric system.
+--   - @{#SETTINGS.SetImperial}(): Enable the Imperial system.
+--   
+-- ### 3.4. **Message** display times
+-- 
+-- #### 3.4.1. Message setting **types**
+-- 
+-- There are various **Message Types** that will influence the duration how long a message will appear as part of the Command Center communications.
+-- 
+--   - **Update** message: A short update message.
+--   - **Information** message: Provides new information **while** executing a mission.
+--   - **Briefing** message: Provides a complete briefing **before** executing a mission.
+--   - **Overview report**: Provides a short report overview, the summary of the report.
+--   - **Detailed report**: Provides a complete report.
+--   
+-- #### 3.4.2. Message setting **menu**
+-- 
+-- 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.
+-- 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!
+-- 
+-- #### 3.4.3. Message setting **methods**
+--   
+-- 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. 
+--   
+-- ===
+-- 
+-- @field #SETTINGS
+SETTINGS = {
+  ClassName = "SETTINGS",
+  ShowPlayerMenu = true,
+}
+
+
+
+do -- SETTINGS
+
+  --- SETTINGS constructor.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:Set( PlayerName ) 
+
+    if PlayerName == nil then
+      local self = BASE:Inherit( self, BASE:New() ) -- #SETTINGS
+      self:SetMetric() -- Defaults
+      self:SetA2G_BR() -- Defaults
+      self:SetA2A_BRAA() -- Defaults
+      self:SetLL_Accuracy( 3 ) -- Defaults
+      self:SetMGRS_Accuracy( 5 ) -- Defaults
+      self:SetMessageTime( MESSAGE.Type.Briefing, 180 )
+      self:SetMessageTime( MESSAGE.Type.Detailed, 60 )
+      self:SetMessageTime( MESSAGE.Type.Information, 30 )
+      self:SetMessageTime( MESSAGE.Type.Overview, 60 )
+      self:SetMessageTime( MESSAGE.Type.Update, 15 )
+      return self
+    else
+      local Settings = _DATABASE:GetPlayerSettings( PlayerName )
+      if not Settings then
+        Settings = BASE:Inherit( self, BASE:New() ) -- #SETTINGS
+        _DATABASE:SetPlayerSettings( PlayerName, Settings )
+      end
+      return Settings
+    end
+  end
+  
+ 
+  --- Sets the SETTINGS metric.
+  -- @param #SETTINGS self
+  function SETTINGS:SetMetric()
+    self.Metric = true
+  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() )
+  end
+
+  --- Sets the SETTINGS imperial.
+  -- @param #SETTINGS self
+  function SETTINGS:SetImperial()
+    self.Metric = false
+  end
+ 
+  --- Gets if the SETTINGS is imperial.
+  -- @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() )
+  end
+
+  --- Sets the SETTINGS LL accuracy.
+  -- @param #SETTINGS self
+  -- @param #number LL_Accuracy
+  -- @return #SETTINGS
+  function SETTINGS:SetLL_Accuracy( LL_Accuracy )
+    self.LL_Accuracy = LL_Accuracy
+  end
+
+  --- Gets the SETTINGS LL accuracy.
+  -- @param #SETTINGS self
+  -- @return #number
+  function SETTINGS:GetLL_DDM_Accuracy()
+    return self.LL_DDM_Accuracy or _SETTINGS:GetLL_DDM_Accuracy()
+  end
+
+  --- Sets the SETTINGS MGRS accuracy.
+  -- @param #SETTINGS self
+  -- @param #number MGRS_Accuracy
+  -- @return #SETTINGS
+  function SETTINGS:SetMGRS_Accuracy( MGRS_Accuracy )
+    self.MGRS_Accuracy = MGRS_Accuracy
+  end
+
+  --- Gets the SETTINGS MGRS accuracy.
+  -- @param #SETTINGS self
+  -- @return #number
+  function SETTINGS:GetMGRS_Accuracy()
+    return self.MGRS_Accuracy or _SETTINGS:GetMGRS_Accuracy()
+  end
+  
+  --- Sets the SETTINGS Message Display Timing of a MessageType
+  -- @param #SETTINGS self
+  -- @param Core.Message#MESSAGE MessageType The type of the message.
+  -- @param #number MessageTime The display time duration in seconds of the MessageType.
+  function SETTINGS:SetMessageTime( MessageType, MessageTime )
+    self.MessageTypeTimings = self.MessageTypeTimings or {}
+    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 )
+  end
+
+  --- Sets A2G LL DMS
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetA2G_LL_DMS()
+    self.A2GSystem = "LL DMS"
+  end
+
+  --- Sets A2G LL DDM
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetA2G_LL_DDM()
+    self.A2GSystem = "LL DDM"
+  end
+
+  --- Is LL DMS
+  -- @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() )
+  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() )
+  end
+
+  --- Sets A2G MGRS
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetA2G_MGRS()
+    self.A2GSystem = "MGRS"
+  end
+
+  --- Is MGRS
+  -- @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() )
+  end
+
+  --- Sets A2G BRA
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetA2G_BR()
+    self.A2GSystem = "BR"
+  end
+
+  --- Is BRA
+  -- @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() )
+  end
+
+  --- Sets A2A BRA
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetA2A_BRAA()
+    self.A2ASystem = "BRAA"
+  end
+
+  --- Is BRA
+  -- @param #SETTINGS self
+  -- @return #boolean true if BRA
+  function SETTINGS:IsA2A_BRAA()
+    self:E( { BRA = ( 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
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetA2A_BULLS()
+    self.A2ASystem = "BULLS"
+  end
+
+  --- Is BULLS
+  -- @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() )
+  end
+
+  --- Sets A2A LL DMS
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetA2A_LL_DMS()
+    self.A2ASystem = "LL DMS"
+  end
+
+  --- Sets A2A LL DDM
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetA2A_LL_DDM()
+    self.A2ASystem = "LL DDM"
+  end
+
+  --- Is LL DMS
+  -- @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() )
+  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() )
+  end
+
+  --- Sets A2A MGRS
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetA2A_MGRS()
+    self.A2ASystem = "MGRS"
+  end
+
+  --- Is MGRS
+  -- @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() )
+  end
+
+  --- @param #SETTINGS self
+  -- @return #SETTINGS
+  function SETTINGS:SetSystemMenu( MenuGroup, RootMenu )
+
+    local MenuText = "System Settings"
+    
+    local MenuTime = timer.getTime()
+    
+    local SettingsMenu = MENU_GROUP:New( MenuGroup, MenuText, RootMenu ):SetTime( MenuTime )
+
+    local A2GCoordinateMenu = MENU_GROUP:New( MenuGroup, "A2G Coordinate System", SettingsMenu ):SetTime( MenuTime )
+  
+    
+    if not self:IsA2G_LL_DMS() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Lat/Lon Degree Min Sec (LL DMS)", A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "LL DMS" ):SetTime( MenuTime )
+    end
+    
+    if not self:IsA2G_LL_DDM() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "LL DDM" ):SetTime( MenuTime )
+    end
+    
+    if self:IsA2G_LL_DDM() then
+      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 )
+      MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 3", A2GCoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 3 ):SetTime( MenuTime )
+    end
+    
+    if not self:IsA2G_BR() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Bearing, Range (BR)", A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "BR" ):SetTime( MenuTime )
+    end
+    
+    if not self:IsA2G_MGRS() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Military Grid (MGRS)", A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "MGRS" ):SetTime( MenuTime )
+    end
+    
+    if self:IsA2G_MGRS() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 1", A2GCoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 1 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 2", A2GCoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 2 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 3", A2GCoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 3 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 4", A2GCoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 4 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 5", A2GCoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 5 ):SetTime( MenuTime )
+    end
+
+    local A2ACoordinateMenu = MENU_GROUP:New( MenuGroup, "A2A Coordinate System", SettingsMenu ):SetTime( MenuTime )
+
+    if not self:IsA2A_LL_DMS() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Lat/Lon Degree Min Sec (LL DMS)", A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "LL DMS" ):SetTime( MenuTime )
+    end
+
+    if not self:IsA2A_LL_DDM() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "LL DDM" ):SetTime( MenuTime )
+    end
+
+    if self:IsA2A_LL_DDM() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 1", A2ACoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 1 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 2", A2ACoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 2 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 3", A2ACoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 3 ):SetTime( MenuTime )
+    end    
+
+    if not self:IsA2A_BULLS() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Bullseye (BULLS)", A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "BULLS" ):SetTime( MenuTime )
+    end
+    
+    if not self:IsA2A_BRAA() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Bearing Range Altitude Aspect (BRAA)", A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "BRAA" ):SetTime( MenuTime )
+    end
+    
+    if not self:IsA2A_MGRS() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Military Grid (MGRS)", A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "MGRS" ):SetTime( MenuTime )
+    end
+
+    if self:IsA2A_MGRS() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 1", A2ACoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 1 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 2", A2ACoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 2 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 3", A2ACoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 3 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 4", A2ACoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 4 ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 5", A2ACoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 5 ):SetTime( MenuTime )
+    end        
+  
+    local MetricsMenu = MENU_GROUP:New( MenuGroup, "Measures and Weights System", SettingsMenu ):SetTime( MenuTime )
+    
+    if self:IsMetric() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Imperial (Miles,Feet)", MetricsMenu, self.MenuMWSystem, self, MenuGroup, RootMenu, false ):SetTime( MenuTime )
+    end
+    
+    if self:IsImperial() then
+      MENU_GROUP_COMMAND:New( MenuGroup, "Metric (Kilometers,Meters)", MetricsMenu, self.MenuMWSystem, self, MenuGroup, RootMenu, true ):SetTime( MenuTime )
+    end    
+    
+    local MessagesMenu = MENU_GROUP:New( MenuGroup, "Messages and Reports", SettingsMenu ):SetTime( MenuTime )
+
+    local UpdateMessagesMenu = MENU_GROUP:New( MenuGroup, "Update Messages", MessagesMenu ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "Off", UpdateMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Update, 0 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "5 seconds", UpdateMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Update, 5 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "10 seconds", UpdateMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Update, 10 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "15 seconds", UpdateMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Update, 15 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "30 seconds", UpdateMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Update, 30 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "1 minute", UpdateMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Update, 60 ):SetTime( MenuTime )
+
+    local InformationMessagesMenu = MENU_GROUP:New( MenuGroup, "Information Messages", MessagesMenu ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "5 seconds", InformationMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Information, 5 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "10 seconds", InformationMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Information, 10 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "15 seconds", InformationMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Information, 15 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "30 seconds", InformationMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Information, 30 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "1 minute", InformationMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Information, 60 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "2 minutes", InformationMessagesMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Information, 120 ):SetTime( MenuTime )
+
+    local BriefingReportsMenu = MENU_GROUP:New( MenuGroup, "Briefing Reports", MessagesMenu ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "15 seconds", BriefingReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Briefing, 15 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "30 seconds", BriefingReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Briefing, 30 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "1 minute", BriefingReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Briefing, 60 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "2 minutes", BriefingReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Briefing, 120 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "3 minutes", BriefingReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Briefing, 180 ):SetTime( MenuTime )
+
+    local OverviewReportsMenu = MENU_GROUP:New( MenuGroup, "Overview Reports", MessagesMenu ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "15 seconds", OverviewReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Overview, 15 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "30 seconds", OverviewReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Overview, 30 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "1 minute", OverviewReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Overview, 60 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "2 minutes", OverviewReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Overview, 120 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "3 minutes", OverviewReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.Overview, 180 ):SetTime( MenuTime )
+
+    local DetailedReportsMenu = MENU_GROUP:New( MenuGroup, "Detailed Reports", MessagesMenu ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "15 seconds", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 15 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "30 seconds", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 30 ):SetTime( MenuTime )
+    MENU_GROUP_COMMAND:New( MenuGroup, "1 minute", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 60 ):SetTime( MenuTime )
+    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
+  end
+
+  --- Sets the player menus on, so that the **Player setting menus** show up for the players.
+  -- But only when a player exits and reenters the slot these settings will have effect!
+  -- It is advised to use this method at the start of the mission.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS
+  -- @usage
+  --   _SETTINGS:SetPlayerMenuOn() -- will enable the player menus.
+  function SETTINGS:SetPlayerMenuOn()
+    self.ShowPlayerMenu = true
+  end
+
+  --- Sets the player menus off, so that the **Player setting menus** won't show up for the players.
+  -- But only when a player exits and reenters the slot these settings will have effect!
+  -- It is advised to use this method at the start of the mission.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS self
+  -- @usage
+  --   _SETTINGS:SetPlayerMenuOff() -- will disable the player menus.
+  function SETTINGS:SetPlayerMenuOff()
+    self.ShowPlayerMenu = false
+  end
+
+
+
+  --- Updates the menu of the player seated in the PlayerUnit.
+  -- @param #SETTINGS self
+  -- @param Wrapper.Client#CLIENT PlayerUnit
+  -- @return #SETTINGS self
+  function SETTINGS:SetPlayerMenu( PlayerUnit )
+
+    if _SETTINGS.ShowPlayerMenu == true then
+    
+      local PlayerGroup = PlayerUnit:GetGroup()
+      local PlayerName = PlayerUnit:GetPlayerName()
+      local PlayerNames = PlayerGroup:GetPlayerNames()
+  
+      local PlayerMenu = MENU_GROUP:New( PlayerGroup, 'Settings "' .. PlayerName .. '"' )
+      
+      self.PlayerMenu = PlayerMenu
+  
+      local A2GCoordinateMenu = MENU_GROUP:New( PlayerGroup, "A2G Coordinate System", PlayerMenu )
+    
+      if not self:IsA2G_LL_DMS() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Min Sec (LL DMS)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
+      end
+    
+      if not self:IsA2G_LL_DDM() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
+      end
+    
+      if self:IsA2G_LL_DDM() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 1", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 2", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 3", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
+      end
+      
+      if not self:IsA2G_BR() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Bearing, Range (BR)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "BR" )
+      end
+      
+      if not self:IsA2G_MGRS() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
+      end    
+  
+      if self:IsA2G_MGRS() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 1", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 2", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 3", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 4", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 5", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 5 )
+      end
+  
+      local A2ACoordinateMenu = MENU_GROUP:New( PlayerGroup, "A2A Coordinate System", PlayerMenu )
+  
+  
+      if not self:IsA2A_LL_DMS() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Min Sec (LL DMS)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
+      end
+    
+      if not self:IsA2A_LL_DDM() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
+      end
+    
+      if self:IsA2A_LL_DDM() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 1", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 2", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 3", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
+      end
+  
+      if not self:IsA2A_BULLS() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Bullseye (BULLS)", A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BULLS" )
+      end
+      
+      if not self:IsA2A_BRAA() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Bearing Range Altitude Aspect (BRAA)", A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BRAA" )
+      end
+      
+      if not self:IsA2A_MGRS() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS)", A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
+      end
+      
+      if self:IsA2A_MGRS() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 1", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 2", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 3", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 4", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 5", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 5 )
+      end    
+  
+      local MetricsMenu = MENU_GROUP:New( PlayerGroup, "Measures and Weights System", PlayerMenu )
+      
+      if self:IsMetric() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Imperial (Miles,Feet)", MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, false )
+      end
+      
+      if self:IsImperial() then
+        MENU_GROUP_COMMAND:New( PlayerGroup, "Metric (Kilometers,Meters)", MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, true )
+      end    
+  
+  
+      local MessagesMenu = MENU_GROUP:New( PlayerGroup, "Messages and Reports", PlayerMenu )
+  
+      local UpdateMessagesMenu = MENU_GROUP:New( PlayerGroup, "Update Messages", MessagesMenu )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Off", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 0 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "5 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 5 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "10 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 10 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 15 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 30 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 60 )
+  
+      local InformationMessagesMenu = MENU_GROUP:New( PlayerGroup, "Information Messages", MessagesMenu )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "5 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 5 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "10 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 10 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 15 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 30 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 60 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 120 )
+  
+      local BriefingReportsMenu = MENU_GROUP:New( PlayerGroup, "Briefing Reports", MessagesMenu )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 15 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 30 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 60 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 120 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 180 )
+  
+      local OverviewReportsMenu = MENU_GROUP:New( PlayerGroup, "Overview Reports", MessagesMenu )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 15 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 30 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 60 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 120 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 180 )
+  
+      local DetailedReportsMenu = MENU_GROUP:New( PlayerGroup, "Detailed Reports", MessagesMenu )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 15 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 30 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 60 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 120 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 180 )
+    
+    end  
+    
+    return self
+  end
+
+  --- Removes the player menu from the PlayerUnit.
+  --- @param #SETTINGS self
+  -- @param Wrapper.Client#CLIENT PlayerUnit
+  -- @return #SETTINGS self
+  function SETTINGS:RemovePlayerMenu( PlayerUnit )
+
+    if self.PlayerMenu then
+      self.PlayerMenu:Remove()
+      self.PlayerMenu = nil
+    end
+    
+    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()
+    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()
+    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()
+    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()
+    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()
+    self:SetSystemMenu( MenuGroup, RootMenu )
+  end
+
+  --- @param #SETTINGS self
+  function SETTINGS:MenuMessageTimingsSystem( MenuGroup, RootMenu, MessageType, MessageTime )
+    self:SetMessageTime( MessageType, MessageTime )
+    MESSAGE:New( string.format( "Settings: Default message time set for %s to %d.", MessageType, MessageTime ), 5 ):ToAll()
+  end
+
+  do
+    --- @param #SETTINGS self
+    function SETTINGS:MenuGroupA2GSystem( PlayerUnit, PlayerGroup, PlayerName, A2GSystem )
+      BASE:E( {self, PlayerUnit:GetName(), A2GSystem} )
+      self.A2GSystem = A2GSystem
+      MESSAGE:New( string.format( "Settings: A2G format set to %s for player %s.", A2GSystem, PlayerName ), 5 ):ToGroup( PlayerGroup )
+      self:RemovePlayerMenu(PlayerUnit)
+      self:SetPlayerMenu(PlayerUnit)
+    end
+  
+    --- @param #SETTINGS self
+    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 )
+      self:RemovePlayerMenu(PlayerUnit)
+      self:SetPlayerMenu(PlayerUnit)
+    end
+  
+    --- @param #SETTINGS self
+    function SETTINGS:MenuGroupLL_DDM_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy )
+      self.LL_Accuracy = LL_Accuracy
+      MESSAGE:New( string.format( "Settings: A2G LL format accuracy set to %d for player %s.", LL_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup )
+      self:RemovePlayerMenu(PlayerUnit)
+      self:SetPlayerMenu(PlayerUnit)
+    end
+  
+    --- @param #SETTINGS self
+    function SETTINGS:MenuGroupMGRS_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy )
+      self.MGRS_Accuracy = MGRS_Accuracy
+      MESSAGE:New( string.format( "Settings: A2G MGRS format accuracy set to %d for player %s.", MGRS_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup )
+      self:RemovePlayerMenu(PlayerUnit)
+      self:SetPlayerMenu(PlayerUnit)
+    end
+
+    --- @param #SETTINGS self
+    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 )
+      self:RemovePlayerMenu(PlayerUnit)
+      self:SetPlayerMenu(PlayerUnit)
+    end
+
+    --- @param #SETTINGS self
+    function SETTINGS:MenuGroupMessageTimingsSystem( PlayerUnit, PlayerGroup, PlayerName, MessageType, MessageTime )
+      self:SetMessageTime( MessageType, MessageTime )
+      MESSAGE:New( string.format( "Settings: Default message time set for %s to %d.", MessageType, MessageTime ), 5 ):ToGroup( PlayerGroup )
+    end
+  
+  end
+
+end
+
+

Moose Development/Moose/Core/SpawnStatic.lua

@@ -0,0 +1,195 @@
+--- **Core** -- Spawn dynamically new STATICs in your missions.
+--  
+-- ![Banner Image](..\Presentations\SPAWNSTATIC\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- SPAWNSTATIC spawns static structures in your missions dynamically. See below the SPAWNSTATIC class documentation.
+-- 
+-- ===
+-- 
+-- # Demo Missions
+-- 
+-- ### [SPAWNSTATIC Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/SPS - Spawning Statics)
+-- 
+-- ### [SPAWNSTATIC Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SPS%20-%20Spawning%20Statics)
+--
+-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
+-- 
+-- ===
+-- 
+-- # YouTube Channel
+-- 
+-- ### [SPAWNSTATIC YouTube Channel]()
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- ### Contributions: 
+-- 
+-- ===
+-- 
+-- @module SpawnStatic
+
+
+
+--- @type SPAWNSTATIC
+-- @extends Core.Base#BASE
+
+
+--- # SPAWNSTATIC class, extends @{Base#BASE}
+-- 
+-- The SPAWNSTATIC class allows to spawn dynamically new @{Static}s.
+-- 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:
+-- 
+--   * 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**.
+-- 
+--   
+-- ## SPAWNSTATIC construction methods
+-- 
+-- Create a new SPAWNSTATIC object with the @{#SPAWNSTATIC.NewFromStatic}():
+-- 
+--   * @{#SPAWNSTATIC.NewFromStatic}(): Creates a new SPAWNSTATIC object given a name that is used as the base of the naming of each spawned Static.
+--
+-- ## **Spawn** methods
+-- 
+-- Groups can be spawned at different times and methods:
+-- 
+--   * @{#SPAWNSTATIC.SpawnFromPointVec2}(): Spawn a new group from a POINT_VEC2 coordinate. 
+--   (The group will be spawned at land height ).
+--   * @{#SPAWNSTATIC.SpawnFromZone}(): Spawn a new group in a @{Zone}.
+--  
+-- @field #SPAWNSTATIC SPAWNSTATIC
+-- 
+SPAWNSTATIC = {
+  ClassName = "SPAWNSTATIC",
+}
+
+
+--- @type SPAWNSTATIC.SpawnZoneTable
+-- @list <Core.Zone#ZONE_BASE> SpawnZone
+
+
+--- Creates the main object to spawn a @{Static} defined in the ME.
+-- @param #SPAWNSTATIC self
+-- @param #string SpawnTemplatePrefix is the name of the Group in the ME that defines the Template.  Each new group will have the name starting with SpawnTemplatePrefix.
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:NewFromStatic( SpawnTemplatePrefix, CountryID ) --R2.1
+	local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
+	self:F( { SpawnTemplatePrefix } )
+  
+	local TemplateStatic = StaticObject.getByName( SpawnTemplatePrefix )
+	if TemplateStatic then
+		self.SpawnTemplatePrefix = SpawnTemplatePrefix
+    self.CountryID = CountryID
+		self.SpawnIndex = 0
+	else
+		error( "SPAWNSTATIC:New: There is no group declared in the mission editor with SpawnTemplatePrefix = '" .. SpawnTemplatePrefix .. "'" )
+	end
+
+  self:SetEventPriority( 5 )
+
+	return self
+end
+
+--- Creates the main object to spawn a @{Static} based on a type name.
+-- @param #SPAWNSTATIC self
+-- @param #string SpawnTypeName is the name of the type.
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:NewFromType( SpawnTypeName, SpawnShapeName, SpawnCategory, CountryID ) --R2.1
+  local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
+  self:F( { SpawnTypeName } )
+  
+  self.SpawnTypeName = SpawnTypeName
+  self.CountryID = CountryID
+  self.SpawnIndex = 0
+
+  self:SetEventPriority( 5 )
+
+  return self
+end
+
+--- Creates a new @{Static} at the original position.
+-- @param #SPAWNSTATIC self
+-- @param #number Heading The heading of the static, which is a number in degrees from 0 to 360.
+-- @param #string (optional) The name of the new static.
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:Spawn( Heading, NewName ) --R2.3
+  self:F( { Heading, NewName  } )
+  
+  local CountryName = _DATABASE.COUNTRY_NAME[self.CountryID]
+  
+  local StaticTemplate = _DATABASE:GetStaticUnitTemplate( self.SpawnTemplatePrefix )
+  
+  StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
+  StaticTemplate.heading = ( Heading / 180 ) * math.pi
+  
+  StaticTemplate.CountryID = nil
+  StaticTemplate.CoalitionID = nil
+  StaticTemplate.CategoryID = nil
+  
+  local Static = coalition.addStaticObject( self.CountryID, StaticTemplate )
+  
+  self.SpawnIndex = self.SpawnIndex + 1
+
+  return Static
+end
+
+
+
+--- Creates a new @{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.
+-- @param #string (optional) The name of the new static.
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:SpawnFromPointVec2( PointVec2, Heading, NewName ) --R2.1
+  self:F( { PointVec2, Heading, NewName  } )
+  
+  local CountryName = _DATABASE.COUNTRY_NAME[self.CountryID]
+  
+  local StaticTemplate = _DATABASE:GetStaticUnitTemplate( self.SpawnTemplatePrefix )
+  
+  StaticTemplate.x = PointVec2.x
+  StaticTemplate.y = PointVec2.z
+
+  StaticTemplate.units = nil
+  StaticTemplate.route = nil
+  StaticTemplate.groupId = nil
+    
+  
+  StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
+  StaticTemplate.heading = ( Heading / 180 ) * math.pi
+  
+  StaticTemplate.CountryID = nil
+  StaticTemplate.CoalitionID = nil
+  StaticTemplate.CategoryID = nil
+  
+  local Static = coalition.addStaticObject( self.CountryID, StaticTemplate )
+  
+  self.SpawnIndex = self.SpawnIndex + 1
+
+  return Static
+end
+
+--- Creates a new @{Static} from a @{Zone}.
+-- @param #SPAWNSTATIC self
+-- @param Core.Zone#ZONE_BASE Zone The Zone where to spawn the static.
+-- @param #number Heading The heading of the static, which is a number in degrees from 0 to 360.
+-- @param #string (optional) The name of the new static.
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:SpawnFromZone( Zone, Heading, NewName ) --R2.1
+  self:F( { Zone, Heading, NewName  } )
+
+  local Static = self:SpawnFromPointVec2( Zone:GetPointVec2(), Heading, NewName )
+  
+  return Static
+end
+

Moose Development/Moose/Core/Spot.lua

@@ -0,0 +1,291 @@
+--- **Core** -- Management of SPOT logistics, that can be transported from and to transportation carriers.
+--
+-- ![Banner Image](..\Presentations\SPOT\Dia1.JPG)
+--
+-- ===
+-- 
+-- SPOT implements the DCS Spot class functionality, but adds additional luxury to be able to:
+-- 
+--   * Spot for a defined duration.
+--   * wiggle the spot at the target.
+--   * Provide a @{Unit} as a target, instead of a point.
+--   * Implement a status machine, LaseOn, LaseOff.
+--
+-- ===
+-- 
+-- # 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]()
+-- 
+-- ===
+-- 
+-- ### 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
+-- 
+-- ===
+-- 
+-- @module Spot
+
+
+do
+
+  --- @type SPOT
+  -- @extends Core.Fsm#FSM
+
+
+  --- # SPOT class, extends @{Fsm#FSM}
+  -- 
+  -- SPOT implements the DCS Spot class functionality, but adds additional luxury to be able to:
+  -- 
+  --   * Mark targets for a defined duration.
+  --   * wiggle the spot at the target.
+  --   * Provide a @{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.
+  -- 
+  -- ## 2. SPOT is a FSM
+  -- 
+  -- ![Process]()
+  -- 
+  -- ### 2.1 SPOT States
+  -- 
+  --   * **Off**: Lasing is switched off.
+  --   * **On**: Lasing is switched on.
+  --   * **Destroyed**: Target is destroyed.
+  -- 
+  -- ### 2.2 SPOT Events
+  -- 
+  --   * **@{#SPOT.LaseOn}(Target, LaserCode, Duration)**: Lase to a target.
+  --   * **@{#SPOT.LaseOff}()**: Stop lasing the target.
+  --   * **@{#SPOT.Lasing}()**: Target is being lased.
+  --   * **@{#SPOT.Destroyed}()**: Triggered when target is destroyed.
+  -- 
+  -- ## 3. Check if a Target is being lased
+  -- 
+  -- The method @{#SPOT.IsLasing}() indicates whether lasing is on or off.
+  -- 
+  -- @field #SPOT
+  SPOT = {
+    ClassName = "SPOT",
+  }
+  
+  --- SPOT Constructor.
+  -- @param #SPOT self
+  -- @param Wrapper.Unit#UNIT Recce
+  -- @param #number LaserCode
+  -- @param #number Duration
+  -- @return #SPOT
+  function SPOT:New( Recce )
+  
+    local self = BASE:Inherit( self, FSM:New() ) -- #SPOT
+    self:F( {} )
+    
+    self:SetStartState( "Off" )
+    self:AddTransition( "Off", "LaseOn", "On" )
+    
+    --- LaseOn Handler OnBefore for SPOT
+    -- @function [parent=#SPOT] OnBeforeLaseOn
+    -- @param #SPOT self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- LaseOn Handler OnAfter for SPOT
+    -- @function [parent=#SPOT] OnAfterLaseOn
+    -- @param #SPOT self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- LaseOn Trigger for SPOT
+    -- @function [parent=#SPOT] LaseOn
+    -- @param #SPOT self
+    
+    --- LaseOn Asynchronous Trigger for SPOT
+    -- @function [parent=#SPOT] __LaseOn
+    -- @param #SPOT self
+    -- @param #number Delay
+    
+    
+    
+    self:AddTransition( "On",  "Lasing", "On" )
+    self:AddTransition( { "On", "Destroyed" } , "LaseOff", "Off" )
+    
+    --- LaseOff Handler OnBefore for SPOT
+    -- @function [parent=#SPOT] OnBeforeLaseOff
+    -- @param #SPOT self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- LaseOff Handler OnAfter for SPOT
+    -- @function [parent=#SPOT] OnAfterLaseOff
+    -- @param #SPOT self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- LaseOff Trigger for SPOT
+    -- @function [parent=#SPOT] LaseOff
+    -- @param #SPOT self
+    
+    --- LaseOff Asynchronous Trigger for SPOT
+    -- @function [parent=#SPOT] __LaseOff
+    -- @param #SPOT self
+    -- @param #number Delay
+    
+    self:AddTransition( "*" , "Destroyed", "Destroyed" )
+    
+    --- Destroyed Handler OnBefore for SPOT
+    -- @function [parent=#SPOT] OnBeforeDestroyed
+    -- @param #SPOT self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- Destroyed Handler OnAfter for SPOT
+    -- @function [parent=#SPOT] OnAfterDestroyed
+    -- @param #SPOT self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- Destroyed Trigger for SPOT
+    -- @function [parent=#SPOT] Destroyed
+    -- @param #SPOT self
+    
+    --- Destroyed Asynchronous Trigger for SPOT
+    -- @function [parent=#SPOT] __Destroyed
+    -- @param #SPOT self
+    -- @param #number Delay
+    
+    
+  
+    self.Recce = Recce
+  
+    self.LaseScheduler = SCHEDULER:New( self )
+  
+    self:SetEventPriority( 5 )
+    
+    self.Lasing = false
+  
+    return self
+  end
+  
+  --- @param #SPOT self
+  -- @param From
+  -- @param Event
+  -- @param To
+  -- @param Wrapper.Positionable#POSITIONABLE Target
+  -- @param #number LaserCode
+  -- @param #number Duration
+  function SPOT:onafterLaseOn( From, Event, To, Target, LaserCode, Duration )
+    self:F( { "LaseOn", Target, LaserCode, Duration } )
+
+    local function StopLase( self )
+      self:LaseOff()
+    end
+    
+    self.Target = Target
+    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 )
+
+    if Duration then
+      self.ScheduleID = self.LaseScheduler:Schedule( self, StopLase, {self}, Duration )
+    end
+    
+    self:HandleEvent( EVENTS.Dead )
+    
+    self:__Lasing( -1 )
+  end
+
+  --- @param #SPOT self
+  -- @param Core.Event#EVENTDATA EventData
+  function SPOT:OnEventDead(EventData)
+    self:F( { Dead = EventData.IniDCSUnitName, Target = self.Target } )
+    if self.Target then
+      if EventData.IniDCSUnitName == self.Target:GetName() then
+        self:F( {"Target dead ", self.Target:GetName() } )
+        self:Destroyed()
+        self:LaseOff()
+      end
+    end
+  end
+  
+  --- @param #SPOT self
+  -- @param From
+  -- @param Event
+  -- @param To
+  function SPOT:onafterLasing( From, Event, To )
+  
+    if 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 )
+    else
+      self:F( { "Target is not alive", self.Target:IsAlive() } )
+    end
+  
+  end
+
+  --- @param #SPOT self
+  -- @param From
+  -- @param Event
+  -- @param To
+  -- @return #SPOT
+  function SPOT:onafterLaseOff( From, Event, To )
+  
+    self:F( {"Stopped lasing for ", self.Target:GetName() , SpotIR = self.SportIR, SpotLaser = self.SpotLaser } )
+    
+    self.Lasing = false
+    
+    self.SpotIR:destroy()
+    self.SpotLaser:destroy()
+
+    self.SpotIR = nil
+    self.SpotLaser = nil
+    
+    if self.ScheduleID then
+      self.LaseScheduler:Stop(self.ScheduleID)
+    end
+    self.ScheduleID = nil
+    
+    self.Target = nil
+    
+    return self
+  end
+  
+  --- Check if the SPOT is lasing
+  -- @param #SPOT self
+  -- @return #boolean true if it is lasing
+  function SPOT:IsLasing()
+    return self.Lasing
+  end
+  
+end

Moose Development/Moose/Core/UserFlag.lua

@@ -0,0 +1,95 @@
+--- **Core (WIP)** -- Manage user flags.
+--
+-- ===
+-- 
+-- Management of DCS User Flags.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===
+-- 
+-- @module UserFlag
+
+do -- UserFlag
+
+  --- @type USERFLAG
+  -- @extends Core.Base#BASE
+
+
+  --- # USERFLAG class, extends @{Base#BASE}
+  -- 
+  -- Management of DCS User Flags.
+  -- 
+  -- ## 1. USERFLAG constructor
+  --   
+  --   * @{#USERFLAG.New}(): Creates a new USERFLAG object.
+  -- 
+  -- @field #USERFLAG
+  USERFLAG = {
+    ClassName = "USERFLAG",
+  }
+  
+  --- 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
+
+    return self
+  end
+
+
+  --- Set the userflag to a given Number.
+  -- @param #USERFLAG self
+  -- @param #number Number The number value to be checked if it is the same as the userflag.
+  -- @return #USERFLAG The userflag instance.
+  -- @usage
+  --   local BlueVictory = USERFLAG:New( "VictoryBlue" )
+  --   BlueVictory:Set( 100 ) -- Set the UserFlag VictoryBlue to 100.
+  --   
+  function USERFLAG:Set( Number ) --R2.3
+  
+    self:F( { Number = Number } )
+    
+    trigger.action.setUserFlag( self.UserFlagName, Number )
+    
+    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.
+  -- @usage
+  --   local BlueVictory = USERFLAG:New( "VictoryBlue" )
+  --   local BlueVictoryValue = BlueVictory:Get() -- Get the UserFlag VictoryBlue value.
+  --   
+  function USERFLAG:Get( Number ) --R2.3
+    
+    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.
+  -- @return #boolean true if the Number is the value of the userflag.
+  -- @usage
+  --   local BlueVictory = USERFLAG:New( "VictoryBlue" )
+  --   if BlueVictory:Is( 1 ) then
+  --     return "Blue has won"
+  --   end
+  function USERFLAG:Is( Number ) --R2.3
+    
+    return trigger.misc.getUserFlag( self.UserFlagName ) == Number
+    
+  end  
+
+end

Moose Development/Moose/Core/UserSound.lua

@@ -0,0 +1,129 @@
+--- **Core (WIP)** -- Manage user sound.
+--
+-- ===
+-- 
+-- Management of DCS User Sound.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===
+-- 
+-- @module UserSound
+
+do -- UserSound
+
+  --- @type USERSOUND
+  -- @extends Core.Base#BASE
+
+
+  --- # USERSOUND class, extends @{Base#BASE}
+  -- 
+  -- Management of DCS User Sound.
+  -- 
+  -- ## 1. USERSOUND constructor
+  --   
+  --   * @{#USERSOUND.New}(): Creates a new USERSOUND object.
+  -- 
+  -- @field #USERSOUND
+  USERSOUND = {
+    ClassName = "USERSOUND",
+  }
+  
+  --- USERSOUND Constructor.
+  -- @param #USERSOUND self
+  -- @param #string UserSoundFileName The filename of the usersound.
+  -- @return #USERSOUND
+  function USERSOUND:New( UserSoundFileName ) --R2.3
+  
+    local self = BASE:Inherit( self, BASE:New() ) -- #USERSOUND
+
+    self.UserSoundFileName = UserSoundFileName
+
+    return self
+  end
+
+
+  --- Set usersound filename.
+  -- @param #USERSOUND self
+  -- @param #string UserSoundFileName The filename of the usersound.
+  -- @return #USERSOUND The usersound instance.
+  -- @usage
+  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  --   BlueVictory:SetFileName( "BlueVictoryLoud.ogg" ) -- Set the BlueVictory to change the file name to play a louder sound.
+  --   
+  function USERSOUND:SetFileName( UserSoundFileName ) --R2.3
+    
+    self.UserSoundFileName = UserSoundFileName
+
+    return self
+  end  
+
+  
+
+
+  --- Play the usersound to all players.
+  -- @param #USERSOUND self
+  -- @return #USERSOUND The usersound instance.
+  -- @usage
+  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  --   BlueVictory:ToAll() -- Play the sound that Blue has won.
+  --   
+  function USERSOUND:ToAll() --R2.3
+    
+    trigger.action.outSound( self.UserSoundFileName )
+    
+    return self
+  end  
+
+  
+  --- Play the usersound to the given coalition.
+  -- @param #USERSOUND self
+  -- @param Dcs.DCScoalition#coalition Coalition The coalition to play the usersound to.
+  -- @return #USERSOUND The usersound instance.
+  -- @usage
+  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  --   BlueVictory:ToCoalition( coalition.side.BLUE ) -- Play the sound that Blue has won to the blue coalition.
+  --   
+  function USERSOUND:ToCoalition( Coalition ) --R2.3
+    
+    trigger.action.outSoundForCoalition(Coalition, self.UserSoundFileName )
+    
+    return self
+  end  
+
+
+  --- Play the usersound to the given country.
+  -- @param #USERSOUND self
+  -- @param Dcs.DCScountry#country Country The country to play the usersound to.
+  -- @return #USERSOUND The usersound instance.
+  -- @usage
+  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  --   BlueVictory:ToCountry( country.id.USA ) -- Play the sound that Blue has won to the USA country.
+  --   
+  function USERSOUND:ToCountry( Country ) --R2.3
+    
+    trigger.action.outSoundForCountry( Country, self.UserSoundFileName )
+    
+    return self
+  end  
+
+
+  --- Play the usersound to the given @{Group}.
+  -- @param #USERSOUND self
+  -- @param Wrapper.Group#GROUP Group The @{Group} to play the usersound to.
+  -- @return #USERSOUND The usersound instance.
+  -- @usage
+  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  --   local PlayerGroup = GROUP:FindByName( "PlayerGroup" ) -- Search for the active group named "PlayerGroup", that contains a human player.
+  --   BlueVictory:ToGroup( PlayerGroup ) -- Play the sound that Blue has won to the player group.
+  --   
+  function USERSOUND:ToGroup( Group ) --R2.3
+    
+    trigger.action.outSoundForGroup( Group:GetID(), self.UserSoundFileName )
+    
+    return self
+  end  
+
+end

Moose Development/Moose/Core/Velocity.lua

@@ -0,0 +1,184 @@
+--- **Core** -- VELOCITY models a speed, which can be expressed in various formats according the Settings.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- ### Contributions: 
+-- 
+-- ===
+-- 
+-- @module Velocity
+
+do -- Velocity
+
+  --- @type VELOCITY
+  -- @extends Core.Base#BASE
+
+
+  --- # VELOCITY class, extends @{Base#BASE}
+  -- 
+  -- VELOCITY models a speed, which can be expressed in various formats according the Settings.
+  -- 
+  -- ## 1. VELOCITY constructor
+  --   
+  --   * @{#VELOCITY.New}(): Creates a new VELOCITY object.
+  -- 
+  -- @field #VELOCITY
+  VELOCITY = {
+    ClassName = "VELOCITY",
+  }
+
+  --- VELOCITY Constructor.
+  -- @param #VELOCITY self
+  -- @param #number VelocityMps The velocity in meters per second. 
+  -- @return #VELOCITY
+  function VELOCITY:New( VelocityMps )
+    local self = BASE:Inherit( self, BASE:New() ) -- #VELOCITY
+    self:F( {} )
+    self.Velocity = VelocityMps
+    return self
+  end
+
+  --- Set the velocity in Mps (meters per second).
+  -- @param #VELOCITY self
+  -- @param #number VelocityMps The velocity in meters per second. 
+  -- @return #VELOCITY
+  function VELOCITY:Set( VelocityMps )
+    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. 
+  function VELOCITY:Get()
+    return self.Velocity
+  end
+
+  --- Set the velocity in Kmph (kilometers per hour).
+  -- @param #VELOCITY self
+  -- @param #number VelocityKmph The velocity in kilometers per hour. 
+  -- @return #VELOCITY
+  function VELOCITY:SetKmph( VelocityKmph )
+    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
+
+  --- Set the velocity in Miph (miles per hour).
+  -- @param #VELOCITY self
+  -- @param #number VelocityMiph The velocity in miles per hour. 
+  -- @return #VELOCITY
+  function VELOCITY:SetMiph( VelocityMiph )
+    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. 
+  function VELOCITY:GetMiph()
+    return UTILS.MpsToMiph( self.Velocity )
+  end
+
+  
+  --- Get the velocity in text, according the player @{Settings}.
+  -- @param #VELOCITY self
+  -- @param Core.Settings#SETTINGS Settings
+  -- @return #string The velocity in text. 
+  function VELOCITY:GetText( Settings )
+    local Settings = Settings or _SETTINGS
+    if self.Velocity ~= 0 then
+      if Settings:IsMetric() then
+        return string.format( "%d km/h", UTILS.MpsToKmph( self.Velocity ) )
+      else
+        return string.format( "%d mi/h", UTILS.MpsToMiph( self.Velocity ) )
+      end
+    else
+      return "stationary"
+    end
+  end
+
+  --- Get the velocity in text, according the player or default @{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}
+  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
+    return self:GetText( Settings )
+  end
+
+end
+
+do -- VELOCITY_POSITIONABLE
+
+  --- @type VELOCITY_POSITIONABLE
+  -- @extends Core.Base#BASE
+
+
+  --- # VELOCITY_POSITIONABLE class, extends @{Base#BASE}
+  -- 
+  -- VELOCITY_POSITIONABLE monitors the speed of an @{Positionable} in the simulation, which can be expressed in various formats according the Settings.
+  -- 
+  -- ## 1. VELOCITY_POSITIONABLE constructor
+  --   
+  --   * @{#VELOCITY_POSITIONABLE.New}(): Creates a new VELOCITY_POSITIONABLE object.
+  -- 
+  -- @field #VELOCITY_POSITIONABLE
+  VELOCITY_POSITIONABLE = {
+    ClassName = "VELOCITY_POSITIONABLE",
+  }
+
+  --- VELOCITY_POSITIONABLE Constructor.
+  -- @param #VELOCITY_POSITIONABLE self
+  -- @param Wrapper.Positionable#POSITIONABLE Positionable The Positionable to monitor the speed. 
+  -- @return #VELOCITY_POSITIONABLE
+  function VELOCITY_POSITIONABLE:New( Positionable )
+    local self = BASE:Inherit( self, VELOCITY:New() ) -- #VELOCITY_POSITIONABLE
+    self:F( {} )
+    self.Positionable = Positionable
+    return self
+  end
+
+  --- Get the velocity in Mps (meters per second).
+  -- @param #VELOCITY_POSITIONABLE self
+  -- @return #number The velocity in meters per second. 
+  function VELOCITY_POSITIONABLE:Get()
+    return self.Positionable:GetVelocityMPS() or 0
+  end
+
+  --- Get the velocity in Kmph (kilometers per hour).
+  -- @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
+
+  --- Get the velocity in Miph (miles per hour).
+  -- @param #VELOCITY_POSITIONABLE self
+  -- @return #number The velocity in miles per hour. 
+  function VELOCITY_POSITIONABLE:GetMiph()
+    return UTILS.MpsToMiph( self.Positionable:GetVelocityMPS() or 0 )
+  end
+
+  --- Get the velocity in text, according the player or default @{Settings}.
+  -- @param #VELOCITY_POSITIONABLE self
+  -- @return #string The velocity in text according the player or default @{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
+    self.Velocity = self.Positionable:GetVelocityMPS()
+    return self:GetText( Settings )
+  end
+
+end

Moose Development/Moose/Database.lua

@@ -1,705 +0,0 @@
---- Manage sets of units and groups. 
--- 
--- @{#Database} class
--- ==================
--- Mission designers can use the DATABASE class to build sets of units belonging to certain:
--- 
---  * Coalitions
---  * Categories
---  * Countries
---  * Unit types
---  * Starting with certain prefix strings.
---  
--- This list will grow over time. Planned developments are to include filters and iterators.
--- Additional filters will be added around @{Zone#ZONEs}, Radiuses, Active players, ...
--- More iterators will be implemented in the near future ...
---
--- Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.
--- 
--- DATABASE construction methods:
--- =================================
--- Create a new DATABASE object with the @{#DATABASE.New} method:
--- 
---    * @{#DATABASE.New}: Creates a new DATABASE object.
---   
--- 
--- DATABASE filter criteria: 
--- =========================
--- You can set filter criteria to define the set of units within the database.
--- Filter criteria are defined by:
--- 
---    * @{#DATABASE.FilterCoalitions}: Builds the DATABASE with the units belonging to the coalition(s).
---    * @{#DATABASE.FilterCategories}: Builds the DATABASE with the units belonging to the category(ies).
---    * @{#DATABASE.FilterTypes}: Builds the DATABASE with the units belonging to the unit type(s).
---    * @{#DATABASE.FilterCountries}: Builds the DATABASE with the units belonging to the country(ies).
---    * @{#DATABASE.FilterUnitPrefixes}: Builds the DATABASE with the units starting with the same prefix string(s).
---   
--- Once the filter criteria have been set for the DATABASE, you can start filtering using:
--- 
---   * @{#DATABASE.FilterStart}: Starts the filtering of the units within the database.
--- 
--- Planned filter criteria within development are (so these are not yet available):
--- 
---    * @{#DATABASE.FilterGroupPrefixes}: Builds the DATABASE with the groups of the units starting with the same prefix string(s).
---    * @{#DATABASE.FilterZones}: Builds the DATABASE with the units within a @{Zone#ZONE}.
--- 
--- 
--- DATABASE iterators:
--- ===================
--- Once the filters have been defined and the DATABASE has been built, you can iterate the database with the available iterator methods.
--- The iterator methods will walk the DATABASE set, and call for each element within the set a function that you provide.
--- The following iterator methods are currently available within the DATABASE:
--- 
---   * @{#DATABASE.ForEachAliveUnit}: Calls a function for each alive unit it finds within the DATABASE.
---   
--- Planned iterators methods in development are (so these are not yet available):
--- 
---   * @{#DATABASE.ForEachUnit}: Calls a function for each unit contained within the DATABASE.
---   * @{#DATABASE.ForEachGroup}: Calls a function for each group contained within the DATABASE.
---   * @{#DATABASE.ForEachUnitInZone}: Calls a function for each unit within a certain zone contained within the DATABASE.
--- 
--- ====
--- @module Database
--- @author FlightControl
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Menu" )
-Include.File( "Group" )
-Include.File( "Unit" )
-Include.File( "Event" )
-Include.File( "Client" )
-
---- DATABASE class
--- @type DATABASE
--- @extends Base#BASE
-DATABASE = {
-  ClassName = "DATABASE",
-  Templates = {
-    Units = {},
-    Groups = {},
-    ClientsByName = {},
-    ClientsByID = {},
-  },
-  DCSUnits = {},
-  DCSGroups = {},
-  UNITS = {},
-  GROUPS = {},
-  NavPoints = {},
-  Statics = {},
-  Players = {},
-  PlayersAlive = {},
-  CLIENTS = {},
-  ClientsAlive = {},
-  Filter = {
-    Coalitions = nil,
-    Categories = nil,
-    Types = nil,
-    Countries = nil,
-    UnitPrefixes = nil,
-    GroupPrefixes = nil,
-  },
-  FilterMeta = {
-    Coalitions = {
-      red = coalition.side.RED,
-      blue = coalition.side.BLUE,
-      neutral = coalition.side.NEUTRAL,
-    },
-    Categories = {
-      plane = Unit.Category.AIRPLANE,
-      helicopter = Unit.Category.HELICOPTER,
-      ground = Unit.Category.GROUND_UNIT,
-      ship = Unit.Category.SHIP,
-      structure = Unit.Category.STRUCTURE,
-    },
-  },
-}
-
-local _DATABASECoalition =
-  {
-    [1] = "Red",
-    [2] = "Blue",
-  }
-
-local _DATABASECategory =
-  {
-    [Unit.Category.AIRPLANE] = "Plane",
-    [Unit.Category.HELICOPTER] = "Helicopter",
-    [Unit.Category.GROUND_UNIT] = "Vehicle",
-    [Unit.Category.SHIP] = "Ship",
-    [Unit.Category.STRUCTURE] = "Structure",
-  }
-
-
---- Creates a new DATABASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.
--- @param #DATABASE self
--- @return #DATABASE
--- @usage
--- -- Define a new DATABASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
--- DBObject = DATABASE:New()
-function DATABASE:New()
-
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, BASE:New() )
-  
-  _EVENTDISPATCHER:OnBirth( self._EventOnBirth, self )
-  _EVENTDISPATCHER:OnDead( self._EventOnDeadOrCrash, self )
-  _EVENTDISPATCHER:OnCrash( self._EventOnDeadOrCrash, self )
-  
-  
-  -- Add database with registered clients and already alive players
-  
-  -- Follow alive players and clients
-  _EVENTDISPATCHER:OnPlayerEnterUnit( self._EventOnPlayerEnterUnit, self )
-  _EVENTDISPATCHER:OnPlayerLeaveUnit( self._EventOnPlayerLeaveUnit, self )
-  
-  
-  return self
-end
-
---- Finds a Unit based on the Unit Name.
--- @param #DATABASE self
--- @param #string UnitName
--- @return Unit#UNIT The found Unit.
-function DATABASE:FindUnit( UnitName )
-
-  local UnitFound = self.UNITS[UnitName]
-  return UnitFound
-end
-
---- Adds a Unit based on the Unit Name in the DATABASE.
--- @param #DATABASE self
-function DATABASE:AddUnit( DCSUnit, DCSUnitName )
-
-  self.DCSUnits[DCSUnitName] = DCSUnit 
-  self.UNITS[DCSUnitName] = UNIT:Register( DCSUnitName )
-end
-
---- Deletes a Unit from the DATABASE based on the Unit Name.
--- @param #DATABASE self
-function DATABASE:DeleteUnit( DCSUnitName )
-
-  self.DCSUnits[DCSUnitName] = nil 
-end
-
---- Finds a CLIENT based on the ClientName.
--- @param #DATABASE self
--- @param #string ClientName
--- @return Client#CLIENT The found CLIENT.
-function DATABASE:FindClient( ClientName )
-
-  local ClientFound = self.CLIENTS[ClientName]
-  return ClientFound
-end
-
---- Adds a CLIENT based on the ClientName in the DATABASE.
--- @param #DATABASE self
-function DATABASE:AddClient( ClientName )
-
-  self.CLIENTS[ClientName] = CLIENT:Register( ClientName )
-  self:E( self.CLIENTS[ClientName]:GetClassNameAndID() )
-end
-
---- Finds a GROUP based on the GroupName.
--- @param #DATABASE self
--- @param #string GroupName
--- @return Group#GROUP The found GROUP.
-function DATABASE:FindGroup( GroupName )
-
-  local GroupFound = self.GROUPS[GroupName]
-  return GroupFound
-end
-
---- Adds a GROUP based on the GroupName in the DATABASE.
--- @param #DATABASE self
-function DATABASE:AddGroup( DCSGroup, GroupName )
-
-  self.DCSGroups[GroupName] = DCSGroup
-  self.GROUPS[GroupName] = GROUP:Register( GroupName )
-end
-
---- Instantiate new Groups within the DCSRTE.
--- This method expects EXACTLY the same structure as a structure within the ME, and needs 2 additional fields defined:
--- SpawnCountryID, SpawnCategoryID
--- This method is used by the SPAWN class.
--- @param #DATABASE self
--- @param #table SpawnTemplate
--- @return #DATABASE self
-function DATABASE:Spawn( SpawnTemplate )
-  self:F( SpawnTemplate.name )
-
-  self:T( { SpawnTemplate.SpawnCountryID, SpawnTemplate.SpawnCategoryID } )
-
-  -- Copy the spawn variables of the template in temporary storage, nullify, and restore the spawn variables.
-  local SpawnCoalitionID = SpawnTemplate.SpawnCoalitionID
-  local SpawnCountryID = SpawnTemplate.SpawnCountryID
-  local SpawnCategoryID = SpawnTemplate.SpawnCategoryID
-
-  -- Nullify
-  SpawnTemplate.SpawnCoalitionID = nil
-  SpawnTemplate.SpawnCountryID = nil
-  SpawnTemplate.SpawnCategoryID = nil
-
-  self:_RegisterGroup( SpawnTemplate )
-  coalition.addGroup( SpawnCountryID, SpawnCategoryID, SpawnTemplate )
-
-  -- Restore
-  SpawnTemplate.SpawnCoalitionID = SpawnCoalitionID
-  SpawnTemplate.SpawnCountryID = SpawnCountryID
-  SpawnTemplate.SpawnCategoryID = SpawnCategoryID
-
-
-  local SpawnGroup = GROUP:Register( SpawnTemplate.name )
-  return SpawnGroup
-end
-
-
---- Set a status to a Group within the Database, this to check crossing events for example.
-function DATABASE:SetStatusGroup( GroupName, Status )
-  self:F( Status )
-
-  self.Templates.Groups[GroupName].Status = Status
-end
-
-
---- Get a status to a Group within the Database, this to check crossing events for example.
-function DATABASE:GetStatusGroup( GroupName )
-  self:F( Status )
-
-  if self.Templates.Groups[GroupName] then
-    return self.Templates.Groups[GroupName].Status
-  else
-    return ""
-  end
-end
-
---- Private method that registers new Group Templates within the DATABASE Object.
--- @param #DATABASE self
--- @param #table GroupTemplate
--- @return #DATABASE self
-function DATABASE:_RegisterGroup( GroupTemplate )
-
-  local GroupTemplateName = env.getValueDictByKey(GroupTemplate.name)
-
-  if not self.Templates.Groups[GroupTemplateName] then
-    self.Templates.Groups[GroupTemplateName] = {}
-    self.Templates.Groups[GroupTemplateName].Status = nil
-  end
-  
-  -- Delete the spans from the route, it is not needed and takes memory.
-  if GroupTemplate.route and GroupTemplate.route.spans then 
-    GroupTemplate.route.spans = nil
-  end
-  
-  self.Templates.Groups[GroupTemplateName].GroupName = GroupTemplateName
-  self.Templates.Groups[GroupTemplateName].Template = GroupTemplate
-  self.Templates.Groups[GroupTemplateName].groupId = GroupTemplate.groupId
-  self.Templates.Groups[GroupTemplateName].UnitCount = #GroupTemplate.units
-  self.Templates.Groups[GroupTemplateName].Units = GroupTemplate.units
-
-  self:T( { "Group", self.Templates.Groups[GroupTemplateName].GroupName, self.Templates.Groups[GroupTemplateName].UnitCount } )
-
-  for unit_num, UnitTemplate in pairs( GroupTemplate.units ) do
-
-    local UnitTemplateName = env.getValueDictByKey(UnitTemplate.name)
-    self.Templates.Units[UnitTemplateName] = {}
-    self.Templates.Units[UnitTemplateName].UnitName = UnitTemplateName
-    self.Templates.Units[UnitTemplateName].Template = UnitTemplate
-    self.Templates.Units[UnitTemplateName].GroupName = GroupTemplateName
-    self.Templates.Units[UnitTemplateName].GroupTemplate = GroupTemplate
-    self.Templates.Units[UnitTemplateName].GroupId = GroupTemplate.groupId
-    self:E( {"skill",UnitTemplate.skill})
-    if UnitTemplate.skill and (UnitTemplate.skill == "Client" or UnitTemplate.skill == "Player") then
-      self.Templates.ClientsByName[UnitTemplateName] = UnitTemplate
-      self.Templates.ClientsByID[UnitTemplate.unitId] = UnitTemplate
-    end
-    self:E( { "Unit", self.Templates.Units[UnitTemplateName].UnitName } )
-  end
-end
-
---- Private method that registers all alive players in the mission.
--- @param #DATABASE self
--- @return #DATABASE self
-function DATABASE:_RegisterPlayers()
-
-  local CoalitionsData = { AlivePlayersRed = coalition.getPlayers( coalition.side.RED ), AlivePlayersBlue = coalition.getPlayers( coalition.side.BLUE ) }
-  for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
-    for UnitId, UnitData in pairs( CoalitionData ) do
-      self:T3( { "UnitData:", UnitData } )
-      if UnitData and UnitData:isExist() then
-        local UnitName = UnitData:getName()
-        if not self.PlayersAlive[UnitName] then
-          self:E( { "Add player for unit:", UnitName, UnitData:getPlayerName() } )
-          self.PlayersAlive[UnitName] = UnitData:getPlayerName()
-        end
-      end
-    end
-  end
-  
-  return self
-end
-
---- Private method that registers all datapoints within in the mission.
--- @param #DATABASE self
--- @return #DATABASE self
-function DATABASE:_RegisterDatabase()
-
-  local CoalitionsData = { GroupsRed = coalition.getGroups( coalition.side.RED ), GroupsBlue = coalition.getGroups( coalition.side.BLUE ) }
-  for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
-    for DCSGroupId, DCSGroup in pairs( CoalitionData ) do
-
-      if DCSGroup:isExist() then
-        local DCSGroupName = DCSGroup:getName()
-  
-        self:E( { "Register Group:", DCSGroup, DCSGroupName } )
-        self:AddGroup( DCSGroup, DCSGroupName )
-
-        for DCSUnitId, DCSUnit in pairs( DCSGroup:getUnits() ) do
-  
-          local DCSUnitName = DCSUnit:getName()
-          self:E( { "Register Unit:", DCSUnit, DCSUnitName } )
-          self:AddUnit( DCSUnit, DCSUnitName )
-        end
-      else
-        self:E( { "Group does not exist: ",  DCSGroup } )
-      end
-      
-    end
-  end
-
-  for ClientName, ClientTemplate in pairs( self.Templates.ClientsByName ) do
-    self:E( { "Adding Client:", ClientName } )
-    self:AddClient( ClientName )
-  end
-  
-  return self
-end
-
---- Events
-
---- Handles the OnBirth event for the alive units set.
--- @param #DATABASE self
--- @param Event#EVENTDATA Event
-function DATABASE:_EventOnBirth( Event )
-  self:F( { Event } )
-
-  if Event.IniDCSUnit then
-    if self:_IsIncludeDCSUnit( Event.IniDCSUnit ) then
-      self:AddUnit( Event.IniDCSUnit, Event.IniDCSUnitName )
-      self:AddGroup( Event.IniDCSGroup, Event.IniDCSGroupName )
-      self:_EventOnPlayerEnterUnit( Event )
-    end
-  end
-end
-
---- Handles the OnDead or OnCrash event for alive units set.
--- @param #DATABASE self
--- @param Event#EVENTDATA Event
-function DATABASE:_EventOnDeadOrCrash( Event )
-  self:F( { Event } )
-
-  if Event.IniDCSUnit then
-    if self.DCSUnits[Event.IniDCSUnitName] then
-      self:DeleteUnit( Event.IniDCSUnitName )
-      -- add logic to correctly remove a group once all units are destroyed...
-    end
-  end
-end
-
---- Handles the OnPlayerEnterUnit event to fill the active players table (with the unit filter applied).
--- @param #DATABASE self
--- @param Event#EVENTDATA Event
-function DATABASE:_EventOnPlayerEnterUnit( Event )
-  self:F( { Event } )
-
-  if Event.IniDCSUnit then
-    if self:_IsIncludeDCSUnit( Event.IniDCSUnit ) then
-      if not self.PlayersAlive[Event.IniDCSUnitName] then
-        self:E( { "Add player for unit:", Event.IniDCSUnitName, Event.IniDCSUnit:getPlayerName() } )
-        self.PlayersAlive[Event.IniDCSUnitName] = Event.IniDCSUnit:getPlayerName()
-        self.ClientsAlive[Event.IniDCSUnitName] = self.CLIENTS[ Event.IniDCSUnitName ]
-      end
-    end
-  end
-end
-
---- Handles the OnPlayerLeaveUnit event to clean the active players table.
--- @param #DATABASE self
--- @param Event#EVENTDATA Event
-function DATABASE:_EventOnPlayerLeaveUnit( Event )
-  self:F( { Event } )
-
-  if Event.IniDCSUnit then
-    if self:_IsIncludeDCSUnit( Event.IniDCSUnit ) then
-      if self.PlayersAlive[Event.IniDCSUnitName] then
-        self:E( { "Cleaning player for unit:", Event.IniDCSUnitName, Event.IniDCSUnit:getPlayerName() } )
-        self.PlayersAlive[Event.IniDCSUnitName] = nil
-        self.ClientsAlive[Event.IniDCSUnitName] = nil
-      end
-    end
-  end
-end
-
---- Iterators
-
---- Interate the DATABASE and call an interator function for the given set, providing the Object for each element within the set and optional parameters.
--- @param #DATABASE self
--- @param #function IteratorFunction The function that will be called when there is an alive player in the database.
--- @return #DATABASE self
-function DATABASE:ForEach( IteratorFunction, arg, Set )
-  self:F( arg )
-  
-  local function CoRoutine()
-    local Count = 0
-    for ObjectID, Object in pairs( Set ) do
-        self:T2( Object )
-        IteratorFunction( Object, unpack( arg ) )
-        Count = Count + 1
-        if Count % 10 == 0 then
-          coroutine.yield( false )
-        end    
-    end
-    return true
-  end
-  
-  local co = coroutine.create( CoRoutine )
-  
-  local function Schedule()
-  
-    local status, res = coroutine.resume( co )
-    self:T( { status, res } )
-    
-    if status == false then
-      error( res )
-    end
-    if res == false then
-      return true -- resume next time the loop
-    end
-    
-    return false
-  end
-
-  local Scheduler = SCHEDULER:New( self, Schedule, {}, 0.001, 0.001, 0 )
-  
-  return self
-end
-
-
---- Interate the DATABASE and call an interator function for each **alive** unit, providing the Unit and optional parameters.
--- @param #DATABASE self
--- @param #function IteratorFunction The function that will be called when there is an alive unit in the database. The function needs to accept a UNIT parameter.
--- @return #DATABASE self
-function DATABASE:ForEachDCSUnit( IteratorFunction, ... )
-  self:F( arg )
-  
-  self:ForEach( IteratorFunction, arg, self.DCSUnits )
-
-  return self
-end
-
---- Interate the DATABASE and call an interator function for each **alive** player, providing the Unit of the player and optional parameters.
--- @param #DATABASE self
--- @param #function IteratorFunction The function that will be called when there is an alive player in the database. The function needs to accept a UNIT parameter.
--- @return #DATABASE self
-function DATABASE:ForEachPlayer( IteratorFunction, ... )
-  self:F( arg )
-  
-  self:ForEach( IteratorFunction, arg, self.PlayersAlive )
-  
-  return self
-end
-
-
---- Interate the DATABASE and call an interator function for each client, providing the Client to the function and optional parameters.
--- @param #DATABASE self
--- @param #function IteratorFunction The function that will be called when there is an alive player in the database. The function needs to accept a CLIENT parameter.
--- @return #DATABASE self
-function DATABASE:ForEachClient( IteratorFunction, ... )
-  self:F( arg )
-  
-  self:ForEach( IteratorFunction, arg, self.CLIENTS )
-
-  return self
-end
-
-
-function DATABASE:ScanEnvironment()
-  self:F()
-
-  self.Navpoints = {}
-  self.UNITS = {}
-  --Build routines.db.units and self.Navpoints
-  for coa_name, coa_data in pairs(env.mission.coalition) do
-
-    if (coa_name == 'red' or coa_name == 'blue') and type(coa_data) == 'table' then
-      --self.Units[coa_name] = {}
-
-      ----------------------------------------------
-      -- build nav points DB
-      self.Navpoints[coa_name] = {}
-      if coa_data.nav_points then --navpoints
-        for nav_ind, nav_data in pairs(coa_data.nav_points) do
-
-          if type(nav_data) == 'table' then
-            self.Navpoints[coa_name][nav_ind] = routines.utils.deepCopy(nav_data)
-
-            self.Navpoints[coa_name][nav_ind]['name'] = nav_data.callsignStr  -- name is a little bit more self-explanatory.
-            self.Navpoints[coa_name][nav_ind]['point'] = {}  -- point is used by SSE, support it.
-            self.Navpoints[coa_name][nav_ind]['point']['x'] = nav_data.x
-            self.Navpoints[coa_name][nav_ind]['point']['y'] = 0
-            self.Navpoints[coa_name][nav_ind]['point']['z'] = nav_data.y
-          end
-      end
-      end
-      -------------------------------------------------
-      if coa_data.country then --there is a country table
-        for cntry_id, cntry_data in pairs(coa_data.country) do
-
-          local countryName = string.lower(cntry_data.name)
-          --self.Units[coa_name][countryName] = {}
-          --self.Units[coa_name][countryName]["countryId"] = cntry_data.id
-
-          if type(cntry_data) == 'table' then  --just making sure
-
-            for obj_type_name, obj_type_data in pairs(cntry_data) do
-
-              if obj_type_name == "helicopter" or obj_type_name == "ship" or obj_type_name == "plane" or obj_type_name == "vehicle" or obj_type_name == "static" then --should be an unncessary check
-
-                local category = obj_type_name
-
-                if ((type(obj_type_data) == 'table') and obj_type_data.group and (type(obj_type_data.group) == 'table') and (#obj_type_data.group > 0)) then  --there's a group!
-
-                  --self.Units[coa_name][countryName][category] = {}
-
-                  for group_num, GroupTemplate in pairs(obj_type_data.group) do
-
-                    if GroupTemplate and GroupTemplate.units and type(GroupTemplate.units) == 'table' then  --making sure again- this is a valid group
-                      self:_RegisterGroup( GroupTemplate )
-                    end --if GroupTemplate and GroupTemplate.units then
-                  end --for group_num, GroupTemplate in pairs(obj_type_data.group) do
-                end --if ((type(obj_type_data) == 'table') and obj_type_data.group and (type(obj_type_data.group) == 'table') and (#obj_type_data.group > 0)) then
-              end --if obj_type_name == "helicopter" or obj_type_name == "ship" or obj_type_name == "plane" or obj_type_name == "vehicle" or obj_type_name == "static" then
-          end --for obj_type_name, obj_type_data in pairs(cntry_data) do
-          end --if type(cntry_data) == 'table' then
-      end --for cntry_id, cntry_data in pairs(coa_data.country) do
-      end --if coa_data.country then --there is a country table
-    end --if coa_name == 'red' or coa_name == 'blue' and type(coa_data) == 'table' then
-  end --for coa_name, coa_data in pairs(mission.coalition) do
-
-  self:_RegisterDatabase()
-  self:_RegisterPlayers()
-
-  return self
-end
-
-
----
--- @param #DATABASE self
--- @param DCSUnit#Unit DCSUnit
--- @return #DATABASE self
-function DATABASE:_IsIncludeDCSUnit( DCSUnit )
-  self:F( DCSUnit )
-  local DCSUnitInclude = true
-
-  if self.Filter.Coalitions then
-    local DCSUnitCoalition = false
-    for CoalitionID, CoalitionName in pairs( self.Filter.Coalitions ) do
-      self:T( { "Coalition:", DCSUnit:getCoalition(), self.FilterMeta.Coalitions[CoalitionName], CoalitionName } )
-      if self.FilterMeta.Coalitions[CoalitionName] and self.FilterMeta.Coalitions[CoalitionName] == DCSUnit:getCoalition() then
-        DCSUnitCoalition = true
-      end
-    end
-    DCSUnitInclude = DCSUnitInclude and DCSUnitCoalition
-  end
-  
-  if self.Filter.Categories then
-    local DCSUnitCategory = false
-    for CategoryID, CategoryName in pairs( self.Filter.Categories ) do
-      self:T( { "Category:", DCSUnit:getDesc().category, self.FilterMeta.Categories[CategoryName], CategoryName } )
-      if self.FilterMeta.Categories[CategoryName] and self.FilterMeta.Categories[CategoryName] == DCSUnit:getDesc().category then
-        DCSUnitCategory = true
-      end
-    end
-    DCSUnitInclude = DCSUnitInclude and DCSUnitCategory
-  end
-  
-  if self.Filter.Types then
-    local DCSUnitType = false
-    for TypeID, TypeName in pairs( self.Filter.Types ) do
-      self:T( { "Type:", DCSUnit:getTypeName(), TypeName } )
-      if TypeName == DCSUnit:getTypeName() then
-        DCSUnitType = true
-      end
-    end
-    DCSUnitInclude = DCSUnitInclude and DCSUnitType
-  end
-  
-  if self.Filter.Countries then
-    local DCSUnitCountry = false
-    for CountryID, CountryName in pairs( self.Filter.Countries ) do
-      self:T( { "Country:", DCSUnit:getCountry(), CountryName } )
-      if country.id[CountryName] == DCSUnit:getCountry() then
-        DCSUnitCountry = true
-      end
-    end
-    DCSUnitInclude = DCSUnitInclude and DCSUnitCountry
-  end
-
-  if self.Filter.UnitPrefixes then
-    local DCSUnitPrefix = false
-    for UnitPrefixId, UnitPrefix in pairs( self.Filter.UnitPrefixes ) do
-      self:T( { "Unit Prefix:", string.find( DCSUnit:getName(), UnitPrefix, 1 ), UnitPrefix } )
-      if string.find( DCSUnit:getName(), UnitPrefix, 1 ) then
-        DCSUnitPrefix = true
-      end
-    end
-    DCSUnitInclude = DCSUnitInclude and DCSUnitPrefix
-  end
-
-  self:T( DCSUnitInclude )
-  return DCSUnitInclude
-end
-
----
--- @param #DATABASE self
--- @param DCSUnit#Unit DCSUnit
--- @return #DATABASE self
-function DATABASE:_IsAliveDCSUnit( DCSUnit )
-  self:F( DCSUnit )
-  local DCSUnitAlive = false
-  if DCSUnit and DCSUnit:isExist() and DCSUnit:isActive() then
-    if self.DCSUnits[DCSUnit:getName()] then
-      DCSUnitAlive = true
-    end
-  end
-  self:T( DCSUnitAlive )
-  return DCSUnitAlive
-end
-
----
--- @param #DATABASE self
--- @param DCSGroup#Group DCSGroup
--- @return #DATABASE self
-function DATABASE:_IsAliveDCSGroup( DCSGroup )
-  self:F( DCSGroup )
-  local DCSGroupAlive = false
-  if DCSGroup and DCSGroup:isExist() then
-    if self.DCSGroups[DCSGroup:getName()] then
-      DCSGroupAlive = true
-    end
-  end
-  self:T( DCSGroupAlive )
-  return DCSGroupAlive
-end
-
-
---- Traces the current database contents in the log ... (for debug reasons).
--- @param #DATABASE self
--- @return #DATABASE self
-function DATABASE:TraceDatabase()
-  self:F()
-  
-  self:T( { "DCSUnits:", self.DCSUnits } )
-end
-
-

Moose Development/Moose/Dcs/DCSAirbase.lua

@@ -4,7 +4,7 @@
 
 --- Represents airbases: airdromes, helipads and ships with flying decks or landing pads.  
 -- @type Airbase
--- @extends DCSCoalitionObject#CoalitionObject
+-- @extends Dcs.DCSCoalitionWrapper.Object#CoalitionObject
 -- @field #Airbase.ID ID Identifier of an airbase. It assigned to an airbase by the Mission Editor automatically. This identifier is used in AI tasks to refer an airbase that exists (spawned and not dead) or not. 
 -- @field #Airbase.Category Category enum contains identifiers of airbase categories. 
 -- @field #Airbase.Desc Desc Airbase descriptor. Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type. 
@@ -33,7 +33,7 @@
 --- Returns Unit that is corresponded to the airbase. Works only for ships.
 -- @function [parent=#Airbase] getUnit
 -- @param self
--- @return Unit#Unit
+-- @return Wrapper.Unit#Unit
 
 --- Returns identifier of the airbase.
 -- @function [parent=#Airbase] getID

Moose Development/Moose/Dcs/DCSCoalitionObject.lua

@@ -2,22 +2,14 @@
 -- @module DCSCoalitionObject
 
 --- @type CoalitionObject
--- @extends DCSObject#Object
-
---- @type coalition
--- @field #coalition.side side
-
---- @type coalition.side
--- @field NEUTRAL
--- @field RED
--- @field BLUE
+-- @extends Dcs.DCSWrapper.Object#Object
 
 coalition = {} --#coalition
 
 --- Returns coalition of the object.
 -- @function [parent=#CoalitionObject] getCoalition
 -- @param #CoalitionObject self
--- @return DCSTypes#coalition.side
+-- @return Dcs.DCSTypes#coalition.side
 
 --- Returns object country.
 -- @function [parent=#CoalitionObject] getCountry

Moose Development/Moose/Dcs/DCSController.lua

@@ -78,7 +78,7 @@
 
 --- Detected target. 
 -- @type DetectedTarget
--- @field Object#Object object The target
+-- @field Wrapper.Object#Object object The target
 -- @field #boolean visible The target is visible
 -- @field #boolean type The target type is known
 -- @field #boolean distance Distance to the target is known
@@ -87,7 +87,7 @@
 --- Checks if the target is detected or not. If one or more detection method is specified the function will return true if the target is detected by at least one of these methods. If no detection methods are specified the function will return true if the target is detected by any method. 
 -- @function [parent=#Controller] isTargetDetected
 -- @param self
--- @param Object#Object target Target to check
+-- @param Wrapper.Object#Object target Target to check
 -- @param #Controller.Detection detection Controller.Detection detection1, Controller.Detection detection2, ... Controller.Detection detectionN 
 -- @return #boolean detected True if the target is detected. 
 -- @return #boolean visible Has effect only if detected is true. True if the target is visible now. 
@@ -107,7 +107,7 @@
 --- Know a target.
 -- @function [parent=#Controller] knowTarget
 -- @param self
--- @param Object#Object object The target.
+-- @param Wrapper.Object#Object object The target.
 -- @param #boolean type Target type is known.
 -- @param #boolean distance Distance to target is known.
 

Moose Development/Moose/Dcs/DCSGroup.lua

@@ -41,7 +41,7 @@
 --- Returns the coalition of the group.
 -- @function [parent=#Group] getCoalition
 -- @param #Group self 
--- @return DCSCoalitionObject#coalition.side
+-- @return Dcs.DCSCoalitionWrapper.Object#coalition.side
 
 --- Returns the group's name. This is the same name assigned to the group in Mission Editor.
 -- @function [parent=#Group] getName
@@ -57,7 +57,7 @@
 -- @function [parent=#Group] getUnit
 -- @param #Group self 
 -- @param #number unitNumber
--- @return DCSUnit#Unit
+-- @return Dcs.DCSWrapper.Unit#Unit
 
 --- Returns current size of the group. If some of the units will be destroyed, As units are destroyed the size of the group will be changed.
 -- @function [parent=#Group] getSize
@@ -72,7 +72,7 @@
 --- Returns array of the units present in the group now. Destroyed units will not be enlisted at all.
 -- @function [parent=#Group] getUnits
 -- @param #Group self 
--- @return #list<DCSUnit#Unit> array of Units
+-- @return #list<Dcs.DCSWrapper.Unit#Unit> array of Units
 
 --- Returns controller of the group. 
 -- @function [parent=#Group] getController

Moose Development/Moose/Dcs/DCSStaticObject.lua

@@ -4,7 +4,7 @@
 
 -------------------------------------------------------------------------------
 -- @module StaticObject
--- @extends CoalitionObject#CoalitionObject
+-- @extends CoalitionWrapper.Object#CoalitionObject
 
 --- Represents static object added in the Mission Editor.
 -- @type StaticObject
@@ -13,7 +13,7 @@
 
 --- StaticObject descriptor. Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type. 
 -- @type StaticObject.Desc
--- @extends Unit#Unit.Desc
+-- @extends Wrapper.Unit#Unit.Desc
 
 --- Returns static object by its name. If no static object found nil will be returned. 
 -- @function [parent=#StaticObject] getByName

Moose Development/Moose/Dcs/DCSTask.lua

@@ -0,0 +1,15 @@
+--- @module DCSTask
+
+
+--- A task descriptor (internal structure for DCS World)
+-- @type Task
+-- @field #string id
+-- @field #Task.param param
+
+--- @type Task.param
+
+--- List of @{#Task}
+-- @type TaskArray
+-- @list <#Task>
+
+env.info( "Task defined" )

Moose Development/Moose/Dcs/DCSTypes.lua

@@ -60,6 +60,16 @@
 -- @type TypeName
 -- @extends #string
 
+--- AttributeName = string 
+-- Each object type may have attributes.
+-- Attributes are enlisted in ./Scripts/Database/db_attributes.Lua.
+-- To know what attributes the object type has, look for the unit type script in sub-directories planes/, helicopter/s, vehicles, navy/ of ./Scripts/Database/ directory. 
+-- @type AttributeName
+-- @extends #string
+
+--- List of @{#AttributeName}
+-- @type AttributeNameArray 
+-- @list <#AttributeName>
 
 --- @type AI
 -- @field #AI.Skill Skill

Moose Development/Moose/Dcs/DCSUnit.lua

@@ -2,7 +2,7 @@
 -- @module DCSUnit
 
 --- @type Unit
--- @extends DCSCoalitionObject#CoalitionObject
+-- @extends Dcs.DCSCoalitionWrapper.Object#CoalitionObject
 -- @field ID Identifier of an unit. It assigned to an unit by the Mission Editor automatically. 
 -- @field #Unit.Category Category
 -- @field #Unit.RefuelingSystem RefuelingSystem
@@ -57,14 +57,14 @@
 
 --- A unit descriptor. 
 -- @type Unit.Desc
--- @extends Object#Object.Desc
+-- @extends Wrapper.Object#Object.Desc
 -- @field #Unit.Category category Unit Category
 -- @field #Mass massEmpty mass of empty unit
 -- @field #number speedMax istance / Time, --maximal velocity
 
 --- An aircraft descriptor. 
 -- @type Unit.DescAircraft
--- @extends Unit#Unit.Desc
+-- @extends Wrapper.Unit#Unit.Desc
 -- @field #Mass fuelMassMax maximal inner fuel mass
 -- @field #Distance range Operational range
 -- @field #Distance Hmax Ceiling
@@ -75,18 +75,18 @@
 
 --- An airplane descriptor.
 -- @type Unit.DescAirplane 
--- @extends Unit#Unit.DescAircraft
+-- @extends Wrapper.Unit#Unit.DescAircraft
 -- @field #number speedMax0 Distance / Time maximal TAS at ground level
 -- @field #number speedMax10K Distance / Time maximal TAS at altitude of 10 km
 
 --- A helicopter descriptor.
 -- @type Unit.DescHelicopter 
--- @extends Unit#Unit.DescAircraft
+-- @extends Wrapper.Unit#Unit.DescAircraft
 -- @field #Distance HmaxStat static ceiling
 
 --- A vehicle descriptor.
 -- @type Unit.DescVehicle 
--- @extends Unit#Unit.Desc
+-- @extends Wrapper.Unit#Unit.Desc
 -- @field #Angle maxSlopeAngle maximal slope angle
 -- @field #boolean riverCrossing can the vehicle cross a rivers
 
@@ -106,12 +106,12 @@
 
 --- An optic sensor.
 -- @type Unit.Optic 
--- @extends Unit#Unit.Sensor
+-- @extends Wrapper.Unit#Unit.Sensor
 -- @field #Unit.OpticType opticType
 
 --- A radar.
 -- @type  Unit.Radar 
--- @extends Unit#Unit.Sensor
+-- @extends Wrapper.Unit#Unit.Sensor
 -- @field #Distance detectionDistanceRBM detection distance for RCS=1m^2 in real-beam mapping mode, nil if radar doesn't support surface/land search
 -- @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
@@ -129,7 +129,7 @@
 -- @field #Distance tailOn
 
 --- An IRST.
---  @type Unit#Unit.IRST 
+--  @type Wrapper.Unit#Unit.IRST 
 --  @extends Unit.Sensor
 --  @field #Distance detectionDistanceIdle detection of tail-on target with heat signature = 1 in upper hemisphere, engines are in idle
 --  @field #Distance detectionDistanceMaximal ..., engines are in maximal mode
@@ -137,7 +137,7 @@
 
 --- An RWR.
 --  @type Unit.RWR 
---  @extends Unit#Unit.Sensor
+--  @extends Wrapper.Unit#Unit.Sensor
 
 --- table that stores all unit sensors.
 -- TODO @type Sensors
@@ -178,7 +178,7 @@
 --- Returns the unit's group if it exist and nil otherwise
 -- @function [parent=#Unit] getGroup
 -- @param #Unit self
--- @return DCSGroup#Group
+-- @return Dcs.DCSWrapper.Group#Group
 
 --- Returns the unit's callsign - the localized string.
 -- @function [parent=#Unit] getCallsign
@@ -230,7 +230,7 @@
 -- Second value is the object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target. 
 -- @function [parent=#Unit] getRadar
 -- @param #Unit self
--- @return #boolean, Object#Object
+-- @return #boolean, Wrapper.Object#Object
 
 --- Returns unit descriptor. Descriptor type depends on unit category. 
 -- @function [parent=#Unit] getDesc

Moose Development/Moose/Dcs/DCSVec3.lua

@@ -0,0 +1,11 @@
+-------------------------------------------------------------------------------
+-- @module DCSVec3
+
+
+
+---
+-- @type Vec3
+-- @field #number x
+-- @field #number y
+-- @field #number z
+Vec3 = {}

Moose Development/Moose/Dcs/DCSZone.lua

@@ -0,0 +1,10 @@
+-------------------------------------------------------------------------------
+-- @module DCSZone
+
+
+
+---
+-- @type Zone
+-- @field DCSVec3#Vec3 point
+-- @field #number radius
+Zone = {}

Moose Development/Moose/Dcs/DCScoalition.lua

@@ -0,0 +1,14 @@
+-------------------------------------------------------------------------------
+-- @module DCScoalition
+
+--- @type coalition
+-- @field #coalition.side side
+
+--- @type coalition.side
+-- @field NEUTRAL
+-- @field RED
+-- @field BLUE
+
+--- @function [parent=#coalition] getCountryCoalition
+-- @param #number countryId
+-- @return #number coalitionId

Moose Development/Moose/Dcs/DCScountry.lua

@@ -3,6 +3,7 @@
 
 --- @type country
 -- @field #country.id id
+country = country -- #country
 
 --- @type country.id
 -- @field RUSSIA
@@ -23,4 +24,4 @@
 -- @field INSURGENTS
 -- @field ABKHAZIA
 -- @field SOUTH_OSETIA
--- @field ITALY
+-- @field ITALY

Moose Development/Moose/Dcs/DCSland.lua

@@ -15,6 +15,12 @@
 --- Returns altitude MSL of the point.
 -- @function [parent=#land] getHeight
 -- @param #Vec2 point point on the ground. 
--- @return DCSTypes#Distance
+-- @return Dcs.DCSTypes#Distance
+
+--- returns surface type at the given point.
+-- @function [parent=#land] getSurfaceType
+-- @param #Vec2 point Point on the land. 
+-- @return #land.SurfaceType
+
 
 land = {} --#land

Moose Development/Moose/Dcs/DCStrigger.lua

@@ -0,0 +1,8 @@
+-------------------------------------------------------------------------------
+-- @module DCStrigger
+
+
+trigger = {} --#timer
+
+
+  

Moose Development/Moose/DeployTask.lua

@@ -1,158 +0,0 @@
---- A DEPLOYTASK orchestrates the deployment of CARGO within a specific landing zone.
--- @module DEPLOYTASK
-
-Include.File( "Task" )
-
---- A DeployTask
--- @type DEPLOYTASK
-DEPLOYTASK = {
-  ClassName = "DEPLOYTASK",
-  TEXT = { "Deploy", "deployed", "unloaded" },
-  GoalVerb = "Deployment"
-}
-
-
---- Creates a new DEPLOYTASK object, which models the sequence of STAGEs to unload a cargo.
--- @function [parent=#DEPLOYTASK] New
--- @param #string CargoType Type of the Cargo.
--- @return #DEPLOYTASK The created DeployTask
-function DEPLOYTASK:New( CargoType )
-	local self = BASE:Inherit( self, TASK:New() )
-	self:F()
-
-	local Valid = true
-  
-    if Valid then
-		self.Name = 'Deploy Cargo'
-		self.TaskBriefing = "Fly to one of the indicated landing zones and deploy " .. CargoType .. ". Your co-pilot will provide you with the directions (required flight angle in degrees) and the distance (in km) to the deployment zone."
-		self.CargoType = CargoType
-		self.GoalVerb = CargoType .. " " .. self.GoalVerb
-		self.Stages = { STAGE_CARGO_INIT:New(), STAGE_CARGO_LOAD:New(), STAGEBRIEF:New(), STAGESTART:New(), STAGEROUTE:New(), STAGELANDING:New(), STAGELANDED:New(), STAGEUNLOAD:New(), STAGEDONE:New() }
-		self.SetStage( self, 1 )
-	end
-  
-	return self
-end
-
-function DEPLOYTASK:ToZone( LandingZone )
-	self:F()
-
-	self.LandingZones.LandingZoneNames[LandingZone.CargoZoneName] = LandingZone.CargoZoneName
-	self.LandingZones.LandingZones[LandingZone.CargoZoneName] = LandingZone
-	
-	return self
-end
-
-
-function DEPLOYTASK:InitCargo( InitCargos )
-	self:F( { InitCargos } )
-
-	if type( InitCargos ) == "table" then
-		self.Cargos.InitCargos = InitCargos
-	else
-		self.Cargos.InitCargos = { InitCargos }
-	end
-
-	return self
-end
-
-
-function DEPLOYTASK:LoadCargo( LoadCargos )
-	self:F( { LoadCargos } )
-
-	if type( LoadCargos ) == "table" then
-		self.Cargos.LoadCargos = LoadCargos
-	else
-		self.Cargos.LoadCargos = { LoadCargos }
-	end
-
-	return self
-end
-
-
---- When the cargo is unloaded, it will move to the target zone name.
--- @param string TargetZoneName Name of the Zone to where the Cargo should move after unloading.
-function DEPLOYTASK:SetCargoTargetZoneName( TargetZoneName )
-	self:F()
-  
-  local Valid = true
-  
-  Valid = routines.ValidateString( TargetZoneName, "TargetZoneName", Valid )
-  
-  if Valid then
-    self.TargetZoneName = TargetZoneName
-  end
-  
-  return Valid
-  
-end
-
-function DEPLOYTASK:AddCargoMenus( Client, Cargos, TransportRadius )
-	self:F()
-
-	local ClientGroupID = Client:GetClientGroupID()
-	
-	self:T( ClientGroupID )
-	
-	for CargoID, Cargo in pairs( Cargos ) do
-
-		self:T( { Cargo.ClassName, Cargo.CargoName, Cargo.CargoType, Cargo.CargoWeight } )
-		
-		if Cargo:IsStatusLoaded() and Client == Cargo:IsLoadedInClient() then
-
-			if Client._Menus[Cargo.CargoType] == nil then
-				Client._Menus[Cargo.CargoType] = {}
-			end
-			
-			if not Client._Menus[Cargo.CargoType].DeployMenu then
-				Client._Menus[Cargo.CargoType].DeployMenu = missionCommands.addSubMenuForGroup(
-					ClientGroupID, 
-					self.TEXT[1] .. " " .. Cargo.CargoType, 
-					nil
-				)
-				self:T( 'Added DeployMenu ' .. self.TEXT[1] )
-			end
-			
-			if Client._Menus[Cargo.CargoType].DeploySubMenus == nil then
-				Client._Menus[Cargo.CargoType].DeploySubMenus = {}
-			end
-			
-			if Client._Menus[Cargo.CargoType].DeployMenu == nil then
-				self:T( 'deploymenu is nil' )
-			end
-
-			Client._Menus[Cargo.CargoType].DeploySubMenus[ #Client._Menus[Cargo.CargoType].DeploySubMenus + 1 ] = missionCommands.addCommandForGroup(
-				ClientGroupID, 
-				Cargo.CargoName .. " ( " .. Cargo.CargoWeight .. "kg )",
-				Client._Menus[Cargo.CargoType].DeployMenu, 
-				self.MenuAction,
-				{ ReferenceTask = self, CargoTask = Cargo }
-			)
-			self:T( 'Added DeploySubMenu ' .. Cargo.CargoType .. ":" .. Cargo.CargoName .. " ( " .. Cargo.CargoWeight .. "kg )" )
-		end
-	end
-
-end
-
-function DEPLOYTASK:RemoveCargoMenus( Client )
-	self:F()
-
-	local ClientGroupID = Client:GetClientGroupID()
-	self:T( ClientGroupID )
-
-	for MenuID, MenuData in pairs( Client._Menus ) do
-		if MenuData.DeploySubMenus ~= nil then
-			for SubMenuID, SubMenuData in pairs( MenuData.DeploySubMenus ) do
-				missionCommands.removeItemForGroup( ClientGroupID, SubMenuData )
-				self:T( "Removed DeploySubMenu " )
-				SubMenuData = nil
-			end
-		end
-		if MenuData.DeployMenu then
-			missionCommands.removeItemForGroup( ClientGroupID, MenuData.DeployMenu )
-			self:T( "Removed DeployMenu " )
-			MenuData.DeployMenu = nil
-		end
-	end
-
-end

Moose Development/Moose/DestroyBaseTask.lua

@@ -1,81 +0,0 @@
---- A DESTROYBASETASK will monitor the destruction of Groups and Units. This is a BASE class, other classes are derived from this class.
--- @module DESTROYBASETASK
--- @see DESTROYGROUPSTASK
--- @see DESTROYUNITTYPESTASK
--- @see DESTROY_RADARS_TASK
-
-Include.File("Task")
-
---- The DESTROYBASETASK class
--- @type DESTROYBASETASK
-DESTROYBASETASK = {
-  ClassName = "DESTROYBASETASK",
-  Destroyed = 0,
-  GoalVerb = "Destroy",
-  DestroyPercentage = 100,
-}
-
---- Creates a new DESTROYBASETASK.
--- @param #DESTROYBASETASK self
--- @param #string DestroyGroupType Text describing the group to be destroyed. f.e. "Radar Installations", "Ships", "Vehicles", "Command Centers".
--- @param #string DestroyUnitType Text describing the unit types to be destroyed. f.e. "SA-6", "Row Boats", "Tanks", "Tents".
--- @param #list<#string> DestroyGroupPrefixes Table of Prefixes of the Groups to be destroyed before task is completed.
--- @param #number DestroyPercentage defines the %-tage that needs to be destroyed to achieve mission success. eg. If in the Group there are 10 units, then a value of 75 would require 8 units to be destroyed from the Group to complete the @{TASK}.
--- @return DESTROYBASETASK
-function DESTROYBASETASK:New( DestroyGroupType, DestroyUnitType, DestroyGroupPrefixes, DestroyPercentage )
-	local self = BASE:Inherit( self, TASK:New() )
-	self:F()
-	
-	self.Name = 'Destroy'
-	self.Destroyed = 0
-	self.DestroyGroupPrefixes = DestroyGroupPrefixes
-	self.DestroyGroupType = DestroyGroupType
-	self.DestroyUnitType = DestroyUnitType
-	if DestroyPercentage then
-  	self.DestroyPercentage = DestroyPercentage
-  end
-	self.TaskBriefing = "Task: Destroy " .. DestroyGroupType .. "."
-    self.Stages = { STAGEBRIEF:New(), STAGESTART:New(), STAGEGROUPSDESTROYED:New(), STAGEDONE:New() }
-	self.SetStage( self, 1 )
-
-	return self
-end
-
---- Handle the S_EVENT_DEAD events to validate the destruction of units for the task monitoring.
--- @param #DESTROYBASETASK self
--- @param Event#EVENTDATA Event structure of MOOSE.
-function DESTROYBASETASK:EventDead( Event )
-	self:F( { Event } )
-	
-	if Event.IniDCSUnit then
-		local DestroyUnit = Event.IniDCSUnit
-		local DestroyUnitName = Event.IniDCSUnitName
-		local DestroyGroup = Event.IniDCSGroup
-		local DestroyGroupName = Event.IniDCSGroupName
-
-    --TODO: I need to fix here if 2 groups in the mission have a similar name with GroupPrefix equal, then i should differentiate for which group the goal was reached!
-    --I may need to test if for the goalverb that group goal was reached or something. Need to think about it a bit more ...
-		local UnitsDestroyed = 0
-		for DestroyGroupPrefixID, DestroyGroupPrefix in pairs( self.DestroyGroupPrefixes ) do
-			self:T( DestroyGroupPrefix )
-			if string.find( DestroyGroupName, DestroyGroupPrefix, 1, true ) then
-				self:T( BASE:Inherited(self).ClassName )
-				UnitsDestroyed = self:ReportGoalProgress( DestroyGroup, DestroyUnit )
-				self:T( UnitsDestroyed )
-			end
-		end
-		
-		self:T( { UnitsDestroyed } )
-		self:IncreaseGoalCount( UnitsDestroyed, self.GoalVerb )
-	end
-	
-end
-
---- Validate task completeness of DESTROYBASETASK.
--- @param 	DestroyGroup 		Group structure describing the group to be evaluated.
--- @param 	DestroyUnit 		Unit structure describing the Unit to be evaluated.
-function DESTROYBASETASK:ReportGoalProgress( DestroyGroup, DestroyUnit )
-	self:F()
-
-	return 0
-end

Moose Development/Moose/DestroyGroupsTask.lua

@@ -1,57 +0,0 @@
---- DESTROYGROUPSTASK
--- @module DESTROYGROUPSTASK
-
-Include.File("DestroyBaseTask")
-
---- The DESTROYGROUPSTASK class
--- @type
-DESTROYGROUPSTASK = {
-  ClassName = "DESTROYGROUPSTASK",
-  GoalVerb = "Destroy Groups",
-}
-
---- Creates a new DESTROYGROUPSTASK.
--- @param #DESTROYGROUPSTASK self
--- @param #string DestroyGroupType 	String describing the group to be destroyed.
--- @param #string DestroyUnitType 	String describing the unit to be destroyed.
--- @param #list<#string> DestroyGroupNames 	Table of string containing the name of the groups to be destroyed before task is completed.
--- @param #number DestroyPercentage defines the %-tage that needs to be destroyed to achieve mission success. eg. If in the Group there are 10 units, then a value of 75 would require 8 units to be destroyed from the Group to complete the @{TASK}.
----@return DESTROYGROUPSTASK
-function DESTROYGROUPSTASK:New( DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage )
-	local self = BASE:Inherit( self, DESTROYBASETASK:New( DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyPercentage ) )
-	self:F()
-  
-	self.Name = 'Destroy Groups'
-	self.GoalVerb = "Destroy " .. DestroyGroupType
-	
-  _EVENTDISPATCHER:OnDead( self.EventDead , self )
-  _EVENTDISPATCHER:OnCrash( self.EventDead , self )
-
-	return self
-end
-
---- Report Goal Progress.
--- @param #DESTROYGROUPSTASK self
--- @param DCSGroup#Group DestroyGroup Group structure describing the group to be evaluated.
--- @param DCSUnit#Unit DestroyUnit Unit structure describing the Unit to be evaluated.
--- @return #number The DestroyCount reflecting the amount of units destroyed within the group.
-function DESTROYGROUPSTASK:ReportGoalProgress( DestroyGroup, DestroyUnit )
-	self:F( { DestroyGroup, DestroyUnit, self.DestroyPercentage } )
-	
-	local DestroyGroupSize = DestroyGroup:getSize() - 1 -- When a DEAD event occurs, the getSize is still one larger than the destroyed unit.
-	local DestroyGroupInitialSize = DestroyGroup:getInitialSize()
-	self:T( { DestroyGroupSize, DestroyGroupInitialSize - ( DestroyGroupInitialSize * self.DestroyPercentage / 100 ) } )
-
-	local DestroyCount = 0
-	if DestroyGroup then
-		if DestroyGroupSize <= DestroyGroupInitialSize - ( DestroyGroupInitialSize * self.DestroyPercentage / 100 ) then
-			DestroyCount = 1
-		end
-	else
-		DestroyCount = 1
-	end
-	
-	self:T( DestroyCount )
-	
-	return DestroyCount
-end

Moose Development/Moose/DestroyRadarsTask.lua

@@ -1,41 +0,0 @@
---- Task class to destroy radar installations.
--- @module DESTROYRADARSTASK 
-
-Include.File("DestroyBaseTask")
-
---- The DESTROYRADARS class
--- @type
-DESTROYRADARSTASK = {
-  ClassName = "DESTROYRADARSTASK",
-  GoalVerb = "Destroy Radars"
-}
-
---- Creates a new DESTROYRADARSTASK.
--- @param table{string,...} DestroyGroupNames 	Table of string containing the group names of which the radars are be destroyed.
--- @return DESTROYRADARSTASK
-function DESTROYRADARSTASK:New( DestroyGroupNames )
-	local self = BASE:Inherit( self, DESTROYGROUPSTASK:New( 'radar installations', 'radars', DestroyGroupNames ) )
-	self:F()
-
-	self.Name = 'Destroy Radars'
-
-  _EVENTDISPATCHER:OnDead( self.EventDead , self )
-
-	return self
-end
-
---- Report Goal Progress.
--- @param 	Group DestroyGroup 		Group structure describing the group to be evaluated.
--- @param 	Unit DestroyUnit 		Unit structure describing the Unit to be evaluated.
-function DESTROYRADARSTASK:ReportGoalProgress( DestroyGroup, DestroyUnit )
-	self:F( { DestroyGroup, DestroyUnit } )
-
-	local DestroyCount = 0
-	if DestroyUnit and DestroyUnit:hasSensors( Unit.SensorType.RADAR, Unit.RadarType.AS ) then
-		if DestroyUnit and DestroyUnit:getLife() <= 1.0 then
-			self:T( 'Destroyed a radar' )
-			DestroyCount = 1
-		end
-	end
-	return DestroyCount
-end

Moose Development/Moose/DestroyUnitTypesTask.lua

@@ -1,52 +0,0 @@
---- Set TASK to destroy certain unit types.
--- @module DESTROYUNITTYPESTASK
-
-Include.File("DestroyBaseTask")
-
---- The DESTROYUNITTYPESTASK class
--- @type
-DESTROYUNITTYPESTASK = {
-  ClassName = "DESTROYUNITTYPESTASK",
-	GoalVerb = "Destroy",
-}
-
---- Creates a new DESTROYUNITTYPESTASK.
--- @param string DestroyGroupType 		String describing the group to be destroyed. f.e. "Radar Installations", "Fleet", "Batallion", "Command Centers".
--- @param string DestroyUnitType 		String describing the unit to be destroyed. f.e. "radars", "ships", "tanks", "centers".
--- @param table{string,...} DestroyGroupNames 	Table of string containing the group names of which the radars are be destroyed.
--- @param string DestroyUnitTypes	 	Table of string containing the type names of the units to achieve mission success.
--- @return DESTROYUNITTYPESTASK
-function DESTROYUNITTYPESTASK:New( DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes )
-	local self = BASE:Inherit( self, DESTROYBASETASK:New( DestroyGroupType, DestroyUnitType, DestroyGroupNames ) )
-	self:F( { DestroyGroupType, DestroyUnitType, DestroyGroupNames, DestroyUnitTypes } )
-  	
-	if type(DestroyUnitTypes) == 'table' then
-		self.DestroyUnitTypes = DestroyUnitTypes
-	else
-		self.DestroyUnitTypes = { DestroyUnitTypes }
-	end
-	
-	self.Name = 'Destroy Unit Types'
-	self.GoalVerb = "Destroy " .. DestroyGroupType
-
-  _EVENTDISPATCHER:OnDead( self.EventDead , self )
-
-	return self
-end
-
---- Report Goal Progress.
--- @param 	Group DestroyGroup 		Group structure describing the group to be evaluated.
--- @param 	Unit DestroyUnit 		Unit structure describing the Unit to be evaluated.
-function DESTROYUNITTYPESTASK:ReportGoalProgress( DestroyGroup, DestroyUnit )
-	self:F( { DestroyGroup, DestroyUnit } )
-
-	local DestroyCount = 0
-	for UnitTypeID, UnitType in pairs( self.DestroyUnitTypes ) do
-		if DestroyUnit and DestroyUnit:getTypeName() == UnitType then
-			if DestroyUnit and DestroyUnit:getLife() <= 1.0 then
-				DestroyCount = DestroyCount + 1
-			end
-		end
-	end
-	return DestroyCount
-end

Moose Development/Moose/Event.lua

@@ -1,511 +0,0 @@
---- The EVENT class models an efficient event handling process between other classes and its units, weapons.
--- @module Event
--- @author FlightControl
-
-Include.File( "Routines" )
-Include.File( "Base" )
-
---- The EVENT structure
--- @type EVENT
--- @field #EVENT.Events Events
-EVENT = {
-  ClassName = "EVENT",
-  ClassID = 0,
-}
-
-local _EVENTCODES = {
-   "S_EVENT_SHOT",
-   "S_EVENT_HIT",
-   "S_EVENT_TAKEOFF",
-   "S_EVENT_LAND",
-   "S_EVENT_CRASH",
-   "S_EVENT_EJECTION",
-   "S_EVENT_REFUELING",
-   "S_EVENT_DEAD",
-   "S_EVENT_PILOT_DEAD",
-   "S_EVENT_BASE_CAPTURED",
-   "S_EVENT_MISSION_START",
-   "S_EVENT_MISSION_END",
-   "S_EVENT_TOOK_CONTROL",
-   "S_EVENT_REFUELING_STOP",
-   "S_EVENT_BIRTH",
-   "S_EVENT_HUMAN_FAILURE",
-   "S_EVENT_ENGINE_STARTUP",
-   "S_EVENT_ENGINE_SHUTDOWN",
-   "S_EVENT_PLAYER_ENTER_UNIT",
-   "S_EVENT_PLAYER_LEAVE_UNIT",
-   "S_EVENT_PLAYER_COMMENT",
-   "S_EVENT_SHOOTING_START",
-   "S_EVENT_SHOOTING_END",
-   "S_EVENT_MAX",
-}
-
---- The Event structure
--- @type EVENTDATA
--- @field id
--- @field initiator
--- @field target
--- @field weapon
--- @field IniDCSUnit
--- @field IniDCSUnitName
--- @field IniDCSGroup
--- @field IniDCSGroupName
--- @field TgtDCSUnit
--- @field TgtDCSUnitName
--- @field TgtDCSGroup
--- @field TgtDCSGroupName
--- @field Weapon
--- @field WeaponName
--- @field WeaponTgtDCSUnit
-
---- The Events structure
--- @type EVENT.Events
--- @field #number IniUnit
-
-function EVENT:New()
-  local self = BASE:Inherit( self, BASE:New() )
-  self:F()
-  self.EventHandler = world.addEventHandler( self )
-  return self
-end
-
-function EVENT:EventText( EventID )
-
-  local EventText = _EVENTCODES[EventID]
-  
-  return EventText
-end
-
-
---- Initializes the Events structure for the event
--- @param #EVENT self
--- @param DCSWorld#world.event EventID
--- @param #string EventClass
--- @return #EVENT.Events
-function EVENT:Init( EventID, EventClass )
-  self:F3( { _EVENTCODES[EventID], EventClass } )
-  if not self.Events[EventID] then
-    self.Events[EventID] = {}
-  end
-  if not self.Events[EventID][EventClass] then
-     self.Events[EventID][EventClass] = {}
-  end
-  return self.Events[EventID][EventClass]
-end
-
-
---- Create an OnDead event handler for a group
--- @param #EVENT self
--- @param #table EventTemplate
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param EventSelf The self instance of the class for which the event is.
--- @param #function OnEventFunction
--- @return #EVENT
-function EVENT:OnEventForTemplate( EventTemplate, EventFunction, EventSelf, OnEventFunction )
-  self:F2( EventTemplate.name )
-
-  for EventUnitID, EventUnit in pairs( EventTemplate.units ) do
-    OnEventFunction( self, EventUnit.name, EventFunction, EventSelf )
-  end
-  return self
-end
-
---- Set a new listener for an S_EVENT_X event independent from a unit or a weapon.
--- @param #EVENT self
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @param EventID
--- @return #EVENT
-function EVENT:OnEventGeneric( EventFunction, EventSelf, EventID )
-  self:F2( { EventID } )
-
-  local Event = self:Init( EventID, EventSelf:GetClassNameAndID() )
-  Event.EventFunction = EventFunction
-  Event.EventSelf = EventSelf
-  return self
-end
-
-
---- Set a new listener for an S_EVENT_X event
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @param EventID
--- @return #EVENT
-function EVENT:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, EventID )
-  self:F2( EventDCSUnitName )
-
-  local Event = self:Init( EventID, EventSelf:GetClassNameAndID() )
-  if not Event.IniUnit then
-    Event.IniUnit = {}
-  end
-  Event.IniUnit[EventDCSUnitName] = {}
-  Event.IniUnit[EventDCSUnitName].EventFunction = EventFunction
-  Event.IniUnit[EventDCSUnitName].EventSelf = EventSelf
-  return self
-end
-
-
---- Create an OnBirth event handler for a group
--- @param #EVENT self
--- @param Group#GROUP EventGroup
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnBirthForTemplate( EventTemplate, EventFunction, EventSelf )
-  self:F( EventTemplate.name )
-
-  self:OnEventForTemplate( EventTemplate, EventFunction, EventSelf, self.OnBirthForUnit )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_BIRTH event, and registers the unit born.
--- @param #EVENT self
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf
--- @return #EVENT
-function EVENT:OnBirth( EventFunction, EventSelf )
-  self:F()
-  
-  self:OnEventGeneric( EventFunction, EventSelf, world.event.S_EVENT_BIRTH )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_BIRTH event.
--- @param #EVENT self
--- @param #string EventDCSUnitName The id of the unit for the event to be handled.
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf
--- @return #EVENT
-function EVENT:OnBirthForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-  
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_BIRTH )
-  
-  return self
-end
-
---- Create an OnCrash event handler for a group
--- @param #EVENT self
--- @param Group#GROUP EventGroup
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnCrashForTemplate( EventTemplate, EventFunction, EventSelf )
-  self:F( EventTemplate.name )
-
-  self:OnEventForTemplate( EventTemplate, EventFunction, EventSelf, self.OnCrashForUnit )
-
-  return self
-end
-
---- Set a new listener for an S_EVENT_CRASH event.
--- @param #EVENT self
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf
--- @return #EVENT
-function EVENT:OnCrash( EventFunction, EventSelf )
-  self:F()
-  
-  self:OnEventGeneric( EventFunction, EventSelf, world.event.S_EVENT_CRASH )
-  
-  return self 
-end
-
---- Set a new listener for an S_EVENT_CRASH event.
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnCrashForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-  
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_CRASH )
-
-  return self
-end
-
---- Create an OnDead event handler for a group
--- @param #EVENT self
--- @param Group#GROUP EventGroup
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnDeadForTemplate( EventTemplate, EventFunction, EventSelf )
-  self:F( EventTemplate.name )
-  
-  self:OnEventForTemplate( EventTemplate, EventFunction, EventSelf, self.OnDeadForUnit )
-
-  return self
-end
-
---- Set a new listener for an S_EVENT_DEAD event.
--- @param #EVENT self
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf
--- @return #EVENT
-function EVENT:OnDead( EventFunction, EventSelf )
-  self:F()
-  
-  self:OnEventGeneric( EventFunction, EventSelf, world.event.S_EVENT_DEAD )
-  
-  return self
-end
-
-
---- Set a new listener for an S_EVENT_DEAD event.
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnDeadForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_DEAD )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_PILOT_DEAD event.
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnPilotDeadForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_PILOT_DEAD )
-
-  return self
-end
-
---- Create an OnDead event handler for a group
--- @param #EVENT self
--- @param #table EventTemplate
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnLandForTemplate( EventTemplate, EventFunction, EventSelf )
-  self:F( EventTemplate.name )
-
-  self:OnEventForTemplate( EventTemplate, EventFunction, EventSelf, self.OnLandForUnit )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_LAND event.
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnLandForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_LAND )
-
-  return self
-end
-
---- Create an OnDead event handler for a group
--- @param #EVENT self
--- @param #table EventTemplate
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnTakeOffForTemplate( EventTemplate, EventFunction, EventSelf )
-  self:F( EventTemplate.name )
-
-  self:OnEventForTemplate( EventTemplate, EventFunction, EventSelf, self.OnTakeOffForUnit )
-
-  return self
-end
-
---- Set a new listener for an S_EVENT_TAKEOFF event.
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnTakeOffForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_TAKEOFF )
-
-  return self
-end
-
---- Create an OnDead event handler for a group
--- @param #EVENT self
--- @param #table EventTemplate
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnEngineShutDownForTemplate( EventTemplate, EventFunction, EventSelf )
-  self:F( EventTemplate.name )
-
-  self:OnEventForTemplate( EventTemplate, EventFunction, EventSelf, self.OnEngineShutDownForUnit )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_ENGINE_SHUTDOWN event.
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnEngineShutDownForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_ENGINE_SHUTDOWN )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_ENGINE_STARTUP event.
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnEngineStartUpForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_ENGINE_STARTUP )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_SHOT event.
--- @param #EVENT self
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnShot( EventFunction, EventSelf )
-  self:F()
-
-  self:OnEventGeneric( EventFunction, EventSelf, world.event.S_EVENT_SHOT )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_SHOT event for a unit.
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnShotForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_SHOT )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_HIT event.
--- @param #EVENT self
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnHit( EventFunction, EventSelf )
-  self:F()
-
-  self:OnEventGeneric( EventFunction, EventSelf, world.event.S_EVENT_HIT )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_HIT event.
--- @param #EVENT self
--- @param #string EventDCSUnitName
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnHitForUnit( EventDCSUnitName, EventFunction, EventSelf )
-  self:F( EventDCSUnitName )
-
-  self:OnEventForUnit( EventDCSUnitName, EventFunction, EventSelf, world.event.S_EVENT_HIT )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_PLAYER_ENTER_UNIT event.
--- @param #EVENT self
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnPlayerEnterUnit( EventFunction, EventSelf )
-  self:F()
-
-  self:OnEventGeneric( EventFunction, EventSelf, world.event.S_EVENT_PLAYER_ENTER_UNIT )
-  
-  return self
-end
-
---- Set a new listener for an S_EVENT_PLAYER_LEAVE_UNIT event.
--- @param #EVENT self
--- @param #function EventFunction The function to be called when the event occurs for the unit.
--- @param Base#BASE EventSelf The self instance of the class for which the event is.
--- @return #EVENT
-function EVENT:OnPlayerLeaveUnit( EventFunction, EventSelf )
-  self:F()
-
-  self:OnEventGeneric( EventFunction, EventSelf, world.event.S_EVENT_PLAYER_LEAVE_UNIT )
-  
-  return self
-end
-
-
-
-function EVENT:onEvent( Event )
-  self:F( { _EVENTCODES[Event.id], Event } )
-
-  if self and self.Events and self.Events[Event.id] then
-    if Event.initiator and Event.initiator:getCategory() == Object.Category.UNIT then
-      Event.IniDCSUnit = Event.initiator
-      Event.IniDCSGroup = Event.IniDCSUnit:getGroup()
-      Event.IniDCSUnitName = Event.IniDCSUnit:getName()
-      Event.IniDCSGroupName = ""
-      if Event.IniDCSGroup and Event.IniDCSGroup:isExist() then
-        Event.IniDCSGroupName = Event.IniDCSGroup:getName()
-      end
-    end
-    if Event.target then
-      if Event.target and Event.target:getCategory() == Object.Category.UNIT then
-        Event.TgtDCSUnit = Event.target
-        Event.TgtDCSGroup = Event.TgtDCSUnit:getGroup()
-        Event.TgtDCSUnitName = Event.TgtDCSUnit:getName()
-        Event.TgtDCSGroupName = ""
-        if Event.TgtDCSGroup and Event.TgtDCSGroup:isExist() then
-          Event.TgtDCSGroupName = Event.TgtDCSGroup:getName()
-        end
-      end
-    end
-    if Event.weapon then
-      Event.Weapon = Event.weapon
-      Event.WeaponName = Event.Weapon:getTypeName()
-      --Event.WeaponTgtDCSUnit = Event.Weapon:getTarget()
-    end
-    self:E( { _EVENTCODES[Event.id], Event } )
-    for ClassName, EventData in pairs( self.Events[Event.id] ) do
-      if Event.IniDCSUnitName and EventData.IniUnit and EventData.IniUnit[Event.IniDCSUnitName] then 
-        self:T2( { "Calling event function for class ", ClassName, " unit ", Event.IniDCSUnitName } )
-        EventData.IniUnit[Event.IniDCSUnitName].EventFunction( EventData.IniUnit[Event.IniDCSUnitName].EventSelf, Event )
-      else
-        if Event.IniDCSUnit and not EventData.IniUnit then
-          self:T2( { "Calling event function for class ", ClassName } )
-          EventData.EventFunction( EventData.EventSelf, Event )
-        end
-      end
-    end
-  end
-end
-

Moose Development/Moose/Functional/CleanUp.lua

@@ -0,0 +1,406 @@
+--- **Functional** -- The CLEANUP_AIRBASE class keeps an area clean of crashing or colliding airplanes. It also prevents airplanes from firing within this area.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- ### Contributions: 
+-- 
+-- ===
+-- 
+-- @module CleanUp
+
+--- @type CLEANUP_AIRBASE.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-)
+-- @field #map<#string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases.
+-- @extends Core.Base#BASE
+
+--- @type CLEANUP_AIRBASE
+-- @extends #CLEANUP_AIRBASE.__
+
+--- # CLEANUP_AIRBASE, extends @{Base#BASE}
+-- 
+-- ![Banner Image](..\Presentations\CLEANUP_AIRBASE\Dia1.JPG)
+-- 
+-- The CLEANUP_AIRBASE class keeps airbases clean, and tries to guarantee continuous airbase operations, even under combat.
+-- Specific airbases need to be provided that need to be guarded. Each airbase registered, will be guarded within a zone of 8 km around the airbase.
+-- Any unit that fires a missile, or shoots within the zone of an airbase, will be monitored by CLEANUP_AIRBASE.
+-- Within the 8km zone, units cannot fire any missile, which prevents the airbase runway to receive missile or bomb hits. 
+-- Any airborne or ground unit that is on the runway below 30 meters (default value) will be automatically removed if it is damaged.
+-- 
+-- This is not a full 100% secure implementation. It is still possible that CLEANUP_AIRBASE cannot prevent (in-time) to keep the airbase clean.
+-- The following situations may happen that will still stop the runway of an airbase:
+-- 
+--   * A damaged unit is not removed on time when above the runway, and crashes on the runway.
+--   * A bomb or missile is still able to dropped on the runway.
+--   * Units collide on the airbase, and could not be removed on time.
+--   
+-- When a unit is within the airbase zone and needs to be monitored,
+-- its status will be checked every 0.25 seconds! This is required to ensure that the airbase is kept clean.
+-- But as a result, there is more CPU overload.
+-- 
+-- So as an advise, I suggest you use the CLEANUP_AIRBASE class with care:
+-- 
+--   * Only monitor airbases that really need to be monitored!
+--   * Try not to monitor airbases that are likely to be invaded by enemy troops.
+--     For these airbases, there is little use to keep them clean, as they will be invaded anyway...
+--     
+-- By following the above guidelines, you can add airbase cleanup with acceptable CPU overhead.
+-- 
+-- ## 1. CLEANUP_AIRBASE Constructor
+-- 
+-- Creates the main object which is preventing the airbase to get polluted with debris on the runway, which halts the airbase.
+-- 
+--      -- Clean these Zones.
+--      CleanUpAirports = CLEANUP_AIRBASE:New( { AIRBASE.Caucasus.Tbilisi, AIRBASE.Caucasus.Kutaisi )
+--      
+--      -- or
+--      CleanUpTbilisi = CLEANUP_AIRBASE:New( AIRBASE.Caucasus.Tbilisi )
+--      CleanUpKutaisi = CLEANUP_AIRBASE:New( AIRBASE.Caucasus.Kutaisi )
+-- 
+-- ## 2. Add or Remove airbases
+-- 
+-- The method @{#CLEANUP_AIRBASE.AddAirbase}() to add an airbase to the cleanup validation process.
+-- The method @{#CLEANUP_AIRBASE.RemoveAirbase}() removes an airbase from the cleanup validation process.
+-- 
+-- ## 3. Clean missiles and bombs within the airbase zone.
+-- 
+-- When missiles or bombs hit the runway, the airbase operations stop.
+-- Use the method @{#CLEANUP_AIRBASE.SetCleanMissiles}() to control the cleaning of missiles, which will prevent airbases to stop.
+-- Note that this method will not allow anymore airbases to be attacked, so there is a trade-off here to do.
+-- 
+-- @field #CLEANUP_AIRBASE
+CLEANUP_AIRBASE = {
+	ClassName = "CLEANUP_AIRBASE",
+	TimeInterval = 0.2,
+	CleanUpList = {},
+}
+
+-- @field #CLEANUP_AIRBASE.__
+CLEANUP_AIRBASE.__ = {}
+
+--- @field #CLEANUP_AIRBASE.__.Airbases
+CLEANUP_AIRBASE.__.Airbases = {}
+
+--- Creates the main object which is handling the cleaning of the debris within the given Zone Names.
+-- @param #CLEANUP_AIRBASE self
+-- @param #list<#string> AirbaseNames Is a table of airbase names where the debris should be cleaned. Also a single string can be passed with one airbase name.
+-- @return #CLEANUP_AIRBASE
+-- @usage
+--  -- Clean these Zones.
+-- CleanUpAirports = CLEANUP_AIRBASE:New( { AIRBASE.Caucasus.Tbilisi, AIRBASE.Caucasus.Kutaisi )
+-- or
+-- CleanUpTbilisi = CLEANUP_AIRBASE:New( AIRBASE.Caucasus.Tbilisi )
+-- CleanUpKutaisi = CLEANUP_AIRBASE:New( AIRBASE.Caucasus.Kutaisi )
+function CLEANUP_AIRBASE:New( AirbaseNames )	
+
+  local self = BASE:Inherit( self, BASE:New() ) -- #CLEANUP_AIRBASE
+	self:F( { AirbaseNames } )
+	
+	if type( AirbaseNames ) == 'table' then
+    for AirbaseID, AirbaseName in pairs( AirbaseNames ) do
+      self:AddAirbase( AirbaseName )
+    end
+	else
+    local AirbaseName = AirbaseNames
+    self:AddAirbase( AirbaseName )
+	end
+	
+	self:HandleEvent( EVENTS.Birth, self.__.OnEventBirth )
+	
+  self.__.CleanUpScheduler = SCHEDULER:New( self, self.__.CleanUpSchedule, {}, 1, self.TimeInterval )
+
+  self:HandleEvent( EVENTS.EngineShutdown , self.__.EventAddForCleanUp )
+  self:HandleEvent( EVENTS.EngineStartup, self.__.EventAddForCleanUp )
+  self:HandleEvent( EVENTS.Hit, self.__.EventAddForCleanUp )
+  self:HandleEvent( EVENTS.PilotDead, self.__.OnEventCrash )
+  self:HandleEvent( EVENTS.Dead, self.__.OnEventCrash )
+  self:HandleEvent( EVENTS.Crash, self.__.OnEventCrash )
+	
+	return self
+end
+
+--- Adds an airbase to the airbase validation list.
+-- @param #CLEANUP_AIRBASE self
+-- @param #string AirbaseName
+-- @return #CLEANUP_AIRBASE
+function CLEANUP_AIRBASE:AddAirbase( AirbaseName )
+  self.__.Airbases[AirbaseName] = AIRBASE:FindByName( AirbaseName )
+  self:F({"Airbase:", AirbaseName, self.__.Airbases[AirbaseName]:GetDesc()})
+  
+  return self
+end
+
+--- Removes an airbase from the airbase validation list.
+-- @param #CLEANUP_AIRBASE self
+-- @param #string AirbaseName
+-- @return #CLEANUP_AIRBASE
+function CLEANUP_AIRBASE:RemoveAirbase( AirbaseName )
+  self.__.Airbases[AirbaseName] = nil
+  return self
+end
+
+--- Enables or disables the cleaning of missiles within the airbase zones.
+-- Airbase operations stop when a missile or bomb is dropped at a runway.
+-- Note that when this method is used, the airbase operations won't stop if
+-- the missile or bomb was cleaned within the airbase zone, which is 8km from the center of the airbase.
+-- However, there is a trade-off to make. Attacks on airbases won't be possible anymore if this method is used.
+-- Note, one can also use the method @{#CLEANUP_AIRBASE.RemoveAirbase}() to remove the airbase from the control process as a whole,
+-- when an enemy unit is near. That is also an option...
+-- @param #CLEANUP_AIRBASE self
+-- @param #string CleanMissiles (Default=true) If true, missiles fired are immediately destroyed. If false missiles are not controlled.
+-- @return #CLEANUP_AIRBASE
+function CLEANUP_AIRBASE:SetCleanMissiles( CleanMissiles )
+
+  if CleanMissiles then
+    self:HandleEvent( EVENTS.Shot, self.__.OnEventShot )
+  else
+    self:UnHandleEvent( EVENTS.Shot )
+  end
+end
+
+function CLEANUP_AIRBASE.__:IsInAirbase( Vec2 )
+
+  local InAirbase = false
+  for AirbaseName, Airbase in pairs( self.__.Airbases ) do
+    local Airbase = Airbase -- Wrapper.Airbase#AIRBASE
+    if Airbase:GetZone():IsVec2InZone( Vec2 ) then
+      InAirbase = true
+      break;
+    end
+  end
+  
+  return InAirbase
+end
+
+
+
+--- Destroys a @{Unit} from the simulator, but checks first if it is still existing!
+-- @param #CLEANUP_AIRBASE self
+-- @param Wrapper.Unit#UNIT CleanUpUnit The object to be destroyed.
+function CLEANUP_AIRBASE.__:DestroyUnit( CleanUpUnit )
+	self:F( { CleanUpUnit } )
+
+	if CleanUpUnit then
+	  local CleanUpUnitName = CleanUpUnit:GetName()
+		local CleanUpGroup = CleanUpUnit:GetGroup()
+    -- TODO Client bug in 1.5.3
+		if CleanUpGroup:IsAlive() then
+			local CleanUpGroupUnits = CleanUpGroup:GetUnits()
+			if #CleanUpGroupUnits == 1 then
+				local CleanUpGroupName = CleanUpGroup:GetName()
+				CleanUpGroup:Destroy()
+			else
+				CleanUpUnit:Destroy()
+			end
+			self.CleanUpList[CleanUpUnitName] = nil
+		end
+	end
+end
+
+
+
+--- Destroys a missile from the simulator, but checks first if it is still existing!
+-- @param #CLEANUP_AIRBASE self
+-- @param Dcs.DCSTypes#Weapon MissileObject
+function CLEANUP_AIRBASE.__:DestroyMissile( MissileObject )
+	self:F( { MissileObject } )
+  
+	if MissileObject and MissileObject:isExist() then
+		MissileObject:destroy()
+		self:T( "MissileObject Destroyed")
+	end
+end
+
+--- @param #CLEANUP_AIRBASE self
+-- @param Core.Event#EVENTDATA EventData
+function CLEANUP_AIRBASE.__:OnEventBirth( EventData )
+  self:F( { EventData } )
+  
+  self.CleanUpList[EventData.IniDCSUnitName] = {}
+  self.CleanUpList[EventData.IniDCSUnitName].CleanUpUnit = EventData.IniUnit
+  self.CleanUpList[EventData.IniDCSUnitName].CleanUpGroup = EventData.IniGroup
+  self.CleanUpList[EventData.IniDCSUnitName].CleanUpGroupName = EventData.IniDCSGroupName
+  self.CleanUpList[EventData.IniDCSUnitName].CleanUpUnitName = EventData.IniDCSUnitName
+
+end
+
+
+--- Detects if a crash event occurs.
+-- Crashed units go into a CleanUpList for removal.
+-- @param #CLEANUP_AIRBASE self
+-- @param Core.Event#EVENTDATA Event
+function CLEANUP_AIRBASE.__:OnEventCrash( Event )
+	self:F( { Event } )
+
+  --TODO: This stuff is not working due to a DCS bug. Burning units cannot be destroyed.
+	-- self:T("before getGroup")
+	-- local _grp = Unit.getGroup(event.initiator)-- Identify the group that fired 
+	-- self:T("after getGroup")
+	-- _grp:destroy()
+	-- self:T("after deactivateGroup")
+	-- event.initiator:destroy()
+
+  if Event.IniDCSUnitName and Event.IniCategory == Object.Category.UNIT then
+    self.CleanUpList[Event.IniDCSUnitName] = {}
+    self.CleanUpList[Event.IniDCSUnitName].CleanUpUnit = Event.IniUnit
+    self.CleanUpList[Event.IniDCSUnitName].CleanUpGroup = Event.IniGroup
+    self.CleanUpList[Event.IniDCSUnitName].CleanUpGroupName = Event.IniDCSGroupName
+    self.CleanUpList[Event.IniDCSUnitName].CleanUpUnitName = Event.IniDCSUnitName
+  end
+  
+end
+
+--- Detects if a unit shoots a missile.
+-- If this occurs within one of the airbases, then the weapon used must be destroyed.
+-- @param #CLEANUP_AIRBASE self
+-- @param Core.Event#EVENTDATA Event
+function CLEANUP_AIRBASE.__:OnEventShot( Event )
+	self:F( { Event } )
+
+	-- Test if the missile was fired within one of the CLEANUP_AIRBASE.AirbaseNames.
+	if self:IsInAirbase( Event.IniUnit:GetVec2() ) then
+		-- Okay, the missile was fired within the CLEANUP_AIRBASE.AirbaseNames, destroy the fired weapon.
+    self:DestroyMissile( Event.Weapon )
+	end
+end
+
+--- Detects if the Unit has an S_EVENT_HIT within the given AirbaseNames. If this is the case, destroy the unit.
+-- @param #CLEANUP_AIRBASE self
+-- @param Core.Event#EVENTDATA Event
+function CLEANUP_AIRBASE.__:OnEventHit( Event )
+	self:F( { Event } )
+
+	if Event.IniUnit then
+		if self:IsInAirbase( Event.IniUnit:GetVec2() ) then
+			self:T( { "Life: ", Event.IniDCSUnitName, ' = ',  Event.IniUnit:GetLife(), "/", Event.IniUnit:GetLife0() } )
+			if Event.IniUnit:GetLife() < Event.IniUnit:GetLife0() then
+				self:T( "CleanUp: Destroy: " .. Event.IniDCSUnitName )
+        CLEANUP_AIRBASE.__:DestroyUnit( Event.IniUnit )
+			end
+		end
+	end
+
+	if Event.TgtUnit then
+		if self:IsInAirbase( Event.TgtUnit:GetVec2() ) then
+			self:T( { "Life: ", Event.TgtDCSUnitName, ' = ', Event.TgtUnit:GetLife(), "/", Event.TgtUnit:GetLife0() } )
+			if Event.TgtUnit:GetLife() < Event.TgtUnit:GetLife0() then
+				self:T( "CleanUp: Destroy: " .. Event.TgtDCSUnitName )
+        CLEANUP_AIRBASE.__:DestroyUnit( Event.TgtUnit )
+			end
+		end
+	end
+end
+
+--- Add the @{DCSWrapper.Unit#Unit} to the CleanUpList for CleanUp.
+-- @param #CLEANUP_AIRBASE self
+-- @param Wrapper.Unit#UNIT CleanUpUnit
+-- @oaram #string CleanUpUnitName
+function CLEANUP_AIRBASE.__:AddForCleanUp( CleanUpUnit, CleanUpUnitName )
+	self:F( { CleanUpUnit, CleanUpUnitName } )
+
+	self.CleanUpList[CleanUpUnitName] = {}
+	self.CleanUpList[CleanUpUnitName].CleanUpUnit = CleanUpUnit
+	self.CleanUpList[CleanUpUnitName].CleanUpUnitName = CleanUpUnitName
+	
+	local CleanUpGroup = CleanUpUnit:GetGroup()
+	
+	self.CleanUpList[CleanUpUnitName].CleanUpGroup = CleanUpGroup
+	self.CleanUpList[CleanUpUnitName].CleanUpGroupName = CleanUpGroup:GetName()
+	self.CleanUpList[CleanUpUnitName].CleanUpTime = timer.getTime()
+	self.CleanUpList[CleanUpUnitName].CleanUpMoved = false
+
+	self:T( { "CleanUp: Add to CleanUpList: ", CleanUpGroup:GetName(), CleanUpUnitName } )
+	
+end
+
+--- Detects if the Unit has an S_EVENT_ENGINE_SHUTDOWN or an S_EVENT_HIT within the given AirbaseNames. If this is the case, add the Group to the CLEANUP_AIRBASE List.
+-- @param #CLEANUP_AIRBASE.__ self
+-- @param Core.Event#EVENTDATA Event
+function CLEANUP_AIRBASE.__:EventAddForCleanUp( Event )
+
+  self:F({Event})
+
+
+	if Event.IniDCSUnit and Event.IniCategory == Object.Category.UNIT then
+		if self.CleanUpList[Event.IniDCSUnitName] == nil then
+			if self:IsInAirbase( Event.IniUnit:GetVec2() ) then
+				self:AddForCleanUp( Event.IniUnit, Event.IniDCSUnitName )
+			end
+		end
+	end
+
+	if Event.TgtDCSUnit and Event.TgtCategory == Object.Category.UNIT then
+		if self.CleanUpList[Event.TgtDCSUnitName] == nil then
+			if self:IsInAirbase( Event.TgtUnit:GetVec2() ) then
+				self:AddForCleanUp( Event.TgtUnit, Event.TgtDCSUnitName )
+			end
+		end
+	end
+	
+end
+
+
+--- At the defined time interval, CleanUp the Groups within the CleanUpList.
+-- @param #CLEANUP_AIRBASE self
+function CLEANUP_AIRBASE.__:CleanUpSchedule()
+
+  local CleanUpCount = 0
+	for CleanUpUnitName, CleanUpListData in pairs( self.CleanUpList ) do
+	  CleanUpCount = CleanUpCount + 1
+	
+		local CleanUpUnit = CleanUpListData.CleanUpUnit -- Wrapper.Unit#UNIT
+		local CleanUpGroupName = CleanUpListData.CleanUpGroupName
+
+		if CleanUpUnit:IsAlive() ~= nil then
+
+			if _DATABASE:GetStatusGroup( CleanUpGroupName ) ~= "ReSpawn" then
+
+				local CleanUpCoordinate = CleanUpUnit:GetCoordinate()
+
+        self:T( { "CleanUp Scheduler", CleanUpUnitName } )
+        if CleanUpUnit:GetLife() <= CleanUpUnit:GetLife0() * 0.95 then
+					if CleanUpUnit:IsAboveRunway() then
+						if CleanUpUnit:InAir() then
+
+							local CleanUpLandHeight = CleanUpCoordinate:GetLandHeight()
+							local CleanUpUnitHeight = CleanUpCoordinate.y - CleanUpLandHeight
+							
+							if CleanUpUnitHeight < 100 then
+								self:T( { "CleanUp Scheduler", "Destroy " .. CleanUpUnitName .. " because below safe height and damaged." } )
+								self:DestroyUnit( CleanUpUnit )
+							end
+						else
+							self:T( { "CleanUp Scheduler", "Destroy " .. CleanUpUnitName .. " because on runway and damaged." } )
+							self:DestroyUnit( CleanUpUnit )
+						end
+					end
+				end
+				-- Clean Units which are waiting for a very long time in the CleanUpZone.
+				if CleanUpUnit then
+					local CleanUpUnitVelocity = CleanUpUnit:GetVelocityKMH()
+					if CleanUpUnitVelocity < 1 then
+						if CleanUpListData.CleanUpMoved then
+							if CleanUpListData.CleanUpTime + 180 <= timer.getTime() then
+								self:T( { "CleanUp Scheduler", "Destroy due to not moving anymore " .. CleanUpUnitName } )
+								self:DestroyUnit( CleanUpUnit )
+							end
+						end
+					else
+						CleanUpListData.CleanUpTime = timer.getTime()
+						CleanUpListData.CleanUpMoved = true
+					end
+				end
+				
+			else
+				-- Do nothing ...
+				self.CleanUpList[CleanUpUnitName] = nil
+			end
+		else
+			self:T( "CleanUp: Group " .. CleanUpUnitName .. " cannot be found in DCS RTE, removing ..." )
+			self.CleanUpList[CleanUpUnitName] = nil
+		end
+	end
+	self:T(CleanUpCount)
+	
+	return true
+end
+

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -1,13 +1,15 @@
---- Provides missile training functions.
+--- **Functional** -- MISSILETRAINER helps you to train missile avoidance.
+-- 
+-- ===
 --
--- @{#MISSILETRAINER} class
--- ========================
+-- 1) @{MissileTrainer#MISSILETRAINER} class, extends @{Base#BASE}
+-- ===
 -- The @{#MISSILETRAINER} class uses the DCS world messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
 -- the class will destroy the missile within a certain range, to avoid damage to your aircraft.
 -- It suports the following functionality:
 --
 --  * Track the missiles fired at you and other players, providing bearing and range information of the missiles towards the airplanes.
---  * Provide alerts of missile launches, including detailed information of the units launching, including bearing, range …
+--  * Provide alerts of missile launches, including detailed information of the units launching, including bearing, range <EFBFBD>
 --  * Provide alerts when a missile would have killed your aircraft.
 --  * Provide alerts when the missile self destructs.
 --  * Enable / Disable and Configure the Missile Trainer using the various menu options.
@@ -43,16 +45,16 @@
 --     * **200 meter**: Destroys the missile when the distance to the aircraft is below or equal to 200 meter.
 --   
 --
--- MISSILETRAINER construction methods:
--- ====================================
+-- 1.1) MISSILETRAINER construction methods:
+-- -----------------------------------------
 -- Create a new MISSILETRAINER object with the @{#MISSILETRAINER.New} method:
 --
 --   * @{#MISSILETRAINER.New}: Creates a new MISSILETRAINER object taking the maximum distance to your aircraft to evaluate when a missile needs to be destroyed.
 --
 -- MISSILETRAINER will collect each unit declared in the mission with a skill level "Client" and "Player", and will monitor the missiles shot at those.
 --
--- MISSILETRAINER initialization methods:
--- ======================================
+-- 1.2) MISSILETRAINER initialization methods:
+-- -------------------------------------------
 -- 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.
@@ -66,20 +68,87 @@
 --  * @{#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.
 --
+-- ===
+-- 
+-- CREDITS
+-- ===
+-- **Stuka (Danny)** Who you can search on the Eagle Dynamics Forums.
+-- Working together with Danny has resulted in the MISSILETRAINER class. 
+-- Danny has shared his ideas and together we made a design. 
+-- Together with the **476 virtual team**, we tested the MISSILETRAINER class, and got much positive feedback!
+-- 
 -- @module MissileTrainer
 -- @author FlightControl
 
 
-Include.File( "Client" )
-Include.File( "Scheduler" )
-
 --- The MISSILETRAINER class
 -- @type MISSILETRAINER
--- @extends Base#BASE
+-- @field Core.Set#SET_CLIENT DBClients
+-- @extends Core.Base#BASE
 MISSILETRAINER = {
   ClassName = "MISSILETRAINER",
+  TrackingMissiles = {},
 }
 
+function MISSILETRAINER._Alive( Client, self )
+
+  if self.Briefing then
+    Client:Message( self.Briefing, 15, "Trainer" )
+  end
+
+  if self.MenusOnOff == true then
+    Client:Message( "Use the 'Radio Menu' -> 'Other (F10)' -> 'Missile Trainer' menu options to change the Missile Trainer settings (for all players).", 15, "Trainer" )
+
+    Client.MainMenu = MENU_GROUP:New( Client:GetGroup(), "Missile Trainer", nil ) -- Menu#MENU_GROUP
+
+    Client.MenuMessages = MENU_GROUP:New( Client:GetGroup(), "Messages", Client.MainMenu )
+    Client.MenuOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Messages On", Client.MenuMessages, self._MenuMessages, { MenuSelf = self, MessagesOnOff = true } )
+    Client.MenuOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Messages Off", Client.MenuMessages, self._MenuMessages, { MenuSelf = self, MessagesOnOff = false } )
+
+    Client.MenuTracking = MENU_GROUP:New( Client:GetGroup(), "Tracking", Client.MainMenu )
+    Client.MenuTrackingToAll = MENU_GROUP_COMMAND:New( Client:GetGroup(), "To All", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingToAll = true } )
+    Client.MenuTrackingToTarget = MENU_GROUP_COMMAND:New( Client:GetGroup(), "To Target", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingToAll = false } )
+    Client.MenuTrackOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Tracking On", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingOnOff = true } )
+    Client.MenuTrackOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Tracking Off", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingOnOff = false } )
+    Client.MenuTrackIncrease = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Frequency Increase", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingFrequency = -1 } )
+    Client.MenuTrackDecrease = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Frequency Decrease", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingFrequency = 1 } )
+
+    Client.MenuAlerts = MENU_GROUP:New( Client:GetGroup(), "Alerts", Client.MainMenu )
+    Client.MenuAlertsToAll = MENU_GROUP_COMMAND:New( Client:GetGroup(), "To All", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsToAll = true } )
+    Client.MenuAlertsToTarget = MENU_GROUP_COMMAND:New( Client:GetGroup(), "To Target", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsToAll = false } )
+    Client.MenuHitsOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Hits On", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsHitsOnOff = true } )
+    Client.MenuHitsOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Hits Off", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsHitsOnOff = false } )
+    Client.MenuLaunchesOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Launches On", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsLaunchesOnOff = true } )
+    Client.MenuLaunchesOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Launches Off", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsLaunchesOnOff = false } )
+
+    Client.MenuDetails = MENU_GROUP:New( Client:GetGroup(), "Details", Client.MainMenu )
+    Client.MenuDetailsDistanceOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Range On", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsRangeOnOff = true } )
+    Client.MenuDetailsDistanceOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Range Off", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsRangeOnOff = false } )
+    Client.MenuDetailsBearingOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Bearing On", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsBearingOnOff = true } )
+    Client.MenuDetailsBearingOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Bearing Off", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsBearingOnOff = false } )
+
+    Client.MenuDistance = MENU_GROUP:New( Client:GetGroup(), "Set distance to plane", Client.MainMenu )
+    Client.MenuDistance50 = MENU_GROUP_COMMAND:New( Client:GetGroup(), "50 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 50 / 1000 } )
+    Client.MenuDistance100 = MENU_GROUP_COMMAND:New( Client:GetGroup(), "100 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 100 / 1000 } )
+    Client.MenuDistance150 = MENU_GROUP_COMMAND:New( Client:GetGroup(), "150 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 150 / 1000 } )
+    Client.MenuDistance200 = MENU_GROUP_COMMAND:New( Client:GetGroup(), "200 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 200 / 1000 } )
+  else
+    if Client.MainMenu then
+      Client.MainMenu:Remove()
+    end
+  end
+
+  local ClientID = Client:GetID()
+  self:T( ClientID )
+  if not self.TrackingMissiles[ClientID] then
+    self.TrackingMissiles[ClientID] = {}
+  end
+  self.TrackingMissiles[ClientID].Client = Client
+  if not self.TrackingMissiles[ClientID].MissileData then
+    self.TrackingMissiles[ClientID].MissileData = {}
+  end
+end
+
 --- Creates the main object which is handling missile tracking.
 -- When a missile is fired a SCHEDULER is set off that follows the missile. When near a certain a client player, the missile will be destroyed.
 -- @param #MISSILETRAINER self
@@ -102,80 +171,27 @@ function MISSILETRAINER:New( Distance, Briefing )
 
   self.Distance = Distance / 1000
 
-  _EVENTDISPATCHER:OnShot( self._EventShot, self )
+  self:HandleEvent( EVENTS.Shot )
 
-  self.DB = DATABASE:New():FilterStart()
-  self.DBClients = self.DB.Clients
-  self.DBUnits = self.DB.Units
-
-  for ClientID, Client in pairs( self.DBClients ) do
-
-    local function _Alive( Client )
-
-      if self.Briefing then
-        Client:Message( self.Briefing, 15, "HELLO WORLD", "Trainer" )
-      end
-
-      if self.MenusOnOff == true then
-        Client:Message( "Use the 'Radio Menu' -> 'Other (F10)' -> 'Missile Trainer' menu options to change the Missile Trainer settings (for all players).", 15, "MENU", "Trainer" )
-  
-        Client.MainMenu = MENU_CLIENT:New( Client, "Missile Trainer", nil ) -- Menu#MENU_CLIENT
-  
-        Client.MenuMessages = MENU_CLIENT:New( Client, "Messages", Client.MainMenu )
-        Client.MenuOn = MENU_CLIENT_COMMAND:New( Client, "Messages On", Client.MenuMessages, self._MenuMessages, { MenuSelf = self, MessagesOnOff = true } )
-        Client.MenuOff = MENU_CLIENT_COMMAND:New( Client, "Messages Off", Client.MenuMessages, self._MenuMessages, { MenuSelf = self, MessagesOnOff = false } )
-  
-        Client.MenuTracking = MENU_CLIENT:New( Client, "Tracking", Client.MainMenu )
-        Client.MenuTrackingToAll = MENU_CLIENT_COMMAND:New( Client, "To All", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingToAll = true } )
-        Client.MenuTrackingToTarget = MENU_CLIENT_COMMAND:New( Client, "To Target", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingToAll = false } )
-        Client.MenuTrackOn = MENU_CLIENT_COMMAND:New( Client, "Tracking On", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingOnOff = true } )
-        Client.MenuTrackOff = MENU_CLIENT_COMMAND:New( Client, "Tracking Off", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingOnOff = false } )
-        Client.MenuTrackIncrease = MENU_CLIENT_COMMAND:New( Client, "Frequency Increase", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingFrequency = -1 } )
-        Client.MenuTrackDecrease = MENU_CLIENT_COMMAND:New( Client, "Frequency Decrease", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingFrequency = 1 } )
-  
-        Client.MenuAlerts = MENU_CLIENT:New( Client, "Alerts", Client.MainMenu )
-        Client.MenuAlertsToAll = MENU_CLIENT_COMMAND:New( Client, "To All", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsToAll = true } )
-        Client.MenuAlertsToTarget = MENU_CLIENT_COMMAND:New( Client, "To Target", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsToAll = false } )
-        Client.MenuHitsOn = MENU_CLIENT_COMMAND:New( Client, "Hits On", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsHitsOnOff = true } )
-        Client.MenuHitsOff = MENU_CLIENT_COMMAND:New( Client, "Hits Off", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsHitsOnOff = false } )
-        Client.MenuLaunchesOn = MENU_CLIENT_COMMAND:New( Client, "Launches On", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsLaunchesOnOff = true } )
-        Client.MenuLaunchesOff = MENU_CLIENT_COMMAND:New( Client, "Launches Off", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsLaunchesOnOff = false } )
-  
-        Client.MenuDetails = MENU_CLIENT:New( Client, "Details", Client.MainMenu )
-        Client.MenuDetailsDistanceOn = MENU_CLIENT_COMMAND:New( Client, "Range On", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsRangeOnOff = true } )
-        Client.MenuDetailsDistanceOff = MENU_CLIENT_COMMAND:New( Client, "Range Off", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsRangeOnOff = false } )
-        Client.MenuDetailsBearingOn = MENU_CLIENT_COMMAND:New( Client, "Bearing On", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsBearingOnOff = true } )
-        Client.MenuDetailsBearingOff = MENU_CLIENT_COMMAND:New( Client, "Bearing Off", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsBearingOnOff = false } )
-  
-        Client.MenuDistance = MENU_CLIENT:New( Client, "Set distance to plane", Client.MainMenu )
-        Client.MenuDistance50 = MENU_CLIENT_COMMAND:New( Client, "50 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 50 / 1000 } )
-        Client.MenuDistance100 = MENU_CLIENT_COMMAND:New( Client, "100 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 100 / 1000 } )
-        Client.MenuDistance150 = MENU_CLIENT_COMMAND:New( Client, "150 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 150 / 1000 } )
-        Client.MenuDistance200 = MENU_CLIENT_COMMAND:New( Client, "200 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 200 / 1000 } )
-      else
-        if Client.MainMenu then
-          Client.MainMenu:Remove()
-        end
-      end
+  self.DBClients = SET_CLIENT:New():FilterStart()
 
 
-      local ClientID = Client:GetID()
-      self:T( ClientID )
-      if not self.TrackingMissiles[ClientID] then
-        self.TrackingMissiles[ClientID] = {}
-      end
-      self.TrackingMissiles[ClientID].Client = Client
-      if not self.TrackingMissiles[ClientID].MissileData then
-        self.TrackingMissiles[ClientID].MissileData = {}
-      end
+--  for ClientID, Client in pairs( self.DBClients.Database ) do
+--      self:F( "ForEach:" .. Client.UnitName )
+--      Client:Alive( self._Alive, self )
+--  end
+--  
+  self.DBClients:ForEachClient( 
+    function( Client )
+      self:F( "ForEach:" .. Client.UnitName )
+      Client:Alive( self._Alive, self )
     end
+  )
+
 
-    Client:Alive( _Alive )
 
-  end
-  
 --  	self.DB:ForEachClient(
---  	 --- @param Client#CLIENT Client
+--  	 --- @param Wrapper.Client#CLIENT Client
 --  	 function( Client )
 --  
 --        ... actions ...
@@ -208,6 +224,7 @@ end
 -- Initialization methods.
 
 
+
 --- Sets by default the display of any message to be ON or OFF.
 -- @param #MISSILETRAINER self
 -- @param #boolean MessagesOnOff true or false
@@ -217,9 +234,9 @@ function MISSILETRAINER:InitMessagesOnOff( MessagesOnOff )
 
   self.MessagesOnOff = MessagesOnOff
   if self.MessagesOnOff == true then
-    MESSAGE:New( "Messages ON", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Messages ON", 15, "Menu" ):ToAll()
   else
-    MESSAGE:New( "Messages OFF", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Messages OFF", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -234,9 +251,9 @@ function MISSILETRAINER:InitTrackingToAll( TrackingToAll )
 
   self.TrackingToAll = TrackingToAll
   if self.TrackingToAll == true then
-    MESSAGE:New( "Missile tracking to all players ON", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Missile tracking to all players ON", 15, "Menu" ):ToAll()
   else
-    MESSAGE:New( "Missile tracking to all players OFF", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Missile tracking to all players OFF", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -251,9 +268,9 @@ function MISSILETRAINER:InitTrackingOnOff( TrackingOnOff )
 
   self.TrackingOnOff = TrackingOnOff
   if self.TrackingOnOff == true then
-    MESSAGE:New( "Missile tracking ON", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Missile tracking ON", 15, "Menu" ):ToAll()
   else
-    MESSAGE:New( "Missile tracking OFF", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Missile tracking OFF", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -272,7 +289,7 @@ function MISSILETRAINER:InitTrackingFrequency( TrackingFrequency )
     self.TrackingFrequency = 0.5
   end
   if self.TrackingFrequency then
-    MESSAGE:New( "Missile tracking frequency is " .. self.TrackingFrequency .. " seconds.", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Missile tracking frequency is " .. self.TrackingFrequency .. " seconds.", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -287,9 +304,9 @@ function MISSILETRAINER:InitAlertsToAll( AlertsToAll )
 
   self.AlertsToAll = AlertsToAll
   if self.AlertsToAll == true then
-    MESSAGE:New( "Alerts to all players ON", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Alerts to all players ON", 15, "Menu" ):ToAll()
   else
-    MESSAGE:New( "Alerts to all players OFF", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Alerts to all players OFF", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -304,9 +321,9 @@ function MISSILETRAINER:InitAlertsHitsOnOff( AlertsHitsOnOff )
 
   self.AlertsHitsOnOff = AlertsHitsOnOff
   if self.AlertsHitsOnOff == true then
-    MESSAGE:New( "Alerts Hits ON", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Alerts Hits ON", 15, "Menu" ):ToAll()
   else
-    MESSAGE:New( "Alerts Hits OFF", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Alerts Hits OFF", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -321,9 +338,9 @@ function MISSILETRAINER:InitAlertsLaunchesOnOff( AlertsLaunchesOnOff )
 
   self.AlertsLaunchesOnOff = AlertsLaunchesOnOff
   if self.AlertsLaunchesOnOff == true then
-    MESSAGE:New( "Alerts Launches ON", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Alerts Launches ON", 15, "Menu" ):ToAll()
   else
-    MESSAGE:New( "Alerts Launches OFF", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Alerts Launches OFF", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -338,9 +355,9 @@ function MISSILETRAINER:InitRangeOnOff( DetailsRangeOnOff )
 
   self.DetailsRangeOnOff = DetailsRangeOnOff
   if self.DetailsRangeOnOff == true then
-    MESSAGE:New( "Range display ON", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Range display ON", 15, "Menu" ):ToAll()
   else
-    MESSAGE:New( "Range display OFF", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Range display OFF", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -355,9 +372,9 @@ function MISSILETRAINER:InitBearingOnOff( DetailsBearingOnOff )
 
   self.DetailsBearingOnOff = DetailsBearingOnOff
   if self.DetailsBearingOnOff == true then
-    MESSAGE:New( "Bearing display OFF", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Bearing display OFF", 15, "Menu" ):ToAll()
   else
-    MESSAGE:New( "Bearing display OFF", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Bearing display OFF", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -372,9 +389,9 @@ function MISSILETRAINER:InitMenusOnOff( MenusOnOff )
 
   self.MenusOnOff = MenusOnOff
   if self.MenusOnOff == true then
-    MESSAGE:New( "Menus are ENABLED (only when a player rejoins a slot)", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Menus are ENABLED (only when a player rejoins a slot)", 15, "Menu" ):ToAll()
   else
-    MESSAGE:New( "Menus are DISABLED", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Menus are DISABLED", 15, "Menu" ):ToAll()
   end
 
   return self
@@ -425,60 +442,69 @@ function MISSILETRAINER._MenuMessages( MenuParameters )
 
   if MenuParameters.Distance ~= nil then
     self.Distance = MenuParameters.Distance
-    MESSAGE:New( "Hit detection distance set to " .. self.Distance .. " meters", "Menu", 15, "ID" ):ToAll()
+    MESSAGE:New( "Hit detection distance set to " .. ( self.Distance * 1000 ) .. " meters", 15, "Menu" ):ToAll()
   end
 
 end
 
 --- Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.
 -- @param #MISSILETRAINER self
--- @param Event#EVENTDATA Event
-function MISSILETRAINER:_EventShot( Event )
-  self:F( { Event } )
+-- @param Core.Event#EVENTDATA EventData
+function MISSILETRAINER:OnEventShot( EVentData )
+  self:F( { EVentData } )
 
-  local TrainerSourceDCSUnit = Event.IniDCSUnit
-  local TrainerSourceDCSUnitName = Event.IniDCSUnitName
-  local TrainerWeapon = Event.Weapon -- Identify the weapon fired
-  local TrainerWeaponName = Event.WeaponName	-- return weapon type
+  local TrainerSourceDCSUnit = EVentData.IniDCSUnit
+  local TrainerSourceDCSUnitName = EVentData.IniDCSUnitName
+  local TrainerWeapon = EVentData.Weapon -- Identify the weapon fired
+  local TrainerWeaponName = EVentData.WeaponName	-- return weapon type
 
   self:T( "Missile Launched = " .. TrainerWeaponName )
 
   local TrainerTargetDCSUnit = TrainerWeapon:getTarget() -- Identify target
-  local TrainerTargetDCSUnitName = Unit.getName( TrainerTargetDCSUnit )
-  local TrainerTargetSkill =  _DATABASE.Templates.Units[TrainerTargetDCSUnitName].Template.skill
-
-  self:T(TrainerTargetDCSUnitName )
-
-  local Client = self.DBClients[TrainerTargetDCSUnitName]
-  if Client then
-
-    local TrainerSourceUnit = UNIT:Find( TrainerSourceDCSUnit )
-    local TrainerTargetUnit = UNIT:Find( TrainerTargetDCSUnit )
-
-    if self.MessagesOnOff == true and self.AlertsLaunchesOnOff == true then
-
-      local Message = MESSAGE:New(
-        string.format( "%s launched a %s",
-          TrainerSourceUnit:GetTypeName(),
-          TrainerWeaponName
-        ) .. self:_AddRange( Client, TrainerWeapon ) .. self:_AddBearing( Client, TrainerWeapon ),"Launch Alert", 5, "ID" )
-
-      if self.AlertsToAll then
-        Message:ToAll()
-      else
-        Message:ToClient( Client )
+  if TrainerTargetDCSUnit then
+    local TrainerTargetDCSUnitName = Unit.getName( TrainerTargetDCSUnit )
+    local TrainerTargetSkill =  _DATABASE.Templates.Units[TrainerTargetDCSUnitName].Template.skill
+  
+    self:T(TrainerTargetDCSUnitName )
+  
+    local Client = self.DBClients:FindClient( TrainerTargetDCSUnitName )
+    if Client then
+  
+      local TrainerSourceUnit = UNIT:Find( TrainerSourceDCSUnit )
+      local TrainerTargetUnit = UNIT:Find( TrainerTargetDCSUnit )
+  
+      if self.MessagesOnOff == true and self.AlertsLaunchesOnOff == true then
+  
+        local Message = MESSAGE:New(
+          string.format( "%s launched a %s",
+            TrainerSourceUnit:GetTypeName(),
+            TrainerWeaponName
+          ) .. self:_AddRange( Client, TrainerWeapon ) .. self:_AddBearing( Client, TrainerWeapon ), 5, "Launch Alert" )
+  
+        if self.AlertsToAll then
+          Message:ToAll()
+        else
+          Message:ToClient( Client )
+        end
       end
+  
+      local ClientID = Client:GetID()
+      self:T( ClientID )
+      local MissileData = {}
+      MissileData.TrainerSourceUnit = TrainerSourceUnit
+      MissileData.TrainerWeapon = TrainerWeapon
+      MissileData.TrainerTargetUnit = TrainerTargetUnit
+      MissileData.TrainerWeaponTypeName = TrainerWeapon:getTypeName()
+      MissileData.TrainerWeaponLaunched = true
+      table.insert( self.TrackingMissiles[ClientID].MissileData, MissileData )
+      --self:T( self.TrackingMissiles )
     end
-
-    local ClientID = Client:GetID()
-    local MissileData = {}
-    MissileData.TrainerSourceUnit = TrainerSourceUnit
-    MissileData.TrainerWeapon = TrainerWeapon
-    MissileData.TrainerTargetUnit = TrainerTargetUnit
-    MissileData.TrainerWeaponTypeName = TrainerWeapon:getTypeName()
-    MissileData.TrainerWeaponLaunched = true
-    table.insert( self.TrackingMissiles[ClientID].MissileData, MissileData )
-    --self:T( self.TrackingMissiles )
+  else
+     -- TODO: some weapons don't know the target unit... Need to develop a workaround for this.
+ if ( TrainerWeapon:getTypeName() == "9M311" ) then
+		SCHEDULER:New( TrainerWeapon, TrainerWeapon.destroy, {}, 1 )
+		else
+		end
   end
 end
 
@@ -489,11 +515,11 @@ function MISSILETRAINER:_AddRange( Client, TrainerWeapon )
   if self.DetailsRangeOnOff then
 
     local PositionMissile = TrainerWeapon:getPoint()
-    local PositionTarget = Client:GetPointVec3()
+    local TargetVec3 = Client:GetVec3()
 
-    local Range = ( ( PositionMissile.x - PositionTarget.x )^2 +
-      ( PositionMissile.y - PositionTarget.y )^2 +
-      ( PositionMissile.z - PositionTarget.z )^2
+    local Range = ( ( PositionMissile.x - TargetVec3.x )^2 +
+      ( PositionMissile.y - TargetVec3.y )^2 +
+      ( PositionMissile.z - TargetVec3.z )^2
       ) ^ 0.5 / 1000
 
     RangeText = string.format( ", at %4.2fkm", Range )
@@ -509,11 +535,11 @@ function MISSILETRAINER:_AddBearing( Client, TrainerWeapon )
   if self.DetailsBearingOnOff then
 
     local PositionMissile = TrainerWeapon:getPoint()
-    local PositionTarget = Client:GetPointVec3()
+    local TargetVec3 = Client:GetVec3()
 
-    self:T2( { PositionTarget, PositionMissile })
+    self:T2( { TargetVec3, PositionMissile })
 
-    local DirectionVector = { x = PositionMissile.x - PositionTarget.x, y = PositionMissile.y - PositionTarget.y, z = PositionMissile.z - PositionTarget.z }
+    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
@@ -544,72 +570,76 @@ function MISSILETRAINER:_TrackMissiles()
   for ClientDataID, ClientData in pairs( self.TrackingMissiles ) do
 
     local Client = ClientData.Client
-    self:T2( { Client:GetName() } )
+    
+    if Client and Client:IsAlive() then
 
-    for MissileDataID, MissileData in pairs( ClientData.MissileData ) do
-      self:T3( MissileDataID )
-
-      local TrainerSourceUnit = MissileData.TrainerSourceUnit
-      local TrainerWeapon = MissileData.TrainerWeapon
-      local TrainerTargetUnit = MissileData.TrainerTargetUnit
-      local TrainerWeaponTypeName = MissileData.TrainerWeaponTypeName
-      local TrainerWeaponLaunched = MissileData.TrainerWeaponLaunched
+      for MissileDataID, MissileData in pairs( ClientData.MissileData ) do
+        self:T3( MissileDataID )
   
-      if Client and Client:IsAlive() and TrainerSourceUnit and TrainerSourceUnit:IsAlive() and TrainerWeapon and TrainerWeapon:isExist() and TrainerTargetUnit and TrainerTargetUnit:IsAlive() then
-        local PositionMissile = TrainerWeapon:getPosition().p
-        local PositionTarget = Client:GetPointVec3()
-  
-        local Distance = ( ( PositionMissile.x - PositionTarget.x )^2 +
-          ( PositionMissile.y - PositionTarget.y )^2 +
-          ( PositionMissile.z - PositionTarget.z )^2
-          ) ^ 0.5 / 1000
-  
-        if Distance <= self.Distance then
-          -- Hit alert
-          TrainerWeapon:destroy()
-          if self.MessagesOnOff == true and self.AlertsHitsOnOff == true then
-  
-            self:T( "killed" )
-  
-            local Message = MESSAGE:New(
-              string.format( "%s launched by %s killed %s",
-                TrainerWeapon:getTypeName(),
-                TrainerSourceUnit:GetTypeName(),
-                TrainerTargetUnit:GetPlayerName()
-              ),"Hit Alert", 15, "ID" )
-  
-            if self.AlertsToAll == true then
-              Message:ToAll()
-            else
-              Message:ToClient( Client )
+        local TrainerSourceUnit = MissileData.TrainerSourceUnit
+        local TrainerWeapon = MissileData.TrainerWeapon
+        local TrainerTargetUnit = MissileData.TrainerTargetUnit
+        local TrainerWeaponTypeName = MissileData.TrainerWeaponTypeName
+        local TrainerWeaponLaunched = MissileData.TrainerWeaponLaunched
+    
+        if Client and Client:IsAlive() and TrainerSourceUnit and TrainerSourceUnit:IsAlive() and TrainerWeapon and TrainerWeapon:isExist() and TrainerTargetUnit and TrainerTargetUnit:IsAlive() then
+          local PositionMissile = TrainerWeapon:getPosition().p
+          local TargetVec3 = Client:GetVec3()
+    
+          local Distance = ( ( PositionMissile.x - TargetVec3.x )^2 +
+            ( PositionMissile.y - TargetVec3.y )^2 +
+            ( PositionMissile.z - TargetVec3.z )^2
+            ) ^ 0.5 / 1000
+    
+          if Distance <= self.Distance then
+            -- Hit alert
+            TrainerWeapon:destroy()
+            if self.MessagesOnOff == true and self.AlertsHitsOnOff == true then
+    
+              self:T( "killed" )
+    
+              local Message = MESSAGE:New(
+                string.format( "%s launched by %s killed %s",
+                  TrainerWeapon:getTypeName(),
+                  TrainerSourceUnit:GetTypeName(),
+                  TrainerTargetUnit:GetPlayerName()
+                ), 15, "Hit Alert" )
+    
+              if self.AlertsToAll == true then
+                Message:ToAll()
+              else
+                Message:ToClient( Client )
+              end
+    
+              MissileData = nil
+              table.remove( ClientData.MissileData, MissileDataID )
+              self:T(ClientData.MissileData)
+            end
+          end
+        else
+          if not ( TrainerWeapon and TrainerWeapon:isExist() ) then
+            if self.MessagesOnOff == true and self.AlertsLaunchesOnOff == true then
+              -- Weapon does not exist anymore. Delete from Table
+              local Message = MESSAGE:New(
+                string.format( "%s launched by %s self destructed!",
+                  TrainerWeaponTypeName,
+                  TrainerSourceUnit:GetTypeName()
+                ), 5, "Tracking" )
+    
+              if self.AlertsToAll == true then
+                Message:ToAll()
+              else
+                Message:ToClient( Client )
+              end
             end
-  
             MissileData = nil
             table.remove( ClientData.MissileData, MissileDataID )
-            self:T(ClientData.MissileData)
+            self:T( ClientData.MissileData )
           end
         end
-      else
-        if not ( TrainerWeapon and TrainerWeapon:isExist() ) then
-          if self.MessagesOnOff == true and self.AlertsLaunchesOnOff == true then
-            -- Weapon does not exist anymore. Delete from Table
-            local Message = MESSAGE:New(
-              string.format( "%s launched by %s self destructed!",
-                TrainerWeaponTypeName,
-                TrainerSourceUnit:GetTypeName()
-              ),"Tracking", 5, "ID" )
-  
-            if self.AlertsToAll == true then
-              Message:ToAll()
-            else
-              Message:ToClient( Client )
-            end
-          end
-          MissileData = nil
-          table.remove( ClientData.MissileData, MissileDataID )
-          self:T( ClientData.MissileData )
-        end
       end
+    else
+      self.TrackingMissiles[ClientDataID] = nil
     end
   end
 
@@ -625,7 +655,7 @@ function MISSILETRAINER:_TrackMissiles()
     for ClientDataID, ClientData in pairs( self.TrackingMissiles ) do
   
       local Client = ClientData.Client
-      self:T2( { Client:GetName() } )
+      --self:T2( { Client:GetName() } )
   
   
       ClientData.MessageToClient = ""
@@ -635,7 +665,7 @@ function MISSILETRAINER:_TrackMissiles()
       for TrackingDataID, TrackingData in pairs( self.TrackingMissiles ) do
   
         for MissileDataID, MissileData in pairs( TrackingData.MissileData ) do
-          self:T3( MissileDataID )
+          --self:T3( MissileDataID )
   
           local TrainerSourceUnit = MissileData.TrainerSourceUnit
           local TrainerWeapon = MissileData.TrainerWeapon
@@ -671,7 +701,7 @@ function MISSILETRAINER:_TrackMissiles()
   
       -- Once the Player Client and the Other Player Client tracking messages are prepared, show them.
       if ClientData.MessageToClient ~= "" or ClientData.MessageToAll ~= "" then
-        local Message = MESSAGE:New( ClientData.MessageToClient .. ClientData.MessageToAll, "Tracking", 1, "ID" ):ToClient( Client )
+        local Message = MESSAGE:New( ClientData.MessageToClient .. ClientData.MessageToAll, 1, "Tracking" ):ToClient( Client )
       end
     end
   end

Moose Development/Moose/Functional/Movement.lua

@@ -1,14 +1,17 @@
---- Limit the simultaneous movement of Groups within a running Mission.
+--- **Functional** -- Limit the MOVEMENT of simulaneous moving ground vehicles.
+-- 
+-- ===
+--  
+-- Limit the simultaneous movement of Groups within a running Mission.
 -- This module is defined to improve the performance in missions, and to bring additional realism for GROUND vehicles.
 -- Performance: If in a DCSRTE there are a lot of moving GROUND units, then in a multi player mission, this WILL create lag if
 -- the main DCS execution core of your CPU is fully utilized. So, this class will limit the amount of simultaneous moving GROUND units
 -- on defined intervals (currently every minute).
--- @module MOVEMENT
-
-Include.File( "Routines" )
+-- @module Movement
 
 --- the MOVEMENT class
--- @type
+-- @type MOVEMENT
+-- @extends Core.Base#BASE
 MOVEMENT = {
 	ClassName = "MOVEMENT",
 }
@@ -22,7 +25,7 @@ MOVEMENT = {
 -- Movement_US_Platoons = MOVEMENT:New( { 'US Tank Platoon Left', 'US Tank Platoon Middle', 'US Tank Platoon Right', 'US CH-47D Troops' }, 15 )
 
 function MOVEMENT:New( MovePrefixes, MoveMaximum )
-	local self = BASE:Inherit( self, BASE:New() )
+	local self = BASE:Inherit( self, BASE:New() ) -- #MOVEMENT
 	self:F( { MovePrefixes, MoveMaximum } )
   
 	if type( MovePrefixes ) == 'table' then
@@ -35,7 +38,7 @@ function MOVEMENT:New( MovePrefixes, MoveMaximum )
 	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.
 	
-	_EVENTDISPATCHER:OnBirth( self.OnBirth, self )
+	self:HandleEvent( EVENTS.Birth )
 	
 --	self:AddEvent( world.event.S_EVENT_BIRTH, self.OnBirth )
 --	
@@ -49,7 +52,8 @@ 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 = routines.scheduleFunction( self._Scheduler, { self }, timer.getTime() + 1, 120 )
+  self.MoveFunction = SCHEDULER:New( self, self._Scheduler, {}, 1, 120 )
 end
 
 --- Call this function to stop the MOVEMENT scheduling.
@@ -61,24 +65,26 @@ 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.
-function MOVEMENT:OnBirth( Event )
-	self:F( { Event } )
+-- @param #MOVEMENT self
+-- @param Core.Event#EVENTDATA self
+function MOVEMENT:OnEventBirth( EventData )
+	self:F( { EventData } )
 
 	if timer.getTime0() < timer.getAbsTime() then -- dont need to add units spawned in at the start of the mission if mist is loaded in init line
-		if Event.IniDCSUnit then
-			self:T( "Birth object : " .. Event.IniDCSUnitName )
-			if Event.IniDCSGroup and Event.IniDCSGroup:isExist() then
+		if EventData.IniDCSUnit then
+			self:T( "Birth object : " .. EventData.IniDCSUnitName )
+			if EventData.IniDCSGroup and EventData.IniDCSGroup:isExist() then
 				for MovePrefixID, MovePrefix in pairs( self.MovePrefixes ) do
-					if string.find( Event.IniDCSUnitName, MovePrefix, 1, true ) then
+					if string.find( EventData.IniDCSUnitName, MovePrefix, 1, true ) then
 						self.AliveUnits = self.AliveUnits + 1
-						self.MoveUnits[Event.IniDCSUnitName] = Event.IniDCSGroupName
+						self.MoveUnits[EventData.IniDCSUnitName] = EventData.IniDCSGroupName
 						self:T( self.AliveUnits )
 					end
 				end
 			end
 		end
-		_EVENTDISPATCHER:OnCrashForUnit( Event.IniDCSUnitName, self.OnDeadOrCrash, self )
-    _EVENTDISPATCHER:OnDeadForUnit( Event.IniDCSUnitName, self.OnDeadOrCrash, self )
+		
+		EventData.IniUnit:HandleEvent( EVENTS.DEAD, self.OnDeadOrCrash )
 	end
 
 end
@@ -125,4 +131,5 @@ function MOVEMENT:_Scheduler()
 			end
 		end
 	end
+	return true
 end

Moose Development/Moose/Functional/Protect.lua

@@ -0,0 +1,305 @@
+--- **Functional** -- The PROTECT class handles the protection of objects, which can be zones, units, scenery.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- ### Contributions: **MillerTime**
+-- 
+-- ===
+-- 
+-- @module Protect
+
+--- @type PROTECT.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-)
+-- @extends Core.Fsm#FSM
+
+--- @type PROTECT
+-- @extends #PROTECT.__
+
+--- # PROTECT, extends @{Base#BASE}
+-- 
+-- @field #PROTECT
+PROTECT = {
+  ClassName = "PROTECT",
+}
+
+--- Get the ProtectZone
+-- @param #PROTECT self
+-- @return Core.Zone#ZONE_BASE
+function PROTECT:GetProtectZone()
+  return self.ProtectZone
+end
+
+
+--- Get the name of the ProtectZone
+-- @param #PROTECT self
+-- @return #string
+function PROTECT:GetProtectZoneName()
+  return self.ProtectZone:GetName()
+end
+
+
+--- Set the owning coalition of the zone.
+-- @param #PROTECT self
+-- @param DCSCoalition.DCSCoalition#coalition Coalition
+function PROTECT:SetCoalition( Coalition )
+  self.Coalition = Coalition
+end
+
+
+--- Get the owning coalition of the zone.
+-- @param #PROTECT self
+-- @return DCSCoalition.DCSCoalition#coalition Coalition.
+function PROTECT:GetCoalition()
+  return self.Coalition
+end
+
+
+--- Get the owning coalition name of the zone.
+-- @param #PROTECT self
+-- @return #string Coalition name.
+function PROTECT:GetCoalitionName()
+
+  if self.Coalition == coalition.side.BLUE then
+    return "Blue"
+  end
+  
+  if self.Coalition == coalition.side.RED then
+    return "Red"
+  end
+  
+  if self.Coalition == coalition.side.NEUTRAL then
+    return "Neutral"
+  end
+  
+  return ""
+end
+
+
+function PROTECT:IsGuarded()
+
+  local IsGuarded = self.ProtectZone:IsAllInZoneOfCoalition( self.Coalition )
+  self:F( { IsGuarded = IsGuarded } )
+  return IsGuarded
+end
+
+function PROTECT:IsCaptured()
+
+  local IsCaptured = self.ProtectZone:IsAllInZoneOfOtherCoalition( self.Coalition )
+  self:F( { IsCaptured = IsCaptured } )
+  return IsCaptured
+end
+
+
+function PROTECT:IsAttacked()
+
+  local IsAttacked = self.ProtectZone:IsSomeInZoneOfCoalition( self.Coalition )
+  self:F( { IsAttacked = IsAttacked } )
+  return IsAttacked
+end
+
+
+function PROTECT:IsEmpty()
+
+  local IsEmpty = self.ProtectZone:IsNoneInZone()
+  self:F( { IsEmpty = IsEmpty } )
+  return IsEmpty
+end
+
+
+--- Check if the units are still alive.
+-- @param #PROTECT self
+function PROTECT:AreProtectUnitsAlive()
+
+  local IsAlive = false
+  
+  local UnitSet = self.ProtectUnitSet
+  UnitSet:Flush( self )
+  local UnitList = UnitSet:GetSet()
+  
+  for UnitID, ProtectUnit in pairs( UnitList ) do
+    local IsUnitAlive = ProtectUnit:IsAlive()
+    if IsUnitAlive == true then
+      IsAlive = true
+      break
+    end
+  end
+  
+  return IsAlive
+end
+
+--- Check if the statics are still alive.
+-- @param #PROTECT self
+function PROTECT:AreProtectStaticsAlive()
+
+  local IsAlive = false
+  
+  local StaticSet = self.ProtectStaticSet
+  StaticSet:Flush( self )
+  local StaticList = StaticSet:GetSet()
+  
+  for UnitID, ProtectStatic in pairs( StaticList ) do
+    local IsStaticAlive = ProtectStatic:IsAlive()
+    if IsStaticAlive == true then
+      IsAlive = true
+      break
+    end
+  end
+  
+  return IsAlive
+end
+
+
+--- Check if there is a capture unit in the zone.
+-- @param #PROTECT self
+function PROTECT:IsCaptureUnitInZone()
+
+  local CaptureUnitSet = self.CaptureUnitSet
+  CaptureUnitSet:Flush( self )
+
+  local IsInZone = self.CaptureUnitSet:IsPartiallyInZone( self.ProtectZone )
+  
+  self:F({IsInZone = IsInZone})
+  
+  return IsInZone
+end
+
+--- Smoke.
+-- @param #PROTECT self
+-- @param #SMOKECOLOR.Color SmokeColor
+function PROTECT:Smoke( SmokeColor )
+
+  self.SmokeColor = SmokeColor
+end
+  
+
+--- Flare.
+-- @param #PROTECT self
+-- @param #SMOKECOLOR.Color FlareColor
+function PROTECT:Flare( FlareColor )
+  self.ProtectZone:FlareZone( FlareColor, math.random( 1, 360 ) )
+end
+  
+
+--- Mark.
+-- @param #PROTECT self
+function PROTECT:Mark()
+
+  local Coord = self.ProtectZone:GetCoordinate()
+  local ZoneName = self:GetProtectZoneName()
+  local State = self:GetState()
+  
+  if self.MarkRed and self.MarkBlue then
+    self:F( { MarkRed = self.MarkRed, MarkBlue = self.MarkBlue } )
+    Coord:RemoveMark( self.MarkRed )
+    Coord:RemoveMark( self.MarkBlue )
+  end
+  
+  if self.Coalition == coalition.side.BLUE then
+    self.MarkBlue = Coord:MarkToCoalitionBlue( "Guard Zone: " .. ZoneName .. "\nStatus: " .. State )  
+    self.MarkRed = Coord:MarkToCoalitionRed( "Capture Zone: " .. ZoneName .. "\nStatus: " .. State )  
+  else
+    self.MarkRed = Coord:MarkToCoalitionRed( "Guard Zone: " .. ZoneName .. "\nStatus: " .. State )  
+    self.MarkBlue = Coord:MarkToCoalitionBlue( "Capture Zone: " .. ZoneName .. "\nStatus: " .. State )  
+  end
+end
+
+
+--- Bound.
+-- @param #PROTECT self
+function PROTECT:onafterStart()
+
+  self:ScheduleRepeat( 5, 15, 0.1, nil, self.StatusCoalition, self )
+  self:ScheduleRepeat( 5, 15, 0.1, nil, self.StatusZone, self )
+  self:ScheduleRepeat( 10, 15, 0, nil, self.StatusSmoke, self )
+end
+
+--- Bound.
+-- @param #PROTECT self
+function PROTECT:onenterGuarded()
+
+
+  if self.Coalition == coalition.side.BLUE then
+    --elf.ProtectZone:BoundZone( 12, country.id.USA )
+  else
+    --self.ProtectZone:BoundZone( 12, country.id.RUSSIA )
+  end
+  
+  self:Mark()
+  
+end
+
+function PROTECT:onenterCaptured()
+
+  local NewCoalition = self.ProtectZone:GetCoalition()
+  self:F( { NewCoalition = NewCoalition } )
+  self:SetCoalition( NewCoalition )
+
+  self:Mark()
+end
+
+
+function PROTECT:onenterEmpty()
+
+  self:Mark()
+end
+
+
+function PROTECT:onenterAttacked()
+
+  self:Mark()
+end
+
+
+--- Check status Coalition ownership.
+-- @param #PROTECT self
+function PROTECT:StatusCoalition()
+
+  self:F( { State = self:GetState() } )
+  
+  self.ProtectZone:Scan()
+
+  if self:IsGuarded() then
+    self:Guard()
+  else
+    if self:IsCaptured() then  
+      self:Capture()
+    end
+  end
+end
+
+--- Check status Zone.
+-- @param #PROTECT self
+function PROTECT:StatusZone()
+  
+  self:F( { State = self:GetState() } )
+
+  self.ProtectZone:Scan()
+
+  if self:IsAttacked() then
+    self:Attack()
+  else
+    if self:IsEmpty() then  
+      self:Empty()
+    end
+  end
+end
+
+--- Check status Smoke.
+-- @param #PROTECT self
+function PROTECT:StatusSmoke()
+  
+  local CurrentTime = timer.getTime()
+
+  if self.SmokeTime == nil or self.SmokeTime + 300 <= CurrentTime then
+    if self.SmokeColor then
+      self.ProtectZone:GetCoordinate():Smoke( self.SmokeColor )
+      --self.SmokeColor = nil
+      self.SmokeTime = CurrentTime
+    end
+  end
+end
+
+
+
+
+

Moose Development/Moose/Functional/Sead.lua

@@ -1,18 +1,12 @@
---- Provides defensive behaviour to a set of SAM sites within a running Mission.
+--- **Functional** -- Provides defensive behaviour to a set of SAM sites within a running Mission.
+-- 
+-- ===
+-- 
 -- @module Sead
--- @author to be searched on the forum
--- @author (co) Flightcontrol (Modified and enriched with functionality)
-
-Include.File( "Routines" )
-Include.File( "Event" )
-Include.File( "Base" )
-Include.File( "Mission" )
-Include.File( "Client" )
-Include.File( "Task" )
 
 --- The SEAD class
 -- @type SEAD
--- @extends Base#BASE
+-- @extends Core.Base#BASE
 SEAD = {
 	ClassName = "SEAD", 
 	TargetSkill = {
@@ -43,26 +37,28 @@ function SEAD:New( SEADGroupPrefixes )
 	else
 		self.SEADGroupNames[SEADGroupPrefixes] = SEADGroupPrefixes
 	end
-	_EVENTDISPATCHER:OnShot( self.EventShot, self )
+	
+	self:HandleEvent( EVENTS.Shot )
 	
 	return self
 end
 
 --- Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.
 -- @see SEAD
-function SEAD:EventShot( Event )
-	self:F( { Event } )
+-- @param #SEAD
+-- @param Core.Event#EVENTDATA EventData
+function SEAD:OnEventShot( EventData )
+	self:F( { EventData } )
 
-	local SEADUnit = Event.IniDCSUnit
-	local SEADUnitName = Event.IniDCSUnitName
-	local SEADWeapon = Event.Weapon -- Identify the weapon fired						
-	local SEADWeaponName = Event.WeaponName	-- return weapon type
-	--trigger.action.outText( string.format("Alerte, depart missile " ..string.format(SEADWeaponName)), 20) --debug message
+	local SEADUnit = EventData.IniDCSUnit
+	local SEADUnitName = EventData.IniDCSUnitName
+	local SEADWeapon = EventData.Weapon -- Identify the weapon fired						
+	local SEADWeaponName = EventData.WeaponName	-- return weapon type
 	-- Start of the 2nd loop
 	self:T( "Missile Launched = " .. SEADWeaponName )
 	if SEADWeaponName == "KH-58" or SEADWeaponName == "KH-25MPU" or SEADWeaponName == "AGM-88" or SEADWeaponName == "KH-31A" or SEADWeaponName == "KH-31P" then -- Check if the missile is a SEAD
 		local _evade = math.random (1,100) -- random number for chance of evading action
-		local _targetMim = Event.Weapon:getTarget() -- Identify target
+		local _targetMim = EventData.Weapon:getTarget() -- Identify target
 		local _targetMimname = Unit.getName(_targetMim)
 		local _targetMimgroup = Unit.getGroup(Weapon.getTarget(SEADWeapon))
 		local _targetMimgroupName = _targetMimgroup:getName()
@@ -83,10 +79,10 @@ function SEAD:EventShot( Event )
 				local Skills = { "Average", "Good", "High", "Excellent" }
 				_targetskill = Skills[ math.random(1,4) ]
 			end
-			self:T( _targetskill ) -- debug message for skill check
+			self:T( _targetskill )
 			if self.TargetSkill[_targetskill] then
 				if (_evade > self.TargetSkill[_targetskill].Evade) then
-					self:T( string.format("Evading, target skill  " ..string.format(_targetskill)) ) --debug message
+					self:T( string.format("Evading, target skill  " ..string.format(_targetskill)) )
 					local _targetMim = Weapon.getTarget(SEADWeapon)
 					local _targetMimname = Unit.getName(_targetMim)
 					local _targetMimgroup = Unit.getGroup(Weapon.getTarget(SEADWeapon))

Moose Development/Moose/Functional/ZoneCaptureCoalition.lua

@@ -0,0 +1,763 @@
+--- **Functional** -- (R2.3) Models the process to zone guarding and capturing.
+--
+-- ===
+-- 
+-- ![Banner Image](..\Presentations\ZONE_CAPTURE_COALITION\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAZ - Capture Zones)
+-- 
+--   - CAZ-000 - Capture Zone: Demonstrates the basic concept of capturing a zone.
+-- 
+-- ===
+-- 
+-- ### [YouTube Playlist](https://www.youtube.com/watch?v=0m6K6Yxa-os&list=PL7ZUrU4zZUl0qqJsfa8DPvZWDY-OyDumE)
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- ### Contributions: **Millertime** - Concept
+-- 
+-- ===
+-- 
+-- @module ZoneCaptureCoalition
+
+do -- ZONE_CAPTURE_COALITION
+
+  --- @type ZONE_CAPTURE_COALITION
+  -- @extends Functional.ZoneGoalCoalition#ZONE_GOAL_COALITION
+
+
+  --- # ZONE\_CAPTURE\_COALITION class, extends @{ZoneGoalCoalition#ZONE_GOAL_COALITION}
+  -- 
+  -- Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.
+  -- This is a powerful concept that allows to create very dynamic missions based on the different state transitions of various zones.
+  -- 
+  -- ---
+  --
+  -- ![Banner Image](..\Presentations\ZONE_CAPTURE_COALITION\Dia1.JPG)
+  --
+  -- ---
+  -- 
+  -- # 0. Player Experience
+  -- 
+  -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia3.JPG)
+  --  
+  -- The above models the possible state transitions between the **Guarded**, **Attacked**, **Empty** and **Captured** states.
+  -- A zone has an __owning coalition__, that means that at a specific point in time, a zone can be owned by the red or blue coalition.
+  --
+  -- The Zone can be in the state **Guarded** by the __owning coalition__, which is the coalition that initially occupies the zone with units of its coalition.
+  -- Once units of an other coalition are entering the Zone, the state will change to **Attacked**. As long as these units remain in the zone, the state keeps set to Attacked.
+  -- When all units are destroyed in the Zone, the state will change to **Empty**, which expresses that the Zone is empty, and can be captured.
+  -- When units of the other coalition are in the Zone, and no other units of the owning coalition is in the Zone, the Zone is captured, and its state will change to **Captured**.
+  -- 
+  -- The zone needs to be monitored regularly for the presence of units to interprete the correct state transition required.
+  -- This monitoring process MUST be started using the @{#ZONE_CAPTURE_COALITION.Start}() method.
+  -- Otherwise no monitoring will be active and the zone will stay in the current state forever.
+  -- See further in chapter 3.3 for more information about this.
+  -- 
+  -- ## 1. ZONE\_CAPTURE\_COALITION constructor
+  --   
+  --   * @{#ZONE_CAPTURE_COALITION.New}(): Creates a new ZONE\_CAPTURE\_COALITION object.
+  --   
+  -- In order to use ZONE\_CAPTURE\_COALITION, you need to:
+  -- 
+  --   - Create a @{Zone} object from one of the ZONE\_ classes. Note that ZONE\_POLYGON\_ classes are not yet functional. The only functional ZONE\_ classses are those derived from a ZONE\_RADIUS.
+  -- 
+  -- ![New](..\Presentations\ZONE_CAPTURE_COALITION\Dia5.JPG)
+  -- 
+  -- Ensure that during the life cycle of the ZONE\_CAPTURE\_COALITION object, the object keeps alive.
+  -- It is best to declare the object globally within your script.
+  -- 
+  -- ## 2. ZONE\_CAPTURE\_COALITION is a finite state machine (FSM).
+  -- 
+  -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia4.JPG)
+  -- 
+  -- ### 2.1 ZONE\_CAPTURE\_COALITION States
+  -- 
+  --   * **Captured**: The Zone has been captured by an other coalition.
+  --   * **Attacked**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
+  --   * **Guarded**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
+  --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
+  --   
+  -- ### 2.2 ZONE\_CAPTURE\_COALITION Events
+  -- 
+  --   * **Capture**: The Zone has been captured by an other coalition.
+  --   * **Attack**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
+  --   * **Guard**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
+  --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
+  -- 
+  -- ## 3. "Script It"
+  -- 
+  -- ZONE\_CAPTURE\_COALITION allows to take action on the various state transitions and add your custom code and logic.
+  -- 
+  -- ### 3.1. Take action using state- and event handlers.
+  -- 
+  -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia6.JPG)
+  -- 
+  -- The most important to understand is how states and events can be tailored.
+  -- Carefully study the diagram and the explanations.
+  -- 
+  -- **State Handlers** capture the moment:
+  -- 
+  --   - On Leave from the old state. Return false to cancel the transition.
+  --   - On Enter to the new state.
+  -- 
+  -- **Event Handlers** capture the moment:
+  -- 
+  --   - On Before the event is triggered. Return false to cancel the transition.
+  --   - On After the event is triggered.
+  -- 
+  -- 
+  -- 
+  -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia7.JPG)
+  -- 
+  -- Each handler can receive optionally 3 parameters:
+  -- 
+  --   - **From**: A string containing the From State.
+  --   - **Event**: A string containing the Event.
+  --   - **To**: A string containing the To State.
+  --   
+  -- The mission designer can use these values to alter the logic.
+  -- For example:
+  -- 
+  --     --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self
+  --     function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To )
+  --       if From ~= "Empty" then
+  --         -- Display a message
+  --       end
+  --     end
+  -- 
+  -- This code checks that when the __Guarded__ state has been reached, that if the **From** state was __Empty__, then display a message.
+  -- 
+  -- ### 3.2. Example Event Handler.
+  -- 
+  --     --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self
+  --     function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To )
+  --       if From ~= To then
+  --         local Coalition = self:GetCoalition()
+  --         self:E( { Coalition = Coalition } )
+  --         if Coalition == coalition.side.BLUE then
+  --           ZoneCaptureCoalition:Smoke( SMOKECOLOR.Blue )
+  --           US_CC:MessageTypeToCoalition( string.format( "%s is under protection of the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --           RU_CC:MessageTypeToCoalition( string.format( "%s is under protection of the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --         else
+  --           ZoneCaptureCoalition:Smoke( SMOKECOLOR.Red )
+  --           RU_CC:MessageTypeToCoalition( string.format( "%s is under protection of Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --           US_CC:MessageTypeToCoalition( string.format( "%s is under protection of Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --         end
+  --       end
+  --     end
+  --     
+  -- ### 3.3. Stop and Start the zone monitoring process.
+  -- 
+  -- At regular intervals, the state of the zone needs to be monitored.
+  -- The zone needs to be scanned for the presence of units within the zone boundaries.
+  -- Depending on the owning coalition of the zone and the presence of units (of the owning and/or other coalition(s)), the zone will transition to another state.
+  -- 
+  -- However, ... this scanning process is rather CPU intensive. Imagine you have 10 of these capture zone objects setup within your mission.
+  -- That would mean that your mission would check 10 capture zones simultaneously, each checking for the presence of units.
+  -- It would be highly **CPU inefficient**, as some of these zones are not required to be monitored (yet).
+  -- 
+  -- Therefore, the mission designer is given 2 methods that allow to take control of the CPU utilization efficiency:
+  -- 
+  --   - @{#ZONE_CAPTURE_COALITION.Start()}(): This starts the monitoring process.
+  --   - @{#ZONE_CAPTURE_COALITION.Stop()}(): This stops the monitoring process.
+  --   
+  -- ### IMPORTANT
+  -- 
+  -- **Each capture zone object must have the monitoring process started specifically.
+  -- The monitoring process is NOT started by default!!!**
+  --   
+  -- 
+  -- ## 4. Full Example
+  -- 
+  -- The following annotated code shows a real example of how ZONE\_CAPTURE\_COALITION can be applied.
+  -- 
+  -- The concept is simple.
+  -- 
+  -- The USA (US), blue coalition, needs to capture the Russian (RU), red coalition, zone, which is near groom lake.
+  -- 
+  -- A capture zone has been setup that guards the presence of the troops.
+  -- Troops are guarded by red forces. Blue is required to destroy the red forces and capture the zones.
+  -- 
+  -- At first, we setup the Command Centers
+  -- 
+  --      do
+  --        
+  --        RU_CC = COMMANDCENTER:New( GROUP:FindByName( "REDHQ" ), "Russia HQ" )
+  --        US_CC = COMMANDCENTER:New( GROUP:FindByName( "BLUEHQ" ), "USA HQ" )
+  --      
+  --      end
+  --      
+  -- Next, we define the mission, and add some scoring to it.
+  --      
+  --      do -- Missions
+  --        
+  --        US_Mission_EchoBay = MISSION:New( US_CC, "Echo Bay", "Primary",
+  --          "Welcome trainee. The airport Groom Lake in Echo Bay needs to be captured.\n" ..
+  --          "There are five random capture zones located at the airbase.\n" ..
+  --          "Move to one of the capture zones, destroy the fuel tanks in the capture zone, " ..
+  --          "and occupy each capture zone with a platoon.\n " .. 
+  --          "Your orders are to hold position until all capture zones are taken.\n" ..
+  --          "Use the map (F10) for a clear indication of the location of each capture zone.\n" ..
+  --          "Note that heavy resistance can be expected at the airbase!\n" ..
+  --          "Mission 'Echo Bay' is complete when all five capture zones are taken, and held for at least 5 minutes!"
+  --          , coalition.side.RED )
+  --          
+  --        US_Mission_EchoBay:Start()
+  --      
+  --      end
+  --      
+  --      
+  -- Now the real work starts.
+  -- We define a **CaptureZone** object, which is a ZONE object.
+  -- Within the mission, a trigger zone is created with the name __CaptureZone__, with the defined radius within the mission editor.
+  -- 
+  --      CaptureZone = ZONE:New( "CaptureZone" )
+  -- 
+  -- Next, we define the **ZoneCaptureCoalition** object, as explained above.
+  --      
+  --      ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( CaptureZone, coalition.side.RED ) 
+  --      
+  -- Of course, we want to let the **ZoneCaptureCoalition** object do something when the state transitions.
+  -- Do accomodate this, it is very simple, as explained above.
+  -- We use **Event Handlers** to tailor the logic.
+  -- 
+  -- Here we place an Event Handler at the Guarded event. So when the **Guarded** event is triggered, then this method is called!
+  -- With the variables **From**, **Event**, **To**. Each of these variables containing a string.
+  -- 
+  -- We check if the previous state wasn't Guarded also.
+  -- If not, we retrieve the owning Coalition of the **ZoneCaptureCoalition**, using `self:GetCoalition()`.
+  -- So **Coalition** will contain the current owning coalition of the zone.
+  -- 
+  -- Depending on the zone ownership, different messages are sent.
+  -- Note the methods `ZoneCaptureCoalition:GetZoneName()`.
+  --      
+  --      --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self
+  --      function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To )
+  --        if From ~= To then
+  --          local Coalition = self:GetCoalition()
+  --          self:E( { Coalition = Coalition } )
+  --          if Coalition == coalition.side.BLUE then
+  --            ZoneCaptureCoalition:Smoke( SMOKECOLOR.Blue )
+  --            US_CC:MessageTypeToCoalition( string.format( "%s is under protection of the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --            RU_CC:MessageTypeToCoalition( string.format( "%s is under protection of the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --          else
+  --            ZoneCaptureCoalition:Smoke( SMOKECOLOR.Red )
+  --            RU_CC:MessageTypeToCoalition( string.format( "%s is under protection of Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --            US_CC:MessageTypeToCoalition( string.format( "%s is under protection of Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --          end
+  --        end
+  --      end
+  -- 
+  -- As you can see, not a rocket science.
+  -- Next is the Event Handler when the **Empty** state transition is triggered.
+  -- Now we smoke the ZoneCaptureCoalition with a green color, using `self:Smoke( SMOKECOLOR.Green )`.
+  --      
+  --      --- @param Functional.Protect#ZONE_CAPTURE_COALITION self
+  --      function ZoneCaptureCoalition:OnEnterEmpty()
+  --        self:Smoke( SMOKECOLOR.Green )
+  --        US_CC:MessageTypeToCoalition( string.format( "%s is unprotected, and can be captured!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --        RU_CC:MessageTypeToCoalition( string.format( "%s is unprotected, and can be captured!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --      end
+  -- 
+  -- The next Event Handlers speak for itself.
+  -- When the zone is Attacked, we smoke the zone white and send some messages to each coalition.     
+  --      
+  --      --- @param Functional.Protect#ZONE_CAPTURE_COALITION self
+  --      function ZoneCaptureCoalition:OnEnterAttacked()
+  --        ZoneCaptureCoalition:Smoke( SMOKECOLOR.White )
+  --        local Coalition = self:GetCoalition()
+  --        self:E({Coalition = Coalition})
+  --        if Coalition == coalition.side.BLUE then
+  --          US_CC:MessageTypeToCoalition( string.format( "%s is under attack by Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --          RU_CC:MessageTypeToCoalition( string.format( "We are attacking %s", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --        else
+  --          RU_CC:MessageTypeToCoalition( string.format( "%s is under attack by the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --          US_CC:MessageTypeToCoalition( string.format( "We are attacking %s", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --        end
+  --      end
+  -- 
+  -- When the zone is Captured, we send some victory or loss messages to the correct coalition.
+  -- And we add some score.
+  -- 
+  --      --- @param Functional.Protect#ZONE_CAPTURE_COALITION self
+  --      function ZoneCaptureCoalition:OnEnterCaptured()
+  --        local Coalition = self:GetCoalition()
+  --        self:E({Coalition = Coalition})
+  --        if Coalition == coalition.side.BLUE then
+  --          RU_CC:MessageTypeToCoalition( string.format( "%s is captured by the USA, we lost it!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --          US_CC:MessageTypeToCoalition( string.format( "We captured %s, Excellent job!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --        else
+  --          US_CC:MessageTypeToCoalition( string.format( "%s is captured by Russia, we lost it!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --          RU_CC:MessageTypeToCoalition( string.format( "We captured %s, Excellent job!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --        end
+  --        
+  --        self:__Guard( 30 )
+  --      end
+  -- 
+  -- And this call is the most important of all!
+  -- In the context of the mission, we need to start the zone capture monitoring process.
+  -- Or nothing will be monitored and the zone won't change states.
+  -- We start the monitoring after 5 seconds, and will repeat every 30 seconds a check.
+  --        
+  --      ZoneCaptureCoalition:Start( 5, 30 )
+  --      
+  -- 
+  -- @field #ZONE_CAPTURE_COALITION
+  ZONE_CAPTURE_COALITION = {
+    ClassName = "ZONE_CAPTURE_COALITION",
+  }
+  
+  --- @field #table ZONE_CAPTURE_COALITION.States
+  ZONE_CAPTURE_COALITION.States = {}
+  
+  --- ZONE_CAPTURE_COALITION Constructor.
+  -- @param #ZONE_CAPTURE_COALITION self
+  -- @param Core.Zone#ZONE Zone A @{Zone} object with the goal to be achieved.
+  -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone.
+  -- @return #ZONE_CAPTURE_COALITION
+  -- @usage
+  -- 
+  --  AttackZone = ZONE:New( "AttackZone" )
+  --
+  --  ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( AttackZone, coalition.side.RED ) -- Create a new ZONE_CAPTURE_COALITION object of zone AttackZone with ownership RED coalition.
+  --  ZoneCaptureCoalition:__Guard( 1 ) -- Start the Guarding of the AttackZone.
+  --  
+  function ZONE_CAPTURE_COALITION:New( Zone, Coalition )
+  
+    local self = BASE:Inherit( self, ZONE_GOAL_COALITION:New( Zone, Coalition ) ) -- #ZONE_CAPTURE_COALITION
+
+    self:F( { Zone = Zone, Coalition  = Coalition } )
+
+    do 
+    
+      --- Captured State Handler OnLeave for ZONE\_CAPTURE\_COALITION
+      -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveCaptured
+      -- @param #ZONE_CAPTURE_COALITION self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+      -- @return #boolean
+  
+      --- Captured State Handler OnEnter for ZONE\_CAPTURE\_COALITION
+      -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterCaptured
+      -- @param #ZONE_CAPTURE_COALITION self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+  
+    end
+  
+  
+    do 
+    
+      --- Attacked State Handler OnLeave for ZONE\_CAPTURE\_COALITION
+      -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveAttacked
+      -- @param #ZONE_CAPTURE_COALITION self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+      -- @return #boolean
+  
+      --- Attacked State Handler OnEnter for ZONE\_CAPTURE\_COALITION
+      -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterAttacked
+      -- @param #ZONE_CAPTURE_COALITION self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+  
+    end
+
+    do 
+    
+      --- Guarded State Handler OnLeave for ZONE\_CAPTURE\_COALITION
+      -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveGuarded
+      -- @param #ZONE_CAPTURE_COALITION self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+      -- @return #boolean
+  
+      --- Guarded State Handler OnEnter for ZONE\_CAPTURE\_COALITION
+      -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterGuarded
+      -- @param #ZONE_CAPTURE_COALITION self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+  
+    end
+  
+
+    do 
+    
+      --- Empty State Handler OnLeave for ZONE\_CAPTURE\_COALITION
+      -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveEmpty
+      -- @param #ZONE_CAPTURE_COALITION self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+      -- @return #boolean
+  
+      --- Empty State Handler OnEnter for ZONE\_CAPTURE\_COALITION
+      -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterEmpty
+      -- @param #ZONE_CAPTURE_COALITION self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+  
+    end
+  
+    self:AddTransition( "*", "Guard", "Guarded" )
+    
+    --- Guard Handler OnBefore for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeGuard
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- Guard Handler OnAfter for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterGuard
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- Guard Trigger for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] Guard
+    -- @param #ZONE_CAPTURE_COALITION self
+    
+    --- Guard Asynchronous Trigger for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] __Guard
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #number Delay
+    
+    self:AddTransition( "*", "Empty", "Empty" )
+    
+    --- Empty Handler OnBefore for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeEmpty
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- Empty Handler OnAfter for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterEmpty
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- Empty Trigger for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] Empty
+    -- @param #ZONE_CAPTURE_COALITION self
+    
+    --- Empty Asynchronous Trigger for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] __Empty
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #number Delay
+    
+    
+    self:AddTransition( {  "Guarded", "Empty" }, "Attack", "Attacked" )
+  
+    --- Attack Handler OnBefore for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeAttack
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- Attack Handler OnAfter for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterAttack
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- Attack Trigger for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] Attack
+    -- @param #ZONE_CAPTURE_COALITION self
+    
+    --- Attack Asynchronous Trigger for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] __Attack
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #number Delay
+    
+    self:AddTransition( { "Guarded", "Attacked", "Empty" }, "Capture", "Captured" )
+   
+    --- Capture Handler OnBefore for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeCapture
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- Capture Handler OnAfter for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterCapture
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- Capture Trigger for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] Capture
+    -- @param #ZONE_CAPTURE_COALITION self
+    
+    --- Capture Asynchronous Trigger for ZONE\_CAPTURE\_COALITION
+    -- @function [parent=#ZONE_CAPTURE_COALITION] __Capture
+    -- @param #ZONE_CAPTURE_COALITION self
+    -- @param #number Delay
+
+    return self
+  end
+  
+
+  --- @param #ZONE_CAPTURE_COALITION self
+  function ZONE_CAPTURE_COALITION:onenterCaptured()
+  
+    self:GetParent( self, ZONE_CAPTURE_COALITION ).onenterCaptured( self )
+    
+    self.Goal:Achieved()
+  end
+
+
+  function ZONE_CAPTURE_COALITION:IsGuarded()
+  
+    local IsGuarded = self.Zone:IsAllInZoneOfCoalition( self.Coalition )
+    self:F( { IsGuarded = IsGuarded } )
+    return IsGuarded
+  end
+
+
+  function ZONE_CAPTURE_COALITION:IsEmpty()
+  
+    local IsEmpty = self.Zone:IsNoneInZone()
+    self:F( { IsEmpty = IsEmpty } )
+    return IsEmpty
+  end
+
+
+  function ZONE_CAPTURE_COALITION:IsCaptured()
+  
+    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
+    self:F( { IsCaptured = IsCaptured } )
+    return IsCaptured
+  end
+  
+  
+  function ZONE_CAPTURE_COALITION:IsAttacked()
+  
+    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
+    self:F( { IsAttacked = IsAttacked } )
+    return IsAttacked
+  end
+  
+  
+
+  --- Mark.
+  -- @param #ZONE_CAPTURE_COALITION self
+  function ZONE_CAPTURE_COALITION:Mark()
+  
+    local Coord = self.Zone:GetCoordinate()
+    local ZoneName = self:GetZoneName()
+    local State = self:GetState()
+    
+    if self.MarkRed and self.MarkBlue then
+      self:F( { MarkRed = self.MarkRed, MarkBlue = self.MarkBlue } )
+      Coord:RemoveMark( self.MarkRed )
+      Coord:RemoveMark( self.MarkBlue )
+    end
+    
+    if self.Coalition == coalition.side.BLUE then
+      self.MarkBlue = Coord:MarkToCoalitionBlue( "Coalition: Blue\nGuard Zone: " .. ZoneName .. "\nStatus: " .. State )  
+      self.MarkRed = Coord:MarkToCoalitionRed( "Coalition: Blue\nCapture Zone: " .. ZoneName .. "\nStatus: " .. State )
+    else
+      self.MarkRed = Coord:MarkToCoalitionRed( "Coalition: Red\nGuard Zone: " .. ZoneName .. "\nStatus: " .. State )  
+      self.MarkBlue = Coord:MarkToCoalitionBlue( "Coalition: Red\nCapture Zone: " .. ZoneName .. "\nStatus: " .. State )  
+    end
+  end
+
+  --- Bound.
+  -- @param #ZONE_CAPTURE_COALITION self
+  function ZONE_CAPTURE_COALITION:onenterGuarded()
+  
+    --self:GetParent( self ):onenterGuarded()
+  
+    if self.Coalition == coalition.side.BLUE then
+      --elf.ProtectZone:BoundZone( 12, country.id.USA )
+    else
+      --self.ProtectZone:BoundZone( 12, country.id.RUSSIA )
+    end
+    
+    self:Mark()
+    
+  end
+  
+  function ZONE_CAPTURE_COALITION:onenterCaptured()
+  
+    --self:GetParent( self ):onenterCaptured()
+
+    local NewCoalition = self.Zone:GetScannedCoalition()
+    self:F( { NewCoalition = NewCoalition } )
+    self:SetCoalition( NewCoalition )
+  
+    self:Mark()
+  end
+  
+  
+  function ZONE_CAPTURE_COALITION:onenterEmpty()
+
+    --self:GetParent( self ):onenterEmpty()
+  
+    self:Mark()
+  end
+  
+  
+  function ZONE_CAPTURE_COALITION:onenterAttacked()
+  
+    --self:GetParent( self ):onenterAttacked()
+  
+    self:Mark()
+  end
+
+
+  --- When started, check the Coalition status.
+  -- @param #ZONE_CAPTURE_COALITION self
+  function ZONE_CAPTURE_COALITION:onafterGuard()
+  
+    --self:F({BASE:GetParent( self )})
+    --BASE:GetParent( self ).onafterGuard( self )
+  
+    if not self.SmokeScheduler then
+      self.SmokeScheduler = self:ScheduleRepeat( 1, 1, 0.1, nil, self.StatusSmoke, self )
+    end
+  end
+
+
+  function ZONE_CAPTURE_COALITION:IsCaptured()
+  
+    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
+    self:F( { IsCaptured = IsCaptured } )
+    return IsCaptured
+  end
+  
+  
+  function ZONE_CAPTURE_COALITION:IsAttacked()
+  
+    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
+    self:F( { IsAttacked = IsAttacked } )
+    return IsAttacked
+  end
+  
+
+  --- Check status Coalition ownership.
+  -- @param #ZONE_CAPTURE_COALITION self
+  function ZONE_CAPTURE_COALITION:StatusZone()
+  
+    local State = self:GetState()
+    self:F( { State = self:GetState() } )
+  
+    self:GetParent( self, ZONE_CAPTURE_COALITION ).StatusZone( self )
+    
+    if State ~= "Guarded" and self:IsGuarded() then
+      self:Guard()
+    end
+    
+    if State ~= "Empty" and self:IsEmpty() then  
+      self:Empty()
+    end
+
+    if State ~= "Attacked" and self:IsAttacked() then
+      self:Attack()
+    end
+    
+    if State ~= "Captured" and self:IsCaptured() then  
+      self:Capture()
+    end
+    
+  end
+
+  --- Starts the zone capturing monitoring process.
+  -- This process can be CPU intensive, ensure that you specify reasonable time intervals for the monitoring process.
+  -- Note that the monitoring process is NOT started automatically during the `:New()` constructor.
+  -- It is advised that the zone monitoring process is only started when the monitoring is of relevance in context of the current mission goals.
+  -- When the zone is of no relevance, it is advised NOT to start the monitoring process, or to stop the monitoring process to save CPU resources.
+  -- Therefore, the mission designer will need to use the `:Start()` method within his script to start the monitoring process specifically.  
+  -- @param #ZONE_CAPTURE_COALITION self
+  -- @param #number StartInterval (optional) Specifies the start time interval in seconds when the zone state will be checked for the first time.
+  -- @param #number RepeatInterval (optional) Specifies the repeat time interval in seconds when the zone state will be checked repeatedly.
+  -- @usage
+  -- 
+  -- -- Setup the zone.
+  -- CaptureZone = ZONE:New( "CaptureZone" )
+  -- ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( CaptureZone, coalition.side.RED )
+  --
+  -- -- This starts the monitoring process within 15 seconds, repeating every 15 seconds.
+  -- ZoneCaptureCoalition:Start() 
+  --      
+  -- -- This starts the monitoring process immediately, but repeats every 30 seconds.
+  -- ZoneCaptureCoalition:Start( 0, 30 ) 
+  -- 
+  function ZONE_CAPTURE_COALITION:Start( StartInterval, RepeatInterval )
+  
+    StartInterval = StartInterval or 15
+    RepeatInterval = RepeatInterval or 15
+  
+    if self.ScheduleStatusZone then
+      self:ScheduleStop( self.ScheduleStatusZone )
+    end
+    self.ScheduleStatusZone = self:ScheduleRepeat( StartInterval, RepeatInterval, 0.1, nil, self.StatusZone, self )
+  end
+  
+
+  --- Stops the zone capturing monitoring process.
+  -- When the zone capturing monitor process is stopped, there won't be any changes anymore in the state and the owning coalition of the zone.
+  -- This method becomes really useful when the zone is of no relevance anymore within a long lasting mission.
+  -- In this case, it is advised to stop the monitoring process, not to consume unnecessary the CPU intensive scanning of units presence within the zone.
+  -- @param #ZONE_CAPTURE_COALITION self
+  -- @usage 
+  -- -- Setup the zone.
+  -- CaptureZone = ZONE:New( "CaptureZone" )
+  -- ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( CaptureZone, coalition.side.RED )
+  --
+  -- -- This starts the monitoring process within 15 seconds, repeating every 15 seconds.
+  -- ZoneCaptureCoalition:Start() 
+  -- 
+  -- -- When the zone capturing is of no relevance anymore, stop the monitoring!
+  -- ZoneCaptureCoalition:Stop()
+  -- 
+  -- @usage
+  -- -- For example, one could stop the monitoring when the zone was captured!
+  -- --- @param Functional.Protect#ZONE_CAPTURE_COALITION self
+  -- function ZoneCaptureCoalition:OnEnterCaptured()
+  --   local Coalition = self:GetCoalition()
+  --   self:E({Coalition = Coalition})
+  --   if Coalition == coalition.side.BLUE then
+  --     RU_CC:MessageTypeToCoalition( string.format( "%s is captured by the USA, we lost it!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --     US_CC:MessageTypeToCoalition( string.format( "We captured %s, Excellent job!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --   else
+  --     US_CC:MessageTypeToCoalition( string.format( "%s is captured by Russia, we lost it!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --     RU_CC:MessageTypeToCoalition( string.format( "We captured %s, Excellent job!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
+  --   end
+  --  
+  --   self:AddScore( "Captured", "Zone captured: Extra points granted.", 200 )    
+  --  
+  --   self:Stop()
+  -- end
+  -- 
+  function ZONE_CAPTURE_COALITION:Stop()
+  
+    if self.ScheduleStatusZone then
+      self:ScheduleStop( self.ScheduleStatusZone )
+    end
+  end
+  
+end
+

Moose Development/Moose/Functional/ZoneGoal.lua

@@ -0,0 +1,177 @@
+--- **Functional (WIP)** -- Base class that models processes to achieve goals involving a Zone.
+--
+-- ===
+-- 
+-- ZONE_GOAL models processes that have a Goal with a defined achievement involving a Zone. 
+-- Derived classes implement the ways how the achievements can be realized.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===
+-- 
+-- @module ZoneGoal
+
+do -- Zone
+
+  --- @type ZONE_GOAL
+  -- @extends Core.Fsm#FSM
+
+
+  --- # ZONE_GOAL class, extends @{Fsm#FSM}
+  -- 
+  -- ZONE_GOAL models processes that have a Goal with a defined achievement involving a Zone. 
+  -- Derived classes implement the ways how the achievements can be realized.
+  -- 
+  -- ## 1. ZONE_GOAL constructor
+  --   
+  --   * @{#ZONE_GOAL.New}(): Creates a new ZONE_GOAL object.
+  -- 
+  -- ## 2. ZONE_GOAL is a finite state machine (FSM).
+  -- 
+  -- ### 2.1 ZONE_GOAL States
+  -- 
+  --  * None: Initial State
+  -- 
+  -- ### 2.2 ZONE_GOAL Events
+  -- 
+  --   * DestroyedUnit: A @{Unit} is destroyed in the Zone. The event will only get triggered if the method @{#ZONE_GOAL.MonitorDestroyedUnits}() is used.
+  -- 
+  -- @field #ZONE_GOAL
+  ZONE_GOAL = {
+    ClassName = "ZONE_GOAL",
+  }
+  
+  --- ZONE_GOAL Constructor.
+  -- @param #ZONE_GOAL self
+  -- @param Core.Zone#ZONE_BASE Zone A @{Zone} object with the goal to be achieved.
+  -- @return #ZONE_GOAL
+  function ZONE_GOAL:New( Zone )
+  
+    local self = BASE:Inherit( self, FSM:New() ) -- #ZONE_GOAL
+    self:F( { Zone = Zone } )
+
+    self.Zone = Zone -- Core.Zone#ZONE_BASE
+    self.Goal = GOAL:New()
+
+    self.SmokeTime = nil
+
+    self:AddTransition( "*", "DestroyedUnit", "*" )
+  
+    --- DestroyedUnit Handler OnAfter for ZONE_GOAL
+    -- @function [parent=#ZONE_GOAL] OnAfterDestroyedUnit
+    -- @param #ZONE_GOAL self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @param Wrapper.Unit#UNIT DestroyedUnit The destroyed unit.
+    -- @param #string PlayerName The name of the player.
+
+    return self
+  end
+  
+  --- Get the Zone
+  -- @param #ZONE_GOAL self
+  -- @return Core.Zone#ZONE_BASE
+  function ZONE_GOAL:GetZone()
+    return self.Zone
+  end
+  
+  
+  --- Get the name of the ProtectZone
+  -- @param #ZONE_GOAL self
+  -- @return #string
+  function ZONE_GOAL:GetZoneName()
+    return self.Zone:GetName()
+  end
+
+
+  --- Smoke the center of theh zone.
+  -- @param #ZONE_GOAL self
+  -- @param #SMOKECOLOR.Color SmokeColor
+  function ZONE_GOAL:Smoke( SmokeColor )
+  
+    self:F( { SmokeColor = SmokeColor} )
+  
+    self.SmokeColor = SmokeColor
+  end
+    
+  
+  --- Flare the center of the zone.
+  -- @param #ZONE_GOAL self
+  -- @param #SMOKECOLOR.Color FlareColor
+  function ZONE_GOAL:Flare( FlareColor )
+    self.Zone:FlareZone( FlareColor, math.random( 1, 360 ) )
+  end
+
+
+  --- When started, check the Smoke and the Zone status.
+  -- @param #ZONE_GOAL self
+  function ZONE_GOAL:onafterGuard()
+  
+    --self:GetParent( self ):onafterStart()
+    
+    self:F("Guard")
+  
+    --self:ScheduleRepeat( 15, 15, 0.1, nil, self.StatusZone, self )
+    if not self.SmokeScheduler then
+      self.SmokeScheduler = self:ScheduleRepeat( 1, 1, 0.1, nil, self.StatusSmoke, self )
+    end
+  end
+
+
+  --- Check status Smoke.
+  -- @param #ZONE_GOAL self
+  function ZONE_GOAL:StatusSmoke()
+  
+    self:F({self.SmokeTime, self.SmokeColor})
+    
+    local CurrentTime = timer.getTime()
+  
+    if self.SmokeTime == nil or self.SmokeTime + 300 <= CurrentTime then
+      if self.SmokeColor then
+        self.Zone:GetCoordinate():Smoke( self.SmokeColor )
+        --self.SmokeColor = nil
+        self.SmokeTime = CurrentTime
+      end
+    end
+  end
+
+
+  --- @param #ZONE_GOAL self
+  -- @param Core.Event#EVENTDATA EventData
+  function ZONE_GOAL:__Destroyed( EventData )
+    self:F( { "EventDead", EventData } )
+
+    self:F( { EventData.IniUnit } )
+    
+    local Vec3 = EventData.IniDCSUnit:getPosition().p
+    self:F( { Vec3 = Vec3 } )
+    local ZoneGoal = self:GetZone()
+    self:F({ZoneGoal})
+
+    if EventData.IniDCSUnit then
+      if ZoneGoal:IsVec3InZone(Vec3)  then
+        local PlayerHits = _DATABASE.HITS[EventData.IniUnitName]
+        if PlayerHits then
+          for PlayerName, PlayerHit in pairs( PlayerHits.Players or {} ) do
+            self.Goal:AddPlayerContribution( PlayerName )
+            self:DestroyedUnit( EventData.IniUnitName, PlayerName )
+          end
+        end
+      end
+    end
+  end
+  
+  
+  --- Activate the event UnitDestroyed to be fired when a unit is destroyed in the zone.
+  -- @param #ZONE_GOAL self
+  function ZONE_GOAL:MonitorDestroyedUnits()
+
+    self:HandleEvent( EVENTS.Dead,  self.__Destroyed )
+    self:HandleEvent( EVENTS.Crash, self.__Destroyed )
+  
+  end
+  
+end

Moose Development/Moose/Functional/ZoneGoalCargo.lua

@@ -0,0 +1,452 @@
+--- **Functional (WIP)** -- Base class that models processes to achieve goals involving a Zone and Cargo.
+--
+-- ===
+-- 
+-- ZONE_GOAL_CARGO models processes that have a Goal with a defined achievement involving a Zone and Cargo.  
+-- Derived classes implement the ways how the achievements can be realized.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===
+-- 
+-- @module ZoneGoalCargo
+
+do -- ZoneGoal
+
+  --- @type ZONE_GOAL_CARGO
+  -- @extends Functional.ZoneGoal#ZONE_GOAL
+
+
+  --- # ZONE_GOAL_CARGO class, extends @{ZoneGoal#ZONE_GOAL}
+  -- 
+  -- ZONE_GOAL_CARGO models processes that have a Goal with a defined achievement involving a Zone and Cargo.  
+  -- Derived classes implement the ways how the achievements can be realized.
+  -- 
+  -- ## 1. ZONE_GOAL_CARGO constructor
+  --   
+  --   * @{#ZONE_GOAL_CARGO.New}(): Creates a new ZONE_GOAL_CARGO object.
+  -- 
+  -- ## 2. ZONE_GOAL_CARGO is a finite state machine (FSM).
+  -- 
+  -- ### 2.1 ZONE_GOAL_CARGO States
+  --  
+  --   * **Deployed**: The Zone has been captured by an other coalition.
+  --   * **Airborne**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
+  --   * **Loaded**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
+  --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
+  -- 
+  -- ### 2.2 ZONE_GOAL_CARGO Events
+  -- 
+  --   * **Capture**: The Zone has been captured by an other coalition.
+  --   * **Attack**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
+  --   * **Guard**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
+  --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
+  --   
+  -- ### 2.3 ZONE_GOAL_CARGO State Machine
+  -- 
+  -- @field #ZONE_GOAL_CARGO
+  ZONE_GOAL_CARGO = {
+    ClassName = "ZONE_GOAL_CARGO",
+  }
+  
+  --- @field #table ZONE_GOAL_CARGO.States
+  ZONE_GOAL_CARGO.States = {}
+  
+  --- ZONE_GOAL_CARGO Constructor.
+  -- @param #ZONE_GOAL_CARGO self
+  -- @param Core.Zone#ZONE Zone A @{Zone} object with the goal to be achieved.
+  -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone.
+  -- @return #ZONE_GOAL_CARGO
+  function ZONE_GOAL_CARGO:New( Zone, Coalition )
+  
+    local self = BASE:Inherit( self, ZONE_GOAL:New( Zone ) ) -- #ZONE_GOAL_CARGO
+    self:F( { Zone = Zone, Coalition  = Coalition  } )
+
+    self:SetCoalition( Coalition )
+
+    do 
+    
+      --- Captured State Handler OnLeave for ZONE_GOAL_CARGO
+      -- @function [parent=#ZONE_GOAL_CARGO] OnLeaveCaptured
+      -- @param #ZONE_GOAL_CARGO self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+      -- @return #boolean
+  
+      --- Captured State Handler OnEnter for ZONE_GOAL_CARGO
+      -- @function [parent=#ZONE_GOAL_CARGO] OnEnterCaptured
+      -- @param #ZONE_GOAL_CARGO self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+  
+    end
+  
+  
+    do 
+    
+      --- Attacked State Handler OnLeave for ZONE_GOAL_CARGO
+      -- @function [parent=#ZONE_GOAL_CARGO] OnLeaveAttacked
+      -- @param #ZONE_GOAL_CARGO self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+      -- @return #boolean
+  
+      --- Attacked State Handler OnEnter for ZONE_GOAL_CARGO
+      -- @function [parent=#ZONE_GOAL_CARGO] OnEnterAttacked
+      -- @param #ZONE_GOAL_CARGO self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+  
+    end
+
+    do 
+    
+      --- Guarded State Handler OnLeave for ZONE_GOAL_CARGO
+      -- @function [parent=#ZONE_GOAL_CARGO] OnLeaveGuarded
+      -- @param #ZONE_GOAL_CARGO self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+      -- @return #boolean
+  
+      --- Guarded State Handler OnEnter for ZONE_GOAL_CARGO
+      -- @function [parent=#ZONE_GOAL_CARGO] OnEnterGuarded
+      -- @param #ZONE_GOAL_CARGO self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+  
+    end
+  
+
+    do 
+    
+      --- Empty State Handler OnLeave for ZONE_GOAL_CARGO
+      -- @function [parent=#ZONE_GOAL_CARGO] OnLeaveEmpty
+      -- @param #ZONE_GOAL_CARGO self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+      -- @return #boolean
+  
+      --- Empty State Handler OnEnter for ZONE_GOAL_CARGO
+      -- @function [parent=#ZONE_GOAL_CARGO] OnEnterEmpty
+      -- @param #ZONE_GOAL_CARGO self
+      -- @param #string From
+      -- @param #string Event
+      -- @param #string To
+  
+    end
+  
+    self:AddTransition( "*", "Guard", "Guarded" )
+    
+    --- Guard Handler OnBefore for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] OnBeforeGuard
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- Guard Handler OnAfter for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] OnAfterGuard
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- Guard Trigger for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] Guard
+    -- @param #ZONE_GOAL_CARGO self
+    
+    --- Guard Asynchronous Trigger for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] __Guard
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #number Delay
+    
+    self:AddTransition( "*", "Empty", "Empty" )
+    
+    --- Empty Handler OnBefore for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] OnBeforeEmpty
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- Empty Handler OnAfter for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] OnAfterEmpty
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- Empty Trigger for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] Empty
+    -- @param #ZONE_GOAL_CARGO self
+    
+    --- Empty Asynchronous Trigger for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] __Empty
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #number Delay
+    
+    
+    self:AddTransition( {  "Guarded", "Empty" }, "Attack", "Attacked" )
+  
+    --- Attack Handler OnBefore for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] OnBeforeAttack
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- Attack Handler OnAfter for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] OnAfterAttack
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- Attack Trigger for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] Attack
+    -- @param #ZONE_GOAL_CARGO self
+    
+    --- Attack Asynchronous Trigger for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] __Attack
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #number Delay
+    
+    self:AddTransition( { "Guarded", "Attacked", "Empty" }, "Capture", "Captured" )
+   
+    --- Capture Handler OnBefore for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] OnBeforeCapture
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- Capture Handler OnAfter for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] OnAfterCapture
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- Capture Trigger for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] Capture
+    -- @param #ZONE_GOAL_CARGO self
+    
+    --- Capture Asynchronous Trigger for ZONE_GOAL_CARGO
+    -- @function [parent=#ZONE_GOAL_CARGO] __Capture
+    -- @param #ZONE_GOAL_CARGO self
+    -- @param #number Delay
+
+    return self
+  end
+  
+
+  --- Set the owning coalition of the zone.
+  -- @param #ZONE_GOAL_CARGO self
+  -- @param DCSCoalition.DCSCoalition#coalition Coalition
+  function ZONE_GOAL_CARGO:SetCoalition( Coalition )
+    self.Coalition = Coalition
+  end
+  
+  
+  --- Get the owning coalition of the zone.
+  -- @param #ZONE_GOAL_CARGO self
+  -- @return DCSCoalition.DCSCoalition#coalition Coalition.
+  function ZONE_GOAL_CARGO:GetCoalition()
+    return self.Coalition
+  end
+
+  
+  --- Get the owning coalition name of the zone.
+  -- @param #ZONE_GOAL_CARGO self
+  -- @return #string Coalition name.
+  function ZONE_GOAL_CARGO:GetCoalitionName()
+  
+    if self.Coalition == coalition.side.BLUE then
+      return "Blue"
+    end
+    
+    if self.Coalition == coalition.side.RED then
+      return "Red"
+    end
+    
+    if self.Coalition == coalition.side.NEUTRAL then
+      return "Neutral"
+    end
+    
+    return ""
+  end
+
+
+  function ZONE_GOAL_CARGO:IsGuarded()
+  
+    local IsGuarded = self.Zone:IsAllInZoneOfCoalition( self.Coalition )
+    self:F( { IsGuarded = IsGuarded } )
+    return IsGuarded
+  end
+
+
+  function ZONE_GOAL_CARGO:IsEmpty()
+  
+    local IsEmpty = self.Zone:IsNoneInZone()
+    self:F( { IsEmpty = IsEmpty } )
+    return IsEmpty
+  end
+
+
+  function ZONE_GOAL_CARGO:IsCaptured()
+  
+    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
+    self:F( { IsCaptured = IsCaptured } )
+    return IsCaptured
+  end
+  
+  
+  function ZONE_GOAL_CARGO:IsAttacked()
+  
+    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
+    self:F( { IsAttacked = IsAttacked } )
+    return IsAttacked
+  end
+  
+  
+
+  --- Mark.
+  -- @param #ZONE_GOAL_CARGO self
+  function ZONE_GOAL_CARGO:Mark()
+  
+    local Coord = self.Zone:GetCoordinate()
+    local ZoneName = self:GetZoneName()
+    local State = self:GetState()
+    
+    if self.MarkRed and self.MarkBlue then
+      self:F( { MarkRed = self.MarkRed, MarkBlue = self.MarkBlue } )
+      Coord:RemoveMark( self.MarkRed )
+      Coord:RemoveMark( self.MarkBlue )
+    end
+    
+    if self.Coalition == coalition.side.BLUE then
+      self.MarkBlue = Coord:MarkToCoalitionBlue( "Guard Zone: " .. ZoneName .. "\nStatus: " .. State )  
+      self.MarkRed = Coord:MarkToCoalitionRed( "Capture Zone: " .. ZoneName .. "\nStatus: " .. State )  
+    else
+      self.MarkRed = Coord:MarkToCoalitionRed( "Guard Zone: " .. ZoneName .. "\nStatus: " .. State )  
+      self.MarkBlue = Coord:MarkToCoalitionBlue( "Capture Zone: " .. ZoneName .. "\nStatus: " .. State )  
+    end
+  end
+
+  --- Bound.
+  -- @param #ZONE_GOAL_CARGO self
+  function ZONE_GOAL_CARGO:onenterGuarded()
+  
+    --self:GetParent( self ):onenterGuarded()
+  
+    if self.Coalition == coalition.side.BLUE then
+      --elf.ProtectZone:BoundZone( 12, country.id.USA )
+    else
+      --self.ProtectZone:BoundZone( 12, country.id.RUSSIA )
+    end
+    
+    self:Mark()
+    
+  end
+  
+  function ZONE_GOAL_CARGO:onenterCaptured()
+  
+    --self:GetParent( self ):onenterCaptured()
+
+    local NewCoalition = self.Zone:GetCoalition()
+    self:F( { NewCoalition = NewCoalition } )
+    self:SetCoalition( NewCoalition )
+  
+    self:Mark()
+  end
+  
+  
+  function ZONE_GOAL_CARGO:onenterEmpty()
+
+    --self:GetParent( self ):onenterEmpty()
+  
+    self:Mark()
+  end
+  
+  
+  function ZONE_GOAL_CARGO:onenterAttacked()
+  
+    --self:GetParent( self ):onenterAttacked()
+  
+    self:Mark()
+  end
+
+
+  --- When started, check the Coalition status.
+  -- @param #ZONE_GOAL_CARGO self
+  function ZONE_GOAL_CARGO:onafterGuard()
+  
+    --self:F({BASE:GetParent( self )})
+    --BASE:GetParent( self ).onafterGuard( self )
+  
+    if not self.SmokeScheduler then
+      self.SmokeScheduler = self:ScheduleRepeat( 1, 1, 0.1, nil, self.StatusSmoke, self )
+    end
+    if not self.ScheduleStatusZone then
+      self.ScheduleStatusZone = self:ScheduleRepeat( 15, 15, 0.1, nil, self.StatusZone, self )
+    end
+  end
+
+
+  function ZONE_GOAL_CARGO:IsCaptured()
+  
+    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
+    self:F( { IsCaptured = IsCaptured } )
+    return IsCaptured
+  end
+  
+  
+  function ZONE_GOAL_CARGO:IsAttacked()
+  
+    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
+    self:F( { IsAttacked = IsAttacked } )
+    return IsAttacked
+  end
+  
+  --- Check status Coalition ownership.
+  -- @param #ZONE_GOAL_CARGO self
+  function ZONE_GOAL_CARGO:StatusZone()
+  
+    local State = self:GetState()
+    self:F( { State = self:GetState() } )
+  
+    self.Zone:Scan()
+  
+    if State ~= "Guarded" and self:IsGuarded() then
+      self:Guard()
+    end
+    
+    if State ~= "Empty" and self:IsEmpty() then  
+      self:Empty()
+    end
+
+    if State ~= "Attacked" and self:IsAttacked() then
+      self:Attack()
+    end
+    
+    if State ~= "Captured" and self:IsCaptured() then  
+      self:Capture()
+    end
+    
+  end
+  
+end
+

Moose Development/Moose/Functional/ZoneGoalCoalition.lua

@@ -0,0 +1,113 @@
+--- **Functional (WIP)** -- Base class that models processes to achieve goals involving a Zone for a Coalition.
+--
+-- ===
+-- 
+-- ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.  
+-- Derived classes implement the ways how the achievements can be realized.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===
+-- 
+-- @module ZoneGoalCoalition
+
+do -- ZoneGoal
+
+  --- @type ZONE_GOAL_COALITION
+  -- @extends Functional.ZoneGoal#ZONE_GOAL
+
+
+  --- # ZONE_GOAL_COALITION class, extends @{ZoneGoal#ZONE_GOAL}
+  -- 
+  -- ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.  
+  -- Derived classes implement the ways how the achievements can be realized.
+  -- 
+  -- ## 1. ZONE_GOAL_COALITION constructor
+  --   
+  --   * @{#ZONE_GOAL_COALITION.New}(): Creates a new ZONE_GOAL_COALITION object.
+  -- 
+  -- ## 2. ZONE_GOAL_COALITION is a finite state machine (FSM).
+  -- 
+  -- ### 2.1 ZONE_GOAL_COALITION States
+  -- 
+  -- ### 2.2 ZONE_GOAL_COALITION Events
+  -- 
+  -- ### 2.3 ZONE_GOAL_COALITION State Machine
+  -- 
+  -- @field #ZONE_GOAL_COALITION
+  ZONE_GOAL_COALITION = {
+    ClassName = "ZONE_GOAL_COALITION",
+  }
+  
+  --- @field #table ZONE_GOAL_COALITION.States
+  ZONE_GOAL_COALITION.States = {}
+  
+  --- ZONE_GOAL_COALITION Constructor.
+  -- @param #ZONE_GOAL_COALITION self
+  -- @param Core.Zone#ZONE Zone A @{Zone} object with the goal to be achieved.
+  -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone.
+  -- @return #ZONE_GOAL_COALITION
+  function ZONE_GOAL_COALITION:New( Zone, Coalition )
+  
+    local self = BASE:Inherit( self, ZONE_GOAL:New( Zone ) ) -- #ZONE_GOAL_COALITION
+    self:F( { Zone = Zone, Coalition  = Coalition  } )
+
+    self:SetCoalition( Coalition )
+
+
+    return self
+  end
+  
+
+  --- Set the owning coalition of the zone.
+  -- @param #ZONE_GOAL_COALITION self
+  -- @param DCSCoalition.DCSCoalition#coalition Coalition
+  function ZONE_GOAL_COALITION:SetCoalition( Coalition )
+    self.Coalition = Coalition
+  end
+  
+  
+  --- Get the owning coalition of the zone.
+  -- @param #ZONE_GOAL_COALITION self
+  -- @return DCSCoalition.DCSCoalition#coalition Coalition.
+  function ZONE_GOAL_COALITION:GetCoalition()
+    return self.Coalition
+  end
+
+  
+  --- Get the owning coalition name of the zone.
+  -- @param #ZONE_GOAL_COALITION self
+  -- @return #string Coalition name.
+  function ZONE_GOAL_COALITION:GetCoalitionName()
+  
+    if self.Coalition == coalition.side.BLUE then
+      return "Blue"
+    end
+    
+    if self.Coalition == coalition.side.RED then
+      return "Red"
+    end
+    
+    if self.Coalition == coalition.side.NEUTRAL then
+      return "Neutral"
+    end
+    
+    return ""
+  end
+
+
+  --- Check status Coalition ownership.
+  -- @param #ZONE_GOAL_COALITION self
+  function ZONE_GOAL_COALITION:StatusZone()
+  
+    local State = self:GetState()
+    self:F( { State = self:GetState() } )
+  
+    self.Zone:Scan( { Object.Category.UNIT, Object.Category.STATIC } )
+  
+  end
+  
+end
+

Moose Development/Moose/GoHomeTask.lua

@@ -1,35 +0,0 @@
---- A GOHOMETASK orchestrates the travel back to the home base, which is a specific zone defined within the ME.
--- @module GOHOMETASK
-
-Include.File("Task")
-
---- The GOHOMETASK class
--- @type
-GOHOMETASK = {
-  ClassName = "GOHOMETASK",
-}
-
---- Creates a new GOHOMETASK.
--- @param table{string,...}|string LandingZones Table of Landing Zone names where Home(s) are located.
--- @return GOHOMETASK
-function GOHOMETASK:New( LandingZones )
-  local self = BASE:Inherit( self, TASK:New() )
-	self:F( { LandingZones } )
-  local Valid = true
-  
-  Valid = routines.ValidateZone( LandingZones, "LandingZones", Valid )
-    
-  if  Valid then
-    self.Name = 'Fly Home'
-    self.TaskBriefing = "Task: Fly back to your home base. Your co-pilot will provide you with the directions (required flight angle in degrees) and the distance (in km) to your home base."
-	if type( LandingZones ) == "table" then
-		self.LandingZones = LandingZones
-	else
-		self.LandingZones = { LandingZones }
-	end
-    self.Stages = { STAGEBRIEF:New(), STAGESTART:New(), STAGEROUTE:New(), STAGEARRIVE:New(), STAGEDONE:New() }
-		self.SetStage( self, 1 )
-  end
-  
-  return self
-end

Moose Development/Moose/Menu.lua

@@ -1,371 +0,0 @@
---- Encapsulation of DCS World Menu system in a set of MENU classes.
--- @module Menu
-
-Include.File( "Routines" )
-Include.File( "Base" )
-
---- The MENU class
--- @type MENU
--- @extends Base#BASE
-MENU = {
-  ClassName = "MENU",
-  MenuPath = nil,
-  MenuText = "",
-  MenuParentPath = nil
-}
-
----
-function MENU:New( MenuText, MenuParentPath )
-
-	-- Arrange meta tables
-	local Child = BASE:Inherit( self, BASE:New() )
-
-	Child.MenuPath = nil 
-	Child.MenuText = MenuText
-	Child.MenuParentPath = MenuParentPath
-	return Child
-end
-
---- The COMMANDMENU class
--- @type COMMANDMENU
--- @extends Menu#MENU
-COMMANDMENU = {
-  ClassName = "COMMANDMENU",
-  CommandMenuFunction = nil,
-  CommandMenuArgument = nil
-}
-
-function COMMANDMENU:New( MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument )
-
-	-- Arrange meta tables
-	
-	local MenuParentPath = nil
-	if ParentMenu ~= nil then
-		MenuParentPath = ParentMenu.MenuPath
-	end
-
-	local Child = BASE:Inherit( self, MENU:New( MenuText, MenuParentPath ) )
-
-	Child.MenuPath = missionCommands.addCommand( MenuText, MenuParentPath, CommandMenuFunction, CommandMenuArgument )
-	Child.CommandMenuFunction = CommandMenuFunction
-	Child.CommandMenuArgument = CommandMenuArgument
-	return Child
-end
-
---- The SUBMENU class
--- @type SUBMENU
--- @extends Menu#MENU
-SUBMENU = {
-  ClassName = "SUBMENU"
-}
-
-function SUBMENU:New( MenuText, ParentMenu )
-
-	-- Arrange meta tables
-	local MenuParentPath = nil
-	if ParentMenu ~= nil then
-		MenuParentPath = ParentMenu.MenuPath
-	end
-
-	local Child = BASE:Inherit( self, MENU:New( MenuText, MenuParentPath ) )
-
-	Child.MenuPath = missionCommands.addSubMenu( MenuText, MenuParentPath )
-	return Child
-end
-
--- This local variable is used to cache the menus registered under clients.
--- Menus don't dissapear when clients are destroyed and restarted.
--- So every menu for a client created must be tracked so that program logic accidentally does not create
--- the same menus twice during initialization logic.
--- These menu classes are handling this logic with this variable.
-local _MENUCLIENTS = {}
-
---- The MENU_CLIENT class
--- @type MENU_CLIENT
--- @extends Menu#MENU
-MENU_CLIENT = {
-  ClassName = "MENU_CLIENT"
-}
-
---- Creates a new menu item for a group
--- @param self
--- @param Client#CLIENT MenuClient The Client owning the menu.
--- @param #string MenuText The text for the menu.
--- @param #table ParentMenu The parent menu.
--- @return #MENU_CLIENT self
-function MENU_CLIENT:New( MenuClient, MenuText, ParentMenu )
-
-	-- Arrange meta tables
-	local MenuParentPath = {}
-	if ParentMenu ~= nil then
-	  MenuParentPath = ParentMenu.MenuPath
-	end
-
-	local self = BASE:Inherit( self, MENU:New( MenuText, MenuParentPath ) )
-	self:F( { MenuClient, MenuText, ParentMenu } )
-
-  self.MenuClient = MenuClient
-  self.MenuClientGroupID = MenuClient:GetClientGroupID()
-  self.MenuParentPath = MenuParentPath
-  self.MenuText = MenuText
-  self.ParentMenu = ParentMenu
-  
-  self.Menus = {}
-
-  if not _MENUCLIENTS[self.MenuClientGroupID] then
-    _MENUCLIENTS[self.MenuClientGroupID] = {}
-  end
-  
-  local MenuPath = _MENUCLIENTS[self.MenuClientGroupID]
-
-  self:T( { MenuClient:GetClientGroupName(), MenuPath[table.concat(MenuParentPath)], MenuParentPath, MenuText } )
-
-  local MenuPathID = table.concat(MenuParentPath) .. "/" .. MenuText
-  if MenuPath[MenuPathID] then
-    missionCommands.removeItemForGroup( self.MenuClient:GetClientGroupID(), MenuPath[MenuPathID] )
-  end
-
-	self.MenuPath = missionCommands.addSubMenuForGroup( self.MenuClient:GetClientGroupID(), MenuText, MenuParentPath )
-	MenuPath[MenuPathID] = self.MenuPath
-
-  self:T( { MenuClient:GetClientGroupName(), self.MenuPath } )
-
-  if ParentMenu and ParentMenu.Menus then
-    ParentMenu.Menus[self.MenuPath] = self
-  end
-	return self
-end
-
---- Removes the sub menus recursively of this MENU_CLIENT.
--- @param #MENU_CLIENT self
--- @return #MENU_CLIENT self
-function MENU_CLIENT:RemoveSubMenus()
-  self:F( self.MenuPath )
-
-  for MenuID, Menu in pairs( self.Menus ) do
-    Menu:Remove()
-  end
-
-end
-
---- Removes the sub menus recursively of this MENU_CLIENT.
--- @param #MENU_CLIENT self
--- @return #MENU_CLIENT self
-function MENU_CLIENT:Remove()
-  self:F( self.MenuPath )
-
-  self:RemoveSubMenus()
-
-  if not _MENUCLIENTS[self.MenuClientGroupID] then
-    _MENUCLIENTS[self.MenuClientGroupID] = {}
-  end
-  
-  local MenuPath = _MENUCLIENTS[self.MenuClientGroupID]
-
-  if MenuPath[table.concat(self.MenuParentPath) .. "/" .. self.MenuText] then
-    MenuPath[table.concat(self.MenuParentPath) .. "/" .. self.MenuText] = nil
-  end
-  
-  missionCommands.removeItemForGroup( self.MenuClient:GetClientGroupID(), self.MenuPath )
-  self.ParentMenu.Menus[self.MenuPath] = nil
-  return nil
-end
-
-
---- The MENU_CLIENT_COMMAND class
--- @type MENU_CLIENT_COMMAND
--- @extends Menu#MENU
-MENU_CLIENT_COMMAND = {
-  ClassName = "MENU_CLIENT_COMMAND"
-}
-
---- Creates a new radio command item for a group
--- @param self
--- @param Client#CLIENT MenuClient The Client owning the menu.
--- @param MenuText The text for the menu.
--- @param ParentMenu The parent menu.
--- @param CommandMenuFunction A function that is called when the menu key is pressed.
--- @param CommandMenuArgument An argument for the function.
--- @return Menu#MENU_CLIENT_COMMAND self
-function MENU_CLIENT_COMMAND:New( MenuClient, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument )
-
-	-- Arrange meta tables
-	
-	local MenuParentPath = {}
-	if ParentMenu ~= nil then
-		MenuParentPath = ParentMenu.MenuPath
-	end
-
-	local self = BASE:Inherit( self, MENU:New( MenuText, MenuParentPath ) )
-	
-  self.MenuClient = MenuClient
-  self.MenuClientGroupID = MenuClient:GetClientGroupID()
-  self.MenuParentPath = MenuParentPath
-  self.MenuText = MenuText
-  self.ParentMenu = ParentMenu
-
-  if not _MENUCLIENTS[self.MenuClientGroupID] then
-    _MENUCLIENTS[self.MenuClientGroupID] = {}
-  end
-  
-  local MenuPath = _MENUCLIENTS[self.MenuClientGroupID]
-
-  self:T( { MenuClient:GetClientGroupName(), MenuPath[table.concat(MenuParentPath)], MenuParentPath, MenuText, CommandMenuFunction, CommandMenuArgument } )
-
-  local MenuPathID = table.concat(MenuParentPath) .. "/" .. MenuText
-  if MenuPath[MenuPathID] then
-    missionCommands.removeItemForGroup( self.MenuClient:GetClientGroupID(), MenuPath[MenuPathID] )
-  end
-  
-	self.MenuPath = missionCommands.addCommandForGroup( self.MenuClient:GetClientGroupID(), MenuText, MenuParentPath, CommandMenuFunction, CommandMenuArgument )
-  MenuPath[MenuPathID] = self.MenuPath
- 
-	self.CommandMenuFunction = CommandMenuFunction
-	self.CommandMenuArgument = CommandMenuArgument
-	
-	ParentMenu.Menus[self.MenuPath] = self
-	
-	return self
-end
-
-function MENU_CLIENT_COMMAND:Remove()
-  self:F( self.MenuPath )
-
-  if not _MENUCLIENTS[self.MenuClientGroupID] then
-    _MENUCLIENTS[self.MenuClientGroupID] = {}
-  end
-  
-  local MenuPath = _MENUCLIENTS[self.MenuClientGroupID]
-
-  if MenuPath[table.concat(self.MenuParentPath) .. "/" .. self.MenuText] then
-    MenuPath[table.concat(self.MenuParentPath) .. "/" .. self.MenuText] = nil
-  end
-  
-  missionCommands.removeItemForGroup( self.MenuClient:GetClientGroupID(), self.MenuPath )
-  self.ParentMenu.Menus[self.MenuPath] = nil
-  return nil
-end
-
-
---- The MENU_COALITION class
--- @type MENU_COALITION
--- @extends Menu#MENU
-MENU_COALITION = {
-  ClassName = "MENU_COALITION"
-}
-
---- Creates a new coalition menu item
--- @param #MENU_COALITION self
--- @param DCSCoalition#coalition.side MenuCoalition The coalition owning the menu.
--- @param #string MenuText The text for the menu.
--- @param #table ParentMenu The parent menu.
--- @return #MENU_COALITION self
-function MENU_COALITION:New( MenuCoalition, MenuText, ParentMenu )
-
-  -- Arrange meta tables
-  local MenuParentPath = {}
-  if ParentMenu ~= nil then
-    MenuParentPath = ParentMenu.MenuPath
-  end
-
-  local self = BASE:Inherit( self, MENU:New( MenuText, MenuParentPath ) )
-  self:F( { MenuCoalition, MenuText, ParentMenu } )
-
-  self.MenuCoalition = MenuCoalition
-  self.MenuParentPath = MenuParentPath
-  self.MenuText = MenuText
-  self.ParentMenu = ParentMenu
-  
-  self.Menus = {}
-
-  self:T( { MenuParentPath, MenuText } )
-
-  self.MenuPath = missionCommands.addSubMenuForCoalition( self.MenuCoalition, MenuText, MenuParentPath )
-
-  self:T( { self.MenuPath } )
-
-  if ParentMenu and ParentMenu.Menus then
-    ParentMenu.Menus[self.MenuPath] = self
-  end
-  return self
-end
-
---- Removes the sub menus recursively of this MENU_COALITION.
--- @param #MENU_COALITION self
--- @return #MENU_COALITION self
-function MENU_COALITION:RemoveSubMenus()
-  self:F( self.MenuPath )
-
-  for MenuID, Menu in pairs( self.Menus ) do
-    Menu:Remove()
-  end
-
-end
-
---- Removes the sub menus recursively of this MENU_COALITION.
--- @param #MENU_COALITION self
--- @return #MENU_COALITION self
-function MENU_COALITION:Remove()
-  self:F( self.MenuPath )
-
-  self:RemoveSubMenus()
-  missionCommands.removeItemForCoalition( self.MenuCoalition, self.MenuPath )
-  self.ParentMenu.Menus[self.MenuPath] = nil
-
-  return nil
-end
-
-
---- The MENU_COALITION_COMMAND class
--- @type MENU_COALITION_COMMAND
--- @extends Menu#MENU
-MENU_COALITION_COMMAND = {
-  ClassName = "MENU_COALITION_COMMAND"
-}
-
---- Creates a new radio command item for a group
--- @param #MENU_COALITION_COMMAND self
--- @param DCSCoalition#coalition.side MenuCoalition The coalition owning the menu.
--- @param MenuText The text for the menu.
--- @param ParentMenu The parent menu.
--- @param CommandMenuFunction A function that is called when the menu key is pressed.
--- @param CommandMenuArgument An argument for the function.
--- @return #MENU_COALITION_COMMAND self
-function MENU_COALITION_COMMAND:New( MenuCoalition, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArgument )
-
-  -- Arrange meta tables
-  
-  local MenuParentPath = {}
-  if ParentMenu ~= nil then
-    MenuParentPath = ParentMenu.MenuPath
-  end
-
-  local self = BASE:Inherit( self, MENU:New( MenuText, MenuParentPath ) )
-  
-  self.MenuCoalition = MenuCoalition
-  self.MenuParentPath = MenuParentPath
-  self.MenuText = MenuText
-  self.ParentMenu = ParentMenu
-
-  self:T( { MenuParentPath, MenuText, CommandMenuFunction, CommandMenuArgument } )
-
-  self.MenuPath = missionCommands.addCommandForCoalition( self.MenuCoalition, MenuText, MenuParentPath, CommandMenuFunction, CommandMenuArgument )
- 
-  self.CommandMenuFunction = CommandMenuFunction
-  self.CommandMenuArgument = CommandMenuArgument
-  
-  ParentMenu.Menus[self.MenuPath] = self
-  
-  return self
-end
-
---- Removes a radio command item for a coalition
--- @param #MENU_COALITION_COMMAND self
--- @return #MENU_COALITION_COMMAND self
-function MENU_COALITION_COMMAND:Remove()
-  self:F( self.MenuPath )
-
-  missionCommands.removeItemForCoalition( self.MenuCoalition, self.MenuPath )
-  self.ParentMenu.Menus[self.MenuPath] = nil
-  return nil
-end