Merge pull request #316 from FlightControl-Master/FlightControl

Fixed weaponexpend problem for gunterlund in AI_CAS
-- The attack sequence was commented out. Put it back in.
-- Fixed documentation order glitch.
-- Documented the usage of AI.Task.WeaponExpend
-- Deleted weaponType from Controller Task

.gitignore

@@ -19,8 +19,6 @@ local.properties
 # External tool builders
 .externalToolBuilders/
 
-# Locally stored "Eclipse launch configurations"
-*.launch
 
 # CDT-specific
 .cproject
@@ -224,3 +222,4 @@ _gsdata_/
 #GITHUB
 .gitattributes
 .gitignore
+Moose Test Missions/MOOSE_Test_Template.miz

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "Moose Development/Moose/Dcs"]
+	path = Moose Development/Moose/Dcs
+	url = https://github.com/FlightControl-Master/DCS-API.git
+	branch = master

DCS_Folder_Sync.bat

@@ -0,0 +1,4 @@
+rem This script will pull the latest changes from the remote repository, and update the submodules accordingly.
+
+C:\Program Files (x86)\Git\bin\git pull
+C:\Program Files (x86)\Git\bin\git submodule update --init

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/DCSAirbase.lua

@@ -1,54 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCSAirbase
-
-
---- Represents airbases: airdromes, helipads and ships with flying decks or landing pads.  
--- @type Airbase
--- @extends DCSCoalitionObject#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. 
-
---- Enum contains identifiers of airbase categories.
--- @type Airbase.Category
--- @field AIRDROME
--- @field HELIPAD
--- @field SHIP
-
---- Airbase descriptor. Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type. 
--- @type Airbase.Desc
--- @extends #Desc
--- @field #Airbase.Category category Category of the airbase type.
-
---- Returns airbase by its name. If no airbase found the function will return nil.
--- @function [parent=#Airbase] getByName
--- @param #string name
--- @return #Airbase
-
---- Returns airbase descriptor by type name. If no descriptor is found the function will return nil.
--- @function [parent=#Airbase] getDescByName
--- @param #TypeName typeName Airbase type name.
--- @return #Airbase.Desc
-
---- Returns Unit that is corresponded to the airbase. Works only for ships.
--- @function [parent=#Airbase] getUnit
--- @param self
--- @return Unit#Unit
-
---- Returns identifier of the airbase.
--- @function [parent=#Airbase] getID
--- @param self
--- @return #Airbase.ID
-
---- Returns the airbase's callsign - the localized string.
--- @function [parent=#Airbase] getCallsign
--- @param self
--- @return #string
-
---- Returns descriptor of the airbase. 
--- @function [parent=#Airbase] getDesc
--- @param self
--- @return #Airbase.Desc
-
-
-Airbase = {} --#Airbase

Moose Development/Dcs/DCSCoalitionObject.lua

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

Moose Development/Dcs/DCSCommand.lua

@@ -1,10 +0,0 @@
---- @module DCSCommand
-
-
---- @type Command
--- @field #string id
--- @field #Command.params params
-
---- @type Command.params
-
-env.info( "Command defined" )

Moose Development/Dcs/DCSController.lua

@@ -1,115 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCSController
-
---- Controller is an object that performs A.I.-routines. Other words controller is an instance of A.I.. Controller stores current main task, active enroute tasks and behavior options. Controller performs commands. Please, read DCS A-10C GUI Manual EN.pdf chapter "Task Planning for Unit Groups", page 91 to understand A.I. system of DCS:A-10C. 
--- 
--- This class has 2 types of functions:
--- 
--- * Tasks
--- * Commands: Commands are instant actions those required zero time to perform. Commands may be used both for control unit/group behavior and control game mechanics. 
--- @type Controller
--- @field #Controller.Detection Detection Enum contains identifiers of surface types. 
-
---- Enables and disables the controller.
--- Note: Now it works only for ground / naval groups!
--- @function [parent=#Controller] setOnOff
--- @param self
--- @param #boolean value Enable / Disable.
-
--- Tasks
-
---- Resets current task and then sets the task to the controller. Task is a table that contains task identifier and task parameters.
--- @function [parent=#Controller] setTask
--- @param self
--- @param #Task task
-
---- Resets current task of the controller.
--- @function [parent=#Controller] resetTask 
--- @param self
-
---- Pushes the task to the front of the queue and makes the task active. Further call of function Controller.setTask() function will stop current task, clear the queue and set the new task active. If the task queue is empty the function will work like function Controller.setTask() function.
--- @function [parent=#Controller] pushTask
--- @param self
--- @param #Task task
-
---- Pops current (front) task from the queue and makes active next task in the queue (if exists). If no more tasks in the queue the function works like function Controller.resetTask() function. Does nothing if the queue is empty.
--- @function [parent=#Controller] popTask
--- @param self
-
---- Returns true if the controller has a task. 
--- @function [parent=#Controller] hasTask
--- @param self
--- @return #boolean
-
--- Commands
-
---TODO: describe #Command structure
---- Sets the command to perform by controller.
--- @function [parent=#Controller] setCommand
--- @param self
--- @param #Command command Table that contains command identifier and command parameters. 
-
-
--- Behaviours
-
---- Sets the option to the controller.
--- Option is a pair of identifier and value. Behavior options are global parameters those affect controller behavior in all tasks it performs.
--- Option identifiers and values are stored in table AI.Option in subtables Air, Ground and Naval.
--- 
--- OptionId = @{#AI.Option.Air.id} or @{#AI.Option.Ground.id} or @{#AI.Option.Naval.id}
--- OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName] or AI.Option.Naval.val[optionName]
--- 
--- @function [parent=#Controller] setOption
--- @param self
--- @param #OptionId optionId Option identifier. 
--- @param #OptionValue optionValue Value of the option.
-
-
--- Detection
-
---- Enum contains identifiers of surface types. 
--- @type Controller.Detection
--- @field VISUAL
--- @field OPTIC
--- @field RADAR
--- @field IRST
--- @field RWR
--- @field DLINK
-
---- Detected target. 
--- @type DetectedTarget
--- @field 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
-
-
---- 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 #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. 
--- @return #ModelTime lastTime Has effect only if visible is false. Last time when target was seen. 
--- @return #boolean type Has effect only if detected is true. True if the target type is known. 
--- @return #boolean distance Has effect only if detected is true. True if the distance to the target is known. 
--- @return #Vec3 lastPos Has effect only if visible is false. Last position of the target when it was seen. 
--- @return #Vec3 lastVel Has effect only if visible is false. Last velocity of the target when it was seen. 
-
-
---- Returns list of detected targets. If one or more detection method is specified the function will return targets which were detected by at least one of these methods. If no detection methods are specified the function will return targets which were detected by any method.
--- @function [parent=#Controller] getDetectedTargets
--- @param self
--- @param #Controller.Detection detection Controller.Detection detection1, Controller.Detection detection2, ... Controller.Detection detectionN 
--- @return #list<#DetectedTarget> array of DetectedTarget
-
---- Know a target.
--- @function [parent=#Controller] knowTarget
--- @param self
--- @param Object#Object object The target.
--- @param #boolean type Target type is known.
--- @param #boolean distance Distance to target is known.
-
-
-Controller = {} --#Controller

Moose Development/Dcs/DCSGroup.lua

@@ -1,83 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCSGroup
-
---- Represents group of Units.
--- @type Group
--- @field #ID ID Identifier of a group. It is assigned to a group by Mission Editor automatically. 
--- @field #Group.Category Category Enum contains identifiers of group types. 
-
---- Enum contains identifiers of group types.
--- @type Group.Category
--- @field AIRPLANE
--- @field HELICOPTER
--- @field GROUND
--- @field SHIP
-
--- Static Functions
-
---- Returns group by the name assigned to the group in Mission Editor. 
--- @function [parent=#Group] getByName
--- @param #string name
--- @return #Group
-
--- Member Functions
-
---- returns true if the group exist or false otherwise. 
--- @function [parent=#Group] isExist
--- @param #Group self 
--- @return #boolean
-
---- Destroys the group and all of its units.
--- @function [parent=#Group] destroy
--- @param #Group self 
-
---- Returns category of the group.
--- @function [parent=#Group] getCategory
--- @param #Group self 
--- @return #Group.Category
-
---TODO check coalition.side
-
---- Returns the coalition of the group.
--- @function [parent=#Group] getCoalition
--- @param #Group self 
--- @return DCSCoalitionObject#coalition.side
-
---- Returns the group's name. This is the same name assigned to the group in Mission Editor.
--- @function [parent=#Group] getName
--- @param #Group self 
--- @return #string
-
---- Returns the group identifier.
--- @function [parent=#Group] getID
--- @param #Group self 
--- @return #ID
-
---- Returns the unit with number unitNumber. If the unit is not exists the function will return nil.
--- @function [parent=#Group] getUnit
--- @param #Group self 
--- @param #number unitNumber
--- @return DCSUnit#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
--- @param #Group self 
--- @return #number
-
---- Returns initial size of the group. If some of the units will be destroyed, initial size of the group will not be changed. Initial size limits the unitNumber parameter for Group.getUnit() function.
--- @function [parent=#Group] getInitialSize
--- @param #Group self 
--- @return #number
-
---- 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
-
---- Returns controller of the group. 
--- @function [parent=#Group] getController
--- @param #Group self 
--- @return Controller#Controller
-
-Group = {} --#Group
-

Moose Development/Dcs/DCSObject.lua

@@ -1,73 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCSObject
-
---- @type Object
--- @field #Object.Category Category
--- @field #Object.Desc Desc
-
---- @type Object.Category
--- @field UNIT
--- @field WEAPON
--- @field STATIC
--- @field SCENERY
--- @field BASE
-
---- @type Object.Desc
--- @extends #Desc
--- @field #number life initial life level
--- @field #Box3 box bounding box of collision geometry
-
---- @function [parent=#Object] isExist
--- @param #Object self
--- @return #boolean
-
---- @function [parent=#Object] destroy
--- @param #Object self
-
---- @function [parent=#Object] getCategory
--- @param #Object self
--- @return #Object.Category
-
---- Returns type name of the Object.
--- @function [parent=#Object] getTypeName
--- @param #Object self
--- @return #string 
-
---- Returns object descriptor.
--- @function [parent=#Object] getDesc
--- @param #Object self
--- @return #Object.Desc
-
---- Returns true if the object belongs to the category.
--- @function [parent=#Object] hasAttribute
--- @param #Object self
--- @param #AttributeName attributeName Attribute name to check.
--- @return #boolean
-
---- Returns name of the object. This is the name that is assigned to the object in the Mission Editor.
--- @function [parent=#Object] getName
--- @param #Object self
--- @return #string
-
---- Returns object coordinates for current time.
--- @function [parent=#Object] getPoint
--- @param #Object self
--- @return #Vec3
-
---- Returns object position for current time. 
--- @function [parent=#Object] getPosition
--- @param #Object self
--- @return #Position3
-
---- Returns the unit's velocity vector.
--- @function [parent=#Object] getVelocity
--- @param #Object self
--- @return #Vec3
-
---- Returns true if the unit is in air.
--- @function [parent=#Object] inAir
--- @param #Object self
--- @return #boolean
-
-Object = {} --#Object
-

Moose Development/Dcs/DCSStaticObject.lua

@@ -1,34 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCSStaticObject
-
-
--------------------------------------------------------------------------------
--- @module StaticObject
--- @extends CoalitionObject#CoalitionObject
-
---- Represents static object added in the Mission Editor.
--- @type StaticObject
--- @field #StaticObject.ID ID Identifier of a StaticObject. It assigned to an StaticObject by the Mission Editor automatically.
--- @field #StaticObject.Desc Desc Descriptor of StaticObject and Unit are equal. StaticObject is just a passive variant of Unit. 
-
---- 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
-
---- Returns static object by its name. If no static object found nil will be returned. 
--- @function [parent=#StaticObject] getByName
--- @param #string name Name of static object to find. 
--- @return #StaticObject
-
---- returns identifier of the static object.
--- @function [parent=#StaticObject] getID
--- @param #StaticObject self
--- @return #StaticObject.ID
-
---- Returns descriptor of the StaticObject. 
--- @function [parent=#StaticObject] getDesc
--- @param #StaticObject self
--- @return #StaticObject.Desc
-
-
-StaticObject = {} --#StaticObject

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/DCSTime.lua

@@ -1,8 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCSTime
-
---- @type ModelTime
--- @extends #number
-
---- @type Time
--- @extends #number

Moose Development/Dcs/DCSTypes.lua

@@ -1,236 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCSTypes
-
-
-
---- Time is given in seconds.
--- @type Time
--- @extends #number
-
---- Model time is the time that drives the simulation. Model time may be stopped, accelerated and decelerated relative real time. 
--- @type ModelTime
--- @extends #number
-
---- Mission time is a model time plus time of the mission start.
--- @type MissionTime
--- @extends #number
-
-
---- Distance is given in meters.
--- @type Distance
--- @extends #number
-
---- Angle is given in radians.
--- @type Angle
--- @extends #number
-
---- Azimuth is an angle of rotation around world axis y counter-clockwise.
--- @type Azimuth
--- @extends #number
-
---- Mass is given in kilograms.
--- @type Mass
--- @extends #number
-
---- Vec3 type is a 3D-vector.
--- DCS world has 3-dimensional coordinate system. DCS ground is an infinite plain.
--- @type Vec3
--- @field #Distance x is directed to the north
--- @field #Distance z is directed to the east
--- @field #Distance y is directed up
-
---- Vec2 is a 2D-vector for the ground plane as a reference plane.
--- @type Vec2
--- @field #Distance x Vec2.x = Vec3.x
--- @field #Distance y Vec2.y = Vec3.z
-
---- Position is a composite structure. It consists of both coordinate vector and orientation matrix. Position3 (also known as "Pos3" for short) is a table that has following format: 
--- @type Position3
--- @field #Vec3 p
--- @field #Vec3 x
--- @field #Vec3 y
--- @field #Vec3 z
-
---- 3-dimensional box.
--- @type Box3
--- @field #Vec3 min
--- @field #Vec3 max
-
---- Each object belongs to a type. Object type is a named couple of properties those independent of mission and common for all units of the same type. Name of unit type is a string. Samples of unit type: "Su-27", "KAMAZ" and "M2 Bradley". 
--- @type TypeName
--- @extends #string
-
-
---- @type AI
--- @field #AI.Skill Skill
--- @field #AI.Task Task
--- @field #AI.Option Option
-
---- @type AI.Skill
--- @field AVERAGE
--- @field GOOD
--- @field HIGH
--- @field EXCELLENT
--- @field PLAYER
--- @field CLIENT
-
---- @type AI.Task
--- @field #AI.Task.WeaponExpend WeaponExpend
--- @field #AI.Task.OrbitPattern OrbitPattern
--- @field #AI.Task.Designation Designation
--- @field #AI.Task.WaypointType WaypointType
--- @field #AI.Task.TurnMethod TurnMethod
--- @field #AI.Task.AltitudeType AltitudeType
--- @field #AI.Task.VehicleFormation VehicleFormation
-
---- @type AI.Task.WeaponExpend
--- @field ONE
--- @field TWO
--- @field FOUR
--- @field QUARTER
--- @field HALF
--- @field ALL
-
---- @type AI.Task.OrbitPattern
--- @field CIRCLE
--- @field RACE_TRACK
-
---- @type AI.Task.Designation
--- @field NO
--- @field AUTO
--- @field WP
--- @field IR_POINTER
--- @field LASER
-
---- @type AI.Task.WaypointType
--- @field TAKEOFF
--- @field TAKEOFF_PARKING
--- @field TURNING_POINT
--- @field LAND
-
---- @type AI.Task.TurnMethod
--- @field FLY_OVER_POINT
--- @field FIN_POINT
-
---- @type AI.Task.AltitudeType
--- @field BARO
--- @field RADIO
-
---- @type AI.Task.VehicleFormation
--- @field OFF_ROAD
--- @field ON_ROAD
--- @field RANK
--- @field CONE
--- @field DIAMOND
--- @field VEE
--- @field ECHELON_LEFT
--- @field ECHELON_RIGHT
-
---- @type AI.Option
--- @field #AI.Option.Air                          Air
--- @field #AI.Option.Ground                       Ground
--- @field #AI.Option.Naval                        Naval
-
---- @type AI.Option.Air
--- @field #AI.Option.Air.id                       id
--- @field #AI.Option.Air.val                      val
-
---- @type AI.Option.Ground
--- @field #AI.Option.Ground.id                    id
--- @field #AI.Option.Ground.val                   val
-
---- @type AI.Option.Naval
--- @field #AI.Option.Naval.id                     id
--- @field #AI.Option.Naval.val                    val
-
---TODO: work on formation
---- @type AI.Option.Air.id
--- @field NO_OPTION
--- @field ROE
--- @field REACTION_ON_THREAT
--- @field RADAR_USING
--- @field FLARE_USING
--- @field FORMATION
--- @field RTB_ON_BINGO
--- @field SILENCE 
-
---- @type AI.Option.Air.val
--- @field #AI.Option.Air.val.ROE ROE
--- @field #AI.Option.Air.val.REACTION_ON_THREAT REACTION_ON_THREAT
--- @field #AI.Option.Air.val.RADAR_USING RADAR_USING
--- @field #AI.Option.Air.val.FLARE_USING FLARE_USING
-
---- @type AI.Option.Air.val.ROE
--- @field WEAPON_FREE
--- @field OPEN_FIRE_WEAPON_FREE
--- @field OPEN_FIRE
--- @field RETURN_FIRE
--- @field WEAPON_HOLD
- 
---- @type AI.Option.Air.val.REACTION_ON_THREAT
--- @field NO_REACTION
--- @field PASSIVE_DEFENCE
--- @field EVADE_FIRE
--- @field BYPASS_AND_ESCAPE
--- @field ALLOW_ABORT_MISSION
-
---- @type AI.Option.Air.val.RADAR_USING
--- @field NEVER
--- @field FOR_ATTACK_ONLY
--- @field FOR_SEARCH_IF_REQUIRED
--- @field FOR_CONTINUOUS_SEARCH
-
---- @type AI.Option.Air.val.FLARE_USING
--- @field NEVER
--- @field AGAINST_FIRED_MISSILE
--- @field WHEN_FLYING_IN_SAM_WEZ
--- @field WHEN_FLYING_NEAR_ENEMIES
-
---- @type AI.Option.Ground.id
--- @field NO_OPTION
--- @field ROE @{#AI.Option.Ground.val.ROE}
--- @field DISPERSE_ON_ATTACK true or false
--- @field ALARM_STATE @{#AI.Option.Ground.val.ALARM_STATE}
-
---- @type AI.Option.Ground.val
--- @field #AI.Option.Ground.val.ROE               ROE
--- @field #AI.Option.Ground.val.ALARM_STATE       ALARM_STATE
-
---- @type AI.Option.Ground.val.ROE
--- @field OPEN_FIRE
--- @field RETURN_FIRE
--- @field WEAPON_HOLD
-
---- @type AI.Option.Ground.val.ALARM_STATE
--- @field AUTO
--- @field GREEN
--- @field RED
-
---- @type AI.Option.Naval.id
--- @field NO_OPTION
--- @field ROE
-
---- @type AI.Option.Naval.val
--- @field #AI.Option.Naval.val.ROE ROE
-
---- @type AI.Option.Naval.val.ROE
--- @field OPEN_FIRE
--- @field RETURN_FIRE
--- @field WEAPON_HOLD
-
-AI = {} --#AI
-
-
---- @type Desc
--- @field #TypeName typeName type name
--- @field #string displayName localized display name
--- @field #table attributes object type attributes
-
---- A distance type
--- @type Distance
-
---- An angle type
--- @type Angle
-
-env.info( 'AI types created' )
-

Moose Development/Dcs/DCSUnit.lua

@@ -1,241 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCSUnit
-
---- @type Unit
--- @extends DCSCoalitionObject#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
--- @field #Unit.SensorType SensorType
--- @field #Unit.OpticType OpticType
--- @field #Unit.RadarType RadarType
--- @field #Unit.Desc Desc
--- @field #Unit.DescAircraft DescAircraft
--- @field #Unit.DescAirplane DescAirplane
--- @field #Unit.DescHelicopter DescHelicopter
--- @field #Unit.DescVehicle DescVehicle
--- @field #Unit.DescShip DescShip
--- @field #Unit.AmmoItem AmmoItem
--- @field #list<#Unit.AmmoItem> Ammo
--- @field #Unit.Sensor Sensor
--- @field #Unit.Optic Optic
--- @field #Unit.Radar Radar
--- @field #Unit.IRST IRST
-
-
---- Enum that stores unit categories.
--- @type Unit.Category
--- @field AIRPLANE
--- @field HELICOPTER
--- @field GROUND_UNIT
--- @field SHIP
--- @field STRUCTURE
-
---- Enum that stores aircraft refueling system types.
--- @type Unit.RefuelingSystem
--- @field BOOM_AND_RECEPTACLE
--- @field PROBE_AND_DROGUE
-
---- Enum that stores sensor types.
--- @type Unit.SensorType
--- @field OPTIC
--- @field RADAR
--- @field IRST
--- @field RWR
-
---- Enum that stores types of optic sensors.
--- @type Unit.OpticType
--- @field TV TV-sensor
--- @field LLTV Low-level TV-sensor
--- @field IR Infra-Red optic sensor
-
---- Enum that stores radar types.
--- @type Unit.RadarType
--- @field AS air search radar
--- @field SS surface/land search radar
-
-
---- A unit descriptor. 
--- @type Unit.Desc
--- @extends 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
--- @field #Mass fuelMassMax maximal inner fuel mass
--- @field #Distance range Operational range
--- @field #Distance Hmax Ceiling
--- @field #number VyMax  #Distance / #Time, --maximal climb rate
--- @field #number NyMin minimal safe acceleration
--- @field #number NyMax maximal safe acceleration
--- @field #Unit.RefuelingSystem tankerType refueling system type
-
---- An airplane descriptor.
--- @type Unit.DescAirplane 
--- @extends 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
--- @field #Distance HmaxStat static ceiling
-
---- A vehicle descriptor.
--- @type Unit.DescVehicle 
--- @extends Unit#Unit.Desc
--- @field #Angle maxSlopeAngle maximal slope angle
--- @field #boolean riverCrossing can the vehicle cross a rivers
-
---- A ship descriptor.
--- @type Unit.DescShip 
--- @extends #Unit.Desc
- 
---- ammunition item: "type-count" pair.
--- @type Unit.AmmoItem
--- @field #Weapon.Desc desc ammunition descriptor
--- @field #number count ammunition count
-
---- A unit sensor.
--- @type Unit.Sensor
--- @field #TypeName typeName
--- @field #Unit.SensorType type
-
---- An optic sensor.
--- @type Unit.Optic 
--- @extends Unit#Unit.Sensor
--- @field #Unit.OpticType opticType
-
---- A radar.
--- @type  Unit.Radar 
--- @extends 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
-
---- @type Unit.Radar.detectionDistanceAir 
--- @field #Unit.Radar.detectionDistanceAir.upperHemisphere upperHemisphere
--- @field #Unit.Radar.detectionDistanceAir.lowerHemisphere lowerHemisphere
-
---- @type Unit.Radar.detectionDistanceAir.upperHemisphere
--- @field #Distance headOn
--- @field #Distance tailOn
-
---- @type Unit.Radar.detectionDistanceAir.lowerHemisphere 
--- @field #Distance headOn
--- @field #Distance tailOn
-
---- An IRST.
---  @type 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
---  @field #Distance detectionDistanceAfterburner ..., engines are in afterburner mode
-
---- An RWR.
---  @type Unit.RWR 
---  @extends Unit#Unit.Sensor
-
---- table that stores all unit sensors.
--- TODO @type Sensors
--- 
-
-
---- Returns unit object by the name assigned to the unit in Mission Editor. If there is unit with such name or the unit is destroyed the function will return nil. The function provides access to non-activated units too. 
--- @function [parent=#Unit] getByName
--- @param #string name
--- @return #Unit
-
---- Returns if the unit is activated.
--- @function [parent=#Unit] isActive
--- @param #Unit self
--- @return #boolean
-
---- Returns name of the player that control the unit or nil if the unit is controlled by A.I.
--- @function [parent=#Unit] getPlayerName
--- @param #Unit self
--- @return #string
-
---- returns the unit's unique identifier.
--- @function [parent=#Unit] getID
--- @param #Unit self
--- @return #Unit.ID
-
-
---- Returns the unit's number in the group. The number is the same number the unit has in ME. It may not be changed during the mission. If any unit in the group is destroyed, the numbers of another units will not be changed.
--- @function [parent=#Unit] getNumber
--- @param #Unit self
--- @return #number
-
---- Returns controller of the unit if it exist and nil otherwise
--- @function [parent=#Unit] getController
--- @param #Unit self
--- @return #Controller
-
---- Returns the unit's group if it exist and nil otherwise
--- @function [parent=#Unit] getGroup
--- @param #Unit self
--- @return DCSGroup#Group
-
---- Returns the unit's callsign - the localized string.
--- @function [parent=#Unit] getCallsign
--- @param #Unit self
--- @return #string
-
---- Returns the unit's health. Dead units has health <= 1.0
--- @function [parent=#Unit] getLife
--- @param #Unit self
--- @return #number
-
---- returns the unit's initial health.
--- @function [parent=#Unit] getLife0
--- @param #Unit self
--- @return #number
-
---- Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks. If there are additional fuel tanks the value may be greater than 1.0.
--- @function [parent=#Unit] getFuel
--- @param #Unit self
--- @return #number
-
---- Returns the unit ammunition.
--- @function [parent=#Unit] getAmmo
--- @param #Unit self
--- @return #Unit.Ammo
-
---- Returns the unit sensors. 
--- @function [parent=#Unit] getSensors
--- @param #Unit self
--- @return #Unit.Sensors
-
---- Returns true if the unit has specified types of sensors. This function is more preferable than Unit.getSensors() if you don't want to get information about all the unit's sensors, and just want to check if the unit has specified types of sensors.
--- @function [parent=#Unit] hasSensors
--- @param #Unit self
--- @param #Unit.SensorType sensorType (= nil) Sensor type.
--- @param ... Additional parameters.
--- @return #boolean
--- @usage
--- If sensorType is Unit.SensorType.OPTIC, additional parameters are optic sensor types. Following example checks if the unit has LLTV or IR optics:
--- unit:hasSensors(Unit.SensorType.OPTIC, Unit.OpticType.LLTV, Unit.OpticType.IR)
--- If sensorType is Unit.SensorType.RADAR, additional parameters are radar types. Following example checks if the unit has air search radars:
--- unit:hasSensors(Unit.SensorType.RADAR, Unit.RadarType.AS)
--- If no additional parameters are specified the function returns true if the unit has at least one sensor of specified type.
--- If sensor type is not specified the function returns true if the unit has at least one sensor of any type.
--- 
-
---- returns two values:
--- First value indicates if at least one of the unit's radar(s) is on.
--- 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
-
---- Returns unit descriptor. Descriptor type depends on unit category. 
--- @function [parent=#Unit] getDesc
--- @param #Unit self
--- @return #Unit.Desc
-
-
-Unit = {} --#Unit

Moose Development/Dcs/DCScountry.lua

@@ -1,26 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCScountry
-
---- @type country
--- @field #country.id id
-
---- @type country.id
--- @field RUSSIA
--- @field UKRAINE
--- @field USA
--- @field TURKEY
--- @field UK
--- @field FRANCE
--- @field GERMANY
--- @field CANADA
--- @field SPAIN
--- @field THE_NETHERLANDS
--- @field BELGIUM
--- @field NORWAY
--- @field DENMARK
--- @field ISRAEL
--- @field GEORGIA
--- @field INSURGENTS
--- @field ABKHAZIA
--- @field SOUTH_OSETIA
--- @field ITALY

Moose Development/Dcs/DCSenv.lua

@@ -1,27 +0,0 @@
--------------------------------------------------------------------------------
--- @module env
-
---- @type env
-
---- Add message to simulator log with caption "INFO". Message box is optional.
--- @function [parent=#env] info
--- @field #string message message string to add to log.
--- @field #boolean showMessageBox If the parameter is true Message Box will appear. Optional.
-
---- Add message to simulator log with caption "WARNING". Message box is optional. 
--- @function [parent=#env] warning
--- @field #string message message string to add to log.
--- @field #boolean showMessageBox If the parameter is true Message Box will appear. Optional.
-
---- Add message to simulator log with caption "ERROR". Message box is optional.
--- @function [parent=#env] error
--- @field #string message message string to add to log.
--- @field #boolean showMessageBox If the parameter is true Message Box will appear. Optional.
-
---- Enables/disables appearance of message box each time lua error occurs.
--- @function [parent=#env] setErrorMessageBoxEnabled
--- @field #boolean on if true message box appearance is enabled.
-
-
-
-env = {} --#env

Moose Development/Dcs/DCSland.lua

@@ -1,20 +0,0 @@
--------------------------------------------------------------------------------
--- @module land
-
---- @type land
--- @field #land.SurfaceType SurfaceType
-
-
---- @type land.SurfaceType
--- @field LAND
--- @field SHALLOW_WATER
--- @field WATER
--- @field ROAD
--- @field RUNWAY
-
---- Returns altitude MSL of the point.
--- @function [parent=#land] getHeight
--- @param #Vec2 point point on the ground. 
--- @return DCSTypes#Distance
-
-land = {} --#land

Moose Development/Dcs/DCStimer.lua

@@ -1,45 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCStimer
-
---- @type timer
-
-
---- Returns model time in seconds.
--- @function [parent=#timer] getTime
--- @return #Time   
-
---- Returns mission time in seconds.
--- @function [parent=#timer] getAbsTime
--- @return #Time
-
---- Returns mission start time in seconds.
--- @function [parent=#timer] getTime0
--- @return #Time
-
---- Schedules function to call at desired model time.
---  Time function FunctionToCall(any argument, Time time)
---  
---  ...
---  
---  return ...
---  
---  end
---  
---  Must return model time of next call or nil. Note that the DCS scheduler calls the function in protected mode and any Lua errors in the called function will be trapped and not reported. If the function triggers a Lua error then it will be terminated and not scheduled to run again. 
--- @function [parent=#timer] scheduleFunction
--- @param #FunctionToCall functionToCall Lua-function to call. Must have prototype of FunctionToCall. 
--- @param functionArgument Function argument of any type to pass to functionToCall.
--- @param #Time time Model time of the function call.
--- @return functionId
-
---- Re-schedules function to call at another model time.
--- @function [parent=#timer] setFunctionTime 
--- @param functionId Lua-function to call. Must have prototype of FunctionToCall. 
--- @param #Time time Model time of the function call. 
-
-
---- Removes the function from schedule.
--- @function [parent=#timer] removeFunction
--- @param functionId Function identifier to remove from schedule 
-
-timer = {} --#timer

Moose Development/Dcs/DCSworld.lua

@@ -1,35 +0,0 @@
--------------------------------------------------------------------------------
--- @module DCSWorld
-
---- @type world
--- @field #world.event event
-
-
---- @type world.event
--- @field S_EVENT_INVALID
--- @field S_EVENT_SHOT
--- @field S_EVENT_HIT
--- @field S_EVENT_TAKEOFF
--- @field S_EVENT_LAND
--- @field S_EVENT_CRASH
--- @field S_EVENT_EJECTION
--- @field S_EVENT_REFUELING
--- @field S_EVENT_DEAD
--- @field S_EVENT_PILOT_DEAD
--- @field S_EVENT_BASE_CAPTURED
--- @field S_EVENT_MISSION_START
--- @field S_EVENT_MISSION_END
--- @field S_EVENT_TOOK_CONTROL
--- @field S_EVENT_REFUELING_STOP
--- @field S_EVENT_BIRTH
--- @field S_EVENT_HUMAN_FAILURE
--- @field S_EVENT_ENGINE_STARTUP
--- @field S_EVENT_ENGINE_SHUTDOWN
--- @field S_EVENT_PLAYER_ENTER_UNIT
--- @field S_EVENT_PLAYER_LEAVE_UNIT
--- @field S_EVENT_PLAYER_COMMENT
--- @field S_EVENT_SHOOTING_START
--- @field S_EVENT_SHOOTING_END
--- @field S_EVENT_MAX
-
-world = {} --#world

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/LDT External Tools/Moose Documentation.launch

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+</listAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="C:\Program Files\lua\5.1\bin\luadocumentor.bat"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="&quot;Moose\Core\*.lua&quot; &quot;Moose\Wrapper\*.lua&quot; &quot;Moose\Actions\*.lua&quot; &quot;Moose\Functional\*.lua&quot; &quot;Moose\Tasking\*.lua&quot; &quot;Moose\Utilities\*.lua&quot; &quot;Moose\AI\*.lua&quot; --dir &quot;${project_loc:}/docs/Documentation&quot; --style &quot;${project_loc:}/docs/Stylesheet/stylesheet.css&quot;"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${project_loc:}/Moose Development"/>
+</launchConfiguration>

Moose Development/LDT External Tools/Moose Dynamic.launch

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+</listAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${project_loc:}/Moose Mission Setup\Moose_Create.bat"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="&quot;${project_loc:}/Moose Development&quot; &quot;${current_date}&quot; &quot;${project_loc:}/Moose Mission Setup/Moose Mission Update/l10n/DEFAULT&quot; &quot;D&quot;"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${project_loc:}/Moose Mission Setup"/>
+</launchConfiguration>

Moose Development/LDT External Tools/Moose Static.launch

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+</listAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${project_loc:}/Moose Mission Setup\Moose_Create.bat"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="&quot;${project_loc:}/Moose Development/Moose&quot; &quot;${current_date}&quot; &quot;${project_loc:}/Moose Mission Setup/Moose Mission Update/l10n/DEFAULT&quot; &quot;S&quot;"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${project_loc:}/Moose Mission Setup"/>
+</launchConfiguration>

Moose Development/LDT External Tools/Update ALL Moose Test Missions.launch

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${project_loc:}/Moose Mission Setup/Moose Mission Update\Moose_Update_Missions.bat"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="&quot;${project_loc:}/Moose Test Missions&quot;"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${project_loc:}/Moose Mission Setup/Moose Mission Update"/>
+</launchConfiguration>

Moose Development/LDT External Tools/Update SELECTED Moose Test Mission.launch

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+</listAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${project_loc:}/Moose Mission Setup/Moose Mission Update\Moose_Update_Missions.bat"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="&quot;${selected_resource_loc}&quot;"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${project_loc:}/Moose Mission Setup/Moose Mission Update"/>
+</launchConfiguration>

Moose Development/Moose/AI/AI_Balancer.lua

@@ -0,0 +1,306 @@
+--- Single-Player:**No** / Multi-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**All** -- **AI Balancing will replace in multi player missions 
+-- non-occupied human slots with AI groups, in order to provide an engaging simulation environment, 
+-- even when there are hardly any players in the mission.**
+-- 
+-- ![Banner Image](..\Presentations\AI_Balancer\Dia1.JPG)
+--  
+-- ===
+-- 
+-- # 1) @{AI_Balancer#AI_BALANCER} class, extends @{Fsm#FSM_SET}
+-- 
+-- The @{AI_Balancer#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.1) AI_BALANCER construction
+-- 
+-- Create a new AI_BALANCER object with the @{#AI_BALANCER.New}() method:
+-- 
+-- ## 1.2) AI_BALANCER is a FSM
+-- 
+-- ![Process](..\Presentations\AI_Balancer\Dia13.JPG)
+-- 
+-- ### 1.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.
+-- 
+-- ### 1.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.
+--    
+-- ## 1.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.
+-- 
+-- ## 1.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.
+--    
+-- ===
+-- 
+-- # **API CHANGE HISTORY**
+-- 
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+-- 
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+-- 
+-- Hereby the change log:
+-- 
+-- 2017-01-17: There is still a problem with AI being destroyed, but not respawned. Need to check further upon that.
+-- 
+-- 2017-01-08: AI_BALANCER:**InitSpawnInterval( Earliest, Latest )** added.
+-- 
+-- ===
+-- 
+-- # **AUTHORS and CONTRIBUTIONS**
+-- 
+-- ### 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 :-)
+--   * **SNAFU**: Had a couple of mails with the guys to validate, if the same concept in the GCI/CAP script could be reworked within MOOSE. None of the script code has been used however within the new AI_BALANCER moose class.
+-- 
+-- ### Authors: 
+-- 
+--   * FlightControl: Framework Design &  Programming and Documentation.
+-- 
+-- @module AI_Balancer
+
+--- AI_BALANCER class
+-- @type AI_BALANCER
+-- @field Core.Set#SET_CLIENT SetClient
+-- @field Functional.Spawn#SPAWN SpawnAI
+-- @field Wrapper.Group#GROUP Test
+-- @extends Core.Fsm#FSM_SET
+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 Functional.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 ReturnTresholdRange If there is an enemy @{Client#CLIENT} within the ReturnTresholdRange 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( ReturnTresholdRange, ReturnAirbaseSet )
+
+  self.ToNearestAirbase = true
+  self.ReturnTresholdRange = ReturnTresholdRange
+  self.ReturnAirbaseSet = ReturnAirbaseSet
+end
+
+--- Returns the AI to the home @{Airbase#AIRBASE}.
+-- @param #AI_BALANCER self
+-- @param Dcs.DCSTypes#Distance ReturnTresholdRange If there is an enemy @{Client#CLIENT} within the ReturnTresholdRange given in meters, the AI will not return to the nearest @{Airbase#AIRBASE}.
+function AI_BALANCER:ReturnToHomeAirbase( ReturnTresholdRange )
+
+  self.ToHomeAirbase = true
+  self.ReturnTresholdRange = ReturnTresholdRange
+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:E( "Spawning new AIGroup" )
+    --TODO: need to rework UnitName thing ...
+    
+    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()
+  SetGroup:Remove( ClientName )
+  SetGroup:Flush()
+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 Client:IsAlive() 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.ReturnTresholdRange 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.ReturnTresholdRange, then the unit will return to the Airbase return method selected.
+
+            local PlayerInRange = { Value = false }          
+            local RangeZone = ZONE_RADIUS:New( 'RangeZone', AIGroup:GetVec2(), self.ReturnTresholdRange )
+            
+            self:T2( RangeZone )
+            
+            _DATABASE:ForEachPlayer(
+              --- @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." )
+          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:E( "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,554 @@
+--- Single-Player:**Yes** / Multi-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**Air** -- **Execute Combat Air Patrol (CAP).**
+--
+-- ![Banner Image](..\Presentations\AI_CAP\Dia1.JPG)
+-- 
+-- ===
+--
+-- # 1) @{#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.1) AI_CAP_ZONE constructor
+--   
+--   * @{#AI_CAP_ZONE.New}(): Creates a new AI_CAP_ZONE object.
+-- 
+-- ## 1.2) AI_CAP_ZONE is a FSM
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia2.JPG)
+-- 
+-- ### 1.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..
+-- 
+-- ### 1.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.
+--
+-- ## 1.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.
+--
+-- ## 1.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.
+--
+-- ====
+--
+-- # **API CHANGE HISTORY**
+--
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+--
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+--
+-- Hereby the change log:
+--
+-- 2017-01-15: Initial class and API.
+--
+-- ===
+--
+-- # **AUTHORS and CONTRIBUTIONS**
+--
+-- ### Contributions:
+--
+--   * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing.
+--   * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing.
+--   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
+--   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing.
+--   * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing. 
+--        
+-- ### Authors:
+--
+--   * **FlightControl**: Concept, Design & Programming.
+--
+-- @module AI_Cap
+
+
+--- AI_CAP_ZONE class
+-- @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 = {
+  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
+
+-- todo: need to fix this global function
+
+--- @param Wrapper.Controllable#CONTROLLABLE AIControllable
+function _NewEngageCapRoute( AIControllable )
+
+  AIControllable:T( "NewEngageRoute" )
+  local EngageZone = AIControllable:GetState( AIControllable, "EngageZone" ) -- AI.AI_Cap#AI_CAP_ZONE
+  EngageZone:__Engage( 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: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:E( '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:RoutePointAir( 
+        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:RoutePointAir( 
+      self.PatrolAltType, 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      ToTargetSpeed, 
+      true 
+    )
+
+    EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
+
+    Controllable:OptionROEOpenFire()
+    Controllable:OptionROTPassiveDefense()
+
+    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:E( {"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:E( {"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
+
+    --- 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( EngageRoute )
+    
+    
+    if #AttackTasks == 0 then
+      self:E("No targets found -> Going back to Patrolling")
+      self:__Abort( 1 )
+      self:__Route( 1 )
+      self:SetDetectionActivated()
+    else
+      EngageRoute[1].task = Controllable:TaskCombo( AttackTasks )
+      
+      --- Do a trick, link the NewEngageRoute function of the object to the AIControllable in a temporary variable ...
+      self.Controllable:SetState( self.Controllable, "EngageZone", self )
+  
+      self.Controllable:WayPointFunction( #EngageRoute, 1, "_NewEngageCapRoute" )
+      
+      self:SetDetectionDeactivated()
+    end
+    
+    --- NOW ROUTE THE GROUP!
+    self.Controllable:WayPointExecute( 1, 2 )
+  
+  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,602 @@
+--- Single-Player:**Yes** / Multi-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**Air** -- 
+-- **Provide Close Air Support to friendly ground troops.**
+--
+-- ![Banner Image](..\Presentations\AI_CAS\Dia1.JPG)
+-- 
+-- ===
+--
+-- # 1) @{#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)
+--
+-- # 1.1) AI_CAS_ZONE constructor
+--
+--   * @{#AI_CAS_ZONE.New}(): Creates a new AI_CAS_ZONE object.
+--
+-- ## 1.2) AI_CAS_ZONE is a FSM
+-- 
+-- ![Process](..\Presentations\AI_CAS\Dia2.JPG)
+-- 
+-- ### 1.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..
+-- 
+-- ### 1.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.
+--    
+-- ====
+--
+-- # **API CHANGE HISTORY**
+--
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+--
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+--
+-- Hereby the change log:
+--
+-- 2017-01-15: Initial class and API.
+--
+-- ===
+--
+-- # **AUTHORS and CONTRIBUTIONS**
+--
+-- ### Contributions:
+--
+--   * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing.
+--   * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing.
+--   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
+--
+-- ### Authors:
+--
+--   * **FlightControl**: Concept, Design & Programming.
+--
+-- @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 = {
+  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 Wrapper.Controllable#CONTROLLABLE AIControllable
+function _NewEngageRoute( AIControllable )
+
+  AIControllable:T( "NewEngageRoute" )
+  local EngageZone = AIControllable:GetState( AIControllable, "EngageZone" ) -- AI.AI_Cas#AI_CAS_ZONE
+  EngageZone:__Engage( 1, EngageZone.EngageSpeed, EngageZone.EngageAltitude, EngageZone.EngageWeaponExpend, EngageZone.EngageAttackQty, EngageZone.EngageDirection )
+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 )
+  self:E("onafterTarget")
+
+  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:E( {"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
+  
+
+    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:RoutePointAir( 
+        self.PatrolAltType, 
+        POINT_VEC3.RoutePointType.TurningPoint, 
+        POINT_VEC3.RoutePointAction.TurningPoint, 
+        self.EngageSpeed, 
+        true 
+      )
+    
+    EngageRoute[#EngageRoute+1] = CurrentRoutePoint
+
+  
+--    if self.Controllable:IsNotInZone( self.EngageZone ) then
+--
+--      -- Find a random 2D point in EngageZone.
+--      local ToEngageZoneVec2 = self.EngageZone:GetRandomVec2()
+--      self:T2( ToEngageZoneVec2 )
+--      
+--      -- Obtain a 3D @{Point} from the 2D point + altitude.
+--      local ToEngageZonePointVec3 = POINT_VEC3:New( ToEngageZoneVec2.x, self.EngageAltitude, ToEngageZoneVec2.y )
+--      
+--      -- Create a route point of type air.
+--      local ToEngageZoneRoutePoint = ToEngageZonePointVec3:RoutePointAir( 
+--        self.PatrolAltType, 
+--        POINT_VEC3.RoutePointType.TurningPoint, 
+--        POINT_VEC3.RoutePointAction.TurningPoint, 
+--        self.EngageSpeed, 
+--        true 
+--      )
+--
+--      EngageRoute[#EngageRoute+1] = ToEngageZoneRoutePoint
+--
+--    end
+--    
+    --- 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:RoutePointAir( 
+      self.PatrolAltType, 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      self.EngageSpeed, 
+      true 
+    )
+    
+    --ToTargetPointVec3:SmokeBlue()
+
+    EngageRoute[#EngageRoute+1] = ToTargetRoutePoint
+    
+
+    Controllable:OptionROEOpenFire()
+    Controllable:OptionROTVertical()
+
+    local AttackTasks = {}
+
+    for DetectedUnitID, DetectedUnit 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:E( {"Engaging ", DetectedUnit } )
+          AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit, 
+                                                                     true, 
+                                                                     EngageWeaponExpend, 
+                                                                     EngageAttackQty, 
+                                                                     EngageDirection 
+                                                                   )
+        end
+      else
+        self.DetectedUnits[DetectedUnit] = nil
+      end
+    end
+
+    EngageRoute[1].task = Controllable:TaskCombo( AttackTasks )
+
+    --- 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( EngageRoute )
+    
+    --- Do a trick, link the NewEngageRoute function of the object to the AIControllable in a temporary variable ...
+    self.Controllable:SetState( self.Controllable, "EngageZone", self )
+
+    self.Controllable:WayPointFunction( #EngageRoute, 1, "_NewEngageRoute" )
+
+    --- NOW ROUTE THE GROUP!
+    self.Controllable:WayPointExecute( 1 )
+    
+    self:SetDetectionInterval( 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,939 @@
+--- Single-Player:**Yes** / Multi-Player:**Yes** / AI:**Yes** / Human:**No** / Types:**Air** -- 
+-- **Air Patrolling or Staging.**
+-- 
+-- ![Banner Image](..\Presentations\AI_PATROL\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- # 1) @{#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.1) AI_PATROL_ZONE constructor
+--   
+--   * @{#AI_PATROL_ZONE.New}(): Creates a new AI_PATROL_ZONE object.
+-- 
+-- ## 1.2) AI_PATROL_ZONE is a FSM
+-- 
+-- ![Process](..\Presentations\AI_PATROL\Dia2.JPG)
+-- 
+-- ### 1.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.
+-- 
+-- ### 1.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.
+--    
+-- ## 1.3) Set or Get the AI controllable
+-- 
+--   * @{#AI_PATROL_ZONE.SetControllable}(): Set the AIControllable.
+--   * @{#AI_PATROL_ZONE.GetControllable}(): Get the AIControllable.
+--
+-- ## 1.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.
+-- 
+-- ## 1.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.SetDetectionInterval}( 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.
+-- 
+-- ## 1.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.
+-- 
+-- ## 1.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.
+-- 
+-- ====
+-- 
+-- # **OPEN ISSUES**
+-- 
+-- 2017-01-17: When Spawned AI is located at an airbase, it will be routed first back to the airbase after take-off.
+-- 
+-- 2016-01-17: 
+--   -- Fixed problem with AI returning to base too early and unexpected.
+--   -- ReSpawning of AI will reset the AI_PATROL and derived classes.
+--   -- Checked the correct workings of SCHEDULER, and it DOES work correctly.
+-- 
+-- ====
+-- 
+-- # **API CHANGE HISTORY**
+-- 
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+-- 
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+-- 
+-- Hereby the change log:
+-- 
+-- 2017-01-17: Rename of class: **AI\_PATROL\_ZONE** is the new name for the old _AI\_PATROLZONE_.
+-- 
+-- 2017-01-15: Complete revision. AI_PATROL_ZONE is the base class for other AI_PATROL like classes.
+-- 
+-- 2016-09-01: Initial class and API.
+-- 
+-- ===
+-- 
+-- # **AUTHORS and CONTRIBUTIONS**
+-- 
+-- ### 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.
+-- 
+-- ### Authors: 
+-- 
+--   * **FlightControl**: Design & Programming.
+-- 
+-- @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 Functional.Spawn#SPAWN CoordTest
+-- @extends Core.Fsm#FSM_CONTROLLABLE
+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:SetDetectionInterval( 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:SetDetectionInterval( 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 PatrolFuelTresholdPercentage 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( PatrolFuelTresholdPercentage, PatrolOutOfFuelOrbitTime )
+
+  self.PatrolManageFuel = true
+  self.PatrolFuelTresholdPercentage = PatrolFuelTresholdPercentage
+  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 PatrolDamageTreshold 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( PatrolDamageTreshold )
+
+  self.PatrolManageDamage = true
+  self.PatrolDamageTreshold = PatrolDamageTreshold
+  
+  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:RoutePointAir( 
+          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:RoutePointAir( 
+          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:RoutePointAir( 
+      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.PatrolFuelTresholdPercentage then
+      self:E( self.Controllable:GetName() .. " is out of fuel:" .. Fuel .. ", RTB!" )
+      local OldAIControllable = self.Controllable
+      local AIControllableTemplate = self.Controllable:GetTemplate()
+      
+      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.PatrolDamageTreshold 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:RoutePointAir( 
+        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,256 @@
+--- (SP) (MP) (FSM) Account for (Detect, count and report) DCS events occuring on DCS objects (units).
+-- 
+-- ===
+-- 
+-- # @{#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 **Events**:
+-- 
+-- These are the events defined in this class:
+-- 
+--   * **Start**:  The process is started. The process will go into the Report state.
+--   * **Event**:  A relevant event has occured that needs to be accounted for. The process will go into the Account state.
+--   * **Report**: The process is reporting to the player the accounting status of the DCS events.
+--   * **More**:  There are more DCS events that need to be accounted for. The process will go back into the Report state.
+--   * **NoMore**:  There are no more DCS events that need to be accounted for. The process will go into the Success state.
+-- 
+-- ### ACT_ACCOUNT **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_ACCOUNT **States**:
+-- 
+--   * **Assigned**: The player is assigned to the task. This is the initialization state for the process.
+--   * **Waiting**: the process is waiting for a DCS event to occur within the simulator. This state is set automatically.
+--   * **Report**: The process is Reporting to the players in the group of the unit. This state is set automatically every 30 seconds.
+--   * **Account**: The relevant DCS event has occurred, and is accounted for.
+--   * **Success (*)**: All DCS events were accounted for. 
+--   * **Failed (*)**: The 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.
+--
+-- # 1) @{#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.
+-- 
+-- === 
+-- 
+-- @module Account
+
+
+do -- ACT_ACCOUNT
+  
+  --- ACT_ACCOUNT class
+  -- @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", "More", "Wait")
+    self:AddTransition( "Account", "NoMore", "Accounted")
+    self:AddTransition( "*", "Fail", "Failed")
+    
+    self:AddEndState( "Accounted" )
+    self:AddEndState( "Failed" )
+    
+    self:SetStartState( "Assigned" ) 
+        
+    return self
+  end
+
+  --- Process Events
+  
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT self
+  -- @param Wrapper.Controllable#CONTROLLABLE 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:__Wait( 1 )
+  end
+
+  
+    --- StateMachine callback function
+    -- @param #ACT_ACCOUNT self
+    -- @param Wrapper.Controllable#CONTROLLABLE 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.Controllable#CONTROLLABLE 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 class
+  -- @type ACT_ACCOUNT_DEADS
+  -- @field Set#SET_UNIT TargetSetUnit
+  -- @extends #ACT_ACCOUNT
+  ACT_ACCOUNT_DEADS = { 
+    ClassName = "ACT_ACCOUNT_DEADS",
+    TargetSetUnit = nil,
+  }
+
+
+  --- Creates a new DESTROY process.
+  -- @param #ACT_ACCOUNT_DEADS self
+  -- @param Set#SET_UNIT TargetSetUnit
+  -- @param #string TaskName
+  function ACT_ACCOUNT_DEADS:New( TargetSetUnit, TaskName )
+    -- Inherits from BASE
+    local self = BASE:Inherit( self, ACT_ACCOUNT:New() ) -- #ACT_ACCOUNT_DEADS
+    
+    self.TargetSetUnit = TargetSetUnit 
+    self.TaskName = TaskName
+      
+    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.TargetSetUnit = FsmAccount.TargetSetUnit 
+    self.TaskName = FsmAccount.TaskName
+  end
+
+  --- Process Events
+  
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT_DEADS self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ACCOUNT_DEADS:onenterReport( ProcessUnit, From, Event, To )
+    self:E( { ProcessUnit, From, Event, To } )
+  
+    self:Message( "Your group with assigned " .. self.TaskName .. " task has " .. self.TargetSetUnit:GetUnitTypesText() .. " targets left to be destroyed." )
+  end
+  
+  
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT_DEADS self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ACCOUNT_DEADS:onenterAccount( ProcessUnit, From, Event, To, EventData  )
+    self:T( { ProcessUnit, EventData, From, Event, To } )
+    
+    self:T({self.Controllable})
+  
+    self.TargetSetUnit:Flush()
+    
+    if self.TargetSetUnit:FindUnit( EventData.IniUnitName ) then
+      local TaskGroup = ProcessUnit:GetGroup()
+      self:Message( "You hit a target. Your group with assigned " .. self.TaskName .. " task has " .. self.TargetSetUnit:Count() .. " targets ( " .. self.TargetSetUnit:GetUnitTypesText() .. " ) left to be destroyed." )
+    end
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ACCOUNT_DEADS self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ACCOUNT_DEADS:onafterEvent( ProcessUnit, From, Event, To, EventData )
+  
+    if self.TargetSetUnit:Count() > 1 then
+      self:__More( 1 )
+    else
+      self:__NoMore( 1 )
+    end
+  end
+  
+  --- DCS Events
+  
+  --- @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
+
+end -- ACT_ACCOUNT DEADS

Moose Development/Moose/Actions/Act_Assign.lua

@@ -0,0 +1,293 @@
+--- (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:E( { 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 )
+    env.info( "in here" )
+    self:E( { ProcessUnit, From, Event, To } )
+  
+    local ProcessGroup = ProcessUnit:GetGroup()
+
+    self:Message( "You are assigned to the task " .. self.Task:GetName() )  
+
+    self.Task:Assign( ProcessUnit, self.Task )
+  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.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIGN_MENU_ACCEPT:onafterStart( ProcessUnit, From, Event, To )
+    self:E( { ProcessUnit, From, Event, To } )
+
+    self:Message( "Access the radio menu to accept the task. You have 30 seconds or the assignment will be cancelled." )  
+   
+    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:E( )
+  
+    self:__Assign( 1 )
+  end
+  
+  --- Menu function.
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  function ACT_ASSIGN_MENU_ACCEPT:MenuReject()
+    self:E( )
+  
+    self:__Reject( 1 )
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIGN_MENU_ACCEPT:onafterAssign( ProcessUnit, From, Event, To )
+    self:E( { ProcessUnit.UnitNameFrom, Event, To } )
+  
+    self.Menu:Remove()
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ASSIGN_MENU_ACCEPT:onafterReject( ProcessUnit, From, Event, To )
+    self:E( { 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,217 @@
+--- (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 )
+      self:E( 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:E( MenuParam.TargetUnit.UnitName )
+    local self = MenuParam.self
+    local TargetUnit = MenuParam.TargetUnit
+
+    self:NextEvent( self.Fsm.JTACMenuSpot, TargetUnit )
+  end
+
+  local function JTACMenuCancel( MenuParam )
+    self:E( 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:E( {"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()
+  
+  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,375 @@
+--- (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
+  -- @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( "None", "Start", "Routing" )
+    self:AddTransition( "*", "Report", "Reporting" )
+    self:AddTransition( "*", "Route", "Routing" )
+    self:AddTransition( "Routing", "Pause", "Pausing" )
+    self:AddTransition( "*", "Abort", "Aborted" )
+    self:AddTransition( "Routing", "Arrive", "Arrived" )
+    self:AddTransition( "Arrived", "Success", "Success" )
+    self:AddTransition( "*", "Fail", "Failed" )
+    self:AddTransition( "", "", "" )
+    self:AddTransition( "", "", "" )
+ 
+    self:AddEndState( "Arrived" )
+    self:AddEndState( "Failed" )
+    
+    self:SetStartState( "None" )  
+  
+    return self
+  end
+
+  --- Task Events
+
+  --- StateMachine callback function
+  -- @param #ACT_ROUTE self
+  -- @param Wrapper.Controllable#CONTROLLABLE 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.Controllable#CONTROLLABLE ProcessUnit
+  -- @return #boolean
+  function ACT_ROUTE:onfuncHasArrived( ProcessUnit )
+    return false
+  end
+  
+  --- StateMachine callback function
+  -- @param #ACT_ROUTE self
+  -- @param Wrapper.Controllable#CONTROLLABLE 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 PointVec2 until the controllable is within the Range.
+  -- @param #ACT_ROUTE_POINT self
+  -- @param Core.Point#POINT_VEC2 The PointVec2 to Target.
+  -- @param #number Range The Distance to Target.
+  -- @param Core.Zone#ZONE_BASE Zone
+  function ACT_ROUTE_POINT:New( PointVec2, Range )
+    local self = BASE:Inherit( self, ACT_ROUTE:New() ) -- #ACT_ROUTE_POINT
+
+    self.PointVec2 = PointVec2
+    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
+  
+  function ACT_ROUTE_POINT:Init( FsmRoute )
+  
+    self.PointVec2 = FsmRoute.PointVec2
+    self.Range = FsmRoute.Range or 0
+    
+    self.DisplayInterval = 30
+    self.DisplayCount = 30
+    self.DisplayMessage = true
+    self.DisplayTime = 10 -- 10 seconds is the default
+  end  
+
+  --- Set PointVec2
+  -- @param #ACT_ROUTE_POINT self
+  -- @param Core.Point#POINT_VEC2 PointVec2 The PointVec2 to route to.
+  function ACT_ROUTE_POINT:SetPointVec2( PointVec2 )
+    self:F2( { PointVec2 } )
+    self.PointVec2 = PointVec2
+  end  
+
+  --- Get PointVec2
+  -- @param #ACT_ROUTE_POINT self
+  -- @return Core.Point#POINT_VEC2 PointVec2 The PointVec2 to route to.
+  function ACT_ROUTE_POINT:GetPointVec2()
+    self:F2( { self.PointVec2 } )
+    return self.PointVec2
+  end  
+
+  --- Set Range around PointVec2
+  -- @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 PointVec2
+  -- @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.Controllable#CONTROLLABLE ProcessUnit
+  -- @return #boolean
+  function ACT_ROUTE_POINT:onfuncHasArrived( ProcessUnit )
+
+    if ProcessUnit:IsAlive() then
+      local Distance = self.PointVec2:Get2DDistance( ProcessUnit:GetPointVec2() )
+      
+      if Distance <= self.Range then
+        local RouteText = "You have arrived."
+        self:Message( RouteText )
+        return true
+      end
+    end
+
+    return false
+  end
+  
+  --- Task Events
+  
+  --- StateMachine callback function
+  -- @param #ACT_ROUTE_POINT self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ROUTE_POINT:onenterReporting( ProcessUnit, From, Event, To )
+  
+    local TaskUnitPointVec2 = ProcessUnit:GetPointVec2()
+    local RouteText = "Route to " .. TaskUnitPointVec2:GetBRText( self.PointVec2 ) .. " km."
+    self:Message( RouteText )
+  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.
+  function ACT_ROUTE_ZONE:SetZone( Zone )
+    self.Zone = Zone
+  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.Controllable#CONTROLLABLE ProcessUnit
+  -- @return #boolean
+  function ACT_ROUTE_ZONE:onfuncHasArrived( ProcessUnit )
+
+    if ProcessUnit:IsInZone( self.Zone ) then
+      local RouteText = "You have arrived within the zone."
+      self:Message( RouteText )
+    end
+
+    return ProcessUnit:IsInZone( self.Zone )
+  end
+  
+  --- Task Events
+  
+  --- StateMachine callback function
+  -- @param #ACT_ROUTE_ZONE self
+  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  function ACT_ROUTE_ZONE:onenterReporting( ProcessUnit, From, Event, To )
+  
+    local ZoneVec2 = self.Zone:GetVec2()
+    local ZonePointVec2 = POINT_VEC2:New( ZoneVec2.x, ZoneVec2.y )
+    local TaskUnitVec2 = ProcessUnit:GetVec2()
+    local TaskUnitPointVec2 = POINT_VEC2:New( TaskUnitVec2.x, TaskUnitVec2.y )
+    local RouteText = "Route to " .. TaskUnitPointVec2:GetBRText( ZonePointVec2 ) .. " km."
+    self:Message( RouteText )
+  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/Core/Base.lua

@@ -0,0 +1,908 @@
+--- **Core** - BASE forms **the basis of the MOOSE framework**. Each class within the MOOSE framework derives from BASE.
+-- 
+-- ![Banner Image](..\Presentations\BASE\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- # 1) @{#BASE} class
+-- 
+-- All classes within the MOOSE framework are derived from the @{#BASE} class. 
+--  
+-- BASE provides facilities for :
+-- 
+--   * The construction and inheritance of MOOSE classes.
+--   * The class naming and numbering system.
+--   * The class hierarchy search system.
+--   * The tracing of information or objects during mission execution for debuggin purposes.
+--   * The subscription to DCS events for event handling in MOOSE objects.
+-- 
+-- Note: The BASE class is an abstract class and is not meant to be used directly.
+-- 
+-- ## 1.1) BASE constructor
+-- 
+-- Any class derived from BASE, will use the @{Base#BASE.New} constructor embedded in the @{Base#BASE.Inherit} method. 
+-- See an example at the @{Base#BASE.New} method how this is done.
+-- 
+-- ## 1.2) Trace information for debugging
+-- 
+-- The BASE class contains trace methods to trace progress within a mission execution of a certain object.
+-- These trace methods are inherited by each MOOSE class interiting BASE, soeach object created from derived class from BASE can use the tracing methods to trace its execution.
+-- 
+-- Any type of information can be passed to these tracing methods. See the following examples:
+-- 
+--     self:E( "Hello" )
+-- 
+-- Result in the word "Hello" in the dcs.log.
+-- 
+--     local Array = { 1, nil, "h", { "a","b" }, "x" }
+--     self:E( Array )
+--     
+-- Results with the text [1]=1,[3]="h",[4]={[1]="a",[2]="b"},[5]="x"} in the dcs.log.   
+-- 
+--     local Object1 = "Object1"
+--     local Object2 = 3
+--     local Object3 = { Object 1, Object 2 }
+--     self:E( { Object1, Object2, Object3 } )
+--     
+-- Results with the text [1]={[1]="Object",[2]=3,[3]={[1]="Object",[2]=3}} in the dcs.log.
+--     
+--     local SpawnObject = SPAWN:New( "Plane" )
+--     local GroupObject = GROUP:FindByName( "Group" )
+--     self:E( { Spawn = SpawnObject, Group = GroupObject } )
+-- 
+-- Results with the text [1]={Spawn={....),Group={...}} in the dcs.log.  
+-- 
+-- Below a more detailed explanation of the different method types for tracing.
+-- 
+-- ### 1.2.1) Tracing methods categories
+--
+-- There are basically 3 types of tracing methods available:
+-- 
+--   * @{#BASE.F}: Used to trace the entrance of a function and its given parameters. An F is indicated at column 44 in the DCS.log file.
+--   * @{#BASE.T}: Used to trace further logic within a function giving optional variables or parameters. A T is indicated at column 44 in the DCS.log file.
+--   * @{#BASE.E}: Used to always trace information giving optional variables or parameters. An E is indicated at column 44 in the DCS.log file.
+-- 
+-- ### 1.2.2) 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.
+-- 
+-- ### 1.2.3) Trace activation.
+-- 
+-- Tracing can be activated in several ways:
+-- 
+--   * Switch tracing on or off through the @{#BASE.TraceOnOff}() method.
+--   * Activate all tracing through the @{#BASE.TraceAll}() method.
+--   * Activate only the tracing of a certain class (name) through the @{#BASE.TraceClass}() method.
+--   * Activate only the tracing of a certain method of a certain class through the @{#BASE.TraceClassMethod}() method.
+--   * Activate only the tracing of a certain level through the @{#BASE.TraceLevel}() method.
+-- 
+-- ### 1.2.4) Check if tracing is on.
+-- 
+-- The method @{#BASE.IsTrace}() will validate if tracing is activated or not.
+-- 
+-- ## 1.3 DCS simulator Event Handling
+-- 
+-- The BASE class provides methods to catch DCS Events. These are events that are triggered from within the DCS simulator, 
+-- and handled through lua scripting. MOOSE provides an encapsulation to handle these events more efficiently.
+-- 
+-- ### 1.3.1 Subscribe / Unsubscribe to DCS Events
+-- 
+-- At first, the mission designer will need to **Subscribe** to a specific DCS event for the class.
+-- So, when the DCS event occurs, the class will be notified of that event.
+-- There are two methods which you use to subscribe to or unsubscribe from an event.
+-- 
+--   * @{#BASE.HandleEvent}(): Subscribe to a DCS Event.
+--   * @{#BASE.UnHandleEvent}(): Unsubscribe from a DCS Event.
+-- 
+-- ### 1.3.2 Event Handling of DCS Events
+-- 
+-- Once the class is subscribed to the event, an **Event Handling** method on the object or class needs to be written that will be called
+-- when the DCS event occurs. The Event Handling method receives an @{Event#EVENTDATA} structure, which contains a lot of information
+-- about the event that occurred.
+-- 
+-- Find below an example of the prototype how to write an event handling function for two units: 
+--
+--      local Tank1 = UNIT:FindByName( "Tank A" )
+--      local Tank2 = UNIT:FindByName( "Tank B" )
+--      
+--      -- Here we subscribe to the Dead events. So, if one of these tanks dies, the Tank1 or Tank2 objects will be notified.
+--      Tank1:HandleEvent( EVENTS.Dead )
+--      Tank2:HandleEvent( EVENTS.Dead )
+--      
+--      --- This function is an Event Handling function that will be called when Tank1 is Dead.
+--      -- @param Wrapper.Unit#UNIT self 
+--      -- @param Core.Event#EVENTDATA EventData
+--      function Tank1:OnEventDead( EventData )
+--
+--        self:SmokeGreen()
+--      end
+--
+--      --- This function is an Event Handling function that will be called when Tank2 is Dead.
+--      -- @param Wrapper.Unit#UNIT self 
+--      -- @param Core.Event#EVENTDATA EventData
+--      function Tank2:OnEventDead( EventData )
+--
+--        self:SmokeBlue()
+--      end
+-- 
+-- 
+-- 
+-- See the @{Event} module for more information about event handling.
+-- 
+-- ## 1.4) Class identification methods
+-- 
+-- BASE provides methods to get more information of each object:
+-- 
+--   * @{#BASE.GetClassID}(): Gets the ID (number) of the object. Each object created is assigned a number, that is incremented by one.
+--   * @{#BASE.GetClassName}(): Gets the name of the object, which is the name of the class the object was instantiated from.
+--   * @{#BASE.GetClassNameAndID}(): Gets the name and ID of the object.
+-- 
+-- ## 1.5) All objects derived from BASE can have "States"
+-- 
+-- A mechanism is in place in MOOSE, that allows to let the objects administer **states**.  
+-- States are essentially properties of objects, which are identified by a **Key** and a **Value**.  
+-- 
+-- The method @{#BASE.SetState}() can be used to set a Value with a reference Key to the object.  
+-- To **read or retrieve** a state Value based on a Key, use the @{#BASE.GetState} method.  
+-- 
+-- These two methods provide a very handy way to keep state at long lasting processes.
+-- Values can be stored within the objects, and later retrieved or changed when needed.
+-- There is one other important thing to note, the @{#BASE.SetState}() and @{#BASE.GetState} methods
+-- receive as the **first parameter the object for which the state needs to be set**.
+-- Thus, if the state is to be set for the same object as the object for which the method is used, then provide the same
+-- object name to the method.
+-- 
+-- ## 1.10) Inheritance
+-- 
+-- The following methods are available to implement inheritance
+-- 
+--   * @{#BASE.Inherit}: Inherits from a class.
+--   * @{#BASE.GetParent}: Returns the parent object from the object it is handling, or nil if there is no parent object.
+--   
+-- ====
+-- 
+-- # **API CHANGE HISTORY**
+-- 
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+-- 
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+-- 
+-- YYYY-MM-DD: CLASS:**NewFunction**( Params ) replaces CLASS:_OldFunction_( Params )
+-- YYYY-MM-DD: CLASS:**NewFunction( Params )** added
+-- 
+-- Hereby the change log:
+-- 
+-- ===
+-- 
+-- # **AUTHORS and CONTRIBUTIONS**
+-- 
+-- ### Contributions: 
+-- 
+--   * None.
+-- 
+-- ### Authors: 
+-- 
+--   * **FlightControl**: Design & Programming
+-- 
+-- @module Base
+
+
+
+local _TraceOnOff = true
+local _TraceLevel = 1
+local _TraceAll = false
+local _TraceClass = {}
+local _TraceClassMethod = {}
+
+local _ClassID = 0
+
+--- The BASE Class
+-- @type BASE
+-- @field ClassName The name of the class.
+-- @field ClassID The ID number of the class.
+-- @field ClassNameAndID The name of the class concatenated with the ID number of the class.
+BASE = {
+  ClassName = "BASE",
+  ClassID = 0,
+  _Private = {},
+  Events = {},
+  States = {}
+}
+
+--- The Formation Class
+-- @type FORMATION
+-- @field Cone A cone formation.
+FORMATION = {
+  Cone = "Cone" 
+}
+
+
+
+--- BASE constructor.  
+-- 
+-- This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.
+--  
+--     function EVENT:New()
+--       local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
+--       return self
+--     end
+--       
+-- @param #BASE self
+-- @return #BASE
+function BASE:New()
+  local self = routines.utils.deepCopy( self ) -- Create a new self instance
+	local MetaTable = {}
+	setmetatable( self, MetaTable )
+	self.__index = self
+	_ClassID = _ClassID + 1
+	self.ClassID = _ClassID
+
+	
+	return self
+end
+
+function BASE:_Destructor()
+  --self:E("_Destructor")
+
+  --self:EventRemoveAll()
+end
+
+
+-- THIS IS WHY WE NEED LUA 5.2 ...
+function BASE:_SetDestructor()
+
+  -- TODO: Okay, this is really technical...
+  -- When you set a proxy to a table to catch __gc, weak tables don't behave like weak...
+  -- Therefore, I am parking this logic until I've properly discussed all this with the community.
+
+  local proxy = newproxy(true)
+  local proxyMeta = getmetatable(proxy)
+
+  proxyMeta.__gc = function ()
+    env.info("In __gc for " .. self:GetClassNameAndID() )
+    if self._Destructor then
+        self:_Destructor()
+    end
+  end
+
+  -- keep the userdata from newproxy reachable until the object
+  -- table is about to be garbage-collected - then the __gc hook
+  -- will be invoked and the destructor called
+  rawset( self, '__proxy', proxy )
+  
+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 )
+  --local Parent = Parent
+	if Child ~= nil then
+		setmetatable( Child, Parent )
+		Child.__index = Child
+		
+		--Child:_SetDestructor()
+	end
+	--self:T( 'Inherited from ' .. Parent.ClassName ) 
+	return Child
+end
+
+--- This is the worker method to retrieve the Parent class.  
+-- Note that the Parent class must be passed to call the parent class method.
+-- 
+--     self:GetParent(self):ParentMethod()
+--     
+--     
+-- @param #BASE self
+-- @param #BASE Child is the Child class from which the Parent class needs to be retrieved.
+-- @return #BASE
+function BASE:GetParent( 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.ClassName, self.ClassID )
+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
+
+do -- Event Handling
+
+  --- Returns the event dispatcher
+  -- @param #BASE self
+  -- @return Core.Event#EVENT
+  function BASE:EventDispatcher()
+  
+    return _EVENTDISPATCHER
+  end
+  
+  
+  --- Get the Class @{Event} processing Priority.
+  -- The Event processing Priority is a number from 1 to 10, 
+  -- reflecting the order of the classes subscribed to the Event to be processed.
+  -- @param #BASE self
+  -- @return #number The @{Event} processing Priority.
+  function BASE:GetEventPriority()
+    return self._Private.EventPriority or 5
+  end
+  
+  --- Set the Class @{Event} processing Priority.
+  -- The Event processing Priority is a number from 1 to 10, 
+  -- reflecting the order of the classes subscribed to the Event to be processed.
+  -- @param #BASE self
+  -- @param #number EventPriority The @{Event} processing Priority.
+  -- @return self
+  function BASE:SetEventPriority( EventPriority )
+    self._Private.EventPriority = EventPriority
+  end
+  
+  --- Remove all subscribed events
+  -- @param #BASE self
+  -- @return #BASE
+  function BASE:EventRemoveAll()
+  
+    self:EventDispatcher():RemoveAll( self )
+    
+    return self
+  end
+  
+  --- Subscribe to a DCS Event.
+  -- @param #BASE self
+  -- @param Core.Event#EVENTS Event
+  -- @param #function EventFunction (optional) The function to be called when the event occurs for the unit.
+  -- @return #BASE
+  function BASE:HandleEvent( Event, EventFunction )
+  
+    self:EventDispatcher():OnEventGeneric( EventFunction, self, Event )
+    
+    return self
+  end
+  
+  --- UnSubscribe to a DCS event.
+  -- @param #BASE self
+  -- @param Core.Event#EVENTS Event
+  -- @return #BASE
+  function BASE:UnHandleEvent( Event )
+  
+    self:EventDispatcher():Remove( self, Event )
+    
+    return self
+  end
+  
+  -- Event handling function prototypes
+  
+  --- Occurs whenever any unit in a mission fires a weapon. But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.
+  -- @function [parent=#BASE] OnEventShot
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs whenever an object is hit by a weapon.
+  -- initiator : The unit object the fired the weapon
+  -- weapon: Weapon object that hit the target
+  -- target: The Object that was hit. 
+  -- @function [parent=#BASE] OnEventHit
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when an aircraft takes off from an airbase, farp, or ship.
+  -- initiator : The unit that tookoff
+  -- place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships 
+  -- @function [parent=#BASE] OnEventTakeoff
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when an aircraft lands at an airbase, farp or ship
+  -- initiator : The unit that has landed
+  -- place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships 
+  -- @function [parent=#BASE] OnEventLand
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when any aircraft crashes into the ground and is completely destroyed.
+  -- initiator : The unit that has crashed 
+  -- @function [parent=#BASE] OnEventCrash
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when a pilot ejects from an aircraft
+  -- initiator : The unit that has ejected 
+  -- @function [parent=#BASE] OnEventEjection
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when an aircraft connects with a tanker and begins taking on fuel.
+  -- initiator : The unit that is receiving fuel. 
+  -- @function [parent=#BASE] OnEventRefueling
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when an object is completely destroyed.
+  -- initiator : The unit that is was destroyed. 
+  -- @function [parent=#BASE] OnEvent
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when the pilot of an aircraft is killed. Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane.
+  -- initiator : The unit that the pilot has died in. 
+  -- @function [parent=#BASE] OnEventPilotDead
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when a ground unit captures either an airbase or a farp.
+  -- initiator : The unit that captured the base
+  -- place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction. 
+  -- @function [parent=#BASE] OnEventBaseCaptured
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when a mission starts 
+  -- @function [parent=#BASE] OnEventMissionStart
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when a mission ends
+  -- @function [parent=#BASE] OnEventMissionEnd
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when an aircraft is finished taking fuel.
+  -- initiator : The unit that was receiving fuel. 
+  -- @function [parent=#BASE] OnEventRefuelingStop
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when any object is spawned into the mission.
+  -- initiator : The unit that was spawned 
+  -- @function [parent=#BASE] OnEventBirth
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when any system fails on a human controlled aircraft.
+  -- initiator : The unit that had the failure 
+  -- @function [parent=#BASE] OnEventHumanFailure
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when any aircraft starts its engines.
+  -- initiator : The unit that is starting its engines. 
+  -- @function [parent=#BASE] OnEventEngineStartup
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when any aircraft shuts down its engines.
+  -- initiator : The unit that is stopping its engines. 
+  -- @function [parent=#BASE] OnEventEngineShutdown
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when any player assumes direct control of a unit.
+  -- initiator : The unit that is being taken control of. 
+  -- @function [parent=#BASE] OnEventPlayerEnterUnit
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when any player relieves control of a unit to the AI.
+  -- initiator : The unit that the player left. 
+  -- @function [parent=#BASE] OnEventPlayerLeaveUnit
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when any unit begins firing a weapon that has a high rate of fire. Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
+  -- initiator : The unit that is doing the shooing.
+  -- target: The unit that is being targeted. 
+  -- @function [parent=#BASE] OnEventShootingStart
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when any unit stops firing its weapon. Event will always correspond with a shooting start event.
+  -- initiator : The unit that was doing the shooing. 
+  -- @function [parent=#BASE] OnEventShootingEnd
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+end
+ 
+
+--- Creation of a Birth Event.
+-- @param #BASE self
+-- @param Dcs.DCSTypes#Time EventTime The time stamp of the event.
+-- @param Dcs.DCSWrapper.Object#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 Dcs.DCSTypes#Time EventTime The time stamp of the event.
+-- @param Dcs.DCSWrapper.Object#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 Dcs.DCSTypes#Event structure.                       
+--- The main event handling function... This function captures all events generated for the class.
+-- @param #BASE self
+-- @param Dcs.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
+
+--- Set a state or property of the Object given a Key and a Value.
+-- Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.
+-- @param #BASE self
+-- @param Object The object that will hold the Value set by the Key.
+-- @param Key The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
+-- @param Value The value to is stored in the object.
+-- @return The Value set.
+-- @return #nil The Key was not found and thus the Value could not be retrieved.
+function BASE:SetState( Object, Key, Value )
+
+  local ClassNameAndID = Object:GetClassNameAndID()
+
+  self.States[ClassNameAndID] = self.States[ClassNameAndID] or {}
+  self.States[ClassNameAndID][Key] = Value
+  self:T2( { ClassNameAndID, Key, Value } )
+  
+  return self.States[ClassNameAndID][Key]
+end
+
+
+--- Get a Value given a Key from the Object.
+-- Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.
+-- @param #BASE self
+-- @param Object The object that holds the Value set by the Key.
+-- @param Key The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
+-- @param Value The value to is stored in the Object.
+-- @return The Value retrieved.
+function BASE:GetState( Object, Key )
+
+  local ClassNameAndID = Object:GetClassNameAndID()
+
+  if self.States[ClassNameAndID] then
+    local Value = self.States[ClassNameAndID][Key] or false
+    self:T2( { ClassNameAndID, Key, Value } )
+    return Value
+  end
+  
+  return nil
+end
+
+function BASE:ClearState( Object, StateName )
+
+  local ClassNameAndID = Object:GetClassNameAndID()
+  if self.States[ClassNameAndID] then
+    self.States[ClassNameAndID][StateName] = nil
+  end
+end
+
+-- Trace section
+
+-- Log a trace (only shown when trace is on)
+-- TODO: Make trace function using variable parameters.
+
+--- Set trace on or off
+-- Note that when trace is off, no debug statement is performed, increasing performance!
+-- When Moose is loaded statically, (as one file), tracing is switched off by default.
+-- So tracing must be switched on manually in your mission if you are using Moose statically.
+-- When moose is loading dynamically (for moose class development), tracing is switched on by default.
+-- @param #BASE self
+-- @param #boolean TraceOnOff Switch the tracing on or off.
+-- @usage
+-- -- Switch the tracing On
+-- BASE:TraceOnOff( true )
+-- 
+-- -- Switch the tracing Off
+-- BASE:TraceOnOff( false )
+function BASE:TraceOnOff( TraceOnOff )
+  _TraceOnOff = TraceOnOff
+end
+
+
+--- Enquires if tracing is on (for the class).
+-- @param #BASE self
+-- @return #boolean
+function BASE:IsTrace()
+
+  if debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
+    return true
+  else
+    return false
+  end
+end
+
+--- Set trace level
+-- @param #BASE self
+-- @param #number Level
+function BASE:TraceLevel( Level )
+  _TraceLevel = Level
+  self:E( "Tracing level " .. Level )
+end
+
+--- Trace all methods in MOOSE
+-- @param #BASE self
+-- @param #boolean TraceAll true = trace all methods in MOOSE.
+function BASE:TraceAll( TraceAll )
+  
+  _TraceAll = TraceAll
+  
+  if _TraceAll then
+    self:E( "Tracing all methods in MOOSE " )
+  else
+    self:E( "Switched off tracing all methods in MOOSE" )
+  end
+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. This function is private.
+-- @param #BASE self
+-- @param Arguments A #table or any field.
+function BASE:_F( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
+
+  if debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
+
+    local DebugInfoCurrent = DebugInfoCurrentParam and DebugInfoCurrentParam or debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = DebugInfoFromParam and DebugInfoFromParam or debug.getinfo( 3, "l" )
+    
+    local Function = "function"
+    if DebugInfoCurrent.name then
+      Function = DebugInfoCurrent.name
+    end
+    
+    if _TraceAll == true or _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName].Method[Function] then
+      local LineCurrent = 0
+      if DebugInfoCurrent.currentline then
+        LineCurrent = DebugInfoCurrent.currentline
+      end
+      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. Must be at the beginning of the function logic.
+-- @param #BASE self
+-- @param Arguments A #table or any field.
+function BASE:F( Arguments )
+
+  if debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
+  
+    if _TraceLevel >= 1 then
+      self:_F( Arguments, DebugInfoCurrent, DebugInfoFrom )
+    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 debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
+  
+    if _TraceLevel >= 2 then
+      self:_F( Arguments, DebugInfoCurrent, DebugInfoFrom )
+    end
+  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 debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
+  
+    if _TraceLevel >= 3 then
+      self:_F( Arguments, DebugInfoCurrent, DebugInfoFrom )
+    end
+  end  
+end
+
+--- Trace a function logic.
+-- @param #BASE self
+-- @param Arguments A #table or any field.
+function BASE:_T( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
+
+	if debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
+
+    local DebugInfoCurrent = DebugInfoCurrentParam and DebugInfoCurrentParam or debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = DebugInfoFromParam and DebugInfoFromParam or debug.getinfo( 3, "l" )
+		
+		local Function = "function"
+		if DebugInfoCurrent.name then
+			Function = DebugInfoCurrent.name
+		end
+
+    if _TraceAll == true or _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName].Method[Function] then
+      local LineCurrent = 0
+      if DebugInfoCurrent.currentline then
+        LineCurrent = DebugInfoCurrent.currentline
+      end
+  		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 1. Can be anywhere within the function logic.
+-- @param #BASE self
+-- @param Arguments A #table or any field.
+function BASE:T( Arguments )
+
+  if debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
+  
+    if _TraceLevel >= 1 then
+      self:_T( Arguments, DebugInfoCurrent, DebugInfoFrom )
+    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 debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
+  
+    if _TraceLevel >= 2 then
+      self:_T( Arguments, DebugInfoCurrent, DebugInfoFrom )
+    end
+  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 debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
+  
+    if _TraceLevel >= 3 then
+      self:_T( Arguments, DebugInfoCurrent, DebugInfoFrom )
+    end
+  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 )
+
+  if debug then
+  	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 = -1 
+  	if DebugInfoFrom then
+  	  LineFrom = DebugInfoFrom.currentline
+  	end
+  
+  	env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s(%s)" , LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+  end
+  
+end
+
+
+

Moose Development/Moose/Core/Database.lua

@@ -0,0 +1,809 @@
+--- This module contains the DATABASE class, managing the database of mission objects. 
+-- 
+-- ====
+-- 
+-- 1) @{#DATABASE} class, extends @{Base#BASE}
+-- ===================================================
+-- Mission designers can use the DATABASE class to refer to:
+-- 
+--  * UNITS
+--  * GROUPS
+--  * CLIENTS
+--  * AIRPORTS
+--  * PLAYERSJOINED
+--  * PLAYERS
+--  
+-- On top, for internal MOOSE administration purposes, the DATBASE administers the Unit and Group TEMPLATES as defined within the Mission Editor.
+-- 
+-- Moose will automatically create one instance of the DATABASE class into the **global** object _DATABASE.
+-- Moose refers to _DATABASE within the framework extensively, but you can also refer to the _DATABASE object within your missions if required.
+-- 
+-- 1.1) DATABASE iterators
+-- -----------------------
+-- 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.ForEachUnit}: Calls a function for each @{UNIT} it finds within the DATABASE.
+--   * @{#DATABASE.ForEachGroup}: Calls a function for each @{GROUP} it finds within the DATABASE.
+--   * @{#DATABASE.ForEachPlayer}: Calls a function for each alive player it finds within the DATABASE.
+--   * @{#DATABASE.ForEachPlayerJoined}: Calls a function for each joined player it finds within the DATABASE.
+--   * @{#DATABASE.ForEachClient}: Calls a function for each @{CLIENT} it finds within the DATABASE.
+--   * @{#DATABASE.ForEachClientAlive}: Calls a function for each alive @{CLIENT} it finds within the DATABASE.
+-- 
+-- ===
+-- 
+-- @module Database
+-- @author FlightControl
+
+--- DATABASE class
+-- @type DATABASE
+-- @extends Core.Base#BASE
+DATABASE = {
+  ClassName = "DATABASE",
+  Templates = {
+    Units = {},
+    Groups = {},
+    ClientsByName = {},
+    ClientsByID = {},
+  },
+  UNITS = {},
+  STATICS = {},
+  GROUPS = {},
+  PLAYERS = {},
+  PLAYERSJOINED = {},
+  CLIENTS = {},
+  AIRBASES = {},
+  COUNTRY_ID = {},
+  COUNTRY_NAME = {},
+  NavPoints = {},
+}
+
+local _DATABASECoalition =
+  {
+    [1] = "Red",
+    [2] = "Blue",
+  }
+
+local _DATABASECategory =
+  {
+    ["plane"] = Unit.Category.AIRPLANE,
+    ["helicopter"] = Unit.Category.HELICOPTER,
+    ["vehicle"] = Unit.Category.GROUND_UNIT,
+    ["ship"] = Unit.Category.SHIP,
+    ["static"] = Unit.Category.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() )
+
+  self:SetEventPriority( 1 )
+  
+  self:HandleEvent( EVENTS.Birth, self._EventOnBirth )
+  self:HandleEvent( EVENTS.Dead, self._EventOnDeadOrCrash )
+  self:HandleEvent( EVENTS.Crash, self._EventOnDeadOrCrash )
+  
+  -- Follow alive players and clients
+  self:HandleEvent( EVENTS.PlayerEnterUnit, self._EventOnPlayerEnterUnit )
+  self:HandleEvent( EVENTS.PlayerLeaveUnit, self._EventOnPlayerLeaveUnit )
+  
+  self:_RegisterTemplates()
+  self:_RegisterGroupsAndUnits()
+  self:_RegisterClients()
+  self:_RegisterStatics()
+  self:_RegisterPlayers()
+  self:_RegisterAirbases()
+  
+  return self
+end
+
+--- Finds a Unit based on the Unit Name.
+-- @param #DATABASE self
+-- @param #string UnitName
+-- @return Wrapper.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( DCSUnitName )
+
+  if not  self.UNITS[DCSUnitName] then
+    local UnitRegister = UNIT:Register( DCSUnitName )
+    self.UNITS[DCSUnitName] = UNIT:Register( DCSUnitName )
+  end
+  
+  return self.UNITS[DCSUnitName]
+end
+
+
+--- Deletes a Unit from the DATABASE based on the Unit Name.
+-- @param #DATABASE self
+function DATABASE:DeleteUnit( DCSUnitName )
+
+  --self.UNITS[DCSUnitName] = nil 
+end
+
+--- Adds a Static based on the Static Name in the DATABASE.
+-- @param #DATABASE self
+function DATABASE:AddStatic( DCSStaticName )
+
+  if not self.STATICS[DCSStaticName] then
+    self.STATICS[DCSStaticName] = STATIC:Register( DCSStaticName )
+  end
+end
+
+
+--- Deletes a Static from the DATABASE based on the Static Name.
+-- @param #DATABASE self
+function DATABASE:DeleteStatic( DCSStaticName )
+
+  --self.STATICS[DCSStaticName] = nil 
+end
+
+--- Finds a STATIC based on the StaticName.
+-- @param #DATABASE self
+-- @param #string StaticName
+-- @return Wrapper.Static#STATIC The found STATIC.
+function DATABASE:FindStatic( StaticName )
+
+  local StaticFound = self.STATICS[StaticName]
+  return StaticFound
+end
+
+--- Adds a Airbase based on the Airbase Name in the DATABASE.
+-- @param #DATABASE self
+function DATABASE:AddAirbase( DCSAirbaseName )
+
+  if not self.AIRBASES[DCSAirbaseName] then
+    self.AIRBASES[DCSAirbaseName] = AIRBASE:Register( DCSAirbaseName )
+  end
+end
+
+
+--- Deletes a Airbase from the DATABASE based on the Airbase Name.
+-- @param #DATABASE self
+function DATABASE:DeleteAirbase( DCSAirbaseName )
+
+  --self.AIRBASES[DCSAirbaseName] = nil 
+end
+
+--- Finds a AIRBASE based on the AirbaseName.
+-- @param #DATABASE self
+-- @param #string AirbaseName
+-- @return Wrapper.Airbase#AIRBASE The found AIRBASE.
+function DATABASE:FindAirbase( AirbaseName )
+
+  local AirbaseFound = self.AIRBASES[AirbaseName]
+  return AirbaseFound
+end
+
+
+--- Finds a CLIENT based on the ClientName.
+-- @param #DATABASE self
+-- @param #string ClientName
+-- @return Wrapper.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 )
+
+  if not self.CLIENTS[ClientName] then
+    self.CLIENTS[ClientName] = CLIENT:Register( ClientName )
+  end
+
+  return self.CLIENTS[ClientName]
+end
+
+
+--- Finds a GROUP based on the GroupName.
+-- @param #DATABASE self
+-- @param #string GroupName
+-- @return Wrapper.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( GroupName )
+
+  if not self.GROUPS[GroupName] then
+    self:E( { "Add GROUP:", GroupName } )
+    self.GROUPS[GroupName] = GROUP:Register( GroupName )
+  end  
+  
+  return self.GROUPS[GroupName] 
+end
+
+--- Adds a player based on the Player Name in the DATABASE.
+-- @param #DATABASE self
+function DATABASE:AddPlayer( UnitName, PlayerName )
+
+  if PlayerName then
+    self:E( { "Add player for unit:", UnitName, PlayerName } )
+    self.PLAYERS[PlayerName] = self:FindUnit( UnitName )
+    self.PLAYERSJOINED[PlayerName] = PlayerName
+  end
+end
+
+--- Deletes a player from the DATABASE based on the Player Name.
+-- @param #DATABASE self
+function DATABASE:DeletePlayer( PlayerName )
+
+  if PlayerName then
+    self:E( { "Clean player:", PlayerName } )
+    self.PLAYERS[PlayerName] = nil
+  end
+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.CoalitionID
+  local SpawnCountryID = SpawnTemplate.CountryID
+  local SpawnCategoryID = SpawnTemplate.CategoryID
+
+  -- Nullify
+  SpawnTemplate.CoalitionID = nil
+  SpawnTemplate.CountryID = nil
+  SpawnTemplate.CategoryID = nil
+
+  self:_RegisterTemplate( SpawnTemplate, SpawnCoalitionID, SpawnCategoryID, SpawnCountryID  )
+
+  self:T3( SpawnTemplate )
+  coalition.addGroup( SpawnCountryID, SpawnCategoryID, SpawnTemplate )
+
+  -- Restore
+  SpawnTemplate.CoalitionID = SpawnCoalitionID
+  SpawnTemplate.CountryID = SpawnCountryID
+  SpawnTemplate.CategoryID = SpawnCategoryID
+
+  local SpawnGroup = self:AddGroup( 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:F2( 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:F2( 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:_RegisterTemplate( GroupTemplate, CoalitionID, CategoryID, CountryID )
+
+  local GroupTemplateName = env.getValueDictByKey(GroupTemplate.name)
+  
+  local TraceTable = {}
+
+  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
+  
+  GroupTemplate.CategoryID = CategoryID
+  GroupTemplate.CoalitionID = CoalitionID
+  GroupTemplate.CountryID = CountryID
+  
+  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.Templates.Groups[GroupTemplateName].CategoryID = CategoryID
+  self.Templates.Groups[GroupTemplateName].CoalitionID = CoalitionID
+  self.Templates.Groups[GroupTemplateName].CountryID = CountryID
+
+  
+  TraceTable[#TraceTable+1] = "Group"
+  TraceTable[#TraceTable+1] = self.Templates.Groups[GroupTemplateName].GroupName
+
+  TraceTable[#TraceTable+1] = "Coalition"
+  TraceTable[#TraceTable+1] = self.Templates.Groups[GroupTemplateName].CoalitionID
+  TraceTable[#TraceTable+1] = "Category"
+  TraceTable[#TraceTable+1] = self.Templates.Groups[GroupTemplateName].CategoryID
+  TraceTable[#TraceTable+1] = "Country"
+  TraceTable[#TraceTable+1] = self.Templates.Groups[GroupTemplateName].CountryID
+
+  TraceTable[#TraceTable+1] = "Units"
+
+  for unit_num, UnitTemplate in pairs( GroupTemplate.units ) do
+
+    UnitTemplate.name = env.getValueDictByKey(UnitTemplate.name)
+    
+    self.Templates.Units[UnitTemplate.name] = {}
+    self.Templates.Units[UnitTemplate.name].UnitName = UnitTemplate.name
+    self.Templates.Units[UnitTemplate.name].Template = UnitTemplate
+    self.Templates.Units[UnitTemplate.name].GroupName = GroupTemplateName
+    self.Templates.Units[UnitTemplate.name].GroupTemplate = GroupTemplate
+    self.Templates.Units[UnitTemplate.name].GroupId = GroupTemplate.groupId
+    self.Templates.Units[UnitTemplate.name].CategoryID = CategoryID
+    self.Templates.Units[UnitTemplate.name].CoalitionID = CoalitionID
+    self.Templates.Units[UnitTemplate.name].CountryID = CountryID
+
+    if UnitTemplate.skill and (UnitTemplate.skill == "Client" or UnitTemplate.skill == "Player") then
+      self.Templates.ClientsByName[UnitTemplate.name] = UnitTemplate
+      self.Templates.ClientsByName[UnitTemplate.name].CategoryID = CategoryID
+      self.Templates.ClientsByName[UnitTemplate.name].CoalitionID = CoalitionID
+      self.Templates.ClientsByName[UnitTemplate.name].CountryID = CountryID
+      self.Templates.ClientsByID[UnitTemplate.unitId] = UnitTemplate
+    end
+    
+    TraceTable[#TraceTable+1] = self.Templates.Units[UnitTemplate.name].UnitName 
+  end
+
+  self:E( TraceTable )
+end
+
+function DATABASE:GetGroupTemplate( GroupName )
+  local GroupTemplate = self.Templates.Groups[GroupName].Template
+  GroupTemplate.SpawnCoalitionID = self.Templates.Groups[GroupName].CoalitionID
+  GroupTemplate.SpawnCategoryID = self.Templates.Groups[GroupName].CategoryID
+  GroupTemplate.SpawnCountryID = self.Templates.Groups[GroupName].CountryID
+  return GroupTemplate
+end
+
+function DATABASE:GetGroupNameFromUnitName( UnitName )
+  return self.Templates.Units[UnitName].GroupName
+end
+
+function DATABASE:GetGroupTemplateFromUnitName( UnitName )
+  return self.Templates.Units[UnitName].GroupTemplate
+end
+
+function DATABASE:GetCoalitionFromClientTemplate( ClientName )
+  return self.Templates.ClientsByName[ClientName].CoalitionID
+end
+
+function DATABASE:GetCategoryFromClientTemplate( ClientName )
+  return self.Templates.ClientsByName[ClientName].CategoryID
+end
+
+function DATABASE:GetCountryFromClientTemplate( ClientName )
+  return self.Templates.ClientsByName[ClientName].CountryID
+end
+
+--- Airbase
+
+function DATABASE:GetCoalitionFromAirbase( AirbaseName )
+  return self.AIRBASES[AirbaseName]:GetCoalition()
+end
+
+function DATABASE:GetCategoryFromAirbase( AirbaseName )
+  return self.AIRBASES[AirbaseName]:GetCategory()
+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()
+        local PlayerName = UnitData:getPlayerName()
+        if not self.PLAYERS[PlayerName] then
+          self:E( { "Add player for unit:", UnitName, PlayerName } )
+          self:AddPlayer( UnitName, PlayerName )
+        end
+      end
+    end
+  end
+  
+  return self
+end
+
+
+--- Private method that registers all Groups and Units within in the mission.
+-- @param #DATABASE self
+-- @return #DATABASE self
+function DATABASE:_RegisterGroupsAndUnits()
+
+  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:", DCSGroupName } )
+        self:AddGroup( DCSGroupName )
+
+        for DCSUnitId, DCSUnit in pairs( DCSGroup:getUnits() ) do
+  
+          local DCSUnitName = DCSUnit:getName()
+          self:E( { "Register Unit:", DCSUnitName } )
+          self:AddUnit( DCSUnitName )
+        end
+      else
+        self:E( { "Group does not exist: ",  DCSGroup } )
+      end
+      
+    end
+  end
+
+  return self
+end
+
+--- Private method that registers all Units of skill Client or Player within in the mission.
+-- @param #DATABASE self
+-- @return #DATABASE self
+function DATABASE:_RegisterClients()
+
+  for ClientName, ClientTemplate in pairs( self.Templates.ClientsByName ) do
+    self:E( { "Register Client:", ClientName } )
+    self:AddClient( ClientName )
+  end
+  
+  return self
+end
+
+--- @param #DATABASE self
+function DATABASE:_RegisterStatics()
+
+  local CoalitionsData = { GroupsRed = coalition.getStaticObjects( coalition.side.RED ), GroupsBlue = coalition.getStaticObjects( coalition.side.BLUE ) }
+  for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
+    for DCSStaticId, DCSStatic in pairs( CoalitionData ) do
+
+      if DCSStatic:isExist() then
+        local DCSStaticName = DCSStatic:getName()
+  
+        self:E( { "Register Static:", DCSStaticName } )
+        self:AddStatic( DCSStaticName )
+      else
+        self:E( { "Static does not exist: ",  DCSStatic } )
+      end
+    end
+  end
+
+  return self
+end
+
+--- @param #DATABASE self
+function DATABASE:_RegisterAirbases()
+
+  local CoalitionsData = { AirbasesRed = coalition.getAirbases( coalition.side.RED ), AirbasesBlue = coalition.getAirbases( coalition.side.BLUE ), AirbasesNeutral = coalition.getAirbases( coalition.side.NEUTRAL ) }
+  for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
+    for DCSAirbaseId, DCSAirbase in pairs( CoalitionData ) do
+
+      local DCSAirbaseName = DCSAirbase:getName()
+
+      self:E( { "Register Airbase:", DCSAirbaseName } )
+      self:AddAirbase( DCSAirbaseName )
+    end
+  end
+
+  return self
+end
+
+
+--- Events
+
+--- Handles the OnBirth event for the alive units set.
+-- @param #DATABASE self
+-- @param Core.Event#EVENTDATA Event
+function DATABASE:_EventOnBirth( Event )
+  self:F2( { Event } )
+
+  if Event.IniDCSUnit then
+    if Event.IniObjectCategory == 3 then
+      self:AddStatic( Event.IniDCSUnitName )    
+    else
+      if Event.IniObjectCategory == 1 then
+        self:AddUnit( Event.IniDCSUnitName )
+        self:AddGroup( Event.IniDCSGroupName )
+      end
+    end
+    self:_EventOnPlayerEnterUnit( Event )
+  end
+end
+
+
+--- Handles the OnDead or OnCrash event for alive units set.
+-- @param #DATABASE self
+-- @param Core.Event#EVENTDATA Event
+function DATABASE:_EventOnDeadOrCrash( Event )
+  self:F2( { Event } )
+
+  if Event.IniDCSUnit then
+    if Event.IniObjectCategory == 3 then
+      if self.STATICS[Event.IniDCSUnitName] then
+        self:DeleteStatic( Event.IniDCSUnitName )
+      end    
+    else
+      if Event.IniObjectCategory == 1 then
+        if self.UNITS[Event.IniDCSUnitName] then
+          self:DeleteUnit( Event.IniDCSUnitName )
+        end
+      end
+    end
+  end
+end
+
+
+--- Handles the OnPlayerEnterUnit event to fill the active players table (with the unit filter applied).
+-- @param #DATABASE self
+-- @param Core.Event#EVENTDATA Event
+function DATABASE:_EventOnPlayerEnterUnit( Event )
+  self:F2( { Event } )
+
+  if Event.IniUnit then
+    if Event.IniObjectCategory == 1 then
+      self:AddUnit( Event.IniDCSUnitName )
+      self:AddGroup( Event.IniDCSGroupName )
+      local PlayerName = Event.IniUnit:GetPlayerName()
+      if not self.PLAYERS[PlayerName] then
+        self:AddPlayer( Event.IniUnitName, PlayerName )
+      end
+    end
+  end
+end
+
+
+--- Handles the OnPlayerLeaveUnit event to clean the active players table.
+-- @param #DATABASE self
+-- @param Core.Event#EVENTDATA Event
+function DATABASE:_EventOnPlayerLeaveUnit( Event )
+  self:F2( { Event } )
+
+  if Event.IniUnit then
+    if Event.IniObjectCategory == 1 then
+      local PlayerName = Event.IniUnit:GetPlayerName()
+      if self.PLAYERS[PlayerName] then
+        self:DeletePlayer( PlayerName )
+      end
+    end
+  end
+end
+
+--- Iterators
+
+--- Iterate the DATABASE and call an iterator 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, FinalizeFunction, arg, Set )
+  self:F2( 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 % 100 == 0 then
+--          coroutine.yield( false )
+--        end    
+    end
+    return true
+  end
+  
+--  local co = coroutine.create( CoRoutine )
+  local co = CoRoutine
+  
+  local function Schedule()
+  
+--    local status, res = coroutine.resume( co )
+    local status, res = co()
+    self:T3( { status, res } )
+    
+    if status == false then
+      error( res )
+    end
+    if res == false then
+      return true -- resume next time the loop
+    end
+    if FinalizeFunction then
+      FinalizeFunction( unpack( arg ) )
+    end
+    return false
+  end
+
+  local Scheduler = SCHEDULER:New( self, Schedule, {}, 0.001, 0.001, 0 )
+  
+  return self
+end
+
+
+--- Iterate the DATABASE and call an iterator 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:ForEachUnit( IteratorFunction, FinalizeFunction, ... )
+  self:F2( arg )
+  
+  self:ForEach( IteratorFunction, FinalizeFunction, arg, self.UNITS )
+
+  return self
+end
+
+--- Iterate the DATABASE and call an iterator function for each **alive** GROUP, providing the GROUP and optional parameters.
+-- @param #DATABASE self
+-- @param #function IteratorFunction The function that will be called when there is an alive GROUP in the database. The function needs to accept a GROUP parameter.
+-- @return #DATABASE self
+function DATABASE:ForEachGroup( IteratorFunction, ... )
+  self:F2( arg )
+  
+  self:ForEach( IteratorFunction, arg, self.GROUPS )
+
+  return self
+end
+
+
+--- Iterate the DATABASE and call an iterator function for each **ALIVE** player, providing the player name and optional parameters.
+-- @param #DATABASE self
+-- @param #function IteratorFunction The function that will be called when there is an player in the database. The function needs to accept the player name.
+-- @return #DATABASE self
+function DATABASE:ForEachPlayer( IteratorFunction, ... )
+  self:F2( arg )
+  
+  self:ForEach( IteratorFunction, arg, self.PLAYERS )
+  
+  return self
+end
+
+
+--- Iterate the DATABASE and call an iterator function for each player who has joined the mission, providing the Unit of the player and optional parameters.
+-- @param #DATABASE self
+-- @param #function IteratorFunction The function that will be called when there is was a player in the database. The function needs to accept a UNIT parameter.
+-- @return #DATABASE self
+function DATABASE:ForEachPlayerJoined( IteratorFunction, ... )
+  self:F2( arg )
+  
+  self:ForEach( IteratorFunction, arg, self.PLAYERSJOINED )
+  
+  return self
+end
+
+--- Iterate the DATABASE and call an iterator 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:F2( arg )
+  
+  self:ForEach( IteratorFunction, arg, self.CLIENTS )
+
+  return self
+end
+
+
+function DATABASE:_RegisterTemplates()
+  self:F2()
+
+  self.Navpoints = {}
+  self.UNITS = {}
+  --Build routines.db.units and self.Navpoints
+  for CoalitionName, coa_data in pairs(env.mission.coalition) do
+
+    if (CoalitionName == 'red' or CoalitionName == 'blue') and type(coa_data) == 'table' then
+      --self.Units[coa_name] = {}
+      
+      local CoalitionSide = coalition.side[string.upper(CoalitionName)]
+
+      ----------------------------------------------
+      -- build nav points DB
+      self.Navpoints[CoalitionName] = {}
+      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[CoalitionName][nav_ind] = routines.utils.deepCopy(nav_data)
+
+            self.Navpoints[CoalitionName][nav_ind]['name'] = nav_data.callsignStr  -- name is a little bit more self-explanatory.
+            self.Navpoints[CoalitionName][nav_ind]['point'] = {}  -- point is used by SSE, support it.
+            self.Navpoints[CoalitionName][nav_ind]['point']['x'] = nav_data.x
+            self.Navpoints[CoalitionName][nav_ind]['point']['y'] = 0
+            self.Navpoints[CoalitionName][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.upper(cntry_data.name)
+          local CountryID = cntry_data.id
+          
+          self.COUNTRY_ID[CountryName] = CountryID
+          self.COUNTRY_NAME[CountryID] = CountryName
+          
+          --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 CategoryName = 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:_RegisterTemplate( 
+                        GroupTemplate, 
+                        CoalitionSide, 
+                        _DATABASECategory[string.lower(CategoryName)], 
+                        CountryID 
+                      )
+                    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
+
+  return self
+end
+
+
+
+

Moose Development/Moose/Core/Menu.lua

@@ -0,0 +1,956 @@
+--- **Core** -- MENU_ classes model the definition of **hierarchical menu structures** and **commands for players** within a mission.
+-- 
+-- ===
+-- 
+-- DCS Menus can be managed using the MENU classes. 
+-- The advantage of using MENU classes is that it hides the complexity of dealing with menu management in more advanced scanerios where you need to 
+-- set menus and later remove them, and later set them again. You'll find while using use normal DCS scripting functions, that setting and removing
+-- menus is not a easy feat if you have complex menu hierarchies defined. 
+-- Using the MOOSE menu classes, the removal and refreshing of menus are nicely being handled within these classes, and becomes much more easy.
+-- On top, MOOSE implements **variable parameter** passing for command menus. 
+-- 
+-- There are basically two different MENU class types that you need to use:
+-- 
+-- ### To manage **main menus**, the classes begin with **MENU_**:
+-- 
+--   * @{Menu#MENU_MISSION}: Manages main menus for whole mission file.
+--   * @{Menu#MENU_COALITION}: Manages main menus for whole coalition.
+--   * @{Menu#MENU_GROUP}: Manages main menus for GROUPs.
+--   * @{Menu#MENU_CLIENT}: Manages main menus for CLIENTs. This manages menus for units with the skill level "Client".
+--   
+-- ### To manage **command menus**, which are menus that allow the player to issue **functions**, the classes begin with **MENU_COMMAND_**:
+--   
+--   * @{Menu#MENU_MISSION_COMMAND}: Manages command menus for whole mission file.
+--   * @{Menu#MENU_COALITION_COMMAND}: Manages command menus for whole coalition.
+--   * @{Menu#MENU_GROUP_COMMAND}: Manages command menus for GROUPs.
+--   * @{Menu#MENU_CLIENT_COMMAND}: Manages command menus for CLIENTs. This manages menus for units with the skill level "Client".
+-- 
+-- ===
+-- 
+-- The above menus classes **are derived** from 2 main **abstract** classes defined within the MOOSE framework (so don't use these):
+-- 
+-- 1) MENU_ BASE abstract base classes (don't use them)
+-- ====================================================
+-- The underlying base menu classes are **NOT** to be used within your missions.
+-- These are simply abstract base classes defining a couple of fields that are used by the 
+-- derived MENU_ classes to manage menus.
+-- 
+-- 1.1) @{#MENU_BASE} class, extends @{Base#BASE}
+-- --------------------------------------------------
+-- The @{#MENU_BASE} class defines the main MENU class where other MENU classes are derived from.
+-- 
+-- 1.2) @{#MENU_COMMAND_BASE} class, extends @{Base#BASE}
+-- ----------------------------------------------------------
+-- The @{#MENU_COMMAND_BASE} class defines the main MENU class where other MENU COMMAND_ classes are derived from, in order to set commands.
+-- 
+-- ===
+-- 
+-- **The next menus define the MENU classes that you can use within your missions.**
+--  
+-- 2) MENU MISSION classes
+-- ======================
+-- The underlying classes manage the menus for a complete mission file.
+-- 
+-- 2.1) @{#MENU_MISSION} class, extends @{Menu#MENU_BASE}
+-- ---------------------------------------------------------
+-- The @{Menu#MENU_MISSION} class manages the main menus for a complete mission.  
+-- You can add menus with the @{#MENU_MISSION.New} method, which constructs a MENU_MISSION object and returns you the object reference.
+-- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_MISSION.Remove}.
+-- 
+-- 2.2) @{#MENU_MISSION_COMMAND} class, extends @{Menu#MENU_COMMAND_BASE}
+-- -------------------------------------------------------------------------
+-- The @{Menu#MENU_MISSION_COMMAND} class manages the command menus for a complete mission, which allow players to execute functions during mission execution.  
+-- You can add menus with the @{#MENU_MISSION_COMMAND.New} method, which constructs a MENU_MISSION_COMMAND object and returns you the object reference.
+-- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_MISSION_COMMAND.Remove}.
+-- 
+-- ===
+-- 
+-- 3) MENU COALITION classes
+-- =========================
+-- The underlying classes manage the menus for whole coalitions.
+-- 
+-- 3.1) @{#MENU_COALITION} class, extends @{Menu#MENU_BASE}
+-- ------------------------------------------------------------
+-- The @{Menu#MENU_COALITION} class manages the main menus for coalitions.  
+-- You can add menus with the @{#MENU_COALITION.New} method, which constructs a MENU_COALITION object and returns you the object reference.
+-- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_COALITION.Remove}.
+-- 
+-- 3.2) @{Menu#MENU_COALITION_COMMAND} class, extends @{Menu#MENU_COMMAND_BASE}
+-- ----------------------------------------------------------------------------
+-- The @{Menu#MENU_COALITION_COMMAND} class manages the command menus for coalitions, which allow players to execute functions during mission execution.  
+-- You can add menus with the @{#MENU_COALITION_COMMAND.New} method, which constructs a MENU_COALITION_COMMAND object and returns you the object reference.
+-- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_COALITION_COMMAND.Remove}.
+-- 
+-- ===
+-- 
+-- 4) MENU GROUP classes
+-- =====================
+-- The underlying classes manage the menus for groups. Note that groups can be inactive, alive or can be destroyed.
+-- 
+-- 4.1) @{Menu#MENU_GROUP} class, extends @{Menu#MENU_BASE}
+-- --------------------------------------------------------
+-- The @{Menu#MENU_GROUP} class manages the main menus for coalitions.  
+-- You can add menus with the @{#MENU_GROUP.New} method, which constructs a MENU_GROUP object and returns you the object reference.
+-- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_GROUP.Remove}.
+-- 
+-- 4.2) @{Menu#MENU_GROUP_COMMAND} class, extends @{Menu#MENU_COMMAND_BASE}
+-- ------------------------------------------------------------------------
+-- The @{Menu#MENU_GROUP_COMMAND} class manages the command menus for coalitions, which allow players to execute functions during mission execution.  
+-- You can add menus with the @{#MENU_GROUP_COMMAND.New} method, which constructs a MENU_GROUP_COMMAND object and returns you the object reference.
+-- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_GROUP_COMMAND.Remove}.
+-- 
+-- ===
+-- 
+-- 5) MENU CLIENT classes
+-- ======================
+-- The underlying classes manage the menus for units with skill level client or player.
+-- 
+-- 5.1) @{Menu#MENU_CLIENT} class, extends @{Menu#MENU_BASE}
+-- ---------------------------------------------------------
+-- The @{Menu#MENU_CLIENT} class manages the main menus for coalitions.  
+-- You can add menus with the @{#MENU_CLIENT.New} method, which constructs a MENU_CLIENT object and returns you the object reference.
+-- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_CLIENT.Remove}.
+-- 
+-- 5.2) @{Menu#MENU_CLIENT_COMMAND} class, extends @{Menu#MENU_COMMAND_BASE}
+-- -------------------------------------------------------------------------
+-- The @{Menu#MENU_CLIENT_COMMAND} class manages the command menus for coalitions, which allow players to execute functions during mission execution.  
+-- You can add menus with the @{#MENU_CLIENT_COMMAND.New} method, which constructs a MENU_CLIENT_COMMAND object and returns you the object reference.
+-- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_CLIENT_COMMAND.Remove}.
+-- 
+-- ===
+-- 
+-- ### Contributions: -
+-- ### Authors: FlightControl : Design & Programming
+-- 
+-- @module Menu
+
+
+do -- MENU_BASE
+
+  --- The MENU_BASE class
+  -- @type MENU_BASE
+  -- @extends Base#BASE
+  MENU_BASE = {
+    ClassName = "MENU_BASE",
+    MenuPath = nil,
+    MenuText = "",
+    MenuParentPath = nil
+  }
+  
+  --- Consructor
+  -- @param #MENU_BASE
+  -- @return #MENU_BASE
+  function MENU_BASE:New( MenuText, ParentMenu )
+  
+    local MenuParentPath = {}
+    if ParentMenu ~= nil then
+      MenuParentPath = ParentMenu.MenuPath
+    end
+
+  	local self = BASE:Inherit( self, BASE:New() )
+  
+  	self.MenuPath = nil 
+  	self.MenuText = MenuText
+  	self.MenuParentPath = MenuParentPath
+    self.Menus = {}
+    self.MenuCount = 0
+    self.MenuRemoveParent = false
+    self.MenuTime = timer.getTime()
+  	
+  	return self
+  end
+  
+  --- Gets a @{Menu} from a parent @{Menu}
+  -- @param #MENU_BASE self
+  -- @param #string MenuText The text of the child menu.
+  -- @return #MENU_BASE
+  function MENU_BASE:GetMenu( MenuText )
+    self:F( { self.Menus, MenuText } )
+    return self.Menus[MenuText]
+  end
+  
+  --- Sets a @{Menu} to remove automatically the parent menu when the menu removed is the last child menu of that parent @{Menu}.
+  -- @param #MENU_BASE self
+  -- @param #boolean RemoveParent If true, the parent menu is automatically removed when this menu is the last child menu of that parent @{Menu}.
+  -- @return #MENU_BASE
+  function MENU_BASE:SetRemoveParent( RemoveParent )
+    self:F( { RemoveParent } )
+    self.MenuRemoveParent = RemoveParent
+    return self
+  end
+  
+  
+  --- Sets a time stamp for later prevention of menu removal.
+  -- @param #MENU_BASE self
+  -- @param MenuTime
+  -- @return #MENU_BASE
+  function MENU_BASE:SetTime( MenuTime )
+    self.MenuTime = MenuTime
+    return self
+  end
+  
+end
+
+do -- MENU_COMMAND_BASE
+
+  --- The MENU_COMMAND_BASE class
+  -- @type MENU_COMMAND_BASE
+  -- @field #function MenuCallHandler
+  -- @extends Core.Menu#MENU_BASE
+  MENU_COMMAND_BASE = {
+    ClassName = "MENU_COMMAND_BASE",
+    CommandMenuFunction = nil,
+    CommandMenuArgument = nil,
+    MenuCallHandler = nil,
+  }
+  
+  --- Constructor
+  -- @param #MENU_COMMAND_BASE
+  -- @return #MENU_COMMAND_BASE
+  function MENU_COMMAND_BASE:New( MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments )
+  
+  	local self = BASE:Inherit( self, MENU_BASE:New( MenuText, ParentMenu ) )
+  
+    self.CommandMenuFunction = CommandMenuFunction
+    self.MenuCallHandler = function( CommandMenuArguments )
+      self.CommandMenuFunction( unpack( CommandMenuArguments ) )
+    end
+  	
+  	return self
+  end
+
+end
+
+
+do -- MENU_MISSION
+
+  --- The MENU_MISSION class
+  -- @type MENU_MISSION
+  -- @extends Core.Menu#MENU_BASE
+  MENU_MISSION = {
+    ClassName = "MENU_MISSION"
+  }
+  
+  --- MENU_MISSION constructor. Creates a new MENU_MISSION object and creates the menu for a complete mission file.
+  -- @param #MENU_MISSION self
+  -- @param #string MenuText The text for the menu.
+  -- @param #table ParentMenu The parent menu. This parameter can be ignored if you want the menu to be located at the perent menu of DCS world (under F10 other).
+  -- @return #MENU_MISSION
+  function MENU_MISSION:New( MenuText, ParentMenu )
+  
+    local self = BASE:Inherit( self, MENU_BASE:New( MenuText, ParentMenu ) )
+    
+    self:F( { MenuText, ParentMenu } )
+  
+    self.MenuText = MenuText
+    self.ParentMenu = ParentMenu
+    
+    self.Menus = {}
+  
+    self:T( { MenuText } )
+  
+    self.MenuPath = missionCommands.addSubMenu( MenuText, self.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_MISSION. Note that the main menu is kept!
+  -- @param #MENU_MISSION self
+  -- @return #MENU_MISSION
+  function MENU_MISSION:RemoveSubMenus()
+    self:F( self.MenuPath )
+  
+    for MenuID, Menu in pairs( self.Menus ) do
+      Menu:Remove()
+    end
+  
+  end
+  
+  --- Removes the main menu and the sub menus recursively of this MENU_MISSION.
+  -- @param #MENU_MISSION self
+  -- @return #nil
+  function MENU_MISSION:Remove()
+    self:F( self.MenuPath )
+  
+    self:RemoveSubMenus()
+    missionCommands.removeItem( self.MenuPath )
+    if self.ParentMenu then
+      self.ParentMenu.Menus[self.MenuPath] = nil
+    end
+  
+    return nil
+  end
+
+end
+
+do -- MENU_MISSION_COMMAND
+  
+  --- The MENU_MISSION_COMMAND class
+  -- @type MENU_MISSION_COMMAND
+  -- @extends Core.Menu#MENU_COMMAND_BASE
+  MENU_MISSION_COMMAND = {
+    ClassName = "MENU_MISSION_COMMAND"
+  }
+  
+  --- MENU_MISSION constructor. Creates a new radio command item for a complete mission file, which can invoke a function with parameters.
+  -- @param #MENU_MISSION_COMMAND self
+  -- @param #string MenuText The text for the menu.
+  -- @param Menu#MENU_MISSION ParentMenu The parent menu.
+  -- @param CommandMenuFunction A function that is called when the menu key is pressed.
+  -- @param CommandMenuArgument An argument for the function. There can only be ONE argument given. So multiple arguments must be wrapped into a table. See the below example how to do this.
+  -- @return #MENU_MISSION_COMMAND self
+  function MENU_MISSION_COMMAND:New( MenuText, ParentMenu, CommandMenuFunction, ... )
+  
+    local self = BASE:Inherit( self, MENU_COMMAND_BASE:New( MenuText, ParentMenu, CommandMenuFunction, arg ) )
+    
+    self.MenuText = MenuText
+    self.ParentMenu = ParentMenu
+  
+    self:T( { MenuText, CommandMenuFunction, arg } )
+    
+  
+    self.MenuPath = missionCommands.addCommand( MenuText, self.MenuParentPath, self.MenuCallHandler, arg )
+   
+    ParentMenu.Menus[self.MenuPath] = self
+    
+    return self
+  end
+  
+  --- Removes a radio command item for a coalition
+  -- @param #MENU_MISSION_COMMAND self
+  -- @return #nil
+  function MENU_MISSION_COMMAND:Remove()
+    self:F( self.MenuPath )
+  
+    missionCommands.removeItem( self.MenuPath )
+    if self.ParentMenu then
+      self.ParentMenu.Menus[self.MenuPath] = nil
+    end
+    return nil
+  end
+
+end
+
+
+
+do -- MENU_COALITION
+
+  --- The MENU_COALITION class
+  -- @type MENU_COALITION
+  -- @extends Core.Menu#MENU_BASE
+  -- @usage
+  --  -- This demo creates a menu structure for the planes within the red coalition.
+  --  -- To test, join the planes, then look at the other radio menus (Option F10).
+  --  -- Then switch planes and check if the menu is still there.
+  --
+  --  local Plane1 = CLIENT:FindByName( "Plane 1" )
+  --  local Plane2 = CLIENT:FindByName( "Plane 2" )
+  --
+  --
+  --  -- This would create a menu for the red coalition under the main DCS "Others" menu.
+  --  local MenuCoalitionRed = MENU_COALITION:New( coalition.side.RED, "Manage Menus" )
+  --
+  --
+  --  local function ShowStatus( StatusText, Coalition )
+  --
+  --    MESSAGE:New( Coalition, 15 ):ToRed()
+  --    Plane1:Message( StatusText, 15 )
+  --    Plane2:Message( StatusText, 15 )
+  --  end
+  --
+  --  local MenuStatus -- Menu#MENU_COALITION
+  --  local MenuStatusShow -- Menu#MENU_COALITION_COMMAND
+  --
+  --  local function RemoveStatusMenu()
+  --    MenuStatus:Remove()
+  --  end
+  --
+  --  local function AddStatusMenu()
+  --    
+  --    -- This would create a menu for the red coalition under the MenuCoalitionRed menu object.
+  --    MenuStatus = MENU_COALITION:New( coalition.side.RED, "Status for Planes" )
+  --    MenuStatusShow = MENU_COALITION_COMMAND:New( coalition.side.RED, "Show Status", MenuStatus, ShowStatus, "Status of planes is ok!", "Message to Red Coalition" )
+  --  end
+  --
+  --  local MenuAdd = MENU_COALITION_COMMAND:New( coalition.side.RED, "Add Status Menu", MenuCoalitionRed, AddStatusMenu )
+  --  local MenuRemove = MENU_COALITION_COMMAND:New( coalition.side.RED, "Remove Status Menu", MenuCoalitionRed, RemoveStatusMenu )
+  MENU_COALITION = {
+    ClassName = "MENU_COALITION"
+  }
+  
+  --- MENU_COALITION constructor. Creates a new MENU_COALITION object and creates the menu for a complete coalition.
+  -- @param #MENU_COALITION self
+  -- @param Dcs.DCSCoalition#coalition.side Coalition The coalition owning the menu.
+  -- @param #string MenuText The text for the menu.
+  -- @param #table ParentMenu The parent menu. This parameter can be ignored if you want the menu to be located at the perent menu of DCS world (under F10 other).
+  -- @return #MENU_COALITION self
+  function MENU_COALITION:New( Coalition, MenuText, ParentMenu )
+  
+    local self = BASE:Inherit( self, MENU_BASE:New( MenuText, ParentMenu ) )
+    
+    self:F( { Coalition, MenuText, ParentMenu } )
+  
+    self.Coalition = Coalition
+    self.MenuText = MenuText
+    self.ParentMenu = ParentMenu
+    
+    self.Menus = {}
+  
+    self:T( { MenuText } )
+  
+    self.MenuPath = missionCommands.addSubMenuForCoalition( Coalition, MenuText, self.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. Note that the main menu is kept!
+  -- @param #MENU_COALITION self
+  -- @return #MENU_COALITION
+  function MENU_COALITION:RemoveSubMenus()
+    self:F( self.MenuPath )
+  
+    for MenuID, Menu in pairs( self.Menus ) do
+      Menu:Remove()
+    end
+  
+  end
+  
+  --- Removes the main menu and the sub menus recursively of this MENU_COALITION.
+  -- @param #MENU_COALITION self
+  -- @return #nil
+  function MENU_COALITION:Remove()
+    self:F( self.MenuPath )
+  
+    self:RemoveSubMenus()
+    missionCommands.removeItemForCoalition( self.Coalition, self.MenuPath )
+    if self.ParentMenu then
+      self.ParentMenu.Menus[self.MenuPath] = nil
+    end
+  
+    return nil
+  end
+
+end
+
+do -- MENU_COALITION_COMMAND
+  
+  --- The MENU_COALITION_COMMAND class
+  -- @type MENU_COALITION_COMMAND
+  -- @extends Core.Menu#MENU_COMMAND_BASE
+  MENU_COALITION_COMMAND = {
+    ClassName = "MENU_COALITION_COMMAND"
+  }
+  
+  --- MENU_COALITION constructor. Creates a new radio command item for a coalition, which can invoke a function with parameters.
+  -- @param #MENU_COALITION_COMMAND self
+  -- @param Dcs.DCSCoalition#coalition.side Coalition The coalition owning the menu.
+  -- @param #string MenuText The text for the menu.
+  -- @param Menu#MENU_COALITION ParentMenu The parent menu.
+  -- @param CommandMenuFunction A function that is called when the menu key is pressed.
+  -- @param CommandMenuArgument An argument for the function. There can only be ONE argument given. So multiple arguments must be wrapped into a table. See the below example how to do this.
+  -- @return #MENU_COALITION_COMMAND
+  function MENU_COALITION_COMMAND:New( Coalition, MenuText, ParentMenu, CommandMenuFunction, ... )
+  
+    local self = BASE:Inherit( self, MENU_COMMAND_BASE:New( MenuText, ParentMenu, CommandMenuFunction, arg ) )
+    
+    self.MenuCoalition = Coalition
+    self.MenuText = MenuText
+    self.ParentMenu = ParentMenu
+  
+    self:T( { MenuText, CommandMenuFunction, arg } )
+    
+  
+    self.MenuPath = missionCommands.addCommandForCoalition( self.MenuCoalition, MenuText, self.MenuParentPath, self.MenuCallHandler, arg )
+   
+    ParentMenu.Menus[self.MenuPath] = self
+    
+    return self
+  end
+  
+  --- Removes a radio command item for a coalition
+  -- @param #MENU_COALITION_COMMAND self
+  -- @return #nil
+  function MENU_COALITION_COMMAND:Remove()
+    self:F( self.MenuPath )
+  
+    missionCommands.removeItemForCoalition( self.MenuCoalition, self.MenuPath )
+    if self.ParentMenu then
+      self.ParentMenu.Menus[self.MenuPath] = nil
+    end
+    return nil
+  end
+
+end
+
+do -- MENU_CLIENT
+
+  -- 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 = {}
+  
+  --- MENU_COALITION constructor. Creates a new radio command item for a coalition, which can invoke a function with parameters.
+  -- @type MENU_CLIENT
+  -- @extends Core.Menu#MENU_BASE
+  -- @usage
+  --  -- This demo creates a menu structure for the two clients of planes.
+  --  -- Each client will receive a different menu structure.
+  --  -- To test, join the planes, then look at the other radio menus (Option F10).
+  --  -- Then switch planes and check if the menu is still there.
+  --  -- And play with the Add and Remove menu options.
+  --  
+  --  -- Note that in multi player, this will only work after the DCS clients bug is solved.
+  --
+  --  local function ShowStatus( PlaneClient, StatusText, Coalition )
+  --
+  --    MESSAGE:New( Coalition, 15 ):ToRed()
+  --    PlaneClient:Message( StatusText, 15 )
+  --  end
+  --
+  --  local MenuStatus = {}
+  --
+  --  local function RemoveStatusMenu( MenuClient )
+  --    local MenuClientName = MenuClient:GetName()
+  --    MenuStatus[MenuClientName]:Remove()
+  --  end
+  --
+  --  --- @param Wrapper.Client#CLIENT MenuClient
+  --  local function AddStatusMenu( MenuClient )
+  --    local MenuClientName = MenuClient:GetName()
+  --    -- This would create a menu for the red coalition under the MenuCoalitionRed menu object.
+  --    MenuStatus[MenuClientName] = MENU_CLIENT:New( MenuClient, "Status for Planes" )
+  --    MENU_CLIENT_COMMAND:New( MenuClient, "Show Status", MenuStatus[MenuClientName], ShowStatus, MenuClient, "Status of planes is ok!", "Message to Red Coalition" )
+  --  end
+  --
+  --  SCHEDULER:New( nil,
+  --    function()
+  --      local PlaneClient = CLIENT:FindByName( "Plane 1" )
+  --      if PlaneClient and PlaneClient:IsAlive() then
+  --        local MenuManage = MENU_CLIENT:New( PlaneClient, "Manage Menus" )
+  --        MENU_CLIENT_COMMAND:New( PlaneClient, "Add Status Menu Plane 1", MenuManage, AddStatusMenu, PlaneClient )
+  --        MENU_CLIENT_COMMAND:New( PlaneClient, "Remove Status Menu Plane 1", MenuManage, RemoveStatusMenu, PlaneClient )
+  --      end
+  --    end, {}, 10, 10 )
+  --
+  --  SCHEDULER:New( nil,
+  --    function()
+  --      local PlaneClient = CLIENT:FindByName( "Plane 2" )
+  --      if PlaneClient and PlaneClient:IsAlive() then
+  --        local MenuManage = MENU_CLIENT:New( PlaneClient, "Manage Menus" )
+  --        MENU_CLIENT_COMMAND:New( PlaneClient, "Add Status Menu Plane 2", MenuManage, AddStatusMenu, PlaneClient )
+  --        MENU_CLIENT_COMMAND:New( PlaneClient, "Remove Status Menu Plane 2", MenuManage, RemoveStatusMenu, PlaneClient )
+  --      end
+  --    end, {}, 10, 10 )
+  MENU_CLIENT = {
+    ClassName = "MENU_CLIENT"
+  }
+  
+  --- MENU_CLIENT constructor. Creates a new radio menu item for a client.
+  -- @param #MENU_CLIENT self
+  -- @param Wrapper.Client#CLIENT Client 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( Client, MenuText, ParentMenu )
+  
+  	-- Arrange meta tables
+  	local MenuParentPath = {}
+  	if ParentMenu ~= nil then
+  	  MenuParentPath = ParentMenu.MenuPath
+  	end
+  
+  	local self = BASE:Inherit( self, MENU_BASE:New( MenuText, MenuParentPath ) )
+  	self:F( { Client, MenuText, ParentMenu } )
+  
+    self.MenuClient = Client
+    self.MenuClientGroupID = Client: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( { Client: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( { Client: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 #nil
+  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 Core.Menu#MENU_COMMAND
+  MENU_CLIENT_COMMAND = {
+    ClassName = "MENU_CLIENT_COMMAND"
+  }
+  
+  --- MENU_CLIENT_COMMAND constructor. Creates a new radio command item for a client, which can invoke a function with parameters.
+  -- @param #MENU_CLIENT_COMMAND self
+  -- @param Wrapper.Client#CLIENT Client The Client owning the menu.
+  -- @param #string MenuText The text for the menu.
+  -- @param #MENU_BASE ParentMenu The parent menu.
+  -- @param CommandMenuFunction A function that is called when the menu key is pressed.
+  -- @return Menu#MENU_CLIENT_COMMAND self
+  function MENU_CLIENT_COMMAND:New( Client, MenuText, ParentMenu, CommandMenuFunction, ... )
+  
+  	-- Arrange meta tables
+  	
+  	local MenuParentPath = {}
+  	if ParentMenu ~= nil then
+  		MenuParentPath = ParentMenu.MenuPath
+  	end
+  
+  	local self = BASE:Inherit( self, MENU_COMMAND_BASE:New( MenuText, MenuParentPath, CommandMenuFunction, arg ) ) -- Menu#MENU_CLIENT_COMMAND
+  	
+    self.MenuClient = Client
+    self.MenuClientGroupID = Client: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( { Client:GetClientGroupName(), MenuPath[table.concat(MenuParentPath)], MenuParentPath, MenuText, CommandMenuFunction, arg } )
+  
+    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, self.MenuCallHandler, arg )
+    MenuPath[MenuPathID] = self.MenuPath
+   
+    if ParentMenu and ParentMenu.Menus then
+    	ParentMenu.Menus[self.MenuPath] = self
+    end
+  	
+  	return self
+  end
+  
+  --- Removes a menu structure for a client.
+  -- @param #MENU_CLIENT_COMMAND self
+  -- @return #nil
+  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
+end
+
+--- MENU_GROUP
+
+do
+  -- This local variable is used to cache the menus registered under groups.
+  -- Menus don't dissapear when groups for players 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 _MENUGROUPS = {}
+
+  --- The MENU_GROUP class
+  -- @type MENU_GROUP
+  -- @extends Core.Menu#MENU_BASE
+  -- @usage
+  --  -- This demo creates a menu structure for the two groups of planes.
+  --  -- Each group will receive a different menu structure.
+  --  -- To test, join the planes, then look at the other radio menus (Option F10).
+  --  -- Then switch planes and check if the menu is still there.
+  --  -- And play with the Add and Remove menu options.
+  --  
+  --  -- Note that in multi player, this will only work after the DCS groups bug is solved.
+  --
+  --  local function ShowStatus( PlaneGroup, StatusText, Coalition )
+  --
+  --    MESSAGE:New( Coalition, 15 ):ToRed()
+  --    PlaneGroup:Message( StatusText, 15 )
+  --  end
+  --
+  --  local MenuStatus = {}
+  --
+  --  local function RemoveStatusMenu( MenuGroup )
+  --    local MenuGroupName = MenuGroup:GetName()
+  --    MenuStatus[MenuGroupName]:Remove()
+  --  end
+  --
+  --  --- @param Wrapper.Group#GROUP MenuGroup
+  --  local function AddStatusMenu( MenuGroup )
+  --    local MenuGroupName = MenuGroup:GetName()
+  --    -- This would create a menu for the red coalition under the MenuCoalitionRed menu object.
+  --    MenuStatus[MenuGroupName] = MENU_GROUP:New( MenuGroup, "Status for Planes" )
+  --    MENU_GROUP_COMMAND:New( MenuGroup, "Show Status", MenuStatus[MenuGroupName], ShowStatus, MenuGroup, "Status of planes is ok!", "Message to Red Coalition" )
+  --  end
+  --
+  --  SCHEDULER:New( nil,
+  --    function()
+  --      local PlaneGroup = GROUP:FindByName( "Plane 1" )
+  --      if PlaneGroup and PlaneGroup:IsAlive() then
+  --        local MenuManage = MENU_GROUP:New( PlaneGroup, "Manage Menus" )
+  --        MENU_GROUP_COMMAND:New( PlaneGroup, "Add Status Menu Plane 1", MenuManage, AddStatusMenu, PlaneGroup )
+  --        MENU_GROUP_COMMAND:New( PlaneGroup, "Remove Status Menu Plane 1", MenuManage, RemoveStatusMenu, PlaneGroup )
+  --      end
+  --    end, {}, 10, 10 )
+  --
+  --  SCHEDULER:New( nil,
+  --    function()
+  --      local PlaneGroup = GROUP:FindByName( "Plane 2" )
+  --      if PlaneGroup and PlaneGroup:IsAlive() then
+  --        local MenuManage = MENU_GROUP:New( PlaneGroup, "Manage Menus" )
+  --        MENU_GROUP_COMMAND:New( PlaneGroup, "Add Status Menu Plane 2", MenuManage, AddStatusMenu, PlaneGroup )
+  --        MENU_GROUP_COMMAND:New( PlaneGroup, "Remove Status Menu Plane 2", MenuManage, RemoveStatusMenu, PlaneGroup )
+  --      end
+  --    end, {}, 10, 10 )
+  --
+  MENU_GROUP = {
+    ClassName = "MENU_GROUP"
+  }
+  
+  --- MENU_GROUP constructor. Creates a new radio menu item for a group.
+  -- @param #MENU_GROUP self
+  -- @param Wrapper.Group#GROUP MenuGroup The Group owning the menu.
+  -- @param #string MenuText The text for the menu.
+  -- @param #table ParentMenu The parent menu.
+  -- @return #MENU_GROUP self
+  function MENU_GROUP:New( MenuGroup, MenuText, ParentMenu )
+  
+    -- Determine if the menu was not already created and already visible at the group.
+    -- If it is visible, then return the cached self, otherwise, create self and cache it.
+    
+    MenuGroup._Menus = MenuGroup._Menus or {}
+    local Path = ( ParentMenu and ( table.concat( ParentMenu.MenuPath or {}, "@" ) .. "@" .. MenuText ) ) or MenuText 
+    if MenuGroup._Menus[Path] then
+      self = MenuGroup._Menus[Path]
+    else
+      self = BASE:Inherit( self, MENU_BASE:New( MenuText, ParentMenu ) )
+      MenuGroup._Menus[Path] = self
+
+      self.MenuGroup = MenuGroup
+      self.Path = Path
+      self.MenuGroupID = MenuGroup:GetID()
+      self.MenuText = MenuText
+      self.ParentMenu = ParentMenu
+
+      self:T( { "Adding Menu ", MenuText, self.MenuParentPath } )
+      self.MenuPath = missionCommands.addSubMenuForGroup( self.MenuGroupID, MenuText, self.MenuParentPath )
+
+      if self.ParentMenu and self.ParentMenu.Menus then
+        self.ParentMenu.Menus[MenuText] = self
+        self:F( { self.ParentMenu.Menus, MenuText } )
+        self.ParentMenu.MenuCount = self.ParentMenu.MenuCount + 1
+      end
+    end
+    
+    --self:F( { MenuGroup:GetName(), MenuText, ParentMenu.MenuPath } )
+
+    return self
+  end
+  
+  --- Removes the sub menus recursively of this MENU_GROUP.
+  -- @param #MENU_GROUP self
+  -- @param MenuTime
+  -- @return #MENU_GROUP self
+  function MENU_GROUP:RemoveSubMenus( MenuTime )
+    self:F2( { self.MenuPath, MenuTime, self.MenuTime } )
+  
+    self:T( { "Removing Group SubMenus:", self.MenuGroup:GetName(), self.MenuPath } )
+    for MenuText, Menu in pairs( self.Menus ) do
+      Menu:Remove( MenuTime )
+    end
+  
+  end
+
+
+  --- Removes the main menu and sub menus recursively of this MENU_GROUP.
+  -- @param #MENU_GROUP self
+  -- @param MenuTime
+  -- @return #nil
+  function MENU_GROUP:Remove( MenuTime )
+    self:F( { self.MenuGroupID, self.MenuPath, MenuTime, self.MenuTime } )
+  
+    self:RemoveSubMenus( MenuTime )
+    
+    if not MenuTime or self.MenuTime ~= MenuTime then
+      if self.MenuGroup._Menus[self.Path] then
+        self = self.MenuGroup._Menus[self.Path]
+      
+        missionCommands.removeItemForGroup( self.MenuGroupID, self.MenuPath )
+        if self.ParentMenu then
+          self.ParentMenu.Menus[self.MenuText] = nil
+          self.ParentMenu.MenuCount = self.ParentMenu.MenuCount - 1
+          if self.ParentMenu.MenuCount == 0 then
+            if self.MenuRemoveParent == true then
+              self:T( "Removing Parent Menu " )
+              self.ParentMenu:Remove()
+            end
+          end
+        end
+        self:T( { "Removing Group Menu:", self.MenuGroup:GetName(), self.MenuGroup._Menus[self.Path].Path } )
+        self.MenuGroup._Menus[self.Path] = nil
+        self = nil
+      end
+    end
+  
+    return nil
+  end
+  
+  
+  --- The MENU_GROUP_COMMAND class
+  -- @type MENU_GROUP_COMMAND
+  -- @extends Core.Menu#MENU_BASE
+  MENU_GROUP_COMMAND = {
+    ClassName = "MENU_GROUP_COMMAND"
+  }
+  
+  --- Creates a new radio command item for a group
+  -- @param #MENU_GROUP_COMMAND self
+  -- @param Wrapper.Group#GROUP MenuGroup The Group 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_GROUP_COMMAND
+  function MENU_GROUP_COMMAND:New( MenuGroup, MenuText, ParentMenu, CommandMenuFunction, ... )
+   
+    MenuGroup._Menus = MenuGroup._Menus or {}
+    local Path = ( ParentMenu and ( table.concat( ParentMenu.MenuPath or {}, "@" ) .. "@" .. MenuText ) ) or MenuText 
+    if MenuGroup._Menus[Path] then
+      self = MenuGroup._Menus[Path]
+      self:T( { "Re-using Group Command Menu:", MenuGroup:GetName(), MenuText } )
+    else
+      self = BASE:Inherit( self, MENU_COMMAND_BASE:New( MenuText, ParentMenu, CommandMenuFunction, arg ) )
+      MenuGroup._Menus[Path] = self
+
+      self.Path = Path
+      self.MenuGroup = MenuGroup
+      self.MenuGroupID = MenuGroup:GetID()
+      self.MenuText = MenuText
+      self.ParentMenu = ParentMenu
+
+      self:T( { "Adding Group Command Menu:", MenuGroup:GetName(), MenuText, self.MenuParentPath } )
+      self.MenuPath = missionCommands.addCommandForGroup( self.MenuGroupID, MenuText, self.MenuParentPath, self.MenuCallHandler, arg )
+
+      if self.ParentMenu and self.ParentMenu.Menus then
+        self.ParentMenu.Menus[MenuText] = self
+        self.ParentMenu.MenuCount = self.ParentMenu.MenuCount + 1
+        self:F( { ParentMenu.Menus, MenuText } )
+      end
+    end
+
+    return self
+  end
+  
+  --- Removes a menu structure for a group.
+  -- @param #MENU_GROUP_COMMAND self
+  -- @param MenuTime
+  -- @return #nil
+  function MENU_GROUP_COMMAND:Remove( MenuTime )
+    self:F( { self.MenuGroupID, self.MenuPath, MenuTime, self.MenuTime } )
+
+    if not MenuTime or self.MenuTime ~= MenuTime then
+      if self.MenuGroup._Menus[self.Path] then
+        self = self.MenuGroup._Menus[self.Path]
+    
+        missionCommands.removeItemForGroup( self.MenuGroupID, self.MenuPath )
+        self:T( { "Removing Group Command Menu:", self.MenuGroup:GetName(), self.MenuText, self.Path, self.MenuGroup._Menus[self.Path].Path } )
+
+        self.ParentMenu.Menus[self.MenuText] = nil
+        self.ParentMenu.MenuCount = self.ParentMenu.MenuCount - 1
+        if self.ParentMenu.MenuCount == 0 then
+          if self.MenuRemoveParent == true then
+            self:T( "Removing Parent Menu " )
+            self.ParentMenu:Remove()
+          end
+        end
+
+        self.MenuGroup._Menus[self.Path] = nil
+        self = nil
+      end
+    end
+    
+    return nil
+  end
+
+end
+

Moose Development/Moose/Core/Message.lua

@@ -1,17 +1,44 @@
---- Message System to display Messages for Clients and Coalitions or All.
--- Messages are grouped on the display panel per Category to improve readability for the players.
+--- **Core** - MESSAGE class takes are of the **real-time notifications** and **messages to players** during a simulation.
+-- 
+-- ![Banner Image](..\Presentations\MESSAGE\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- # 1) @{Message#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 are identified by an ID. The messages with the same ID belonging to the same category will be overwritten if they were still being displayed on the display panel.
--- Messages are created with MESSAGE:@{New}().
--- Messages are sent to Clients with MESSAGE:@{ToClient}().
--- Messages are sent to Coalitions with MESSAGE:@{ToCoalition}().
--- Messages are sent to All Players with MESSAGE:@{ToAll}().
+-- Messages can contain a category which is indicating the category of the message.
+-- 
+-- ## 1.1) 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.
+-- 
+-- ## 1.2) 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}().
+-- 
+-- ## 1.3) 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}().
+-- 
+-- 
 -- @module Message
 
-Include.File( "Base" )
-
 --- The MESSAGE class
 -- @type MESSAGE
+-- @extends Core.Base#BASE
 MESSAGE = {
 	ClassName = "MESSAGE", 
 	MessageCategory = 0,
@@ -22,9 +49,8 @@ MESSAGE = {
 --- 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 #string MessageCategory is a string expressing the Category of the Message. Messages are grouped on the display panel per Category to improve readability.
 -- @param #number MessageDuration is a number in seconds of how long the MESSAGE should be shown on the display panel.
--- @param #string MessageID is a string expressing the ID of the Message.
+-- @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.
@@ -32,23 +58,26 @@ MESSAGE = {
 -- -- 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!", "End of Mission", 25, "Win" )
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
--- 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" )
-function MESSAGE:New( MessageText, MessageCategory, MessageDuration, MessageID )
+-- 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, MessageCategory, MessageDuration, MessageID } )
+	self:F( { MessageText, MessageDuration, MessageCategory } )
 
-  -- When no messagecategory is given, we don't show it as a title...	
+  -- When no MessageCategory is given, we don't show it as a title...	
 	if MessageCategory and MessageCategory ~= "" then
-    self.MessageCategory = MessageCategory .. ": "
+	  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
-	self.MessageID = MessageID
+	self.MessageDuration = MessageDuration or 5
 	self.MessageTime = timer.getTime()
 	self.MessageText = MessageText
 	
@@ -61,7 +90,7 @@ 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 Client#CLIENT Client is the Group of the Client.
+-- @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.
@@ -91,6 +120,21 @@ function MESSAGE:ToClient( Client )
 	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 )
+  self:F( Group.GroupName )
+
+  if Group 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
+  
+  return self
+end
 --- Sends a MESSAGE to the Blue coalition.
 -- @param #MESSAGE self 
 -- @return #MESSAGE
@@ -152,6 +196,20 @@ function MESSAGE:ToCoalition( CoalitionSide )
 	return self
 end
 
+--- Sends a MESSAGE to a Coalition if the given Condition is true. 
+-- @param #MESSAGE self
+-- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}. 
+-- @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
@@ -164,84 +222,24 @@ end
 -- 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()
+  self:F()
 
-	self:ToCoalition( coalition.side.RED )
-	self:ToCoalition( coalition.side.BLUE )
+  self:ToCoalition( coalition.side.RED )
+  self:ToCoalition( coalition.side.BLUE )
+
+  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:ToCoalition( coalition.side.RED )
+  	self:ToCoalition( coalition.side.BLUE )
+  end
 
 	return self
 end
-
-
-
---- The MESSAGEQUEUE class
--- @type MESSAGEQUEUE
-MESSAGEQUEUE = {
-	ClientGroups = {},
-	CoalitionSides = {}
-}
-
-function MESSAGEQUEUE:New( RefreshInterval )
-	local self = BASE:Inherit( self, BASE:New() )
-	self:F( { RefreshInterval } )
-	
-	self.RefreshInterval = RefreshInterval
-
-	self.DisplayFunction = routines.scheduleFunction( self._DisplayMessages, { self }, 0, RefreshInterval )
-
-	return self
-end
-
---- This function is called automatically by the MESSAGEQUEUE scheduler.
-function MESSAGEQUEUE:_DisplayMessages()
-
-	-- First we display all messages that a coalition needs to receive... Also those who are not in a client (CA module clients...).
-	for CoalitionSideID, CoalitionSideData in pairs( self.CoalitionSides ) do
-		for MessageID, MessageData in pairs( CoalitionSideData.Messages ) do
-			if MessageData.MessageSent == false then
-				--trigger.action.outTextForCoalition( CoalitionSideID, MessageData.MessageCategory .. '\n' .. MessageData.MessageText:gsub("\n$",""):gsub("\n$",""), MessageData.MessageDuration )
-				MessageData.MessageSent = true
-			end
-			local MessageTimeLeft = ( MessageData.MessageTime + MessageData.MessageDuration ) - timer.getTime()
-			if MessageTimeLeft <= 0 then
-				MessageData = nil
-			end
-		end
-	end
-
-	-- Then we send the messages for each individual client, but also to be included are those Coalition messages for the Clients who belong to a coalition.
-	-- Because the Client messages will overwrite the Coalition messages (for that Client).
-	for ClientGroupName, ClientGroupData in pairs( self.ClientGroups ) do
-		for MessageID, MessageData in pairs( ClientGroupData.Messages ) do
-			if MessageData.MessageGroup == false then
-				trigger.action.outTextForGroup( Group.getByName(ClientGroupName):getID(), MessageData.MessageCategory .. '\n' .. MessageData.MessageText:gsub("\n$",""):gsub("\n$",""), MessageData.MessageDuration )
-				MessageData.MessageGroup = true
-			end
-			local MessageTimeLeft = ( MessageData.MessageTime + MessageData.MessageDuration ) - timer.getTime()
-			if MessageTimeLeft <= 0 then
-				MessageData = nil
-			end
-		end
-		
-		-- Now check if the Client also has messages that belong to the Coalition of the Client...
-		for CoalitionSideID, CoalitionSideData in pairs( self.CoalitionSides ) do
-			for MessageID, MessageData in pairs( CoalitionSideData.Messages ) do
-				local CoalitionGroup = Group.getByName( ClientGroupName )
-				if CoalitionGroup and CoalitionGroup:getCoalition() == CoalitionSideID then 
-					if MessageData.MessageCoalition == false then
-						trigger.action.outTextForGroup( Group.getByName(ClientGroupName):getID(), MessageData.MessageCategory .. '\n' .. MessageData.MessageText:gsub("\n$",""):gsub("\n$",""), MessageData.MessageDuration )
-						MessageData.MessageCoalition = true
-					end
-				end
-				local MessageTimeLeft = ( MessageData.MessageTime + MessageData.MessageDuration ) - timer.getTime()
-				if MessageTimeLeft <= 0 then
-					MessageData = nil
-				end
-			end
-		end
-	end
-end
-
---- The _MessageQueue object is created when the MESSAGE class module is loaded.
---_MessageQueue = MESSAGEQUEUE:New( 0.5 )
-

Moose Development/Moose/Core/Point.lua

@@ -0,0 +1,922 @@
+--- **Core** - **POINT\_VEC** classes define an **extensive API** to **manage 3D points** in the simulation space.
+-- 
+-- 1) @{Point#POINT_VEC3} class, extends @{Base#BASE}
+-- ==================================================
+-- The @{Point#POINT_VEC3} class defines a 3D point in the simulator.
+-- 
+-- **Important Note:** Most of the functions in this section were taken from MIST, and reworked to OO concepts.
+-- In order to keep the credibility of the the author, I want to emphasize that the of the MIST framework was created by Grimes, who you can find on the Eagle Dynamics Forums.
+-- 
+-- ## 1.1) POINT_VEC3 constructor
+-- 
+-- A new POINT_VEC3 instance can be created with:
+-- 
+--  * @{Point#POINT_VEC3.New}(): a 3D point.
+--  * @{Point#POINT_VEC3.NewFromVec3}(): a 3D point created from a @{DCSTypes#Vec3}.
+-- 
+-- ## 1.2) Manupulate the X, Y, Z coordinates of the point
+-- 
+-- A POINT_VEC3 class works in 3D space. It contains internally an X, Y, Z coordinate.
+-- Methods exist to manupulate these coordinates.
+-- 
+-- The current X, Y, Z axis can be retrieved with the methods @{#POINT_VEC3.GetX}(), @{#POINT_VEC3.GetY}(), @{#POINT_VEC3.GetZ}() respectively.
+-- The methods @{#POINT_VEC3.SetX}(), @{#POINT_VEC3.SetY}(), @{#POINT_VEC3.SetZ}() change the respective axis with a new value.
+-- The current axis values can be changed by using the methods @{#POINT_VEC3.AddX}(), @{#POINT_VEC3.AddY}(), @{#POINT_VEC3.AddZ}()
+-- to add or substract a value from the current respective axis value.
+-- Note that the Set and Add methods return the current POINT_VEC3 object, so these manipulation methods can be chained... For example:
+-- 
+--      local Vec3 = PointVec3:AddX( 100 ):AddZ( 150 ):GetVec3()
+-- 
+-- ## 1.3) Create waypoints for routes
+-- 
+-- A POINT_VEC3 can prepare waypoints for Ground, Air and Naval groups to be embedded into a Route.
+-- 
+-- 
+-- ## 1.5) Smoke, flare, explode, illuminate
+-- 
+-- At the point a smoke, flare, explosion and illumination bomb can be triggered. Use the following methods:
+-- 
+-- ### 1.5.1) Smoke
+-- 
+--   * @{#POINT_VEC3.Smoke}(): To smoke the point in a certain color.
+--   * @{#POINT_VEC3.SmokeBlue}(): To smoke the point in blue.
+--   * @{#POINT_VEC3.SmokeRed}(): To smoke the point in red.
+--   * @{#POINT_VEC3.SmokeOrange}(): To smoke the point in orange.
+--   * @{#POINT_VEC3.SmokeWhite}(): To smoke the point in white.
+--   * @{#POINT_VEC3.SmokeGreen}(): To smoke the point in green.
+--   
+-- ### 1.5.2) Flare
+-- 
+--   * @{#POINT_VEC3.Flare}(): To flare the point in a certain color.
+--   * @{#POINT_VEC3.FlareRed}(): To flare the point in red.
+--   * @{#POINT_VEC3.FlareYellow}(): To flare the point in yellow.
+--   * @{#POINT_VEC3.FlareWhite}(): To flare the point in white.
+--   * @{#POINT_VEC3.FlareGreen}(): To flare the point in green.
+-- 
+-- ### 1.5.3) Explode
+-- 
+--   * @{#POINT_VEC3.Explosion}(): To explode the point with a certain intensity.
+--   
+-- ### 1.5.4) Illuminate
+-- 
+--   * @{#POINT_VEC3.IlluminationBomb}(): To illuminate the point.
+-- 
+--
+-- 2) @{Point#POINT_VEC2} class, extends @{Point#POINT_VEC3}
+-- =========================================================
+-- The @{Point#POINT_VEC2} class defines a 2D point in the simulator. The height coordinate (if needed) will be the land height + an optional added height specified.
+-- 
+-- 2.1) POINT_VEC2 constructor
+-- ---------------------------
+-- A new POINT_VEC2 instance can be created with:
+-- 
+--  * @{Point#POINT_VEC2.New}(): a 2D point, taking an additional height parameter.
+--  * @{Point#POINT_VEC2.NewFromVec2}(): a 2D point created from a @{DCSTypes#Vec2}.
+-- 
+-- ## 1.2) Manupulate the X, Altitude, Y coordinates of the 2D point
+-- 
+-- A POINT_VEC2 class works in 2D space, with an altitude setting. It contains internally an X, Altitude, Y coordinate.
+-- Methods exist to manupulate these coordinates.
+-- 
+-- The current X, Altitude, Y axis can be retrieved with the methods @{#POINT_VEC2.GetX}(), @{#POINT_VEC2.GetAlt}(), @{#POINT_VEC2.GetY}() respectively.
+-- The methods @{#POINT_VEC2.SetX}(), @{#POINT_VEC2.SetAlt}(), @{#POINT_VEC2.SetY}() change the respective axis with a new value.
+-- The current Lat(itude), Alt(itude), Lon(gitude) values can also be retrieved with the methods @{#POINT_VEC2.GetLat}(), @{#POINT_VEC2.GetAlt}(), @{#POINT_VEC2.GetLon}() respectively.
+-- The current axis values can be changed by using the methods @{#POINT_VEC2.AddX}(), @{#POINT_VEC2.AddAlt}(), @{#POINT_VEC2.AddY}()
+-- to add or substract a value from the current respective axis value.
+-- Note that the Set and Add methods return the current POINT_VEC2 object, so these manipulation methods can be chained... For example:
+-- 
+--      local Vec2 = PointVec2:AddX( 100 ):AddY( 2000 ):GetVec2()
+-- 
+-- ===
+-- 
+-- **API CHANGE HISTORY**
+-- ======================
+-- 
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+-- 
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+-- 
+-- Hereby the change log:
+-- 
+-- 2017-03-03: POINT\_VEC3:**Explosion( ExplosionIntensity )** added.  
+-- 2017-03-03: POINT\_VEC3:**IlluminationBomb()** added.  
+-- 
+-- 2017-02-18: POINT\_VEC3:**NewFromVec2( Vec2, LandHeightAdd )** added.
+-- 
+-- 2016-08-12: POINT\_VEC3:**Translate( Distance, Angle )** added.
+-- 
+-- 2016-08-06: Made PointVec3 and Vec3, PointVec2 and Vec2 terminology used in the code consistent.
+-- 
+--   * Replaced method _Point_Vec3() to **Vec3**() where the code manages a Vec3. Replaced all references to the method.
+--   * Replaced method _Point_Vec2() to **Vec2**() where the code manages a Vec2. Replaced all references to the method.
+--   * Replaced method Random_Point_Vec3() to **RandomVec3**() where the code manages a Vec3. Replaced all references to the method.
+-- .
+-- ===
+--  
+-- ### Authors: 
+-- 
+--   * FlightControl : Design & Programming
+--   
+-- ### Contributions: 
+-- 
+-- @module Point
+
+--- The POINT_VEC3 class
+-- @type POINT_VEC3
+-- @field #number x The x coordinate in 3D space.
+-- @field #number y The y coordinate in 3D space.
+-- @field #number z The z coordiante in 3D space.
+-- @field Utilities.Utils#SMOKECOLOR SmokeColor
+-- @field Utilities.Utils#FLARECOLOR FlareColor
+-- @field #POINT_VEC3.RoutePointAltType RoutePointAltType
+-- @field #POINT_VEC3.RoutePointType RoutePointType
+-- @field #POINT_VEC3.RoutePointAction RoutePointAction
+-- @extends Core.Base#BASE
+POINT_VEC3 = {
+  ClassName = "POINT_VEC3",
+  Metric = true,
+  RoutePointAltType = {
+    BARO = "BARO",
+  },
+  RoutePointType = {
+    TakeOffParking = "TakeOffParking",
+    TurningPoint = "Turning Point",
+  },
+  RoutePointAction = {
+    FromParkingArea = "From Parking Area",
+    TurningPoint = "Turning Point",
+  },
+}
+
+--- The POINT_VEC2 class
+-- @type POINT_VEC2
+-- @field Dcs.DCSTypes#Distance x The x coordinate in meters.
+-- @field Dcs.DCSTypes#Distance y the y coordinate in meters.
+-- @extends Core.Point#POINT_VEC3
+POINT_VEC2 = {
+  ClassName = "POINT_VEC2",
+}
+
+
+do -- POINT_VEC3
+
+--- RoutePoint AltTypes
+-- @type POINT_VEC3.RoutePointAltType
+-- @field BARO "BARO"
+
+--- RoutePoint Types
+-- @type POINT_VEC3.RoutePointType
+-- @field TakeOffParking "TakeOffParking"
+-- @field TurningPoint "Turning Point"
+
+--- RoutePoint Actions
+-- @type POINT_VEC3.RoutePointAction
+-- @field FromParkingArea "From Parking Area"
+-- @field TurningPoint "Turning Point"
+
+-- Constructor.
+  
+--- Create a new POINT_VEC3 object.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Distance x The x coordinate of the Vec3 point, pointing to the North.
+-- @param Dcs.DCSTypes#Distance y The y coordinate of the Vec3 point, pointing Upwards.
+-- @param Dcs.DCSTypes#Distance z The z coordinate of the Vec3 point, pointing to the Right.
+-- @return Core.Point#POINT_VEC3 self
+function POINT_VEC3:New( x, y, z )
+
+  local self = BASE:Inherit( self, BASE:New() )
+  self.x = x
+  self.y = y
+  self.z = z
+  
+  return self
+end
+
+--- Create a new POINT_VEC3 object from Vec2 coordinates.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Vec2 Vec2 The Vec2 point.
+-- @return Core.Point#POINT_VEC3 self
+function POINT_VEC3:NewFromVec2( Vec2, LandHeightAdd )
+
+  local LandHeight = land.getHeight( Vec2 )
+
+  LandHeightAdd = LandHeightAdd or 0
+  LandHeight = LandHeight + LandHeightAdd
+  
+  self = self:New( Vec2.x, LandHeight, Vec2.y )
+  
+  self:F2( self )
+
+  return self
+end
+
+--- Create a new POINT_VEC3 object from  Vec3 coordinates.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Vec3 Vec3 The Vec3 point.
+-- @return Core.Point#POINT_VEC3 self
+function POINT_VEC3:NewFromVec3( Vec3 )
+
+  self = self:New( Vec3.x, Vec3.y, Vec3.z )
+  self:F2( self )
+  return self
+end
+
+
+--- Return the coordinates of the POINT_VEC3 in Vec3 format.
+-- @param #POINT_VEC3 self
+-- @return Dcs.DCSTypes#Vec3 The Vec3 coodinate.
+function POINT_VEC3:GetVec3()
+  return { x = self.x, y = self.y, z = self.z }
+end
+
+--- Return the coordinates of the POINT_VEC3 in Vec2 format.
+-- @param #POINT_VEC3 self
+-- @return Dcs.DCSTypes#Vec2 The Vec2 coodinate.
+function POINT_VEC3:GetVec2()
+  return { x = self.x, y = self.z }
+end
+
+
+--- Return the x coordinate of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @return #number The x coodinate.
+function POINT_VEC3:GetX()
+  return self.x
+end
+
+--- Return the y coordinate of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @return #number The y coodinate.
+function POINT_VEC3:GetY()
+  return self.y
+end
+
+--- Return the z coordinate of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @return #number The z coodinate.
+function POINT_VEC3:GetZ()
+  return self.z
+end
+
+--- Set the x coordinate of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #number x The x coordinate.
+-- @return #POINT_VEC3
+function POINT_VEC3:SetX( x )
+  self.x = x
+  return self
+end
+
+--- Set the y coordinate of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #number y The y coordinate.
+-- @return #POINT_VEC3
+function POINT_VEC3:SetY( y )
+  self.y = y
+  return self
+end
+
+--- Set the z coordinate of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #number z The z coordinate.
+-- @return #POINT_VEC3
+function POINT_VEC3:SetZ( z )
+  self.z = z
+  return self
+end
+
+--- Add to the x coordinate of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #number x The x coordinate value to add to the current x coodinate.
+-- @return #POINT_VEC3
+function POINT_VEC3:AddX( x )
+  self.x = self.x + x
+  return self
+end
+
+--- Add to the y coordinate of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #number y The y coordinate value to add to the current y coodinate.
+-- @return #POINT_VEC3
+function POINT_VEC3:AddY( y )
+  self.y = self.y + y
+  return self
+end
+
+--- Add to the z coordinate of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #number z The z coordinate value to add to the current z coodinate.
+-- @return #POINT_VEC3
+function POINT_VEC3:AddZ( z )
+  self.z = self.z +z
+  return self
+end
+
+--- Return a random Vec2 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Distance OuterRadius
+-- @param Dcs.DCSTypes#Distance InnerRadius
+-- @return Dcs.DCSTypes#Vec2 Vec2
+function POINT_VEC3:GetRandomVec2InRadius( OuterRadius, InnerRadius )
+  self:F2( { OuterRadius, InnerRadius } )
+
+  local Theta = 2 * math.pi * math.random()
+  local Radials = math.random() + math.random()
+  if Radials > 1 then
+    Radials = 2 - Radials
+  end
+
+  local RadialMultiplier
+  if InnerRadius and InnerRadius <= OuterRadius then
+    RadialMultiplier = ( OuterRadius - InnerRadius ) * Radials + InnerRadius
+  else
+    RadialMultiplier = OuterRadius * Radials
+  end
+
+  local RandomVec2
+  if OuterRadius > 0 then
+    RandomVec2 = { x = math.cos( Theta ) * RadialMultiplier + self:GetX(), y = math.sin( Theta ) * RadialMultiplier + self:GetZ() }
+  else
+    RandomVec2 = { x = self:GetX(), y = self:GetZ() }
+  end
+  
+  return RandomVec2
+end
+
+--- Return a random POINT_VEC2 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Distance OuterRadius
+-- @param Dcs.DCSTypes#Distance InnerRadius
+-- @return #POINT_VEC2
+function POINT_VEC3:GetRandomPointVec2InRadius( OuterRadius, InnerRadius )
+  self:F2( { OuterRadius, InnerRadius } )
+  
+  return POINT_VEC2:NewFromVec2( self:GetRandomVec2InRadius( OuterRadius, InnerRadius ) )
+end
+
+--- Return a random Vec3 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Distance OuterRadius
+-- @param Dcs.DCSTypes#Distance InnerRadius
+-- @return Dcs.DCSTypes#Vec3 Vec3
+function POINT_VEC3:GetRandomVec3InRadius( OuterRadius, InnerRadius )
+
+  local RandomVec2 = self:GetRandomVec2InRadius( OuterRadius, InnerRadius )
+  local y = self:GetY() + math.random( InnerRadius, OuterRadius )
+  local RandomVec3 = { x = RandomVec2.x, y = y, z = RandomVec2.y }
+
+  return RandomVec3
+end
+
+--- Return a random POINT_VEC3 within an Outer Radius and optionally NOT within an Inner Radius of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Distance OuterRadius
+-- @param Dcs.DCSTypes#Distance InnerRadius
+-- @return #POINT_VEC3
+function POINT_VEC3:GetRandomPointVec3InRadius( OuterRadius, InnerRadius )
+
+  return POINT_VEC3:NewFromVec3( self:GetRandomVec3InRadius( OuterRadius, InnerRadius ) )
+end
+
+
+--- Return a direction vector Vec3 from POINT_VEC3 to the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #POINT_VEC3 TargetPointVec3 The target POINT_VEC3.
+-- @return Dcs.DCSTypes#Vec3 DirectionVec3 The direction vector in Vec3 format.
+function POINT_VEC3:GetDirectionVec3( TargetPointVec3 )
+  return { x = TargetPointVec3:GetX() - self:GetX(), y = TargetPointVec3:GetY() - self:GetY(), z = TargetPointVec3:GetZ() - self:GetZ() }
+end
+
+--- Get a correction in radians of the real magnetic north of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @return #number CorrectionRadians The correction in radians.
+function POINT_VEC3:GetNorthCorrectionRadians()
+  local TargetVec3 = self:GetVec3()
+  local lat, lon = coord.LOtoLL(TargetVec3)
+  local north_posit = coord.LLtoLO(lat + 1, lon)
+  return math.atan2( north_posit.z - TargetVec3.z, north_posit.x - TargetVec3.x )
+end
+
+
+--- Return a direction in radians from the POINT_VEC3 using a direction vector in Vec3 format.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Vec3 DirectionVec3 The direction vector in Vec3 format.
+-- @return #number DirectionRadians The direction in radians.
+function POINT_VEC3:GetDirectionRadians( DirectionVec3 )
+  local DirectionRadians = math.atan2( DirectionVec3.z, DirectionVec3.x )
+  --DirectionRadians = DirectionRadians + self:GetNorthCorrectionRadians()
+  if DirectionRadians < 0 then
+    DirectionRadians = DirectionRadians + 2 * math.pi  -- put dir in range of 0 to 2*pi ( the full circle )
+  end
+  return DirectionRadians
+end
+
+--- Return the 2D distance in meters between the target POINT_VEC3 and the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #POINT_VEC3 TargetPointVec3 The target POINT_VEC3.
+-- @return Dcs.DCSTypes#Distance Distance The distance in meters.
+function POINT_VEC3:Get2DDistance( TargetPointVec3 )
+  local TargetVec3 = TargetPointVec3:GetVec3()
+  local SourceVec3 = self:GetVec3()
+  return ( ( TargetVec3.x - SourceVec3.x ) ^ 2 + ( TargetVec3.z - SourceVec3.z ) ^ 2 ) ^ 0.5
+end
+
+--- Return the 3D distance in meters between the target POINT_VEC3 and the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #POINT_VEC3 TargetPointVec3 The target POINT_VEC3.
+-- @return Dcs.DCSTypes#Distance Distance The distance in meters.
+function POINT_VEC3:Get3DDistance( TargetPointVec3 )
+  local TargetVec3 = TargetPointVec3:GetVec3()
+  local SourceVec3 = self:GetVec3()
+  return ( ( TargetVec3.x - SourceVec3.x ) ^ 2 + ( TargetVec3.y - SourceVec3.y ) ^ 2 + ( TargetVec3.z - SourceVec3.z ) ^ 2 ) ^ 0.5
+end
+
+--- Provides a Bearing / Range string
+-- @param #POINT_VEC3 self
+-- @param #number AngleRadians The angle in randians
+-- @param #number Distance The distance
+-- @return #string The BR Text
+function POINT_VEC3:ToStringBR( AngleRadians, Distance )
+
+  AngleRadians = UTILS.Round( UTILS.ToDegree( AngleRadians ), 0 )
+  if self:IsMetric() then
+    Distance = UTILS.Round( Distance / 1000, 2 )
+  else
+    Distance = UTILS.Round( UTILS.MetersToNM( Distance ), 2 )
+  end
+
+  local s = string.format( '%03d', AngleRadians ) .. ' for ' .. Distance
+
+  s = s .. self:GetAltitudeText() -- When the POINT is a VEC2, there will be no altitude shown.
+
+  return s
+end
+
+--- Provides a Bearing / Range string
+-- @param #POINT_VEC3 self
+-- @param #number AngleRadians The angle in randians
+-- @param #number Distance The distance
+-- @return #string The BR Text
+function POINT_VEC3:ToStringLL( acc, DMS )
+
+  acc = acc or 3
+  local lat, lon = coord.LOtoLL( self:GetVec3() )
+  return UTILS.tostringLL(lat, lon, acc, DMS)
+end
+
+--- Return the altitude text of the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @return #string Altitude text.
+function POINT_VEC3:GetAltitudeText()
+  if self:IsMetric() then
+    return ' at ' .. UTILS.Round( self:GetY(), 0 )
+  else
+    return ' at ' .. UTILS.Round( UTILS.MetersToFeet( self:GetY() ), 0 )
+  end
+end
+
+--- Return a BR string from a POINT_VEC3 to the POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param #POINT_VEC3 TargetPointVec3 The target POINT_VEC3.
+-- @return #string The BR text.
+function POINT_VEC3:GetBRText( TargetPointVec3 )
+    local DirectionVec3 = self:GetDirectionVec3( TargetPointVec3 )
+    local AngleRadians =  self:GetDirectionRadians( DirectionVec3 )
+    local Distance = self:Get2DDistance( TargetPointVec3 )
+    return self:ToStringBR( AngleRadians, Distance )
+end
+
+--- Sets the POINT_VEC3 metric or NM.
+-- @param #POINT_VEC3 self
+-- @param #boolean Metric true means metric, false means NM.
+function POINT_VEC3:SetMetric( Metric )
+  self.Metric = Metric
+end
+
+--- Gets if the POINT_VEC3 is metric or NM.
+-- @param #POINT_VEC3 self
+-- @return #boolean Metric true means metric, false means NM.
+function POINT_VEC3:IsMetric()
+  return self.Metric
+end
+
+--- Add a Distance in meters from the POINT_VEC3 horizontal plane, with the given angle, and calculate the new POINT_VEC3.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Distance Distance The Distance to be added in meters.
+-- @param Dcs.DCSTypes#Angle Angle The Angle in degrees.
+-- @return #POINT_VEC3 The new calculated POINT_VEC3.
+function POINT_VEC3:Translate( Distance, Angle )
+  local SX = self:GetX()
+  local SZ = self:GetZ()
+  local Radians = Angle / 180 * math.pi
+  local TX = Distance * math.cos( Radians ) + SX
+  local TZ = Distance * math.sin( Radians ) + SZ
+  
+  return POINT_VEC3:New( TX, self:GetY(), TZ )
+end
+
+
+
+--- Build an air type route point.
+-- @param #POINT_VEC3 self
+-- @param #POINT_VEC3.RoutePointAltType AltType The altitude type.
+-- @param #POINT_VEC3.RoutePointType Type The route point type.
+-- @param #POINT_VEC3.RoutePointAction Action The route point action.
+-- @param Dcs.DCSTypes#Speed Speed Airspeed in km/h.
+-- @param #boolean SpeedLocked true means the speed is locked.
+-- @return #table The route point.
+function POINT_VEC3:RoutePointAir( AltType, Type, Action, Speed, SpeedLocked )
+  self:F2( { AltType, Type, Action, Speed, SpeedLocked } )
+
+  local RoutePoint = {}
+  RoutePoint.x = self.x
+  RoutePoint.y = self.z
+  RoutePoint.alt = self.y
+  RoutePoint.alt_type = AltType
+  
+  RoutePoint.type = Type
+  RoutePoint.action = Action
+
+  RoutePoint.speed = Speed / 3.6
+  RoutePoint.speed_locked = true
+  
+--  ["task"] = 
+--  {
+--      ["id"] = "ComboTask",
+--      ["params"] = 
+--      {
+--          ["tasks"] = 
+--          {
+--          }, -- end of ["tasks"]
+--      }, -- end of ["params"]
+--  }, -- end of ["task"]
+
+
+  RoutePoint.task = {}
+  RoutePoint.task.id = "ComboTask"
+  RoutePoint.task.params = {}
+  RoutePoint.task.params.tasks = {}
+  
+  
+  return RoutePoint
+end
+
+--- Build an ground type route point.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Speed Speed Speed in km/h.
+-- @param #POINT_VEC3.RoutePointAction Formation The route point Formation.
+-- @return #table The route point.
+function POINT_VEC3:RoutePointGround( Speed, Formation )
+  self:F2( { Formation, Speed } )
+
+  local RoutePoint = {}
+  RoutePoint.x = self.x
+  RoutePoint.y = self.z
+  
+  RoutePoint.action = Formation or ""
+    
+
+  RoutePoint.speed = Speed / 3.6
+  RoutePoint.speed_locked = true
+  
+--  ["task"] = 
+--  {
+--      ["id"] = "ComboTask",
+--      ["params"] = 
+--      {
+--          ["tasks"] = 
+--          {
+--          }, -- end of ["tasks"]
+--      }, -- end of ["params"]
+--  }, -- end of ["task"]
+
+
+  RoutePoint.task = {}
+  RoutePoint.task.id = "ComboTask"
+  RoutePoint.task.params = {}
+  RoutePoint.task.params.tasks = {}
+  
+  
+  return RoutePoint
+end
+
+--- Creates an explosion at the point of a certain intensity.
+-- @param #POINT_VEC3 self
+-- @param #number ExplosionIntensity
+function POINT_VEC3:Explosion( ExplosionIntensity )
+  self:F2( { ExplosionIntensity } )
+  trigger.action.explosion( self:GetVec3(), ExplosionIntensity )
+end
+
+--- Creates an illumination bomb at the point.
+-- @param #POINT_VEC3 self
+function POINT_VEC3:IlluminationBomb()
+  self:F2()
+  trigger.action.illuminationBomb( self:GetVec3() )
+end
+
+
+--- Smokes the point in a color.
+-- @param #POINT_VEC3 self
+-- @param Utilities.Utils#SMOKECOLOR SmokeColor
+function POINT_VEC3:Smoke( SmokeColor )
+  self:F2( { SmokeColor } )
+  trigger.action.smoke( self:GetVec3(), SmokeColor )
+end
+
+--- Smoke the POINT_VEC3 Green.
+-- @param #POINT_VEC3 self
+function POINT_VEC3:SmokeGreen()
+  self:F2()
+  self:Smoke( SMOKECOLOR.Green )
+end
+
+--- Smoke the POINT_VEC3 Red.
+-- @param #POINT_VEC3 self
+function POINT_VEC3:SmokeRed()
+  self:F2()
+  self:Smoke( SMOKECOLOR.Red )
+end
+
+--- Smoke the POINT_VEC3 White.
+-- @param #POINT_VEC3 self
+function POINT_VEC3:SmokeWhite()
+  self:F2()
+  self:Smoke( SMOKECOLOR.White )
+end
+
+--- Smoke the POINT_VEC3 Orange.
+-- @param #POINT_VEC3 self
+function POINT_VEC3:SmokeOrange()
+  self:F2()
+  self:Smoke( SMOKECOLOR.Orange )
+end
+
+--- Smoke the POINT_VEC3 Blue.
+-- @param #POINT_VEC3 self
+function POINT_VEC3:SmokeBlue()
+  self:F2()
+  self:Smoke( SMOKECOLOR.Blue )
+end
+
+--- Flares the point in a color.
+-- @param #POINT_VEC3 self
+-- @param Utilities.Utils#FLARECOLOR FlareColor
+-- @param Dcs.DCSTypes#Azimuth (optional) Azimuth The azimuth of the flare direction. The default azimuth is 0.
+function POINT_VEC3:Flare( FlareColor, Azimuth )
+  self:F2( { FlareColor } )
+  trigger.action.signalFlare( self:GetVec3(), FlareColor, Azimuth and Azimuth or 0 )
+end
+
+--- Flare the POINT_VEC3 White.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Azimuth (optional) Azimuth The azimuth of the flare direction. The default azimuth is 0.
+function POINT_VEC3:FlareWhite( Azimuth )
+  self:F2( Azimuth )
+  self:Flare( FLARECOLOR.White, Azimuth )
+end
+
+--- Flare the POINT_VEC3 Yellow.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Azimuth (optional) Azimuth The azimuth of the flare direction. The default azimuth is 0.
+function POINT_VEC3:FlareYellow( Azimuth )
+  self:F2( Azimuth )
+  self:Flare( FLARECOLOR.Yellow, Azimuth )
+end
+
+--- Flare the POINT_VEC3 Green.
+-- @param #POINT_VEC3 self
+-- @param Dcs.DCSTypes#Azimuth (optional) Azimuth The azimuth of the flare direction. The default azimuth is 0.
+function POINT_VEC3:FlareGreen( Azimuth )
+  self:F2( Azimuth )
+  self:Flare( FLARECOLOR.Green, Azimuth )
+end
+
+--- Flare the POINT_VEC3 Red.
+-- @param #POINT_VEC3 self
+function POINT_VEC3:FlareRed( Azimuth )
+  self:F2( Azimuth )
+  self:Flare( FLARECOLOR.Red, Azimuth )
+end
+
+end
+
+do -- POINT_VEC2
+
+
+
+--- POINT_VEC2 constructor.
+-- @param #POINT_VEC2 self
+-- @param Dcs.DCSTypes#Distance x The x coordinate of the Vec3 point, pointing to the North.
+-- @param Dcs.DCSTypes#Distance y The y coordinate of the Vec3 point, pointing to the Right.
+-- @param Dcs.DCSTypes#Distance LandHeightAdd (optional) The default height if required to be evaluated will be the land height of the x, y coordinate. You can specify an extra height to be added to the land height.
+-- @return Core.Point#POINT_VEC2
+function POINT_VEC2:New( x, y, LandHeightAdd )
+
+  local LandHeight = land.getHeight( { ["x"] = x, ["y"] = y } )
+  
+  LandHeightAdd = LandHeightAdd or 0
+  LandHeight = LandHeight + LandHeightAdd
+  
+  self = BASE:Inherit( self, POINT_VEC3:New( x, LandHeight, y ) )
+  self:F2( self )
+  
+  return self
+end
+
+--- Create a new POINT_VEC2 object from  Vec2 coordinates.
+-- @param #POINT_VEC2 self
+-- @param Dcs.DCSTypes#Vec2 Vec2 The Vec2 point.
+-- @return Core.Point#POINT_VEC2 self
+function POINT_VEC2:NewFromVec2( Vec2, LandHeightAdd )
+
+  local LandHeight = land.getHeight( Vec2 )
+
+  LandHeightAdd = LandHeightAdd or 0
+  LandHeight = LandHeight + LandHeightAdd
+  
+  self = BASE:Inherit( self, POINT_VEC3:New( Vec2.x, LandHeight, Vec2.y ) )
+  self:F2( self )
+
+  return self
+end
+
+--- Create a new POINT_VEC2 object from  Vec3 coordinates.
+-- @param #POINT_VEC2 self
+-- @param Dcs.DCSTypes#Vec3 Vec3 The Vec3 point.
+-- @return Core.Point#POINT_VEC2 self
+function POINT_VEC2:NewFromVec3( Vec3 )
+
+  local self = BASE:Inherit( self, BASE:New() )
+  local Vec2 = { x = Vec3.x, y = Vec3.z }
+
+  local LandHeight = land.getHeight( Vec2 )
+  
+  self = BASE:Inherit( self, POINT_VEC3:New( Vec2.x, LandHeight, Vec2.y ) )
+  self:F2( self )
+
+  return self
+end
+
+--- Return the x coordinate of the POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @return #number The x coodinate.
+function POINT_VEC2:GetX()
+  return self.x
+end
+
+--- Return the y coordinate of the POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @return #number The y coodinate.
+function POINT_VEC2:GetY()
+  return self.z
+end
+
+--- Return the altitude (height) of the land at the POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @return #number The land altitude.
+function POINT_VEC2:GetAlt()
+  return land.getHeight( { x = self.x, y = self.z } )
+end
+
+--- Return Return the Lat(itude) coordinate of the POINT_VEC2 (ie: (parent)POINT_VEC3.x).
+-- @param #POINT_VEC2 self
+-- @return #number The x coodinate.
+function POINT_VEC2:GetLat()
+  return self.x
+end
+
+--- Return the Lon(gitude) coordinate of the POINT_VEC2 (ie: (parent)POINT_VEC3.z).
+-- @param #POINT_VEC2 self
+-- @return #number The y coodinate.
+function POINT_VEC2:GetLon()
+  return self.z
+end
+
+--- Set the x coordinate of the POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @param #number x The x coordinate.
+-- @return #POINT_VEC2
+function POINT_VEC2:SetX( x )
+  self.x = x
+  return self
+end
+
+--- Set the y coordinate of the POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @param #number y The y coordinate.
+-- @return #POINT_VEC2
+function POINT_VEC2:SetY( y )
+  self.z = y
+  return self
+end
+
+--- Set the Lat(itude) coordinate of the POINT_VEC2 (ie: POINT_VEC3.x).
+-- @param #POINT_VEC2 self
+-- @param #number x The x coordinate.
+-- @return #POINT_VEC2
+function POINT_VEC2:SetLat( x )
+  self.x = x
+  return self
+end
+
+--- Set the altitude of the POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @param #number Altitude The land altitude. If nothing (nil) is given, then the current land altitude is set.
+-- @return #POINT_VEC2
+function POINT_VEC2:SetAlt( Altitude )
+  self.y = Altitude or land.getHeight( { x = self.x, y = self.z } )
+  return self
+end
+
+--- Set the Lon(gitude) coordinate of the POINT_VEC2 (ie: POINT_VEC3.z).
+-- @param #POINT_VEC2 self
+-- @param #number y The y coordinate.
+-- @return #POINT_VEC2
+function POINT_VEC2:SetLon( z )
+  self.z = z
+  return self
+end
+
+--- Add to the x coordinate of the POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @param #number x The x coordinate.
+-- @return #POINT_VEC2
+function POINT_VEC2:AddX( x )
+  self.x = self.x + x
+  return self
+end
+
+--- Add to the y coordinate of the POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @param #number y The y coordinate.
+-- @return #POINT_VEC2
+function POINT_VEC2:AddY( y )
+  self.z = self.z + y
+  return self
+end
+
+--- Add to the current land height an altitude.
+-- @param #POINT_VEC2 self
+-- @param #number Altitude The Altitude to add. If nothing (nil) is given, then the current land altitude is set.
+-- @return #POINT_VEC2
+function POINT_VEC2:AddAlt( Altitude )
+  self.y = land.getHeight( { x = self.x, y = self.z } ) + Altitude or 0
+  return self
+end
+
+
+
+--- Calculate the distance from a reference @{#POINT_VEC2}.
+-- @param #POINT_VEC2 self
+-- @param #POINT_VEC2 PointVec2Reference The reference @{#POINT_VEC2}.
+-- @return Dcs.DCSTypes#Distance The distance from the reference @{#POINT_VEC2} in meters.
+function POINT_VEC2:DistanceFromPointVec2( PointVec2Reference )
+  self:F2( PointVec2Reference )
+  
+  local Distance = ( ( PointVec2Reference:GetX() - self:GetX() ) ^ 2 + ( PointVec2Reference:GetY() - self:GetY() ) ^2 ) ^0.5
+  
+  self:T2( Distance )
+  return Distance
+end
+
+--- Calculate the distance from a reference @{DCSTypes#Vec2}.
+-- @param #POINT_VEC2 self
+-- @param Dcs.DCSTypes#Vec2 Vec2Reference The reference @{DCSTypes#Vec2}.
+-- @return Dcs.DCSTypes#Distance The distance from the reference @{DCSTypes#Vec2} in meters.
+function POINT_VEC2:DistanceFromVec2( Vec2Reference )
+  self:F2( Vec2Reference )
+  
+  local Distance = ( ( Vec2Reference.x - self:GetX() ) ^ 2 + ( Vec2Reference.y - self:GetY() ) ^2 ) ^0.5
+  
+  self:T2( Distance )
+  return Distance
+end
+
+
+--- Return no text for the altitude of the POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @return #string Empty string.
+function POINT_VEC2:GetAltitudeText()
+  return ''
+end
+
+--- Add a Distance in meters from the POINT_VEC2 orthonormal plane, with the given angle, and calculate the new POINT_VEC2.
+-- @param #POINT_VEC2 self
+-- @param Dcs.DCSTypes#Distance Distance The Distance to be added in meters.
+-- @param Dcs.DCSTypes#Angle Angle The Angle in degrees.
+-- @return #POINT_VEC2 The new calculated POINT_VEC2.
+function POINT_VEC2:Translate( Distance, Angle )
+  local SX = self:GetX()
+  local SY = self:GetY()
+  local Radians = Angle / 180 * math.pi
+  local TX = Distance * math.cos( Radians ) + SX
+  local TY = Distance * math.sin( Radians ) + SY
+  
+  return POINT_VEC2:New( TX, TY )
+end
+
+end
+
+

Moose Development/Moose/Core/ScheduleDispatcher.lua

@@ -0,0 +1,227 @@
+--- This module defines the SCHEDULEDISPATCHER class, which is used by a central object called _SCHEDULEDISPATCHER.
+-- 
+-- ===
+-- 
+-- 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
+
+  -- 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" } ) -- or {}
+  
+  if Scheduler.MasterObject then
+    self.ObjectSchedulers[self.CallID] = Scheduler
+    self:F3( { CallID = self.CallID, ObjectScheduler = tostring(self.ObjectSchedulers[self.CallID]), MasterObject = tostring(Scheduler.MasterObject) } )
+  else
+    self.PersistentSchedulers[self.CallID] = Scheduler
+    self:F3( { CallID = self.CallID, PersistentScheduler = self.PersistentSchedulers[self.CallID] } )
+  end
+  
+  self.Schedule = self.Schedule or setmetatable( {}, { __mode = "k" } )
+  self.Schedule[Scheduler] = self.Schedule[Scheduler] or {}
+  self.Schedule[Scheduler][self.CallID] = {}
+  self.Schedule[Scheduler][self.CallID].Function = ScheduleFunction
+  self.Schedule[Scheduler][self.CallID].Arguments = ScheduleArguments
+  self.Schedule[Scheduler][self.CallID].StartTime = timer.getTime() + ( Start or 0 )
+  self.Schedule[Scheduler][self.CallID].Start = Start + .1
+  self.Schedule[Scheduler][self.CallID].Repeat = Repeat
+  self.Schedule[Scheduler][self.CallID].Randomize = Randomize
+  self.Schedule[Scheduler][self.CallID].Stop = Stop
+
+  self:T3( self.Schedule[Scheduler][self.CallID] )
+
+  self.Schedule[Scheduler][self.CallID].CallHandler = function( CallID )
+    self:F2( CallID )
+
+    local ErrorHandler = function( errmsg )
+      env.info( "Error in timer function: " .. errmsg )
+      if debug ~= nil then
+        env.info( 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 Schedule = self.Schedule[Scheduler][CallID]
+      
+      self:T3( { Schedule = Schedule } )
+
+      local ScheduleObject = 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
+      if ScheduleObject then
+        local function Timer()
+          return ScheduleFunction( ScheduleObject, 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 = CurrentTime + Start
+      
+      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 obscolete call for CallID: " .. CallID )
+    end
+    
+    return nil
+  end
+  
+  self:Start( Scheduler, self.CallID )
+  
+  return self.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].ScheduleID = timer.scheduleFunction( 
+        Schedule[CallID].CallHandler, 
+        CallID, 
+        timer.getTime() + Schedule[CallID].Start
+      )
+    end
+  else
+    for CallID, Schedule in pairs( self.Schedule[Scheduler] ) 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] ) 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] ) do
+    self:Stop( Scheduler, CallID ) -- Recursive
+  end
+end
+
+
+

Moose Development/Moose/Core/Scheduler.lua

@@ -0,0 +1,174 @@
+--- **Core** - SCHEDULER prepares and handles the **execution of functions over scheduled time (intervals)**.
+--
+-- ![Banner Image](..\Presentations\SCHEDULER\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- # 1) @{Scheduler#SCHEDULER} class, extends @{Base#BASE}
+-- 
+-- The @{Scheduler#SCHEDULER} class creates schedule.
+--
+-- ## 1.1) SCHEDULER constructor
+-- 
+-- The SCHEDULER class is quite easy to use, but note that the New constructor has variable parameters:
+--
+--  * @{Scheduler#SCHEDULER.New}( nil ): Setup a new SCHEDULER object, which is persistently executed after garbage collection.
+--  * @{Scheduler#SCHEDULER.New}( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is nillified or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.
+--  * @{Scheduler#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.
+--  * @{Scheduler#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.
+--
+-- ## 1.2) SCHEDULER timer stopping and (re-)starting.
+--
+-- The SCHEDULER can be stopped and restarted with the following methods:
+--
+--  * @{Scheduler#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#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.
+--
+-- ## 1.3) Create a new schedule
+-- 
+-- With @{Scheduler#SCHEDULER.Schedule}() a new time event can be scheduled. This function is used by the :New() constructor when a new schedule is planned.
+--
+-- ===
+--
+-- ### Contributions: 
+-- 
+--   * FlightControl : Concept & Testing
+-- 
+-- ### Authors: 
+-- 
+--   * FlightControl : Design & Programming
+-- 
+-- ### Test Missions:
+-- 
+--   * SCH - Scheduler
+-- 
+-- ===
+--
+-- @module Scheduler
+
+
+--- The SCHEDULER class
+-- @type SCHEDULER
+-- @field #number ScheduleID the ID of the scheduler.
+-- @extends Core.Base#BASE
+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() )
+  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/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/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

@@ -2,15 +2,15 @@
 -- @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
+-- @extends Core.Base#BASE
 CLEANUP = {
 	ClassName = "CLEANUP",
 	ZoneNames = {},
@@ -29,7 +29,9 @@ CLEANUP = {
 -- 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() )
+function CLEANUP:New( ZoneNames, TimeInterval )	
+
+  local self = BASE:Inherit( self, BASE:New() ) -- #CLEANUP
 	self:F( { ZoneNames, TimeInterval } )
 	
 	if type( ZoneNames ) == 'table' then
@@ -41,9 +43,9 @@ function CLEANUP:New( ZoneNames, TimeInterval )	local self = BASE:Inherit( self,
 		self.TimeInterval = TimeInterval
 	end
 	
-	_EVENTDISPATCHER:OnBirth( self._OnEventBirth, self )
+	self:HandleEvent( EVENTS.Birth )
 	
-	self.CleanUpScheduler = routines.scheduleFunction( self._CleanUpScheduler, { self }, timer.getTime() + 1, TimeInterval )
+  self.CleanUpScheduler = SCHEDULER:New( self, self._CleanUpScheduler, {}, 1, TimeInterval )
 	
 	return self
 end
@@ -51,27 +53,25 @@ 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 Dcs.DCSWrapper.Group#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!
+--- Destroys a @{DCSWrapper.Unit#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 Dcs.DCSWrapper.Unit#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
@@ -91,10 +91,10 @@ function CLEANUP:_DestroyUnit( CleanUpUnit, CleanUpUnitName )
 	end
 end
 
--- TODO check DCSTypes#Weapon
+-- TODO check Dcs.DCSTypes#Weapon
 --- Destroys a missile from the simulator, but checks first if it is still existing!
 -- @param #CLEANUP self
--- @param DCSTypes#Weapon MissileObject
+-- @param Dcs.DCSTypes#Weapon MissileObject
 function CLEANUP:_DestroyMissile( MissileObject )
 	self:F( { MissileObject } )
 
@@ -104,44 +104,35 @@ function CLEANUP:_DestroyMissile( MissileObject )
 	end
 end
 
-function CLEANUP:_OnEventBirth( Event )
-  self:F( { Event } )
+--- @param #CLEANUP self
+-- @param Core.Event#EVENTDATA EventData
+function CLEANUP:_OnEventBirth( EventData )
+  self:F( { EventData } )
   
-  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()
+  self.CleanUpList[EventData.IniDCSUnitName] = {}
+  self.CleanUpList[EventData.IniDCSUnitName].CleanUpUnit = EventData.IniDCSUnit
+  self.CleanUpList[EventData.IniDCSUnitName].CleanUpGroup = EventData.IniDCSGroup
+  self.CleanUpList[EventData.IniDCSUnitName].CleanUpGroupName = EventData.IniDCSGroupName
+  self.CleanUpList[EventData.IniDCSUnitName].CleanUpUnitName = EventData.IniDCSUnitName
 
+  EventData.IniUnit:HandleEvent( EVENTS.EngineShutdown , self._EventAddForCleanUp )
+  EventData.IniUnit:HandleEvent( EVENTS.EngineStartup, self._EventAddForCleanUp )
+  EventData.IniUnit:HandleEvent( EVENTS.Hit, self._EventAddForCleanUp )
+  EventData.IniUnit:HandleEvent( EVENTS.PilotDead, self._EventCrash )
+  EventData.IniUnit:HandleEvent( EVENTS.Dead, self._EventCrash )
+  EventData.IniUnit:HandleEvent( EVENTS.Crash, self._EventCrash )
+  EventData.IniUnit:HandleEvent( EVENTS.Shot, self._EventShot )
 
 end
 
 --- Detects if a crash event occurs.
 -- Crashed units go into a CleanUpList for removal.
 -- @param #CLEANUP self
--- @param DCSTypes#Event event
+-- @param Dcs.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")
@@ -160,7 +151,7 @@ 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
+-- @param Dcs.DCSTypes#Event event
 function CLEANUP:_EventShot( Event )
 	self:F( { Event } )
 
@@ -170,14 +161,14 @@ function CLEANUP:_EventShot( Event )
 	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)
+    SCHEDULER:New( self, CLEANUP._DestroyMissile, { Event.Weapon }, 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
+-- @param Dcs.DCSTypes#Event event
 function CLEANUP:_EventHitCleanUp( Event )
 	self:F( { Event } )
 
@@ -186,7 +177,7 @@ function CLEANUP:_EventHitCleanUp( Event )
 			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)
+        SCHEDULER:New( self, CLEANUP._DestroyUnit, { Event.IniDCSUnit }, 0.1 )
 			end
 		end
 	end
@@ -196,13 +187,13 @@ function CLEANUP:_EventHitCleanUp( Event )
 			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 )
+        SCHEDULER:New( self, CLEANUP._DestroyUnit, { Event.TgtDCSUnit }, 0.1 )
 			end
 		end
 	end
 end
 
---- Add the @{DCSUnit#Unit} to the CleanUpList for CleanUp.
+--- Add the @{DCSWrapper.Unit#Unit} to the CleanUpList for CleanUp.
 function CLEANUP:_AddForCleanUp( CleanUpUnit, CleanUpUnitName )
 	self:F( { CleanUpUnit, CleanUpUnitName } )
 
@@ -220,7 +211,7 @@ 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
+-- @param Dcs.DCSTypes#Event event
 function CLEANUP:_EventAddForCleanUp( Event )
 
 	if Event.IniDCSUnit then
@@ -273,7 +264,6 @@ function CLEANUP:_CleanUpScheduler()
 				--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
@@ -305,7 +295,6 @@ function CLEANUP:_CleanUpScheduler()
 					else
 						UnitData.CleanUpTime = timer.getTime()
 						UnitData.CleanUpMoved = true
-						--MESSAGE:New( "Moved " .. CleanUpUnitName, CleanUpUnitName, 10, CleanUpUnitName ):ToAll()
 					end
 				end
 				
@@ -319,5 +308,7 @@ function CLEANUP:_CleanUpScheduler()
 		end
 	end
 	self:T(CleanUpCount)
+	
+	return true
 end
 

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -1,13 +1,15 @@
---- Provides missile training functions.
+--- This module contains the MISSILETRAINER class.
+-- 
+-- ===
 --
--- @{#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_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
+
+  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:E( "ForEach:" .. Client.UnitName )
+--      Client:Alive( self._Alive, self )
+--  end
+--  
+  self.DBClients:ForEachClient( 
+    function( Client )
+      self:E( "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 .. " 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
@@ -557,11 +583,11 @@ function MISSILETRAINER:_TrackMissiles()
   
       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 TargetVec3 = Client:GetVec3()
   
-        local Distance = ( ( PositionMissile.x - PositionTarget.x )^2 +
-          ( PositionMissile.y - PositionTarget.y )^2 +
-          ( PositionMissile.z - PositionTarget.z )^2
+        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
@@ -576,7 +602,7 @@ function MISSILETRAINER:_TrackMissiles()
                 TrainerWeapon:getTypeName(),
                 TrainerSourceUnit:GetTypeName(),
                 TrainerTargetUnit:GetPlayerName()
-              ),"Hit Alert", 15, "ID" )
+              ), 15, "Hit Alert" )
   
             if self.AlertsToAll == true then
               Message:ToAll()
@@ -597,7 +623,7 @@ function MISSILETRAINER:_TrackMissiles()
               string.format( "%s launched by %s self destructed!",
                 TrainerWeaponTypeName,
                 TrainerSourceUnit:GetTypeName()
-              ),"Tracking", 5, "ID" )
+              ), 5, "Tracking" )
   
             if self.AlertsToAll == true then
               Message:ToAll()
@@ -671,7 +697,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

@@ -3,12 +3,11 @@
 -- 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 +21,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 +34,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 +48,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 +61,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 +127,5 @@ function MOVEMENT:_Scheduler()
 			end
 		end
 	end
+	return true
 end

Moose Development/Moose/Functional/Sead.lua

@@ -3,16 +3,9 @@
 -- @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 +36,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 +78,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/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

Moose Development/Moose/Mission.lua

@@ -1,654 +0,0 @@
---- A MISSION is the main owner of a Mission orchestration within MOOSE	. The Mission framework orchestrates @{CLIENT}s, @{TASK}s, @{STAGE}s etc.
--- A @{CLIENT} needs to be registered within the @{MISSION} through the function @{AddClient}. A @{TASK} needs to be registered within the @{MISSION} through the function @{AddTask}.
--- @module MISSION
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Client" )
-Include.File( "Task" )
-
---- The MISSION class
--- @type
-MISSION = {
-	ClassName = "MISSION",
-	Name = "",
-	MissionStatus = "PENDING",
-	_Clients = {},
-	_Tasks = {},
-	_ActiveTasks = {},
-	GoalFunction = nil,
-	MissionReportTrigger = 0,
-	MissionProgressTrigger = 0,
-	MissionReportShow = false,
-	MissionReportFlash = false,
-	MissionTimeInterval = 0,
-	MissionCoalition = "",
-	SUCCESS = 1,
-	FAILED = 2,
-	REPEAT = 3,
-	_GoalTasks = {}
-}
-
-
-function MISSION:Meta()
-
-	local self = BASE:Inherit( self, BASE:New() )
-	self:F()
-	
-	return self
-end
-
---- This is the main MISSION declaration method. Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc.
--- @param string MissionName is the name of the mission. This name will be used to reference the status of each mission by the players.
--- @param string MissionPriority is a string indicating the "priority" of the Mission. f.e. "Primary", "Secondary" or "First", "Second". It is free format and up to the Mission designer to choose. There are no rules behind this field.
--- @param string MissionBriefing is a string indicating the mission briefing to be shown when a player joins a @{CLIENT}.
--- @param string MissionCoalition is a string indicating the coalition or party to which this mission belongs to. It is free format and can be chosen freely by the mission designer. Note that this field is not to be confused with the coalition concept of the ME. Examples of a Mission Coalition could be "NATO", "CCCP", "Intruders", "Terrorists"...
--- @return MISSION
--- @usage 
--- -- Declare a few missions.
--- local Mission = MISSIONSCHEDULER.AddMission( 'Russia Transport Troops SA-6', 'Operational', 'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 'Russia' )
--- local Mission = MISSIONSCHEDULER.AddMission( 'Patriots', 'Primary', 'Our intelligence reports that 3 Patriot SAM defense batteries are located near Ruisi, Kvarhiti and Gori.', 'Russia'  )
--- local Mission = MISSIONSCHEDULER.AddMission( 'Package Delivery', 'Operational', 'In order to be in full control of the situation, we need you to deliver a very important package at a secret location. Fly undetected through the NATO defenses and deliver the secret package. The secret agent is located at waypoint 4.', 'Russia'  )
--- local Mission = MISSIONSCHEDULER.AddMission( 'Rescue General', 'Tactical', 'Our intelligence has received a remote signal behind Gori. We believe it is a very important Russian General that was captured by Georgia. Go out there and rescue him! Ensure you stay out of the battle zone, keep south. Waypoint 4 is the location of our Russian General.', 'Russia'  )
--- local Mission = MISSIONSCHEDULER.AddMission( 'NATO Transport Troops', 'Operational', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.', 'NATO' )
--- local Mission = MISSIONSCHEDULER.AddMission( 'SA-6 SAMs', 'Primary', 'Our intelligence reports that 3 SA-6 SAM defense batteries are located near Didmukha, Khetagurov and Berula. Eliminate the Russian SAMs.', 'NATO'  )
--- local Mission = MISSIONSCHEDULER.AddMission( 'NATO Sling Load', 'Operational', 'Fly to the cargo pickup zone at Dzegvi or Kaspi, and sling the cargo to Soganlug airbase.', 'NATO' )
--- local Mission = MISSIONSCHEDULER.AddMission( 'Rescue secret agent', 'Tactical', 'In order to be in full control of the situation, we need you to rescue a secret agent from the woods behind enemy lines. Avoid the Russian defenses and rescue the agent. Keep south until Khasuri, and keep your eyes open for any SAM presence. The agent is located at waypoint 4 on your kneeboard.', 'NATO'  )
-function MISSION:New( MissionName, MissionPriority, MissionBriefing, MissionCoalition )
-
-	self = MISSION:Meta()
-	self:T({ MissionName, MissionPriority, MissionBriefing, MissionCoalition })
-  
-	local Valid = true
-  
-	Valid = routines.ValidateString( MissionName, "MissionName", Valid )
-	Valid = routines.ValidateString( MissionPriority, "MissionPriority", Valid )
-	Valid = routines.ValidateString( MissionBriefing, "MissionBriefing", Valid )
-	Valid = routines.ValidateString( MissionCoalition, "MissionCoalition", Valid )
-  
-	if Valid then
-		self.Name = MissionName
-		self.MissionPriority = MissionPriority
-		self.MissionBriefing = MissionBriefing
-		self.MissionCoalition = MissionCoalition
-	end
-
-	return self
-end
-
---- Returns if a Mission has completed.
--- @return bool
-function MISSION:IsCompleted()
-	self:F()
-	return self.MissionStatus == "ACCOMPLISHED"
-end
-
---- Set a Mission to completed.
-function MISSION:Completed()
-	self:F()
-	self.MissionStatus = "ACCOMPLISHED"
-	self:StatusToClients()
-end
-
---- Returns if a Mission is ongoing.
--- treturn bool
-function MISSION:IsOngoing()
-	self:F()
-	return self.MissionStatus == "ONGOING"
-end
-
---- Set a Mission to ongoing.
-function MISSION:Ongoing()
-	self:F()
-	self.MissionStatus = "ONGOING"
-	--self:StatusToClients()
-end
-
---- Returns if a Mission is pending.
--- treturn bool
-function MISSION:IsPending()
-	self:F()
-	return self.MissionStatus == "PENDING"
-end
-
---- Set a Mission to pending.
-function MISSION:Pending()
-	self:F()
-	self.MissionStatus = "PENDING"
-	self:StatusToClients()
-end
-
---- Returns if a Mission has failed.
--- treturn bool
-function MISSION:IsFailed() 
-	self:F()
-	return self.MissionStatus == "FAILED"
-end
-
---- Set a Mission to failed.
-function MISSION:Failed()
-	self:F()
-	self.MissionStatus = "FAILED"
-	self:StatusToClients()
-end
-
---- Send the status of the MISSION to all Clients.
-function MISSION:StatusToClients()
-	self:F()
-	if self.MissionReportFlash then
-		for ClientID, Client in pairs( self._Clients ) do
-			Client:Message( self.MissionCoalition .. ' "' .. self.Name .. '": ' .. self.MissionStatus .. '! ( ' .. self.MissionPriority .. ' mission ) ', 10,  self.Name .. '/Status', "Mission Command: Mission Status")
-		end
-	end
-end
-
---- Handles the reporting. After certain time intervals, a MISSION report MESSAGE will be shown to All Players.
-function MISSION:ReportTrigger()
-	self:F()
-
-	if self.MissionReportShow == true then
-		self.MissionReportShow = false
-		return true
-	else
-		if self.MissionReportFlash == true then
-			if timer.getTime() >= self.MissionReportTrigger then
-				self.MissionReportTrigger = timer.getTime() + self.MissionTimeInterval
-				return true
-			else
-				return false
-			end
-		else
-			return false 
-		end
-	end
-end
-
---- Report the status of all MISSIONs to all active Clients.
-function MISSION:ReportToAll()
-	self:F()
-
-	local AlivePlayers = ''
-	for ClientID, Client in pairs( self._Clients ) do
-		if  Client:GetDCSGroup() then
-			if Client:GetClientGroupDCSUnit() then
-				if Client:GetClientGroupDCSUnit():getLife() > 0.0 then
-					if AlivePlayers == '' then
-						AlivePlayers = ' Players: ' .. Client:GetClientGroupDCSUnit():getPlayerName()
-					else
-						AlivePlayers = AlivePlayers .. ' / ' .. Client:GetClientGroupDCSUnit():getPlayerName()
-					end
-				end
-			end
-		end
-	end
-	local Tasks = self:GetTasks()
-	local TaskText = ""
-	for TaskID, TaskData in pairs( Tasks ) do
-		TaskText = TaskText .. "         - Task " .. TaskID .. ": " .. TaskData.Name .. ": " .. TaskData:GetGoalProgress() .. "\n"
-	end
-	MESSAGE:New( self.MissionCoalition .. ' "' .. self.Name .. '": ' .. self.MissionStatus .. ' ( ' .. self.MissionPriority .. ' mission )' .. AlivePlayers .. "\n" .. TaskText:gsub("\n$",""), "Mission Command: Mission Report", 10,  self.Name .. '/Status'):ToAll()
-end
-
-
---- Add a goal function to a MISSION. Goal functions are called when a @{TASK} within a mission has been completed.
--- @param function GoalFunction is the function defined by the mission designer to evaluate whether a certain goal has been reached after a @{TASK} finishes within the @{MISSION}. A GoalFunction must accept 2 parameters: Mission, Client, which contains the current MISSION object and the current CLIENT object respectively.
--- @usage
---  PatriotActivation = { 
---		{ "US SAM Patriot Zerti", false },
---		{ "US SAM Patriot Zegduleti", false },
---		{ "US SAM Patriot Gvleti", false }
---	}
---
---	function DeployPatriotTroopsGoal( Mission, Client )
---
---
---		-- Check if the cargo is all deployed for mission success.
---		for CargoID, CargoData in pairs( Mission._Cargos ) do
---			if Group.getByName( CargoData.CargoGroupName ) then
---				CargoGroup = Group.getByName( CargoData.CargoGroupName )
---				if CargoGroup then
---					-- Check if the cargo is ready to activate
---					CurrentLandingZoneID = routines.IsUnitInZones( CargoGroup:getUnits()[1], Mission:GetTask( 2 ).LandingZones ) -- The second task is the Deploytask to measure mission success upon
---					if CurrentLandingZoneID then
---						if PatriotActivation[CurrentLandingZoneID][2] == false then
---							-- Now check if this is a new Mission Task to be completed...
---							trigger.action.setGroupAIOn( Group.getByName( PatriotActivation[CurrentLandingZoneID][1] ) )
---							PatriotActivation[CurrentLandingZoneID][2] = true
---							MessageToBlue( "Mission Command: Message to all airborne units! The " .. PatriotActivation[CurrentLandingZoneID][1] .. " is armed. Our air defenses are now stronger.", 60, "BLUE/PatriotDefense" )
---							MessageToRed( "Mission Command: Our satellite systems are detecting additional NATO air defenses. To all airborne units: Take care!!!", 60, "RED/PatriotDefense" )
---							Mission:GetTask( 2 ):AddGoalCompletion( "Patriots activated", PatriotActivation[CurrentLandingZoneID][1], 1 ) -- Register Patriot activation as part of mission goal.
---						end
---					end
---				end
---			end
---		end
---	end
---
---	local Mission = MISSIONSCHEDULER.AddMission( 'NATO Transport Troops', 'Operational', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.', 'NATO' )
---	Mission:AddGoalFunction( DeployPatriotTroopsGoal )
-function MISSION:AddGoalFunction( GoalFunction )
-	self:F()
-	self.GoalFunction = GoalFunction 
-end
-
---- Register a new @{CLIENT} to participate within the mission.
--- @param CLIENT Client is the @{CLIENT} object. The object must have been instantiated with @{CLIENT:New}.
--- @return CLIENT
--- @usage
--- Add a number of Client objects to the Mission.
--- 	Mission:AddClient( CLIENT:New( 'US UH-1H*HOT-Deploy Troops 1', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
---	Mission:AddClient( CLIENT:New( 'US UH-1H*RAMP-Deploy Troops 3', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
---	Mission:AddClient( CLIENT:New( 'US UH-1H*HOT-Deploy Troops 2', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
---	Mission:AddClient( CLIENT:New( 'US UH-1H*RAMP-Deploy Troops 4', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
-function MISSION:AddClient( Client )
-	self:F( { Client } )
-
-	local Valid = true
- 
-	if Valid then
-		self._Clients[Client.ClientName] = Client
-	end
-
-	return Client
-end
-
---- Find a @{CLIENT} object within the @{MISSION} by its ClientName.
--- @param CLIENT ClientName is a string defining the Client Group as defined within the ME.
--- @return CLIENT
--- @usage
--- -- Seach for Client "Bomber" within the Mission.
--- local BomberClient = Mission:FindClient( "Bomber" )
-function MISSION:FindClient( ClientName )
-	self:F( { self._Clients[ClientName] } )
-	return self._Clients[ClientName]
-end
-
-
---- Register a @{TASK} to be completed within the @{MISSION}. Note that there can be multiple @{TASK}s registered to be completed. Each TASK can be set a certain Goal. The MISSION will not be completed until all Goals are reached.
--- @param TASK Task is the @{TASK} object. The object must have been instantiated with @{TASK:New} or any of its inherited @{TASK}s.
--- @param number TaskNumber is the sequence number of the TASK within the MISSION. This number does have to be chronological.
--- @return TASK
--- @usage
--- -- Define a few tasks for the Mission.
---	PickupZones = { "NATO Gold Pickup Zone", "NATO Titan Pickup Zone" }
---	PickupSignalUnits = { "NATO Gold Coordination Center", "NATO Titan Coordination Center" }
---
---	-- Assign the Pickup Task
---	local PickupTask = PICKUPTASK:New( PickupZones, CARGO_TYPE.ENGINEERS, CLIENT.ONBOARDSIDE.LEFT )
---	PickupTask:AddSmokeBlue( PickupSignalUnits  )
---	PickupTask:SetGoalTotal( 3 )
---	Mission:AddTask( PickupTask, 1 )
---
---	-- Assign the Deploy Task
---	local PatriotActivationZones = { "US Patriot Battery 1 Activation", "US Patriot Battery 2 Activation", "US Patriot Battery 3 Activation" }
---	local PatriotActivationZonesSmokeUnits = { "US SAM Patriot - Battery 1 Control", "US SAM Patriot - Battery 2 Control", "US SAM Patriot - Battery 3 Control" }
---	local DeployTask = DEPLOYTASK:New( PatriotActivationZones, CARGO_TYPE.ENGINEERS )
---	--DeployTask:SetCargoTargetZoneName( 'US Troops Attack ' .. math.random(2) )
---	DeployTask:AddSmokeBlue( PatriotActivationZonesSmokeUnits )
---	DeployTask:SetGoalTotal( 3 )
---	DeployTask:SetGoalTotal( 3, "Patriots activated" )
---	Mission:AddTask( DeployTask, 2 )
-	
-function MISSION:AddTask( Task, TaskNumber )
-	self:F()
-
-	self._Tasks[TaskNumber] = Task
-	self._Tasks[TaskNumber]:EnableEvents()
-	self._Tasks[TaskNumber].ID = TaskNumber
-
-	return Task
- end
-
---- Get the TASK idenified by the TaskNumber from the Mission. This function is useful in GoalFunctions.
--- @param number TaskNumber is the number of the @{TASK} within the @{MISSION}.
--- @return TASK
--- @usage
--- -- Get Task 2 from the Mission.
--- Task2 = Mission:GetTask( 2 )
-
-function MISSION:GetTask( TaskNumber )
-	self:F()
-
-	local Valid = true
-
-	local Task = nil
-
-	if type(TaskNumber) ~= "number" then
-		Valid = false
-	end
-
-	if Valid then
-		Task = self._Tasks[TaskNumber]
-	end
-
-	return Task
-end
-
---- Get all the TASKs from the Mission. This function is useful in GoalFunctions.
--- @return {TASK,...} Structure of TASKS with the @{TASK} number as the key.
--- @usage
--- -- Get Tasks from the Mission.
--- Tasks = Mission:GetTasks()
--- env.info( "Task 2 Completion = " .. Tasks[2]:GetGoalPercentage() .. "%" )
-function MISSION:GetTasks()
-	self:F()
-
-	return self._Tasks
-end
- 
-
---[[
-  _TransportExecuteStage: Defines the different stages of Transport unload/load execution. This table is internal and is used to control the validity of Transport load/unload timing.
-  
-  - _TransportExecuteStage.EXECUTING
-  - _TransportExecuteStage.SUCCESS
-  - _TransportExecuteStage.FAILED
-  
---]]
-_TransportExecuteStage = { 
-  NONE = 0,
-  EXECUTING = 1, 
-  SUCCESS = 2, 
-  FAILED = 3
-}
-
-
---- The MISSIONSCHEDULER is an OBJECT and is the main scheduler of ALL active MISSIONs registered within this scheduler. It's workings are considered internal and is automatically created when the Mission.lua file is included.
--- @type MISSIONSCHEDULER
-MISSIONSCHEDULER = {
-  Missions = {},
-  MissionCount = 0,
-  TimeIntervalCount = 0,
-  TimeIntervalShow = 150,
-  TimeSeconds = 14400,
-  TimeShow = 5
-}
-
---- This is the main MISSIONSCHEDULER Scheduler function. It is considered internal and is automatically created when the Mission.lua file is included.
-function MISSIONSCHEDULER.Scheduler()
-
-	-- loop through the missions in the TransportTasks
-	for MissionName, Mission in pairs( MISSIONSCHEDULER.Missions ) do
-	
-		if not Mission:IsCompleted() then
-		
-			-- This flag will monitor if for this mission, there are clients alive. If this flag is still false at the end of the loop, the mission status will be set to Pending (if not Failed or Completed).
-			local ClientsAlive = false
-			
-			for ClientID, Client in pairs( Mission._Clients ) do
-			
-				if Client:GetDCSGroup() then
-
-					-- There is at least one Client that is alive... So the Mission status is set to Ongoing.
-					ClientsAlive = true 
-					
-					-- If this Client was not registered as Alive before:
-					-- 1. We register the Client as Alive.
-					-- 2. We initialize the Client Tasks and make a link to the original Mission Task.
-					-- 3. We initialize the Cargos.
-					-- 4. We flag the Mission as Ongoing.
-					if not Client.ClientAlive then
-						Client.ClientAlive = true
-						Client.ClientBriefingShown = false
-						for TaskNumber, Task in pairs( Mission._Tasks ) do
-							-- Note that this a deepCopy. Each client must have their own Tasks with own Stages!!!
-							Client._Tasks[TaskNumber] = routines.utils.deepCopy( Mission._Tasks[TaskNumber] )
-							-- Each MissionTask must point to the original Mission.
-							Client._Tasks[TaskNumber].MissionTask = Mission._Tasks[TaskNumber]
-							Client._Tasks[TaskNumber].Cargos = Mission._Tasks[TaskNumber].Cargos
-							Client._Tasks[TaskNumber].LandingZones = Mission._Tasks[TaskNumber].LandingZones
-						end
-
-						Mission:Ongoing()				
-					end
-					
-
-					-- For each Client, check for each Task the state and evolve the mission.
-					-- This flag will indicate if the Task of the Client is Complete.
-					TaskComplete = false
-
-					for TaskNumber, Task in pairs( Client._Tasks ) do
-
-						if not Task.Stage then
-							Task:SetStage( 1 )
-						end
-
-						
-						local TransportTime = timer.getTime()
-				
-						if not Task:IsDone() then
-
-							if Task:Goal() then
-								Task:ShowGoalProgress( Mission, Client )
-							end
-							
-							--env.info( 'Scheduler: Mission = ' .. Mission.Name .. ' / Client = ' .. Client.ClientName .. ' / Task = ' .. Task.Name .. ' / Stage = ' .. Task.ActiveStage .. ' - ' .. Task.Stage.Name .. ' - ' .. Task.Stage.StageType )
-							
-							-- Action
-							if Task:StageExecute() then
-								Task.Stage:Execute( Mission, Client, Task )
-							end
-						  
-							-- Wait until execution is finished            
-							if  Task.ExecuteStage == _TransportExecuteStage.EXECUTING then
-								Task.Stage:Executing( Mission, Client, Task )
-							end
-						  
-							-- Validate completion or reverse to earlier stage
-							if Task.Time + Task.Stage.WaitTime <= TransportTime then
-								Task:SetStage( Task.Stage:Validate( Mission, Client, Task ) )
-							end
-							 
-							if Task:IsDone() then
-								--env.info( 'Scheduler: Mission '.. Mission.Name .. ' Task ' .. Task.Name .. ' Stage ' .. Task.Stage.Name .. ' done. TaskComplete = ' .. string.format ( "%s", TaskComplete and "true" or "false" ) )
-								TaskComplete = true -- when a task is not yet completed, a mission cannot be completed
-								
-							else
-								-- break only if this task is not yet done, so that future task are not yet activated.
-								TaskComplete = false -- when a task is not yet completed, a mission cannot be completed
-								--env.info( 'Scheduler: Mission "'.. Mission.Name .. '" Task "' .. Task.Name .. '" Stage "' .. Task.Stage.Name .. '" break. TaskComplete = ' .. string.format ( "%s", TaskComplete and "true" or "false" ) )
-								break
-							end
-
-							if TaskComplete then
-
-								if Mission.GoalFunction ~= nil then
-									Mission.GoalFunction( Mission, Client )
-								end
-								if MISSIONSCHEDULER.Scoring then
-								  MISSIONSCHEDULER.Scoring:_AddMissionTaskScore( Client:GetClientGroupDCSUnit(), Mission.Name, 25 )
-								end
-
---								if not Mission:IsCompleted() then
---								end
-							end
-						end
-					end
-					
-					local MissionComplete = true
-					for TaskNumber, Task in pairs( Mission._Tasks ) do
-						if Task:Goal() then
---							Task:ShowGoalProgress( Mission, Client )
-							if Task:IsGoalReached() then
-							else
-								MissionComplete = false
-							end
-						else
-							MissionComplete = false -- If there is no goal, the mission should never be ended. The goal status will be set somewhere else.
-						end
-					end
-
-					if MissionComplete then
-						Mission:Completed()
-						if MISSIONSCHEDULER.Scoring then
-						  MISSIONSCHEDULER.Scoring:_AddMissionScore( Mission.Name, 100 )
-						end
-					else
-						if TaskComplete then
-							-- Reset for new tasking of active client
-							Client.ClientAlive = false -- Reset the client tasks.
-						end
-					end
-					
-
-				else
-					if Client.ClientAlive then
-						env.info( 'Scheduler: Client "' .. Client.ClientName .. '" is inactive.' )
-						Client.ClientAlive = false
-						
-						-- This is tricky. If we sanitize Client._Tasks before sanitizing Client._Tasks[TaskNumber].MissionTask, then the original MissionTask will be sanitized, and will be lost within the garbage collector.
-						-- So first sanitize Client._Tasks[TaskNumber].MissionTask, after that, sanitize only the whole _Tasks structure...
-						--Client._Tasks[TaskNumber].MissionTask = nil
-						--Client._Tasks = nil
-					end
-				end
-			end
-
-			-- If all Clients of this Mission are not activated, then the Mission status needs to be put back into Pending status.
-			-- But only if the Mission was Ongoing. In case the Mission is Completed or Failed, the Mission status may not be changed. In these cases, this will be the last run of this Mission in the Scheduler.
-			if ClientsAlive == false then
-				if Mission:IsOngoing() then
-					-- Mission status back to pending...
-					Mission:Pending()
-				end
-			end
-		end
-		
-		Mission:StatusToClients()
-		
-		if Mission:ReportTrigger() then
-			Mission:ReportToAll()
-		end
-	end
-end
-
---- Start the MISSIONSCHEDULER.
-function MISSIONSCHEDULER.Start()
-  if MISSIONSCHEDULER ~= nil then
-    MISSIONSCHEDULER.SchedulerId = routines.scheduleFunction( MISSIONSCHEDULER.Scheduler, { }, 0, 2 )
-  end
-end
-
---- Stop the MISSIONSCHEDULER.
-function MISSIONSCHEDULER.Stop()
-	if MISSIONSCHEDULER.SchedulerId then
-		routines.removeFunction(MISSIONSCHEDULER.SchedulerId)
-		MISSIONSCHEDULER.SchedulerId = nil
-	end
-end
-
---- This is the main MISSION declaration method. Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc.
--- @param Mission is the MISSION object instantiated by @{MISSION:New}.
--- @return MISSION
--- @usage 
--- -- Declare a mission.
--- Mission = MISSION:New( 'Russia Transport Troops SA-6', 
---                        'Operational', 
---                        'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 
---                        'Russia' )
--- MISSIONSCHEDULER:AddMission( Mission )
-function MISSIONSCHEDULER.AddMission( Mission )
-	MISSIONSCHEDULER.Missions[Mission.Name] = Mission
-	MISSIONSCHEDULER.MissionCount = MISSIONSCHEDULER.MissionCount + 1
-	-- Add an overall AI Client for the AI tasks... This AI Client will facilitate the Events in the background for each Task. 
-	--MissionAdd:AddClient( CLIENT:New( 'AI' ) )
-	
-	return Mission
-end
-
---- Remove a MISSION from the MISSIONSCHEDULER.
--- @param MissionName is the name of the MISSION given at declaration using @{AddMission}.
--- @usage
--- -- Declare a mission.
--- Mission = MISSION:New( 'Russia Transport Troops SA-6', 
---                        'Operational', 
---                        'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 
---                        'Russia' )
--- MISSIONSCHEDULER:AddMission( Mission )
---
--- -- Now remove the Mission.
--- MISSIONSCHEDULER:RemoveMission( 'Russia Transport Troops SA-6' )
-function MISSIONSCHEDULER.RemoveMission( MissionName )
-	MISSIONSCHEDULER.Missions[MissionName] = nil
-	MISSIONSCHEDULER.MissionCount = MISSIONSCHEDULER.MissionCount - 1
-end
-
---- Find a MISSION within the MISSIONSCHEDULER.
--- @param MissionName is the name of the MISSION given at declaration using @{AddMission}.
--- @return MISSION
--- @usage
--- -- Declare a mission.
--- Mission = MISSION:New( 'Russia Transport Troops SA-6', 
---                        'Operational', 
---                        'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 
---                        'Russia' )
--- MISSIONSCHEDULER:AddMission( Mission )
---
--- -- Now find the Mission.
--- MissionFind = MISSIONSCHEDULER:FindMission( 'Russia Transport Troops SA-6' )
-function MISSIONSCHEDULER.FindMission( MissionName )
-	return MISSIONSCHEDULER.Missions[MissionName]
-end
-
--- Internal function used by the MISSIONSCHEDULER menu.
-function MISSIONSCHEDULER.ReportMissionsShow( )
-	for MissionName, Mission in pairs( MISSIONSCHEDULER.Missions ) do
-		Mission.MissionReportShow = true
-		Mission.MissionReportFlash = false 
-	end
-end
-
--- Internal function used by the MISSIONSCHEDULER menu.
-function MISSIONSCHEDULER.ReportMissionsFlash( TimeInterval )
-	local Count = 0
-	for MissionName, Mission in pairs( MISSIONSCHEDULER.Missions ) do
-		Mission.MissionReportShow = false 
-		Mission.MissionReportFlash = true
-		Mission.MissionReportTrigger = timer.getTime() + Count * TimeInterval
-		Mission.MissionTimeInterval = MISSIONSCHEDULER.MissionCount * TimeInterval 
-		env.info( "TimeInterval = "  .. Mission.MissionTimeInterval )
-		Count = Count + 1
-	end
-end
-
--- Internal function used by the MISSIONSCHEDULER menu.
-function MISSIONSCHEDULER.ReportMissionsHide( Prm )
-	for MissionName, Mission in pairs( MISSIONSCHEDULER.Missions ) do
-		Mission.MissionReportShow = false
-		Mission.MissionReportFlash = false
-	end
-end
-
---- Enables a MENU option in the communications menu under F10 to control the status of the active missions.
--- This function should be called only once when starting the MISSIONSCHEDULER.
-function MISSIONSCHEDULER.ReportMenu()
-	local ReportMenu = SUBMENU:New( 'Status' )
-	local ReportMenuShow = COMMANDMENU:New( 'Show Report Missions', ReportMenu, MISSIONSCHEDULER.ReportMissionsShow, 0 )
-	local ReportMenuFlash = COMMANDMENU:New('Flash Report Missions', ReportMenu, MISSIONSCHEDULER.ReportMissionsFlash, 120 )
-	local ReportMenuHide = COMMANDMENU:New( 'Hide Report Missions', ReportMenu, MISSIONSCHEDULER.ReportMissionsHide, 0 )
-end
-
---- Show the remaining mission time.
-function MISSIONSCHEDULER:TimeShow()
-	self.TimeIntervalCount = self.TimeIntervalCount + 1
-	if self.TimeIntervalCount >= self.TimeTriggerShow then
-		local TimeMsg = string.format("%00d", ( self.TimeSeconds / 60 ) - ( timer.getTime() / 60 )) .. ' minutes left until mission reload.'
-		MESSAGE:New( TimeMsg, "Mission time", self.TimeShow, '/TimeMsg' ):ToAll()
-		self.TimeIntervalCount = 0
-	end
-end
-
-function MISSIONSCHEDULER:Time( TimeSeconds, TimeIntervalShow, TimeShow )
-
-	self.TimeIntervalCount = 0
-	self.TimeSeconds = TimeSeconds
-	self.TimeIntervalShow = TimeIntervalShow
-	self.TimeShow = TimeShow
-end
-
---- Adds a mission scoring to the game.
-function MISSIONSCHEDULER:Scoring( Scoring )
-
-  self.Scoring = Scoring
-end
-

Moose Development/Moose/Moose.lua

@@ -1,15 +1,78 @@
 --- The main include file for the MOOSE system.
+-- Test of permissions
+
+--- Core Routines
+Include.File( "Utilities/Routines" )
+Include.File( "Utilities/Utils" )
+
+--- Core Classes
+Include.File( "Core/Base" )
+Include.File( "Core/Scheduler" )
+Include.File( "Core/ScheduleDispatcher")
+Include.File( "Core/Event" )
+Include.File( "Core/Menu" )
+Include.File( "Core/Zone" )
+Include.File( "Core/Database" )
+Include.File( "Core/Set" )
+Include.File( "Core/Point" )
+Include.File( "Core/Message" )
+Include.File( "Core/Fsm" )
+
+--- Wrapper Classes
+Include.File( "Wrapper/Object" )
+Include.File( "Wrapper/Identifiable" )
+Include.File( "Wrapper/Positionable" )
+Include.File( "Wrapper/Controllable" )
+Include.File( "Wrapper/Group" )
+Include.File( "Wrapper/Unit" )
+Include.File( "Wrapper/Client" )
+Include.File( "Wrapper/Static" )
+Include.File( "Wrapper/Airbase" )
+Include.File( "Wrapper/Scenery" )
+
+--- Functional Classes
+Include.File( "Functional/Scoring" )
+Include.File( "Functional/CleanUp" )
+Include.File( "Functional/Spawn" )
+Include.File( "Functional/Movement" )
+Include.File( "Functional/Sead" )
+Include.File( "Functional/Escort" )
+Include.File( "Functional/MissileTrainer" )
+Include.File( "Functional/AirbasePolice" )
+Include.File( "Functional/Detection" )
+
+--- AI Classes
+Include.File( "AI/AI_Balancer" )
+Include.File( "AI/AI_Patrol" )
+Include.File( "AI/AI_Cap" )
+Include.File( "AI/AI_Cas" )
+Include.File( "AI/AI_Cargo" )
+
+--- Actions
+Include.File( "Actions/Act_Assign" )
+Include.File( "Actions/Act_Route" )
+Include.File( "Actions/Act_Account" )
+Include.File( "Actions/Act_Assist" )
+
+--- Task Handling Classes
+Include.File( "Tasking/CommandCenter" )
+Include.File( "Tasking/Mission" )
+Include.File( "Tasking/Task" )
+Include.File( "Tasking/DetectionManager" )
+Include.File( "Tasking/Task_A2G_Dispatcher")
+Include.File( "Tasking/Task_A2G" )
 
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Database" )
-Include.File( "Event" )
 
 -- The order of the declarations is important here. Don't touch it.
 
 --- Declare the event dispatcher based on the EVENT class
-_EVENTDISPATCHER = EVENT:New() -- #EVENT
+_EVENTDISPATCHER = EVENT:New() -- Core.Event#EVENT
+
+--- Declare the timer dispatcher based on the SCHEDULEDISPATCHER class
+_SCHEDULEDISPATCHER = SCHEDULEDISPATCHER:New() -- Core.Timer#SCHEDULEDISPATCHER
 
 --- Declare the main database object, which is used internally by the MOOSE classes.
-_DATABASE = DATABASE:New():ScanEnvironment() -- Database#DATABASE
+_DATABASE = DATABASE:New() -- Database#DATABASE
+
+
 

Moose Development/Moose/Scheduler.lua

@@ -1,114 +0,0 @@
---- Models time events calling event handing functions.
--- @module Scheduler
--- @author FlightControl
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Cargo" )
-Include.File( "Message" )
-
-
---- The SCHEDULER class
--- @type SCHEDULER
--- @extends Base#BASE
-SCHEDULER = {
-  ClassName = "SCHEDULER",
-}
-
-
---- SCHEDULER constructor.
--- @param #SCHEDULER self
--- @param #table TimeEventObject
--- @param #function TimeEventFunction
--- @param #table TimeEventFunctionArguments
--- @param #number StartSeconds
--- @param #number RepeatSecondsInterval
--- @param #number RandomizationFactor
--- @param #number StopSeconds
--- @return #SCHEDULER
-function SCHEDULER:New( TimeEventObject, TimeEventFunction, TimeEventFunctionArguments, StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds )
-  local self = BASE:Inherit( self, BASE:New() )
-  self:F( { TimeEventObject, TimeEventFunction, TimeEventFunctionArguments, StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds } )
-
-  self.TimeEventObject = TimeEventObject
-  self.TimeEventFunction = TimeEventFunction
-  self.TimeEventFunctionArguments = TimeEventFunctionArguments
-  self.StartSeconds = StartSeconds
-
-  if RepeatSecondsInterval then
-    self.RepeatSecondsInterval = RepeatSecondsInterval
-  else
-    self.RepeatSecondsInterval = 0
-  end
-
-  if RandomizationFactor then
-    self.RandomizationFactor = RandomizationFactor
-  else
-    self.RandomizationFactor = 0
-  end
-
-  if StopSeconds then
-    self.StopSeconds = StopSeconds
-  end
-  
-  self.Repeat = false
-
-  self.StartTime = timer.getTime()
-  
-  self:Start()
-
-  return self
-end
-
-function SCHEDULER:Scheduler()
-  self:F( self.TimeEventFunctionArguments )
-  
-  local ErrorHandler = function( errmsg )
-
-    env.info( "Error in SCHEDULER function:" .. errmsg )
-    env.info( debug.traceback() )
-
-    return errmsg
-  end
-
-  local Status, Result  
-  if self.TimeEventObject then
-    Status, Result = xpcall( function() return self.TimeEventFunction( self.TimeEventObject, unpack( self.TimeEventFunctionArguments ) ) end, ErrorHandler )
-  else
-    Status, Result = xpcall( function() return self.TimeEventFunction( unpack( self.TimeEventFunctionArguments ) ) end, ErrorHandler )
-  end
-  
-  self:T( { Status, Result } )
-  
-  if Status and Status == true and Result and Result == true then
-    if self.Repeat and ( not self.StopSeconds or ( self.StopSeconds and timer.getTime() <= self.StartTime + self.StopSeconds ) ) then
-      timer.scheduleFunction(
-        self.Scheduler,
-        self,
-        timer.getTime() + self.RepeatSecondsInterval + math.random( - ( self.RandomizationFactor * self.RepeatSecondsInterval / 2 ), ( self.RandomizationFactor * self.RepeatSecondsInterval  / 2 ) ) + 0.01
-      )
-    end
-  end
-
-end
-
-function SCHEDULER:Start()
-  self:F( self.TimeEventObject )
-  
-  self.Repeat = true
-  timer.scheduleFunction( self.Scheduler, self, timer.getTime() + self.StartSeconds + .01 )
-  
-  return self
-end
-
-function SCHEDULER:Stop()
-  self:F( self.TimeEventObject )
-  
-  self.Repeat = false
-end
-
-
-
-
-
-

Moose Development/Moose/Scoring.lua

@@ -1,815 +0,0 @@
---- Scoring system for MOOSE.
--- This scoring class calculates the hits and kills that players make within a simulation session.
--- Scoring is calculated using a defined algorithm.
--- With a small change in MissionScripting.lua, the scoring can also be logged in a CSV file, that can then be uploaded
--- to a database or a BI tool to publish the scoring results to the player community.
--- @module Scoring
--- @author FlightControl
-
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Menu" )
-Include.File( "Group" )
-Include.File( "Event" )
-
-
---- The Scoring class
--- @type SCORING
--- @field Players A collection of the current players that have joined the game.
--- @extends Base#BASE
-SCORING = {
-  ClassName = "SCORING",
-  ClassID = 0,
-  Players = {},
-}
-
-local _SCORINGCoalition =
-  {
-    [1] = "Red",
-    [2] = "Blue",
-  }
-
-local _SCORINGCategory =
-  {
-    [Unit.Category.AIRPLANE] = "Plane",
-    [Unit.Category.HELICOPTER] = "Helicopter",
-    [Unit.Category.GROUND_UNIT] = "Vehicle",
-    [Unit.Category.SHIP] = "Ship",
-    [Unit.Category.STRUCTURE] = "Structure",
-  }
-
---- Creates a new SCORING object to administer the scoring achieved by players.
--- @param #SCORING self
--- @param #string GameName The name of the game. This name is also logged in the CSV score file.
--- @return #SCORING self
--- @usage
--- -- Define a new scoring object for the mission Gori Valley.
--- ScoringObject = SCORING:New( "Gori Valley" )
-function SCORING:New( GameName )
-
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, BASE:New() )
-  
-  if GameName then 
-    self.GameName = GameName
-  else
-    error( "A game name must be given to register the scoring results" )
-  end
-  
-  
-  _EVENTDISPATCHER:OnDead( self._EventOnDeadOrCrash, self )
-  _EVENTDISPATCHER:OnCrash( self._EventOnDeadOrCrash, self )
-  _EVENTDISPATCHER:OnHit( self._EventOnHit, self )
-
-  self.SchedulerId = routines.scheduleFunction( SCORING._FollowPlayersScheduled, { self }, 0, 5 )
-
-  self:ScoreMenu()
-
-  return self
-  
-end
-
---- Creates a score radio menu. Can be accessed using Radio -> F10.
--- @param #SCORING self
--- @return #SCORING self
-function SCORING:ScoreMenu()
-  self.Menu = SUBMENU:New( 'Scoring' )
-  self.AllScoresMenu = COMMANDMENU:New( 'Score All Active Players', self.Menu, SCORING.ReportScoreAll, self )
-  --- = COMMANDMENU:New('Your Current Score', ReportScore, SCORING.ReportScorePlayer, self )
-  return self
-end
-
---- Follows new players entering Clients within the DCSRTE.
--- TODO: Need to see if i can catch this also with an event. It will eliminate the schedule ...
-function SCORING:_FollowPlayersScheduled()
-  self:F3( "_FollowPlayersScheduled" )
-
-  local ClientUnit = 0
-  local CoalitionsData = { AlivePlayersRed = coalition.getPlayers(coalition.side.RED), AlivePlayersBlue = coalition.getPlayers(coalition.side.BLUE) }
-  local unitId
-  local unitData
-  local AlivePlayerUnits = {}
-
-  for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
-    self:T3( { "_FollowPlayersScheduled", CoalitionData } )
-    for UnitId, UnitData in pairs( CoalitionData ) do
-      self:_AddPlayerFromUnit( UnitData )
-    end
-  end
-end
-
-
---- Track  DEAD or CRASH events for the scoring.
--- @param #SCORING self
--- @param Event#EVENTDATA Event
-function SCORING:_EventOnDeadOrCrash( Event )
-  self:F( { Event } )
-
-  local TargetUnit = nil
-  local TargetGroup = nil
-  local TargetUnitName = ""
-  local TargetGroupName = ""
-  local TargetPlayerName = ""
-  local TargetCoalition = nil
-  local TargetCategory = nil
-  local TargetType = nil
-  local TargetUnitCoalition = nil
-  local TargetUnitCategory = nil
-  local TargetUnitType = nil
-
-  if Event.IniDCSUnit then
-
-    TargetUnit = Event.IniDCSUnit
-    TargetUnitName = Event.IniDCSUnitName
-    TargetGroup = Event.IniDCSGroup
-    TargetGroupName = Event.IniDCSGroupName
-    TargetPlayerName = TargetUnit:getPlayerName()
-
-    TargetCoalition = TargetUnit:getCoalition()
-    --TargetCategory = TargetUnit:getCategory()
-    TargetCategory = TargetUnit:getDesc().category  -- Workaround
-    TargetType = TargetUnit:getTypeName()
-
-    TargetUnitCoalition = _SCORINGCoalition[TargetCoalition]
-    TargetUnitCategory = _SCORINGCategory[TargetCategory]
-    TargetUnitType = TargetType
-
-    self:T( { TargetUnitName, TargetGroupName, TargetPlayerName, TargetCoalition, TargetCategory, TargetType } )
-  end
-
-  for PlayerName, PlayerData in pairs( self.Players ) do
-    if PlayerData then -- This should normally not happen, but i'll test it anyway.
-      self:T( "Something got killed" )
-
-      -- Some variables
-      local InitUnitName = PlayerData.UnitName
-      local InitUnitType = PlayerData.UnitType
-      local InitCoalition = PlayerData.UnitCoalition
-      local InitCategory = PlayerData.UnitCategory
-      local InitUnitCoalition = _SCORINGCoalition[InitCoalition]
-      local InitUnitCategory = _SCORINGCategory[InitCategory]
-
-      self:T( { InitUnitName, InitUnitType, InitUnitCoalition, InitCoalition, InitUnitCategory, InitCategory } )
-
-      -- What is he hitting?
-      if TargetCategory then
-        if PlayerData and PlayerData.Hit and PlayerData.Hit[TargetCategory] and PlayerData.Hit[TargetCategory][TargetUnitName] then -- Was there a hit for this unit for this player before registered???
-          if not PlayerData.Kill[TargetCategory] then
-            PlayerData.Kill[TargetCategory] = {}
-        end
-        if not PlayerData.Kill[TargetCategory][TargetType] then
-          PlayerData.Kill[TargetCategory][TargetType] = {}
-          PlayerData.Kill[TargetCategory][TargetType].Score = 0
-          PlayerData.Kill[TargetCategory][TargetType].ScoreKill = 0
-          PlayerData.Kill[TargetCategory][TargetType].Penalty = 0
-          PlayerData.Kill[TargetCategory][TargetType].PenaltyKill = 0
-        end
-
-        if InitCoalition == TargetCoalition then
-          PlayerData.Penalty = PlayerData.Penalty + 25
-          PlayerData.Kill[TargetCategory][TargetType].Penalty = PlayerData.Kill[TargetCategory][TargetType].Penalty + 25
-          PlayerData.Kill[TargetCategory][TargetType].PenaltyKill = PlayerData.Kill[TargetCategory][TargetType].PenaltyKill + 1
-          MESSAGE:New( "Player '" .. PlayerName .. "' killed a friendly " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " ..
-            PlayerData.Kill[TargetCategory][TargetType].PenaltyKill .. " times. Penalty: -" .. PlayerData.Kill[TargetCategory][TargetType].Penalty ..
-            ".  Score Total:" .. PlayerData.Score - PlayerData.Penalty,
-            "", 5, "/PENALTY" .. PlayerName .. "/" .. InitUnitName ):ToAll()
-          self:ScoreCSV( PlayerName, "KILL_PENALTY", 1, -125, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
-        else
-          PlayerData.Score = PlayerData.Score + 10
-          PlayerData.Kill[TargetCategory][TargetType].Score = PlayerData.Kill[TargetCategory][TargetType].Score + 10
-          PlayerData.Kill[TargetCategory][TargetType].ScoreKill = PlayerData.Kill[TargetCategory][TargetType].ScoreKill + 1
-          MESSAGE:New( "Player '" .. PlayerName .. "' killed an enemy " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " ..
-            PlayerData.Kill[TargetCategory][TargetType].ScoreKill .. " times. Score: " .. PlayerData.Kill[TargetCategory][TargetType].Score ..
-            ".  Score Total:" .. PlayerData.Score - PlayerData.Penalty,
-            "", 5, "/SCORE" .. PlayerName .. "/" .. InitUnitName ):ToAll()
-          self:ScoreCSV( PlayerName, "KILL_SCORE", 1, 10, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
-        end
-        end
-      end
-    end
-  end
-end
-
-
-
---- Add a new player entering a Unit.
-function SCORING:_AddPlayerFromUnit( UnitData )
-  self:F( UnitData )
-
-  if UnitData and UnitData:isExist() then
-    local UnitName = UnitData:getName()
-    local PlayerName = UnitData:getPlayerName()
-    local UnitDesc = UnitData:getDesc()
-    local UnitCategory = UnitDesc.category
-    local UnitCoalition = UnitData:getCoalition()
-    local UnitTypeName = UnitData:getTypeName()
-
-    self:T( { PlayerName, UnitName, UnitCategory, UnitCoalition, UnitTypeName } )
-
-    if self.Players[PlayerName] == nil then -- I believe this is the place where a Player gets a life in a mission when he enters a unit ...
-      self.Players[PlayerName] = {}
-      self.Players[PlayerName].Hit = {}
-      self.Players[PlayerName].Kill = {}
-      self.Players[PlayerName].Mission = {}
-
-      -- for CategoryID, CategoryName in pairs( SCORINGCategory ) do
-      -- self.Players[PlayerName].Hit[CategoryID] = {}
-      -- self.Players[PlayerName].Kill[CategoryID] = {}
-      -- end
-      self.Players[PlayerName].HitPlayers = {}
-      self.Players[PlayerName].HitUnits = {}
-      self.Players[PlayerName].Score = 0
-      self.Players[PlayerName].Penalty = 0
-      self.Players[PlayerName].PenaltyCoalition = 0
-      self.Players[PlayerName].PenaltyWarning = 0
-    end
-
-    if not self.Players[PlayerName].UnitCoalition then
-      self.Players[PlayerName].UnitCoalition = UnitCoalition
-    else
-      if self.Players[PlayerName].UnitCoalition ~= UnitCoalition then
-        self.Players[PlayerName].Penalty = self.Players[PlayerName].Penalty + 50
-        self.Players[PlayerName].PenaltyCoalition = self.Players[PlayerName].PenaltyCoalition + 1
-        MESSAGE:New( "Player '" .. PlayerName .. "' changed coalition from " .. _SCORINGCoalition[self.Players[PlayerName].UnitCoalition] .. " to " .. _SCORINGCoalition[UnitCoalition] ..
-          "(changed " .. self.Players[PlayerName].PenaltyCoalition .. " times the coalition). 50 Penalty points added.",
-          "",
-          2,
-          "/PENALTYCOALITION" .. PlayerName
-        ):ToAll()
-        self:ScoreCSV( PlayerName, "COALITION_PENALTY",  1, -50, self.Players[PlayerName].UnitName, _SCORINGCoalition[self.Players[PlayerName].UnitCoalition], _SCORINGCategory[self.Players[PlayerName].UnitCategory], self.Players[PlayerName].UnitType,
-          UnitName, _SCORINGCoalition[UnitCoalition], _SCORINGCategory[UnitCategory], UnitData:getTypeName() )
-      end
-    end
-    self.Players[PlayerName].UnitName = UnitName
-    self.Players[PlayerName].UnitCoalition = UnitCoalition
-    self.Players[PlayerName].UnitCategory = UnitCategory
-    self.Players[PlayerName].UnitType = UnitTypeName
-
-    if self.Players[PlayerName].Penalty > 100 then
-      if self.Players[PlayerName].PenaltyWarning < 1 then
-        MESSAGE:New( "Player '" .. PlayerName .. "': WARNING! If you continue to commit FRATRICIDE and have a PENALTY score higher than 150, you will be COURT MARTIALED and DISMISSED from this mission! \nYour total penalty is: " .. self.Players[PlayerName].Penalty,
-          "",
-          30,
-          "/PENALTYCOALITION" .. PlayerName
-        ):ToAll()
-        self.Players[PlayerName].PenaltyWarning = self.Players[PlayerName].PenaltyWarning + 1
-      end
-    end
-
-    if self.Players[PlayerName].Penalty > 150 then
-      ClientGroup = GROUP:NewFromDCSUnit( UnitData )
-      ClientGroup:Destroy()
-      MESSAGE:New( "Player '" .. PlayerName .. "' committed FRATRICIDE, he will be COURT MARTIALED and is DISMISSED from this mission!",
-        "",
-        10,
-        "/PENALTYCOALITION" .. PlayerName
-      ):ToAll()
-    end
-
-  end
-end
-
-
---- Registers Scores the players completing a Mission Task.
-function SCORING:_AddMissionTaskScore( PlayerUnit, MissionName, Score )
-  self:F( { PlayerUnit, MissionName, Score } )
-
-  local PlayerName = PlayerUnit:getPlayerName()
-
-  if not self.Players[PlayerName].Mission[MissionName] then
-    self.Players[PlayerName].Mission[MissionName] = {}
-    self.Players[PlayerName].Mission[MissionName].ScoreTask = 0
-    self.Players[PlayerName].Mission[MissionName].ScoreMission = 0
-  end
-
-  self:T( PlayerName )
-  self:T( self.Players[PlayerName].Mission[MissionName] )
-
-  self.Players[PlayerName].Score = self.Players[PlayerName].Score + Score
-  self.Players[PlayerName].Mission[MissionName].ScoreTask = self.Players[PlayerName].Mission[MissionName].ScoreTask + Score
-
-  MESSAGE:New( "Player '" .. PlayerName .. "' has finished another Task in Mission '" .. MissionName .. "'. " ..
-    Score .. " Score points added.",
-    "", 20, "/SCORETASK" .. PlayerName ):ToAll()
-
-  self:ScoreCSV( PlayerName, "TASK_" .. MissionName:gsub( ' ', '_' ), 1, Score, PlayerUnit:getName() )
-end
-
-
---- Registers Mission Scores for possible multiple players that contributed in the Mission.
-function SCORING:_AddMissionScore( MissionName, Score )
-  self:F( { MissionName, Score } )
-
-  for PlayerName, PlayerData in pairs( self.Players ) do
-
-    if PlayerData.Mission[MissionName] then
-      PlayerData.Score = PlayerData.Score + Score
-      PlayerData.Mission[MissionName].ScoreMission = PlayerData.Mission[MissionName].ScoreMission + Score
-      MESSAGE:New( "Player '" .. PlayerName .. "' has finished Mission '" .. MissionName .. "'. " ..
-        Score .. " Score points added.",
-        "", 20, "/SCOREMISSION" .. PlayerName ):ToAll()
-      self:ScoreCSV( PlayerName, "MISSION_" .. MissionName:gsub( ' ', '_' ), 1, Score )
-    end
-  end
-end
-
---- Handles the OnHit event for the scoring.
--- @param #SCORING self
--- @param Event#EVENTDATA Event
-function SCORING:_EventOnHit( Event )
-  self:F( { Event } )
-
-  local InitUnit = nil
-  local InitUnitName = ""
-  local InitGroup = nil
-  local InitGroupName = ""
-  local InitPlayerName = nil
-
-  local InitCoalition = nil
-  local InitCategory = nil
-  local InitType = nil
-  local InitUnitCoalition = nil
-  local InitUnitCategory = nil
-  local InitUnitType = nil
-
-  local TargetUnit = nil
-  local TargetUnitName = ""
-  local TargetGroup = nil
-  local TargetGroupName = ""
-  local TargetPlayerName = ""
-
-  local TargetCoalition = nil
-  local TargetCategory = nil
-  local TargetType = nil
-  local TargetUnitCoalition = nil
-  local TargetUnitCategory = nil
-  local TargetUnitType = nil
-
-  if Event.IniDCSUnit then
-
-    InitUnit = Event.IniDCSUnit
-    InitUnitName = Event.IniDCSUnitName
-    InitGroup = Event.IniDCSGroup
-    InitGroupName = Event.IniDCSGroupName
-    InitPlayerName = InitUnit:getPlayerName()
-
-    InitCoalition = InitUnit:getCoalition()
-    --TODO: Workaround Client DCS Bug
-    --InitCategory = InitUnit:getCategory()
-    InitCategory = InitUnit:getDesc().category
-    InitType = InitUnit:getTypeName()
-
-    InitUnitCoalition = _SCORINGCoalition[InitCoalition]
-    InitUnitCategory = _SCORINGCategory[InitCategory]
-    InitUnitType = InitType
-
-    self:T( { InitUnitName, InitGroupName, InitPlayerName, InitCoalition, InitCategory, InitType , InitUnitCoalition, InitUnitCategory, InitUnitType } )
-  end
-
-
-  if Event.TgtDCSUnit then
-
-    TargetUnit = Event.TgtDCSUnit
-    TargetUnitName = Event.TgtDCSUnitName
-    TargetGroup = Event.TgtDCSGroup
-    TargetGroupName = Event.TgtDCSGroupName
-    TargetPlayerName = TargetUnit:getPlayerName()
-
-    TargetCoalition = TargetUnit:getCoalition()
-    --TODO: Workaround Client DCS Bug
-    --TargetCategory = TargetUnit:getCategory()
-    TargetCategory = TargetUnit:getDesc().category
-    TargetType = TargetUnit:getTypeName()
-
-    TargetUnitCoalition = _SCORINGCoalition[TargetCoalition]
-    TargetUnitCategory = _SCORINGCategory[TargetCategory]
-    TargetUnitType = TargetType
-
-    self:T( { TargetUnitName, TargetGroupName, TargetPlayerName, TargetCoalition, TargetCategory, TargetType, TargetUnitCoalition, TargetUnitCategory, TargetUnitType } )
-  end
-
-  if InitPlayerName ~= nil then -- It is a player that is hitting something
-    self:_AddPlayerFromUnit( InitUnit )
-    if self.Players[InitPlayerName] then -- This should normally not happen, but i'll test it anyway.
-      if TargetPlayerName ~= nil then -- It is a player hitting another player ...
-        self:_AddPlayerFromUnit( TargetUnit )
-        self.Players[InitPlayerName].HitPlayers = self.Players[InitPlayerName].HitPlayers + 1
-    end
-
-    self:T( "Hitting Something" )
-    -- What is he hitting?
-    if TargetCategory then
-      if not self.Players[InitPlayerName].Hit[TargetCategory] then
-        self.Players[InitPlayerName].Hit[TargetCategory] = {}
-      end
-      if not self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName] then
-        self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName] = {}
-        self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].Score = 0
-        self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].Penalty = 0
-        self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].ScoreHit = 0
-        self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].PenaltyHit = 0
-      end
-      local Score = 0
-      if InitCoalition == TargetCoalition then
-        self.Players[InitPlayerName].Penalty = self.Players[InitPlayerName].Penalty + 10
-        self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].Penalty = self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].Penalty + 10
-        self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].PenaltyHit = self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].PenaltyHit + 1
-        MESSAGE:New( "Player '" .. InitPlayerName .. "' hit a friendly " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " ..
-          self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].PenaltyHit .. " times. Penalty: -" .. self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].Penalty ..
-          ".  Score Total:" .. self.Players[InitPlayerName].Score - self.Players[InitPlayerName].Penalty,
-          "",
-          2,
-          "/PENALTY" .. InitPlayerName .. "/" .. InitUnitName
-        ):ToAll()
-        self:ScoreCSV( InitPlayerName, "HIT_PENALTY", 1, -25, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
-      else
-        self.Players[InitPlayerName].Score = self.Players[InitPlayerName].Score + 10
-        self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].Score = self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].Score + 1
-        self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].ScoreHit = self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].ScoreHit + 1
-        MESSAGE:New( "Player '" .. InitPlayerName .. "' hit a target " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " ..
-          self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].ScoreHit .. " times. Score: " .. self.Players[InitPlayerName].Hit[TargetCategory][TargetUnitName].Score ..
-          ".  Score Total:" .. self.Players[InitPlayerName].Score - self.Players[InitPlayerName].Penalty,
-          "",
-          2,
-          "/SCORE" .. InitPlayerName .. "/" .. InitUnitName
-        ):ToAll()
-        self:ScoreCSV( InitPlayerName, "HIT_SCORE", 1, 1, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
-      end
-    end
-    end
-  elseif InitPlayerName == nil then -- It is an AI hitting a player???
-
-  end
-end
-
-
-function SCORING:ReportScoreAll()
-
-  env.info( "Hello World " )
-
-  local ScoreMessage = ""
-  local PlayerMessage = ""
-
-  self:T( "Score Report" )
-
-  for PlayerName, PlayerData in pairs( self.Players ) do
-    if PlayerData then -- This should normally not happen, but i'll test it anyway.
-      self:T( "Score Player: " .. PlayerName )
-
-      -- Some variables
-      local InitUnitCoalition = _SCORINGCoalition[PlayerData.UnitCoalition]
-      local InitUnitCategory = _SCORINGCategory[PlayerData.UnitCategory]
-      local InitUnitType = PlayerData.UnitType
-      local InitUnitName = PlayerData.UnitName
-
-      local PlayerScore = 0
-      local PlayerPenalty = 0
-
-      ScoreMessage = ":\n"
-
-      local ScoreMessageHits = ""
-
-      for CategoryID, CategoryName in pairs( _SCORINGCategory ) do
-        self:T( CategoryName )
-        if PlayerData.Hit[CategoryID] then
-          local Score = 0
-          local ScoreHit = 0
-          local Penalty = 0
-          local PenaltyHit = 0
-          self:T( "Hit scores exist for player " .. PlayerName )
-          for UnitName, UnitData in pairs( PlayerData.Hit[CategoryID] ) do
-            Score = Score + UnitData.Score
-            ScoreHit = ScoreHit + UnitData.ScoreHit
-            Penalty = Penalty + UnitData.Penalty
-            PenaltyHit = UnitData.PenaltyHit
-          end
-          local ScoreMessageHit = string.format( "%s:%d  ", CategoryName, Score - Penalty )
-          self:T( ScoreMessageHit )
-          ScoreMessageHits = ScoreMessageHits .. ScoreMessageHit
-          PlayerScore = PlayerScore + Score
-          PlayerPenalty = PlayerPenalty + Penalty
-        else
-        --ScoreMessageHits = ScoreMessageHits .. string.format( "%s:%d  ", string.format(CategoryName, 1, 1), 0 )
-        end
-      end
-      if ScoreMessageHits ~= "" then
-        ScoreMessage = ScoreMessage .. "  Hits: " .. ScoreMessageHits .. "\n"
-      end
-
-      local ScoreMessageKills = ""
-      for CategoryID, CategoryName in pairs( _SCORINGCategory ) do
-        self:T( "Kill scores exist for player " .. PlayerName )
-        if PlayerData.Kill[CategoryID] then
-          local Score = 0
-          local ScoreKill = 0
-          local Penalty = 0
-          local PenaltyKill = 0
-
-          for UnitName, UnitData in pairs( PlayerData.Kill[CategoryID] ) do
-            Score = Score + UnitData.Score
-            ScoreKill = ScoreKill + UnitData.ScoreKill
-            Penalty = Penalty + UnitData.Penalty
-            PenaltyKill = PenaltyKill + UnitData.PenaltyKill
-          end
-
-          local ScoreMessageKill = string.format( "  %s:%d  ", CategoryName, Score - Penalty )
-          self:T( ScoreMessageKill )
-          ScoreMessageKills = ScoreMessageKills .. ScoreMessageKill
-
-          PlayerScore = PlayerScore + Score
-          PlayerPenalty = PlayerPenalty + Penalty
-        else
-        --ScoreMessageKills = ScoreMessageKills .. string.format( "%s:%d  ", string.format(CategoryName, 1, 1), 0 )
-        end
-      end
-      if ScoreMessageKills ~= "" then
-        ScoreMessage = ScoreMessage .. "  Kills: " .. ScoreMessageKills .. "\n"
-      end
-
-      local ScoreMessageCoalitionChangePenalties = ""
-      if PlayerData.PenaltyCoalition ~= 0 then
-        ScoreMessageCoalitionChangePenalties = ScoreMessageCoalitionChangePenalties .. string.format( " -%d (%d changed)", PlayerData.Penalty, PlayerData.PenaltyCoalition )
-        PlayerPenalty = PlayerPenalty + PlayerData.Penalty
-      end
-      if ScoreMessageCoalitionChangePenalties ~= "" then
-        ScoreMessage = ScoreMessage .. "  Coalition Penalties: " .. ScoreMessageCoalitionChangePenalties .. "\n"
-      end
-
-      local ScoreMessageMission = ""
-      local ScoreMission = 0
-      local ScoreTask = 0
-      for MissionName, MissionData in pairs( PlayerData.Mission ) do
-        ScoreMission = ScoreMission + MissionData.ScoreMission
-        ScoreTask = ScoreTask + MissionData.ScoreTask
-        ScoreMessageMission = ScoreMessageMission .. "'" .. MissionName .. "'; "
-      end
-      PlayerScore = PlayerScore + ScoreMission + ScoreTask
-
-      if ScoreMessageMission ~= "" then
-        ScoreMessage = ScoreMessage .. "  Tasks: " .. ScoreTask .. " Mission: " .. ScoreMission .. " ( " .. ScoreMessageMission .. ")\n"
-      end
-
-      PlayerMessage = PlayerMessage .. string.format( "Player '%s' Score:%d (%d Score -%d Penalties)%s", PlayerName, PlayerScore - PlayerPenalty, PlayerScore, PlayerPenalty, ScoreMessage )
-    end
-  end
-  MESSAGE:New( PlayerMessage, "Player Scores", 30, "AllPlayerScores"):ToAll()
-end
-
-
-function SCORING:ReportScorePlayer()
-
-  env.info( "Hello World " )
-
-  local ScoreMessage = ""
-  local PlayerMessage = ""
-
-  self:T( "Score Report" )
-
-  for PlayerName, PlayerData in pairs( self.Players ) do
-    if PlayerData then -- This should normally not happen, but i'll test it anyway.
-      self:T( "Score Player: " .. PlayerName )
-
-      -- Some variables
-      local InitUnitCoalition = _SCORINGCoalition[PlayerData.UnitCoalition]
-      local InitUnitCategory = _SCORINGCategory[PlayerData.UnitCategory]
-      local InitUnitType = PlayerData.UnitType
-      local InitUnitName = PlayerData.UnitName
-
-      local PlayerScore = 0
-      local PlayerPenalty = 0
-
-      ScoreMessage = ""
-
-      local ScoreMessageHits = ""
-
-      for CategoryID, CategoryName in pairs( _SCORINGCategory ) do
-        self:T( CategoryName )
-        if PlayerData.Hit[CategoryID] then
-          local Score = 0
-          local ScoreHit = 0
-          local Penalty = 0
-          local PenaltyHit = 0
-          self:T( "Hit scores exist for player " .. PlayerName )
-          for UnitName, UnitData in pairs( PlayerData.Hit[CategoryID] ) do
-            Score = Score + UnitData.Score
-            ScoreHit = ScoreHit + UnitData.ScoreHit
-            Penalty = Penalty + UnitData.Penalty
-            PenaltyHit = UnitData.PenaltyHit
-          end
-          local ScoreMessageHit = string.format( "\n    %s = %d score(%d;-%d) hits(#%d;#-%d)", CategoryName, Score - Penalty, Score, Penalty, ScoreHit,  PenaltyHit )
-          self:T( ScoreMessageHit )
-          ScoreMessageHits = ScoreMessageHits .. ScoreMessageHit
-          PlayerScore = PlayerScore + Score
-          PlayerPenalty = PlayerPenalty + Penalty
-        else
-        --ScoreMessageHits = ScoreMessageHits .. string.format( "%s:%d  ", string.format(CategoryName, 1, 1), 0 )
-        end
-      end
-      if ScoreMessageHits ~= "" then
-        ScoreMessage = ScoreMessage .. "\n  Hits: " .. ScoreMessageHits .. " "
-      end
-
-      local ScoreMessageKills = ""
-      for CategoryID, CategoryName in pairs( _SCORINGCategory ) do
-        self:T( "Kill scores exist for player " .. PlayerName )
-        if PlayerData.Kill[CategoryID] then
-          local Score = 0
-          local ScoreKill = 0
-          local Penalty = 0
-          local PenaltyKill = 0
-
-          for UnitName, UnitData in pairs( PlayerData.Kill[CategoryID] ) do
-            Score = Score + UnitData.Score
-            ScoreKill = ScoreKill + UnitData.ScoreKill
-            Penalty = Penalty + UnitData.Penalty
-            PenaltyKill = PenaltyKill + UnitData.PenaltyKill
-          end
-
-          local ScoreMessageKill = string.format( "\n    %s = %d score(%d;-%d) hits(#%d;#-%d)", CategoryName, Score - Penalty, Score, Penalty, ScoreKill, PenaltyKill )
-          self:T( ScoreMessageKill )
-          ScoreMessageKills = ScoreMessageKills .. ScoreMessageKill
-
-          PlayerScore = PlayerScore + Score
-          PlayerPenalty = PlayerPenalty + Penalty
-        else
-        --ScoreMessageKills = ScoreMessageKills .. string.format( "%s:%d  ", string.format(CategoryName, 1, 1), 0 )
-        end
-      end
-      if ScoreMessageKills ~= "" then
-        ScoreMessage = ScoreMessage .. "\n  Kills: " .. ScoreMessageKills .. " "
-      end
-
-      local ScoreMessageCoalitionChangePenalties = ""
-      if PlayerData.PenaltyCoalition ~= 0 then
-        ScoreMessageCoalitionChangePenalties = ScoreMessageCoalitionChangePenalties .. string.format( " -%d (%d changed)", PlayerData.Penalty, PlayerData.PenaltyCoalition )
-        PlayerPenalty = PlayerPenalty + PlayerData.Penalty
-      end
-      if ScoreMessageCoalitionChangePenalties ~= "" then
-        ScoreMessage = ScoreMessage .. "\n  Coalition: " .. ScoreMessageCoalitionChangePenalties .. " "
-      end
-
-      local ScoreMessageMission = ""
-      local ScoreMission = 0
-      local ScoreTask = 0
-      for MissionName, MissionData in pairs( PlayerData.Mission ) do
-        ScoreMission = ScoreMission + MissionData.ScoreMission
-        ScoreTask = ScoreTask + MissionData.ScoreTask
-        ScoreMessageMission = ScoreMessageMission .. "'" .. MissionName .. "'; "
-      end
-      PlayerScore = PlayerScore + ScoreMission + ScoreTask
-
-      if ScoreMessageMission ~= "" then
-        ScoreMessage = ScoreMessage .. "\n  Tasks: " .. ScoreTask .. " Mission: " .. ScoreMission .. " ( " .. ScoreMessageMission .. ") "
-      end
-
-      PlayerMessage = PlayerMessage .. string.format( "Player '%s' Score = %d ( %d Score, -%d Penalties ):%s", PlayerName, PlayerScore - PlayerPenalty, PlayerScore, PlayerPenalty, ScoreMessage )
-    end
-  end
-  MESSAGE:New( PlayerMessage, "Player Scores", 30, "AllPlayerScores"):ToAll()
-
-end
-
-
-function SCORING:SecondsToClock(sSeconds)
-  local nSeconds = sSeconds
-  if nSeconds == 0 then
-    --return nil;
-    return "00:00:00";
-  else
-    nHours = string.format("%02.f", math.floor(nSeconds/3600));
-    nMins = string.format("%02.f", math.floor(nSeconds/60 - (nHours*60)));
-    nSecs = string.format("%02.f", math.floor(nSeconds - nHours*3600 - nMins *60));
-    return nHours..":"..nMins..":"..nSecs
-  end
-end
-
---- Opens a score CSV file to log the scores.
--- @param #SCORING self
--- @param #string ScoringCSV
--- @return #SCORING self
--- @usage
--- -- Open a new CSV file to log the scores of the game Gori Valley. Let the name of the CSV file begin with "Player Scores".
--- ScoringObject = SCORING:New( "Gori Valley" )
--- ScoringObject:OpenCSV( "Player Scores" )
-function SCORING:OpenCSV( ScoringCSV )
-  self:F( ScoringCSV )
-  
-  if lfs and io and os then
-    if ScoringCSV then
-      self.ScoringCSV = ScoringCSV
-      local fdir = lfs.writedir() .. [[Logs\]] .. self.ScoringCSV .. " " .. os.date( "%Y-%m-%d %H-%M-%S" ) .. ".csv"
-
-      self.CSVFile, self.err = io.open( fdir, "w+" )
-      if not self.CSVFile then
-        error( "Error: Cannot open CSV file in " .. lfs.writedir() )
-      end
-
-      self.CSVFile:write( '"GameName","RunTime","Time","PlayerName","ScoreType","PlayerUnitCoaltion","PlayerUnitCategory","PlayerUnitType","PlayerUnitName","TargetUnitCoalition","TargetUnitCategory","TargetUnitType","TargetUnitName","Times","Score"\n' )
-  
-      self.RunTime = os.date("%y-%m-%d_%H-%M-%S")
-    else
-      error( "A string containing the CSV file name must be given." )
-    end
-  else
-    self:E( "The MissionScripting.lua file has not been changed to allow lfs, io and os modules to be used..." )
-  end
-  return self
-end
-
-
---- Registers a score for a player.
--- @param #SCORING self
--- @param #string PlayerName The name of the player.
--- @param #string ScoreType The type of the score.
--- @param #string ScoreTimes The amount of scores achieved.
--- @param #string ScoreAmount The score given.
--- @param #string PlayerUnitName The unit name of the player.
--- @param #string PlayerUnitCoalition The coalition of the player unit.
--- @param #string PlayerUnitCategory The category of the player unit.
--- @param #string PlayerUnitType The type of the player unit.
--- @param #string TargetUnitName The name of the target unit.
--- @param #string TargetUnitCoalition The coalition of the target unit.
--- @param #string TargetUnitCategory The category of the target unit.
--- @param #string TargetUnitType The type of the target unit.
--- @return #SCORING self
-function SCORING:ScoreCSV( PlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
-  --write statistic information to file
-  local ScoreTime = self:SecondsToClock( timer.getTime() )
-  PlayerName = PlayerName:gsub( '"', '_' )
-
-  if PlayerUnitName and PlayerUnitName ~= '' then
-    local PlayerUnit = Unit.getByName( PlayerUnitName )
-
-    if PlayerUnit then
-      if not PlayerUnitCategory then
-        --PlayerUnitCategory = SCORINGCategory[PlayerUnit:getCategory()]
-        PlayerUnitCategory = _SCORINGCategory[PlayerUnit:getDesc().category]
-      end
-
-      if not PlayerUnitCoalition then
-        PlayerUnitCoalition = _SCORINGCoalition[PlayerUnit:getCoalition()]
-      end
-
-      if not PlayerUnitType then
-        PlayerUnitType = PlayerUnit:getTypeName()
-      end
-    else
-      PlayerUnitName = ''
-      PlayerUnitCategory = ''
-      PlayerUnitCoalition = ''
-      PlayerUnitType = ''
-    end
-  else
-    PlayerUnitName = ''
-    PlayerUnitCategory = ''
-    PlayerUnitCoalition = ''
-    PlayerUnitType = ''
-  end
-
-  if not TargetUnitCoalition then
-    TargetUnitCoalition = ''
-  end
-
-  if not TargetUnitCategory then
-    TargetUnitCategory = ''
-  end
-
-  if not TargetUnitType then
-    TargetUnitType = ''
-  end
-
-  if not TargetUnitName then
-    TargetUnitName = ''
-  end
-
-  if lfs and io and os then
-    self.CSVFile:write(
-      '"' .. self.GameName        .. '"' .. ',' ..
-      '"' .. self.RunTime         .. '"' .. ',' ..
-      ''  .. ScoreTime            .. ''  .. ',' ..
-      '"' .. PlayerName           .. '"' .. ',' ..
-      '"' .. ScoreType            .. '"' .. ',' ..
-      '"' .. PlayerUnitCoalition  .. '"' .. ',' ..
-      '"' .. PlayerUnitCategory   .. '"' .. ',' ..
-      '"' .. PlayerUnitType       .. '"' .. ',' ..
-      '"' .. PlayerUnitName       .. '"' .. ',' ..
-      '"' .. TargetUnitCoalition  .. '"' .. ',' ..
-      '"' .. TargetUnitCategory   .. '"' .. ',' ..
-      '"' .. TargetUnitType       .. '"' .. ',' ..
-      '"' .. TargetUnitName       .. '"' .. ',' ..
-      ''  .. ScoreTimes           .. ''  .. ',' ..
-      ''  .. ScoreAmount
-    )
-
-    self.CSVFile:write( "\n" )
-  end
-end
-
-
-function SCORING:CloseCSV()
-  if lfs and io and os then
-    self.CSVFile:close()
-  end
-end
-

Moose Development/Moose/Set.lua

@@ -1,758 +0,0 @@
---- Manage sets of units and groups. 
--- 
--- @{#Set} class
--- ==================
--- Mission designers can use the SET 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.
--- 
--- SET construction methods:
--- =================================
--- Create a new SET object with the @{#SET.New} method:
--- 
---    * @{#SET.New}: Creates a new SET object.
---   
--- 
--- SET filter criteria: 
--- =========================
--- You can set filter criteria to define the set of units within the SET.
--- Filter criteria are defined by:
--- 
---    * @{#SET.FilterCoalitions}: Builds the SET with the units belonging to the coalition(s).
---    * @{#SET.FilterCategories}: Builds the SET with the units belonging to the category(ies).
---    * @{#SET.FilterTypes}: Builds the SET with the units belonging to the unit type(s).
---    * @{#SET.FilterCountries}: Builds the SET with the units belonging to the country(ies).
---    * @{#SET.FilterUnitPrefixes}: Builds the SET with the units starting with the same prefix string(s).
---   
--- Once the filter criteria have been set for the SET, you can start filtering using:
--- 
---   * @{#SET.FilterStart}: Starts the filtering of the units within the SET.
--- 
--- Planned filter criteria within development are (so these are not yet available):
--- 
---    * @{#SET.FilterGroupPrefixes}: Builds the SET with the groups of the units starting with the same prefix string(s).
---    * @{#SET.FilterZones}: Builds the SET with the units within a @{Zone#ZONE}.
--- 
--- 
--- SET iterators:
--- ===================
--- Once the filters have been defined and the SET has been built, you can iterate the SET with the available iterator methods.
--- The iterator methods will walk the SET set, and call for each element within the set a function that you provide.
--- The following iterator methods are currently available within the SET:
--- 
---   * @{#SET.ForEachAliveUnit}: Calls a function for each alive unit it finds within the SET.
---   
--- Planned iterators methods in development are (so these are not yet available):
--- 
---   * @{#SET.ForEachUnit}: Calls a function for each unit contained within the SET.
---   * @{#SET.ForEachGroup}: Calls a function for each group contained within the SET.
---   * @{#SET.ForEachUnitInZone}: Calls a function for each unit within a certain zone contained within the SET.
--- 
--- ====
--- @module Set
--- @author FlightControl
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Menu" )
-Include.File( "Group" )
-Include.File( "Unit" )
-Include.File( "Event" )
-Include.File( "Client" )
-
---- SET class
--- @type SET
--- @extends Base#BASE
-SET = {
-  ClassName = "SET",
-  Templates = {
-    Units = {},
-    Groups = {},
-    ClientsByName = {},
-    ClientsByID = {},
-  },
-  DCSUnits = {},
-  DCSUnitsAlive = {},
-  DCSGroups = {},
-  DCSGroupsAlive = {},
-  Units = {},
-  UnitsAlive = {},
-  Groups = {},
-  GroupsAlive = {},
-  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 SET object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.
--- @param #SET self
--- @return #SET
--- @usage
--- -- Define a new SET Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
--- DBObject = SET:New()
-function SET: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 SET 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 #SET self
--- @param #string UnitName
--- @return Unit#UNIT The found Unit.
-function SET:FindUnit( UnitName )
-
-  local UnitFound = self.Units[UnitName]
-  return UnitFound
-end
-
---- Finds a Unit based on the Unit Name.
--- @param #SET self
--- @param Unit#UNIT UnitToAdd
--- @return Unit#UNIT The added Unit.
-function SET:AddUnit( UnitToAdd )
-
-  self.Units[UnitToAdd.UnitName] = UnitToAdd
-  return self.Units[UnitToAdd.UnitName]
-end
-
-
-
---- Builds a set of units of coalitons.
--- Possible current coalitions are red, blue and neutral.
--- @param #SET self
--- @param #string Coalitions Can take the following values: "red", "blue", "neutral".
--- @return #SET self
-function SET:FilterCoalitions( Coalitions )
-  if not self.Filter.Coalitions then
-    self.Filter.Coalitions = {}
-  end
-  if type( Coalitions ) ~= "table" then
-    Coalitions = { Coalitions }
-  end
-  for CoalitionID, Coalition in pairs( Coalitions ) do
-    self.Filter.Coalitions[Coalition] = Coalition
-  end
-  return self
-end
-
---- Builds a set of units out of categories.
--- Possible current categories are plane, helicopter, ground, ship.
--- @param #SET self
--- @param #string Categories Can take the following values: "plane", "helicopter", "ground", "ship".
--- @return #SET self
-function SET:FilterCategories( Categories )
-  if not self.Filter.Categories then
-    self.Filter.Categories = {}
-  end
-  if type( Categories ) ~= "table" then
-    Categories = { Categories }
-  end
-  for CategoryID, Category in pairs( Categories ) do
-    self.Filter.Categories[Category] = Category
-  end
-  return self
-end
-
---- Builds a set of units of defined unit types.
--- Possible current types are those types known within DCS world.
--- @param #SET self
--- @param #string Types Can take those type strings known within DCS world.
--- @return #SET self
-function SET:FilterTypes( Types )
-  if not self.Filter.Types then
-    self.Filter.Types = {}
-  end
-  if type( Types ) ~= "table" then
-    Types = { Types }
-  end
-  for TypeID, Type in pairs( Types ) do
-    self.Filter.Types[Type] = Type
-  end
-  return self
-end
-
---- Builds a set of units of defined countries.
--- Possible current countries are those known within DCS world.
--- @param #SET self
--- @param #string Countries Can take those country strings known within DCS world.
--- @return #SET self
-function SET:FilterCountries( Countries )
-  if not self.Filter.Countries then
-    self.Filter.Countries = {}
-  end
-  if type( Countries ) ~= "table" then
-    Countries = { Countries }
-  end
-  for CountryID, Country in pairs( Countries ) do
-    self.Filter.Countries[Country] = Country
-  end
-  return self
-end
-
---- Builds a set of units of defined unit prefixes.
--- All the units starting with the given prefixes will be included within the set.
--- @param #SET self
--- @param #string Prefixes The prefix of which the unit name starts with.
--- @return #SET self
-function SET:FilterUnitPrefixes( Prefixes )
-  if not self.Filter.UnitPrefixes then
-    self.Filter.UnitPrefixes = {}
-  end
-  if type( Prefixes ) ~= "table" then
-    Prefixes = { Prefixes }
-  end
-  for PrefixID, Prefix in pairs( Prefixes ) do
-    self.Filter.UnitPrefixes[Prefix] = Prefix
-  end
-  return self
-end
-
---- Builds a set of units of defined group prefixes.
--- All the units starting with the given group prefixes will be included within the set.
--- @param #SET self
--- @param #string Prefixes The prefix of which the group name where the unit belongs to starts with.
--- @return #SET self
-function SET:FilterGroupPrefixes( Prefixes )
-  if not self.Filter.GroupPrefixes then
-    self.Filter.GroupPrefixes = {}
-  end
-  if type( Prefixes ) ~= "table" then
-    Prefixes = { Prefixes }
-  end
-  for PrefixID, Prefix in pairs( Prefixes ) do
-    self.Filter.GroupPrefixes[Prefix] = Prefix
-  end
-  return self
-end
-
---- Starts the filtering.
--- @param #SET self
--- @return #SET self
-function SET:FilterStart()
-
-  if _DATABASE then
-    -- OK, we have a _DATABASE
-    -- Now use the different filters to build the set.
-    -- We first take ALL of the Units of the _DATABASE.
-    
-    self:E( { "Adding Set Datapoints with filters" } )
-    for DCSUnitName, DCSUnit in pairs( _DATABASE.DCSUnits ) do
-
-      if self:_IsIncludeDCSUnit( DCSUnit ) then
-
-        self:E( { "Adding Unit:", DCSUnitName } )
-        self.DCSUnits[DCSUnitName] = _DATABASE.DCSUnits[DCSUnitName]
-        self.Units[DCSUnitName] = _DATABASE:FindUnit( DCSUnitName )
-        
-        if _DATABASE.DCSUnitsAlive[DCSUnitName] then
-          self.DCSUnitsAlive[DCSUnitName] = _DATABASE.DCSUnitsAlive[DCSUnitName]
-          self.UnitsAlive[DCSUnitName] = _DATABASE.UnitsAlive[DCSUnitName]
-        end
-        
-      end
-    end
-    
-    for DCSGroupName, DCSGroup in pairs( _DATABASE.DCSGroups ) do
-      
-      --if self:_IsIncludeDCSGroup( DCSGroup ) then
-      self:E( { "Adding Group:", DCSGroupName } )
-      self.DCSGroups[DCSGroupName] = _DATABASE.DCSGroups[DCSGroupName]
-      self.Groups[DCSGroupName] = _DATABASE:FindGroups( DCSGroupName )
-      --end
-      
-      if _DATABASE.DCSGroupsAlive[DCSGroupName] then
-        self.DCSGroupsAlive[DCSGroupName] = _DATABASE.DCSGroupsAlive[DCSGroupName]
-        self.GroupsAlive[DCSGroupName] = _DATABASE.GroupsAlive[DCSGroupName]
-      end
-    end
-
-    for DCSUnitName, Client in pairs( _DATABASE.CLIENTS ) do
-      self:E( { "Adding Client for Unit:", DCSUnitName } )
-      self.Clients[DCSUnitName] = _DATABASE.Clients[DCSUnitName]
-    end
-    
-  else
-    self:E( "There is a structural error in MOOSE. No _DATABASE has been defined! Cannot build this custom SET." )
-  end
-  
-  return self
-end
-
-
-
---- Private method that registers all alive players in the mission.
--- @param #SET self
--- @return #SET self
-function SET:_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 #SET self
--- @return #SET self
-function SET:_RegisterDatabase()
-
-  local CoalitionsData = { AlivePlayersRed = coalition.getGroups( coalition.side.RED ), AlivePlayersBlue = 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.DCSGroups[DCSGroupName] = DCSGroup
-        self.Groups[DCSGroupName] = GROUP:New( DCSGroup )
-  
-        if self:_IsAliveDCSGroup(DCSGroup) then
-          self:E( { "Register Alive Group:", DCSGroup, DCSGroupName } )
-          self.DCSGroupsAlive[DCSGroupName] = DCSGroup
-          self.GroupsAlive[DCSGroupName] = self.Groups[DCSGroupName]  
-        end
-  
-        for DCSUnitId, DCSUnit in pairs( DCSGroup:getUnits() ) do
-  
-          local DCSUnitName = DCSUnit:getName()
-          self:E( { "Register Unit:", DCSUnit, DCSUnitName } )
-  
-          self.DCSUnits[DCSUnitName] = DCSUnit
-          self:AddUnit( UNIT:Find( DCSUnit ) )
-          --self.Units[DCSUnitName] = UNIT:Register( DCSUnit )
-  
-          if self:_IsAliveDCSUnit(DCSUnit) then
-            self:E( { "Register Alive Unit:", DCSUnit, DCSUnitName } )
-            self.DCSUnitsAlive[DCSUnitName] = DCSUnit
-            self.UnitsAlive[DCSUnitName] = self.Units[DCSUnitName]  
-          end
-        end
-      else
-        self:E( "Group does not exist: " .. DCSGroup )
-      end
-      
-      for ClientName, ClientTemplate in pairs( self.Templates.ClientsByName ) do
-        self.Clients[ClientName] = CLIENT:Find( ClientName )
-      end
-    end
-  end
-  
-  return self
-end
-
-
---- Events
-
---- Handles the OnBirth event for the alive units set.
--- @param #SET self
--- @param Event#EVENTDATA Event
-function SET:_EventOnBirth( Event )
-  self:F( { Event } )
-
-  if Event.IniDCSUnit then
-    if self:_IsIncludeDCSUnit( Event.IniDCSUnit ) then
-      self.DCSUnits[Event.IniDCSUnitName] = Event.IniDCSUnit 
-      self.DCSUnitsAlive[Event.IniDCSUnitName] = Event.IniDCSUnit
-      self:AddUnit( UNIT:Register( Event.IniDCSUnit ) )
-      --self.Units[Event.IniDCSUnitName] = UNIT:Register( Event.IniDCSUnit )
-      
-      --if not self.DCSGroups[Event.IniDCSGroupName] then
-      --  self.DCSGroups[Event.IniDCSGroupName] = Event.IniDCSGroupName
-      --  self.DCSGroupsAlive[Event.IniDCSGroupName] = Event.IniDCSGroupName
-      --  self.Groups[Event.IniDCSGroupName] = GROUP:New( Event.IniDCSGroup )
-      --end
-      self:_EventOnPlayerEnterUnit( Event )
-    end
-  end
-end
-
---- Handles the OnDead or OnCrash event for alive units set.
--- @param #SET self
--- @param Event#EVENTDATA Event
-function SET:_EventOnDeadOrCrash( Event )
-  self:F( { Event } )
-
-  if Event.IniDCSUnit then
-    if self.DCSUnitsAlive[Event.IniDCSUnitName] then
-      self.DCSUnits[Event.IniDCSUnitName] = nil 
-      self.DCSUnitsAlive[Event.IniDCSUnitName] = nil
-    end
-  end
-end
-
---- Handles the OnPlayerEnterUnit event to fill the active players table (with the unit filter applied).
--- @param #SET self
--- @param Event#EVENTDATA Event
-function SET:_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] = _DATABASE.Clients[ Event.IniDCSUnitName ]
-      end
-    end
-  end
-end
-
---- Handles the OnPlayerLeaveUnit event to clean the active players table.
--- @param #SET self
--- @param Event#EVENTDATA Event
-function SET:_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 SET and call an interator function for the given set, providing the Object for each element within the set and optional parameters.
--- @param #SET self
--- @param #function IteratorFunction The function that will be called when there is an alive player in the SET.
--- @return #SET self
-function SET: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 SET and call an interator function for each **alive** unit, providing the Unit and optional parameters.
--- @param #SET self
--- @param #function IteratorFunction The function that will be called when there is an alive unit in the SET. The function needs to accept a UNIT parameter.
--- @return #SET self
-function SET:ForEachDCSUnitAlive( IteratorFunction, ... )
-  self:F( arg )
-  
-  self:ForEach( IteratorFunction, arg, self.DCSUnitsAlive )
-
-  return self
-end
-
---- Interate the SET and call an interator function for each **alive** player, providing the Unit of the player and optional parameters.
--- @param #SET self
--- @param #function IteratorFunction The function that will be called when there is an alive player in the SET. The function needs to accept a UNIT parameter.
--- @return #SET self
-function SET:ForEachPlayer( IteratorFunction, ... )
-  self:F( arg )
-  
-  self:ForEach( IteratorFunction, arg, self.PlayersAlive )
-  
-  return self
-end
-
-
---- Interate the SET and call an interator function for each client, providing the Client to the function and optional parameters.
--- @param #SET self
--- @param #function IteratorFunction The function that will be called when there is an alive player in the SET. The function needs to accept a CLIENT parameter.
--- @return #SET self
-function SET:ForEachClient( IteratorFunction, ... )
-  self:F( arg )
-  
-  self:ForEach( IteratorFunction, arg, self.Clients )
-
-  return self
-end
-
-
-function SET: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 #SET self
--- @param DCSUnit#Unit DCSUnit
--- @return #SET self
-function SET:_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 #SET self
--- @param DCSUnit#Unit DCSUnit
--- @return #SET self
-function SET:_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 #SET self
--- @param DCSGroup#Group DCSGroup
--- @return #SET self
-function SET:_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 SET contents in the log ... (for debug reasons).
--- @param #SET self
--- @return #SET self
-function SET:TraceDatabase()
-  self:F()
-  
-  self:T( { "DCSUnits:", self.DCSUnits } )
-  self:T( { "DCSUnitsAlive:", self.DCSUnitsAlive } )
-end
-
-

Moose Development/Moose/Task.lua

@@ -1,465 +0,0 @@
---- The TASK Classes define major end-to-end activities within a MISSION. The TASK Class is the Master Class to orchestrate these activities. From this class, many concrete TASK classes are inherited.
--- @module TASK
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Mission" )
-Include.File( "Client" )
-Include.File( "Stage" )
-
---- The TASK class
--- @type TASK
--- @extends Base#BASE
-TASK = {
-
-	-- Defines the different signal types with a Task.
-	SIGNAL = {
-		COLOR = { 
-			RED = { ID = 1, COLOR = trigger.smokeColor.Red, TEXT = "A red" },
-			GREEN = { ID = 2, COLOR = trigger.smokeColor.Green, TEXT = "A green" }, 
-			BLUE = { ID = 3, COLOR = trigger.smokeColor.Blue, TEXT = "A blue" },
-			WHITE = { ID = 4, COLOR = trigger.smokeColor.White, TEXT = "A white" }, 
-			ORANGE = { ID = 5, COLOR = trigger.smokeColor.Orange, TEXT = "An orange" } 
-		},
-		TYPE = {
-			SMOKE = { ID = 1, TEXT = "smoke" },
-			FLARE = { ID = 2, TEXT = "flare" }
-		}
-	},
-	ClassName = "TASK",
-	Mission = {}, -- Owning mission of the Task
-	Name = '',
-	Stages = {},
-	Stage = {},
-	Cargos = {
-		InitCargos = {},
-		LoadCargos = {}
-	},
-	LandingZones = {
-		LandingZoneNames = {},
-		LandingZones = {}
-	},
-	ActiveStage = 0,
-	TaskDone = false,
-	TaskFailed = false,
-	GoalTasks = {}
-}
-
---- Instantiates a new TASK Base. Should never be used. Interface Class.
--- @return TASK
-function TASK:New()
-  local self = BASE:Inherit( self, BASE:New() )
-	self:F()
-  
-  -- assign Task default values during construction
-  self.TaskBriefing = "Task: No Task."
-  self.Time = timer.getTime()
-  self.ExecuteStage = _TransportExecuteStage.NONE
-
-  return self
-end
-
-function TASK:SetStage( StageSequenceIncrement )
-	self:F( { StageSequenceIncrement } )
-
-	local Valid = false
-	if StageSequenceIncrement ~= 0 then
-		self.ActiveStage = self.ActiveStage + StageSequenceIncrement
-		if 1 <= self.ActiveStage and self.ActiveStage <= #self.Stages then
-			self.Stage = self.Stages[self.ActiveStage]
-			self:T( { self.Stage.Name } )
-			self.Frequency = self.Stage.Frequency
-			Valid = true
-		else
-			Valid = false
-			env.info( "TASK:SetStage() self.ActiveStage is smaller or larger than self.Stages array. self.ActiveStage = " .. self.ActiveStage )
-		end
-	end
-	self.Time = timer.getTime()
-	return Valid
-end
-
-function TASK:Init()
-	self:F()
-	self.ActiveStage = 0
-	self:SetStage(1)
-	self.TaskDone = false
-	self.TaskFailed = false
-end
-
-
---- Get progress of a TASK.
--- @return string GoalsText
-function TASK:GetGoalProgress()
-	self:F2()
-
-	local GoalsText = ""
-	for GoalVerb, GoalVerbData in pairs( self.GoalTasks ) do
-		local Goals = self:GetGoalCompletion( GoalVerb )
-		if Goals and Goals ~= "" then 
-			Goals = '(' .. Goals .. ')' 
-		else
-			Goals = '( - )'
-		end
-		GoalsText = GoalsText .. GoalVerb .. ': ' .. self:GetGoalCount(GoalVerb) .. ' goals ' .. Goals .. ' of ' .. self:GetGoalTotal(GoalVerb) .. ' goals completed (' .. self:GetGoalPercentage(GoalVerb) .. '%); '
-	end
-	
-	if GoalsText == "" then
-		GoalsText = "( - )"
-	end
-	
-	return GoalsText
-end
-
---- Show progress of a TASK.
--- @param MISSION 	Mission 		Group structure describing the Mission.
--- @param CLIENT	Client	 		Group structure describing the Client.
-function TASK:ShowGoalProgress( Mission, Client )
-	self:F2()
-
-	local GoalsText = ""
-	for GoalVerb, GoalVerbData in pairs( self.GoalTasks ) do
-		if Mission:IsCompleted() then
-		else
-			local Goals = self:GetGoalCompletion( GoalVerb )
-			if Goals and Goals ~= "" then 
-			else
-				Goals = "-"
-			end
-			GoalsText = GoalsText .. self:GetGoalProgress()
-		end
-	end
-	
-	if Mission.MissionReportFlash or Mission.MissionReportShow then
-		Client:Message( GoalsText, 10,  "/TASKPROGRESS" .. self.ClassName, "Mission Command: Task Status", 30 )
-	end
-end
-
---- Sets a TASK to status Done.
-function TASK:Done()
-	self:F2()
-	self.TaskDone = true
-end
-
---- Returns if a TASK is done.
--- @return bool
-function TASK:IsDone()
-	self:F2( self.TaskDone )
-	return self.TaskDone
-end
-
---- Sets a TASK to status failed.
-function TASK:Failed()
-	self:F()
-	self.TaskFailed = true
-end
-
---- Returns if a TASk has failed.
--- @return bool
-function TASK:IsFailed()
-	self:F2( self.TaskFailed )
-	return self.TaskFailed
-end
-
-function TASK:Reset( Mission, Client )
-	self:F2()
-	self.ExecuteStage = _TransportExecuteStage.NONE
-end
-
---- Returns the Goals of a TASK
--- @return @table Goals
-function TASK:GetGoals()
-	return self.GoalTasks
-end
-
---- Returns if a TASK has Goal(s).
--- @param #TASK self
--- @param #string GoalVerb is the name of the Goal of the TASK.
--- @return bool
-function TASK:Goal( GoalVerb )
-	self:F2( { GoalVerb } )
-	if not GoalVerb then
-		GoalVerb = self.GoalVerb
-	end
-	self:T2( {self.GoalTasks[GoalVerb] } )
-	if self.GoalTasks[GoalVerb] and self.GoalTasks[GoalVerb].GoalTotal > 0 then
-		return true
-	else
-		return false
-	end
-end
-
---- Sets the total Goals to be achieved of the Goal Name
--- @param number GoalTotal is the number of times the GoalVerb needs to be achieved.
--- @param ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
-function TASK:SetGoalTotal( GoalTotal, GoalVerb )
-	self:F2( { GoalTotal, GoalVerb } )
-	
-	if not GoalVerb then
-		GoalVerb = self.GoalVerb
-	end
-	self.GoalTasks[GoalVerb] = {}
-	self.GoalTasks[GoalVerb].Goals = {}
-	self.GoalTasks[GoalVerb].GoalTotal = GoalTotal
-	self.GoalTasks[GoalVerb].GoalCount = 0
-	return self
-end
-
---- Gets the total of Goals to be achieved within the TASK of the GoalVerb.
--- @param ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
-function TASK:GetGoalTotal( GoalVerb )
-	self:F2( { GoalVerb } )
-	if not GoalVerb then
-		GoalVerb = self.GoalVerb
-	end
-	if self:Goal( GoalVerb ) then
-		return self.GoalTasks[GoalVerb].GoalTotal
-	else
-		return 0
-	end
-end
-
---- Sets the total of Goals currently achieved within the TASK of the GoalVerb.
--- @param number GoalCount is the total number of Goals achieved within the TASK.
--- @param ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
--- @return TASK
-function TASK:SetGoalCount( GoalCount, GoalVerb )
-	self:F2()
-	if not GoalVerb then
-		GoalVerb = self.GoalVerb
-	end
-	if self:Goal( GoalVerb) then
-		self.GoalTasks[GoalVerb].GoalCount = GoalCount
-	end
-	return self
-end
-
---- Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.
--- @param number GoalCountIncrease is the number of new Goals achieved within the TASK.
--- @param ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
--- @return TASK
-function TASK:IncreaseGoalCount( GoalCountIncrease, GoalVerb )
-	self:F2( { GoalCountIncrease, GoalVerb } )
-	if not GoalVerb then
-		GoalVerb = self.GoalVerb
-	end
-	if self:Goal( GoalVerb) then
-		self.GoalTasks[GoalVerb].GoalCount = self.GoalTasks[GoalVerb].GoalCount + GoalCountIncrease
-	end
-	return self
-end
-
---- Gets the total of Goals currently achieved within the TASK of the GoalVerb.
--- @param ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
--- @return TASK
-function TASK:GetGoalCount( GoalVerb )
-	self:F2()
-	if not GoalVerb then
-		GoalVerb = self.GoalVerb
-	end
-	if self:Goal( GoalVerb ) then
-		return self.GoalTasks[GoalVerb].GoalCount
-	else
-		return 0
-	end
-end
-
---- Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.
--- @param ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
--- @return TASK
-function TASK:GetGoalPercentage( GoalVerb )
-	self:F2()
-	if not GoalVerb then
-		GoalVerb = self.GoalVerb
-	end
-	if self:Goal( GoalVerb ) then
-		return math.floor( self:GetGoalCount( GoalVerb ) / self:GetGoalTotal( GoalVerb ) * 100 + .5 )
-	else
-		return 100
-	end
-end
-
---- Returns if all the Goals of the TASK were achieved.
--- @return bool
-function TASK:IsGoalReached()
-  self:F2()
-
-	local GoalReached = true
-
-	for GoalVerb, Goals in pairs( self.GoalTasks ) do
-		self:T2( { "GoalVerb", GoalVerb } )
-		if self:Goal( GoalVerb ) then
-			local GoalToDo = self:GetGoalTotal( GoalVerb ) - self:GetGoalCount( GoalVerb )
-			self:T2( "GoalToDo = " .. GoalToDo )
-			if GoalToDo <= 0 then
-			else
-				GoalReached = false
-				break
-			end
-		else
-			break
-		end
-	end
-	
-	self:T( { GoalReached, self.GoalTasks } )
-	return GoalReached
-end
-
---- Adds an Additional Goal for the TASK to be achieved.
--- @param string GoalVerb is the name of the Goal of the TASK.
--- @param string GoalTask is a text describing the Goal of the TASK to be achieved.
--- @param number GoalIncrease is a number by which the Goal achievement is increasing.
-function TASK:AddGoalCompletion( GoalVerb, GoalTask, GoalIncrease )
-	self:F2( { GoalVerb, GoalTask, GoalIncrease } )
-
-	if self:Goal( GoalVerb ) then
-		self.GoalTasks[GoalVerb].Goals[#self.GoalTasks[GoalVerb].Goals+1] = GoalTask
-		self.GoalTasks[GoalVerb].GoalCount = self.GoalTasks[GoalVerb].GoalCount + GoalIncrease
-	end
-	return self
-end
-
---- Returns if the additional Goal for the TASK was completed.
--- @param ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
--- @return string Goals
-function TASK:GetGoalCompletion( GoalVerb )
-	self:F2( { GoalVerb } )
-	
-	if self:Goal( GoalVerb ) then
-		local Goals = ""
-		for GoalID, GoalName in pairs( self.GoalTasks[GoalVerb].Goals ) do Goals = Goals .. GoalName .. " + " end
-		return Goals:gsub(" + $", ""), self.GoalTasks[GoalVerb].GoalCount
-	end
-end
-
-function TASK.MenuAction( Parameter )
-  Parameter.ReferenceTask.ExecuteStage = _TransportExecuteStage.EXECUTING
-  Parameter.ReferenceTask.Cargo = Parameter.CargoTask
-end
-
-function TASK:StageExecute()
-	self:F()
-
-  local Execute = false
-
-  if      self.Frequency == STAGE.FREQUENCY.REPEAT then
-    Execute = true
-  elseif  self.Frequency == STAGE.FREQUENCY.NONE then
-    Execute = false
-  elseif  self.Frequency >= 0 then
-    Execute = true
-    self.Frequency = self.Frequency - 1
-  end
-  
-  return Execute
-
-end
-
---- Work function to set signal events within a TASK.
-function TASK:AddSignal( SignalUnitNames, SignalType, SignalColor, SignalHeight )
-	self:F()
-  
-	local Valid = true
-	
-	if Valid then
-		if type( SignalUnitNames ) == "table" then
-			self.LandingZoneSignalUnitNames = SignalUnitNames
-		else
-			self.LandingZoneSignalUnitNames = { SignalUnitNames }
-		end
-		self.LandingZoneSignalType = SignalType
-		self.LandingZoneSignalColor = SignalColor
-		self.Signalled = false 
-		if SignalHeight ~= nil then
-			self.LandingZoneSignalHeight = SignalHeight
-		else
-			self.LandingZoneSignalHeight = 0 
-		end
-	  
-		if self.TaskBriefing then 
-			self.TaskBriefing = self.TaskBriefing .. " " .. SignalColor.TEXT .. " " .. SignalType.TEXT .. " will be fired when entering the landing zone."
-		end
-	end
-	
-	return Valid
-end
-
---- When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddSmokeRed( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.RED, SignalHeight )
-end
-
---- When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddSmokeGreen( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.GREEN, SignalHeight )
-end
-        
---- When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddSmokeBlue( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.BLUE, SignalHeight )
-end
-
---- When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddSmokeWhite( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.WHITE, SignalHeight )
-end
-
---- When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddSmokeOrange( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.ORANGE, SignalHeight )
-end
-
---- When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddFlareRed( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.RED, SignalHeight )
-end
-
---- When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddFlareGreen( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.GREEN, SignalHeight )
-end
-        
---- When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddFlareBlue( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.BLUE, SignalHeight )
-end
-
---- When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddFlareWhite( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.WHITE, SignalHeight )
-end
-
---- When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.
--- @param table|string SignalUnitNames Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
--- @param number SignalHeight Altitude that the Signal should be fired...
-function TASK:AddFlareOrange( SignalUnitNames, SignalHeight )
-	self:F()
-  self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.ORANGE, SignalHeight )
-end

Moose Development/Moose/Tasking/CommandCenter.lua

@@ -0,0 +1,304 @@
+--- A COMMANDCENTER is the owner of multiple missions within MOOSE. 
+-- A COMMANDCENTER governs multiple missions, the tasking and the reporting.
+-- @module CommandCenter
+
+
+
+--- The REPORT class
+-- @type REPORT
+-- @extends Core.Base#BASE
+REPORT = {
+  ClassName = "REPORT",
+}
+
+--- Create a new REPORT.
+-- @param #REPORT self
+-- @param #string Title
+-- @return #REPORT
+function REPORT:New( Title )
+
+  local self = BASE:Inherit( self, BASE:New() )
+
+  self.Report = {}
+  if Title then
+    self.Report[#self.Report+1] = Title  
+  end
+
+  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.Report[#self.Report]
+end
+
+function REPORT:Text()
+  return table.concat( self.Report, "\n" ) 
+end
+
+--- The COMMANDCENTER class
+-- @type COMMANDCENTER
+-- @field Wrapper.Group#GROUP HQ
+-- @field Dcs.DCSCoalitionWrapper.Object#coalition CommandCenterCoalition
+-- @list<Tasking.Mission#MISSION> Missions
+-- @extends Core.Base#BASE
+COMMANDCENTER = {
+  ClassName = "COMMANDCENTER",
+  CommandCenterName = "",
+  CommandCenterCoalition = nil,
+  CommandCenterPositionable = nil,
+  Name = "",
+}
+--- The constructor takes an IDENTIFIABLE as the HQ command center.
+-- @param #COMMANDCENTER self
+-- @param Wrapper.Positionable#POSITIONABLE CommandCenterPositionable
+-- @param #string CommandCenterName
+-- @return #COMMANDCENTER
+function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
+
+  local self = BASE:Inherit( self, BASE:New() )
+
+  self.CommandCenterPositionable = CommandCenterPositionable  
+  self.CommandCenterName = CommandCenterName or CommandCenterPositionable:GetName()
+  self.CommandCenterCoalition = CommandCenterPositionable:GetCoalition()
+	
+	self.Missions = {}
+
+  self:HandleEvent( EVENTS.Birth,
+    --- @param #COMMANDCENTER self
+    -- @param Core.Event#EVENTDATA EventData
+    function( self, EventData )
+      if EventData.IniObjectCategory == 1 then
+        local EventGroup = GROUP:Find( EventData.IniDCSGroup )
+        if EventGroup and self:HasGroup( EventGroup ) then
+          local MenuReporting = MENU_GROUP:New( EventGroup, "Reporting", self.CommandCenterMenu )
+          local MenuMissionsSummary = MENU_GROUP_COMMAND:New( EventGroup, "Missions Summary Report", MenuReporting, self.ReportSummary, self, EventGroup )
+          local MenuMissionsDetails = MENU_GROUP_COMMAND:New( EventGroup, "Missions Details Report", MenuReporting, self.ReportDetails, self, EventGroup )
+          self:ReportSummary( EventGroup )
+        end
+        local PlayerUnit = EventData.IniUnit
+        for MissionID, Mission in pairs( self:GetMissions() ) do
+          local Mission = Mission -- Tasking.Mission#MISSION
+          local PlayerGroup = EventData.IniGroup -- The GROUP object should be filled!
+          Mission:JoinUnit( PlayerUnit, PlayerGroup )
+          Mission:ReportDetails()
+        end
+      end
+      
+    end
+    )
+  
+  -- When a player enters a client or a unit, the CommandCenter will check for each Mission and each Task in the Mission if the player has things to do.
+  -- For these elements, it will=
+  -- - Set the correct menu.
+  -- - Assign the PlayerUnit to the Task if required.
+  -- - Send a message to the other players in the group that this player has joined.
+  self:HandleEvent( EVENTS.PlayerEnterUnit,
+    --- @param #COMMANDCENTER self
+    -- @param Core.Event#EVENTDATA EventData
+    function( self, EventData )
+      local PlayerUnit = EventData.IniUnit
+      for MissionID, Mission in pairs( self:GetMissions() ) do
+        local Mission = Mission -- Tasking.Mission#MISSION
+        local PlayerGroup = EventData.IniGroup -- The GROUP object should be filled!
+        Mission:JoinUnit( PlayerUnit, PlayerGroup )
+        Mission:ReportDetails()
+      end
+    end
+  )
+
+  -- Handle when a player leaves a slot and goes back to spectators ... 
+  -- The PlayerUnit will be UnAssigned from the Task.
+  -- When there is no Unit left running the Task, the Task goes into Abort...
+  self:HandleEvent( EVENTS.PlayerLeaveUnit,
+    --- @param #TASK self
+    -- @param Core.Event#EVENTDATA EventData
+    function( self, EventData )
+      local PlayerUnit = EventData.IniUnit
+      for MissionID, Mission in pairs( self:GetMissions() ) do
+        local Mission = Mission -- Tasking.Mission#MISSION
+        Mission:AbortUnit( PlayerUnit )
+      end
+    end
+  )
+
+  -- Handle when a player leaves a slot and goes back to spectators ... 
+  -- The PlayerUnit will be UnAssigned from the Task.
+  -- When there is no Unit left running the Task, the Task goes into Abort...
+  self:HandleEvent( EVENTS.Crash,
+    --- @param #TASK self
+    -- @param Core.Event#EVENTDATA EventData
+    function( self, EventData )
+      local PlayerUnit = EventData.IniUnit
+      for MissionID, Mission in pairs( self:GetMissions() ) do
+        Mission:CrashUnit( PlayerUnit )
+      end
+    end
+  )
+	
+	return self
+end
+
+--- Gets the name of the HQ command center.
+-- @param #COMMANDCENTER self
+-- @return #string
+function COMMANDCENTER:GetName()
+
+  return self.CommandCenterName
+end
+
+--- Gets the POSITIONABLE of the HQ command center.
+-- @param #COMMANDCENTER self
+-- @return Wrapper.Positionable#POSITIONABLE
+function COMMANDCENTER:GetPositionable()
+  return self.CommandCenterPositionable
+end
+
+--- Get the Missions governed by the HQ command center.
+-- @param #COMMANDCENTER self
+-- @return #list<Tasking.Mission#MISSION>
+function COMMANDCENTER:GetMissions()
+
+  return self.Missions
+end
+
+--- Add a MISSION to be governed by the HQ command center.
+-- @param #COMMANDCENTER self
+-- @param Tasking.Mission#MISSION Mission
+-- @return Tasking.Mission#MISSION
+function COMMANDCENTER:AddMission( Mission )
+
+  self.Missions[Mission] = Mission
+
+  return Mission
+end
+
+--- Removes a MISSION to be governed by the HQ command center.
+-- The given Mission is not nilified.
+-- @param #COMMANDCENTER self
+-- @param Tasking.Mission#MISSION Mission
+-- @return Tasking.Mission#MISSION
+function COMMANDCENTER:RemoveMission( Mission )
+
+  self.Missions[Mission] = nil
+
+  return Mission
+end
+
+--- Sets the menu structure of the Missions governed by the HQ command center.
+-- @param #COMMANDCENTER self
+function COMMANDCENTER:SetMenu()
+  self:F()
+
+  self.CommandCenterMenu = self.CommandCenterMenu or MENU_COALITION:New( self.CommandCenterCoalition, "Command Center (" .. self:GetName() .. ")" )
+
+  local MenuTime = timer.getTime()
+  for MissionID, Mission in pairs( self:GetMissions() ) do
+    local Mission = Mission -- Tasking.Mission#MISSION
+    Mission:SetMenu( MenuTime )
+  end
+
+  for MissionID, Mission in pairs( self:GetMissions() ) do
+    local Mission = Mission -- Tasking.Mission#MISSION
+    Mission:RemoveMenu( MenuTime )
+  end
+  
+end
+
+--- Gets the commandcenter menu structure governed by the HQ command center.
+-- @param #COMMANDCENTER self
+-- @return Core.Menu#MENU_COALITION
+function COMMANDCENTER:GetMenu()
+  self:F()
+  return self.CommandCenterMenu
+end
+
+--- Checks of the COMMANDCENTER has a GROUP.
+-- @param #COMMANDCENTER self
+-- @param Wrapper.Group#GROUP
+-- @return #boolean
+function COMMANDCENTER:HasGroup( MissionGroup )
+
+  local Has = false
+  
+  for MissionID, Mission in pairs( self.Missions ) do
+    local Mission = Mission -- Tasking.Mission#MISSION
+    if Mission:HasGroup( MissionGroup ) then
+      Has = true
+      break
+    end      
+  end
+  
+  return Has
+end
+
+--- Send a CC message to the coalition of the CC.
+-- @param #COMMANDCENTER self
+function COMMANDCENTER:MessageToAll( Message )
+
+    self:GetPositionable():MessageToAll( Message, 20, self:GetName() )
+
+end
+
+--- Send a CC message to a GROUP.
+-- @param #COMMANDCENTER self
+-- @param #string Message
+-- @param Wrapper.Group#GROUP TaskGroup
+-- @param #sring Name (optional) The name of the Group used as a prefix for the message to the Group. If not provided, there will be nothing shown.
+function COMMANDCENTER:MessageToGroup( Message, TaskGroup, Name )
+
+  local Prefix = "@ Group"
+  Prefix = Prefix .. ( Name and " (" .. Name .. "): " or '' )
+  Message = Prefix .. Message 
+  self:GetPositionable():MessageToGroup( Message , 20, TaskGroup, self:GetName() )
+
+end
+
+--- Send a CC message to the coalition of the CC.
+-- @param #COMMANDCENTER self
+function COMMANDCENTER:MessageToCoalition( Message )
+
+  local CCCoalition = self:GetPositionable():GetCoalition()
+    --TODO: Fix coalition bug!
+    self:GetPositionable():MessageToCoalition( Message, 20, CCCoalition, self:GetName() )
+
+end
+
+
+--- Report the status of all MISSIONs to a GROUP.
+-- Each Mission is listed, with an indication how many Tasks are still to be completed.
+-- @param #COMMANDCENTER self
+function COMMANDCENTER:ReportSummary( ReportGroup )
+  self:E( ReportGroup )
+
+  local Report = REPORT:New()
+  
+  for MissionID, Mission in pairs( self.Missions ) do
+    local Mission = Mission -- Tasking.Mission#MISSION
+    Report:Add( " - " .. Mission:ReportOverview() )
+  end
+  
+  self:GetPositionable():MessageToGroup( Report:Text(), 30, ReportGroup )
+  
+end
+
+--- Report the status of a Task to a Group.
+-- Report the details of a Mission, listing the Mission, and all the Task details.
+-- @param #COMMANDCENTER self
+function COMMANDCENTER:ReportDetails( ReportGroup, Task )
+  self:E( ReportGroup )
+
+  local Report = REPORT:New()
+  
+  for MissionID, Mission in pairs( self.Missions ) do
+    local Mission = Mission -- Tasking.Mission#MISSION
+    Report:Add( " - " .. Mission:ReportDetails() )
+  end
+  
+  self:GetPositionable():MessageToGroup( Report:Text(), 30, ReportGroup )
+end
+

Moose Development/Moose/Tasking/DetectionManager.lua

@@ -0,0 +1,237 @@
+--- This module contains the DETECTION_MANAGER class and derived classes.
+-- 
+-- ===
+-- 
+-- 1) @{DetectionManager#DETECTION_MANAGER} class, extends @{Base#BASE}
+-- ====================================================================
+-- The @{DetectionManager#DETECTION_MANAGER} class defines the core functions to report detected objects to groups.
+-- Reportings can be done in several manners, and it is up to the derived classes if DETECTION_MANAGER to model the reporting behaviour.
+-- 
+-- 1.1) DETECTION_MANAGER constructor:
+-- -----------------------------------
+--   * @{DetectionManager#DETECTION_MANAGER.New}(): Create a new DETECTION_MANAGER instance.
+-- 
+-- 1.2) DETECTION_MANAGER reporting:
+-- ---------------------------------
+-- Derived DETECTION_MANAGER classes will reports detected units using the method @{DetectionManager#DETECTION_MANAGER.ReportDetected}(). This method implements polymorphic behaviour.
+-- 
+-- The time interval in seconds of the reporting can be changed using the methods @{DetectionManager#DETECTION_MANAGER.SetReportInterval}(). 
+-- To control how long a reporting message is displayed, use @{DetectionManager#DETECTION_MANAGER.SetReportDisplayTime}().
+-- Derived classes need to implement the method @{DetectionManager#DETECTION_MANAGER.GetReportDisplayTime}() to use the correct display time for displayed messages during a report.
+-- 
+-- Reporting can be started and stopped using the methods @{DetectionManager#DETECTION_MANAGER.StartReporting}() and @{DetectionManager#DETECTION_MANAGER.StopReporting}() respectively.
+-- If an ad-hoc report is requested, use the method @{DetectionManager#DETECTION_MANAGER#ReportNow}().
+-- 
+-- The default reporting interval is every 60 seconds. The reporting messages are displayed 15 seconds.
+-- 
+-- ===
+-- 
+-- 2) @{DetectionManager#DETECTION_REPORTING} class, extends @{DetectionManager#DETECTION_MANAGER}
+-- =========================================================================================
+-- The @{DetectionManager#DETECTION_REPORTING} class implements detected units reporting. Reporting can be controlled using the reporting methods available in the @{DetectionManager#DETECTION_MANAGER} class.
+-- 
+-- 2.1) DETECTION_REPORTING constructor:
+-- -------------------------------
+-- The @{DetectionManager#DETECTION_REPORTING.New}() method creates a new DETECTION_REPORTING instance.
+--    
+--    
+-- ===
+-- 
+-- ### Contributions: Mechanist, Prof_Hilactic, FlightControl - Concept & Testing
+-- ### Author: FlightControl - Framework Design &  Programming
+-- 
+-- @module DetectionManager
+
+do -- DETECTION MANAGER
+  
+  --- DETECTION_MANAGER class.
+  -- @type DETECTION_MANAGER
+  -- @field Set#SET_GROUP SetGroup The groups to which the FAC will report to.
+  -- @field Functional.Detection#DETECTION_BASE Detection The DETECTION_BASE object that is used to report the detected objects.
+  -- @extends Base#BASE
+  DETECTION_MANAGER = {
+    ClassName = "DETECTION_MANAGER",
+    SetGroup = nil,
+    Detection = nil,
+  }
+  
+  --- FAC constructor.
+  -- @param #DETECTION_MANAGER self
+  -- @param Set#SET_GROUP SetGroup
+  -- @param Functional.Detection#DETECTION_BASE Detection
+  -- @return #DETECTION_MANAGER self
+  function DETECTION_MANAGER:New( SetGroup, Detection )
+  
+    -- Inherits from BASE
+    local self = BASE:Inherit( self, BASE:New() ) -- Functional.Detection#DETECTION_MANAGER
+    
+    self.SetGroup = SetGroup
+    self.Detection = Detection
+    
+    self:SetReportInterval( 30 )
+    self:SetReportDisplayTime( 25 )
+    
+    Detection:__Start( 5 )
+    
+    return self
+  end
+  
+  --- Set the reporting time interval.
+  -- @param #DETECTION_MANAGER self
+  -- @param #number ReportInterval The interval in seconds when a report needs to be done.
+  -- @return #DETECTION_MANAGER self
+  function DETECTION_MANAGER:SetReportInterval( ReportInterval )
+    self:F2()
+  
+    self._ReportInterval = ReportInterval
+  end
+  
+  
+  --- Set the reporting message display time.
+  -- @param #DETECTION_MANAGER self
+  -- @param #number ReportDisplayTime The display time in seconds when a report needs to be done.
+  -- @return #DETECTION_MANAGER self
+  function DETECTION_MANAGER:SetReportDisplayTime( ReportDisplayTime )
+    self:F2()
+  
+    self._ReportDisplayTime = ReportDisplayTime
+  end
+  
+  --- Get the reporting message display time.
+  -- @param #DETECTION_MANAGER self
+  -- @return #number ReportDisplayTime The display time in seconds when a report needs to be done.
+  function DETECTION_MANAGER:GetReportDisplayTime()
+    self:F2()
+  
+    return self._ReportDisplayTime
+  end
+  
+  
+  
+  --- Reports the detected items to the @{Set#SET_GROUP}.
+  -- @param #DETECTION_MANAGER self
+  -- @param Functional.Detection#DETECTION_BASE Detection
+  -- @return #DETECTION_MANAGER self
+  function DETECTION_MANAGER:ReportDetected( Detection )
+  	self:F2()
+  
+  end
+  
+  --- Schedule the FAC reporting.
+  -- @param #DETECTION_MANAGER self
+  -- @param #number DelayTime The delay in seconds to wait the reporting.
+  -- @param #number ReportInterval The repeat interval in seconds for the reporting to happen repeatedly.
+  -- @return #DETECTION_MANAGER self
+  function DETECTION_MANAGER:Schedule( DelayTime, ReportInterval )
+  	self:F2()
+  
+    self._ScheduleDelayTime = DelayTime
+    
+    self:SetReportInterval( ReportInterval )
+    
+    self.FacScheduler = SCHEDULER:New(self, self._FacScheduler, { self, "DetectionManager" }, self._ScheduleDelayTime, self._ReportInterval )
+    return self
+  end
+  
+  --- Report the detected @{Unit#UNIT}s detected within the @{Detection#DETECTION_BASE} object to the @{Set#SET_GROUP}s.
+  -- @param #DETECTION_MANAGER self
+  function DETECTION_MANAGER:_FacScheduler( SchedulerName )
+    self:F2( { SchedulerName } )
+    
+    return self:ProcessDetected( self.Detection )
+    
+--    self.SetGroup:ForEachGroup(
+--      --- @param Wrapper.Group#GROUP Group
+--      function( Group )
+--        if Group:IsAlive() then
+--          return self:ProcessDetected( self.Detection )
+--        end
+--      end
+--    )
+    
+--    return true
+  end
+
+end
+
+
+do -- DETECTION_REPORTING
+
+  --- DETECTION_REPORTING class.
+  -- @type DETECTION_REPORTING
+  -- @field Set#SET_GROUP SetGroup The groups to which the FAC will report to.
+  -- @field Functional.Detection#DETECTION_BASE Detection The DETECTION_BASE object that is used to report the detected objects.
+  -- @extends #DETECTION_MANAGER
+  DETECTION_REPORTING = {
+    ClassName = "DETECTION_REPORTING",
+  }
+  
+  
+  --- DETECTION_REPORTING constructor.
+  -- @param #DETECTION_REPORTING self
+  -- @param Set#SET_GROUP SetGroup
+  -- @param Functional.Detection#DETECTION_AREAS Detection
+  -- @return #DETECTION_REPORTING self
+  function DETECTION_REPORTING:New( SetGroup, Detection )
+  
+    -- Inherits from DETECTION_MANAGER
+    local self = BASE:Inherit( self, DETECTION_MANAGER:New( SetGroup, Detection ) ) -- #DETECTION_REPORTING
+    
+    self:Schedule( 1, 30 )
+    return self
+  end
+  
+  --- Creates a string of the detected items in a @{Detection}.
+  -- @param #DETECTION_MANAGER self
+  -- @param Set#SET_UNIT DetectedSet The detected Set created by the @{Detection#DETECTION_BASE} object.
+  -- @return #DETECTION_MANAGER self
+  function DETECTION_REPORTING:GetDetectedItemsText( DetectedSet )
+    self:F2()
+  
+    local MT = {} -- Message Text
+    local UnitTypes = {}
+  
+    for DetectedUnitID, DetectedUnitData in pairs( DetectedSet:GetSet() ) do
+      local DetectedUnit = DetectedUnitData -- Wrapper.Unit#UNIT
+      if DetectedUnit:IsAlive() then
+        local UnitType = DetectedUnit:GetTypeName()
+    
+        if not UnitTypes[UnitType] then
+          UnitTypes[UnitType] = 1
+        else
+          UnitTypes[UnitType] = UnitTypes[UnitType] + 1
+        end
+      end
+    end
+  
+    for UnitTypeID, UnitType in pairs( UnitTypes ) do
+      MT[#MT+1] = UnitType .. " of " .. UnitTypeID
+    end
+  
+    return table.concat( MT, ", " )
+  end
+  
+  
+  
+  --- Reports the detected items to the @{Set#SET_GROUP}.
+  -- @param #DETECTION_REPORTING self
+  -- @param Wrapper.Group#GROUP Group The @{Group} object to where the report needs to go.
+  -- @param Functional.Detection#DETECTION_AREAS Detection The detection created by the @{Detection#DETECTION_BASE} object.
+  -- @return #boolean Return true if you want the reporting to continue... false will cancel the reporting loop.
+  function DETECTION_REPORTING:ProcessDetected( Group, Detection )
+    self:F2( Group )
+  
+    self:E( Group )
+    local DetectedMsg = {}
+    for DetectedAreaID, DetectedAreaData in pairs( Detection:GetDetectedAreas() ) do
+      local DetectedArea = DetectedAreaData -- Functional.Detection#DETECTION_AREAS.DetectedArea
+      DetectedMsg[#DetectedMsg+1] = " - Group #" .. DetectedAreaID .. ": " .. self:GetDetectedItemsText( DetectedArea.Set )
+    end  
+    local FACGroup = Detection:GetDetectionGroups()
+    FACGroup:MessageToGroup( "Reporting detected target groups:\n" .. table.concat( DetectedMsg, "\n" ), self:GetReportDisplayTime(), Group  )
+  
+    return true
+  end
+
+end
+

Moose Development/Moose/Tasking/Mission.lua

@@ -0,0 +1,635 @@
+--- A MISSION is the main owner of a Mission orchestration within MOOSE	. The Mission framework orchestrates @{CLIENT}s, @{TASK}s, @{STAGE}s etc.
+-- A @{CLIENT} needs to be registered within the @{MISSION} through the function @{AddClient}. A @{TASK} needs to be registered within the @{MISSION} through the function @{AddTask}.
+-- @module Mission
+
+--- The MISSION class
+-- @type MISSION
+-- @field #MISSION.Clients _Clients
+-- @field Core.Menu#MENU_COALITION MissionMenu
+-- @field #string MissionBriefing
+-- @extends Core.Fsm#FSM
+MISSION = {
+	ClassName = "MISSION",
+	Name = "",
+	MissionStatus = "PENDING",
+}
+
+--- This is the main MISSION declaration method. Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc.
+-- @param #MISSION self
+-- @param Tasking.CommandCenter#COMMANDCENTER CommandCenter
+-- @param #string MissionName is the name of the mission. This name will be used to reference the status of each mission by the players.
+-- @param #string MissionPriority is a string indicating the "priority" of the Mission. f.e. "Primary", "Secondary" or "First", "Second". It is free format and up to the Mission designer to choose. There are no rules behind this field.
+-- @param #string MissionBriefing is a string indicating the mission briefing to be shown when a player joins a @{CLIENT}.
+-- @param Dcs.DCSCoalitionWrapper.Object#coalition MissionCoalition is a string indicating the coalition or party to which this mission belongs to. It is free format and can be chosen freely by the mission designer. Note that this field is not to be confused with the coalition concept of the ME. Examples of a Mission Coalition could be "NATO", "CCCP", "Intruders", "Terrorists"...
+-- @return #MISSION self
+function MISSION:New( CommandCenter, MissionName, MissionPriority, MissionBriefing, MissionCoalition )
+
+  local self = BASE:Inherit( self, FSM:New() ) -- Core.Fsm#FSM
+
+  self:SetStartState( "Idle" )
+  
+  self:AddTransition( "Idle", "Start", "Ongoing" )
+  
+  --- OnLeave Transition Handler for State Idle.
+  -- @function [parent=#MISSION] OnLeaveIdle
+  -- @param #MISSION self
+  -- @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 Idle.
+  -- @function [parent=#MISSION] OnEnterIdle
+  -- @param #MISSION self
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  
+  --- OnLeave Transition Handler for State Ongoing.
+  -- @function [parent=#MISSION] OnLeaveOngoing
+  -- @param #MISSION self
+  -- @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 Ongoing.
+  -- @function [parent=#MISSION] OnEnterOngoing
+  -- @param #MISSION self
+  -- @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 Start.
+  -- @function [parent=#MISSION] OnBeforeStart
+  -- @param #MISSION self
+  -- @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=#MISSION] OnAfterStart
+  -- @param #MISSION self
+  -- @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=#MISSION] Start
+  -- @param #MISSION self
+  
+  --- Asynchronous Event Trigger for Event Start.
+  -- @function [parent=#MISSION] __Start
+  -- @param #MISSION self
+  -- @param #number Delay The delay in seconds.
+  
+  self:AddTransition( "Ongoing", "Stop", "Idle" )
+  
+  --- OnLeave Transition Handler for State Idle.
+  -- @function [parent=#MISSION] OnLeaveIdle
+  -- @param #MISSION self
+  -- @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 Idle.
+  -- @function [parent=#MISSION] OnEnterIdle
+  -- @param #MISSION self
+  -- @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=#MISSION] OnBeforeStop
+  -- @param #MISSION self
+  -- @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=#MISSION] OnAfterStop
+  -- @param #MISSION self
+  -- @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=#MISSION] Stop
+  -- @param #MISSION self
+  
+  --- Asynchronous Event Trigger for Event Stop.
+  -- @function [parent=#MISSION] __Stop
+  -- @param #MISSION self
+  -- @param #number Delay The delay in seconds.
+  
+  self:AddTransition( "Ongoing", "Complete", "Completed" )
+  
+  --- OnLeave Transition Handler for State Completed.
+  -- @function [parent=#MISSION] OnLeaveCompleted
+  -- @param #MISSION self
+  -- @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 Completed.
+  -- @function [parent=#MISSION] OnEnterCompleted
+  -- @param #MISSION self
+  -- @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 Complete.
+  -- @function [parent=#MISSION] OnBeforeComplete
+  -- @param #MISSION self
+  -- @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 Complete.
+  -- @function [parent=#MISSION] OnAfterComplete
+  -- @param #MISSION self
+  -- @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 Complete.
+  -- @function [parent=#MISSION] Complete
+  -- @param #MISSION self
+  
+  --- Asynchronous Event Trigger for Event Complete.
+  -- @function [parent=#MISSION] __Complete
+  -- @param #MISSION self
+  -- @param #number Delay The delay in seconds.
+  
+  self:AddTransition( "*", "Fail", "Failed" )
+  
+  --- OnLeave Transition Handler for State Failed.
+  -- @function [parent=#MISSION] OnLeaveFailed
+  -- @param #MISSION self
+  -- @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 Failed.
+  -- @function [parent=#MISSION] OnEnterFailed
+  -- @param #MISSION self
+  -- @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 Fail.
+  -- @function [parent=#MISSION] OnBeforeFail
+  -- @param #MISSION self
+  -- @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 Fail.
+  -- @function [parent=#MISSION] OnAfterFail
+  -- @param #MISSION self
+  -- @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 Fail.
+  -- @function [parent=#MISSION] Fail
+  -- @param #MISSION self
+  
+  --- Asynchronous Event Trigger for Event Fail.
+  -- @function [parent=#MISSION] __Fail
+  -- @param #MISSION self
+  -- @param #number Delay The delay in seconds.
+  
+	self:T( { MissionName, MissionPriority, MissionBriefing, MissionCoalition } )
+  
+  self.CommandCenter = CommandCenter
+  CommandCenter:AddMission( self )
+  
+	self.Name = MissionName
+	self.MissionPriority = MissionPriority
+	self.MissionBriefing = MissionBriefing
+	self.MissionCoalition = MissionCoalition
+	
+	self.Tasks = {}
+	
+	-- Private  implementations
+	
+	
+
+	return self
+end
+
+-- FSM function for a MISSION
+-- @param #MISSION self
+-- @param #string From
+-- @param #string Event
+-- @param #string To
+function MISSION:onbeforeComplete( From, Event, To )
+
+  for TaskID, Task in pairs( self:GetTasks() ) do
+    local Task = Task -- Tasking.Task#TASK
+    if not Task:IsStateSuccess() and not Task:IsStateFailed() and not Task:IsStateAborted() and not Task:IsStateCancelled() then
+      return false -- Mission cannot be completed. Other Tasks are still active.
+    end
+  end
+  return true -- Allow Mission completion.
+end
+
+-- FSM function for a MISSION
+-- @param #MISSION self
+-- @param #string From
+-- @param #string Event
+-- @param #string To
+function MISSION:onenterCompleted( From, Event, To )
+
+  self:GetCommandCenter():MessageToCoalition( "Mission " .. self:GetName() .. " has been completed! Good job guys!" )
+end
+
+--- Gets the mission name.
+-- @param #MISSION self
+-- @return #MISSION self
+function MISSION:GetName()
+  return self.Name
+end
+
+--- Add a Unit to join the Mission.
+-- For each Task within the Mission, the Unit is joined with the Task.
+-- If the Unit was not part of a Task in the Mission, false is returned.
+-- If the Unit is part of a Task in the Mission, true is returned.
+-- @param #MISSION self
+-- @param Wrapper.Unit#UNIT PlayerUnit The CLIENT or UNIT of the Player joining the Mission.
+-- @param Wrapper.Group#GROUP PlayerGroup The GROUP of the player joining the Mission.
+-- @return #boolean true if Unit is part of a Task in the Mission.
+function MISSION:JoinUnit( PlayerUnit, PlayerGroup )
+  self:F( { PlayerUnit = PlayerUnit, PlayerGroup = PlayerGroup } )
+  
+  local PlayerUnitAdded = false
+  
+  for TaskID, Task in pairs( self:GetTasks() ) do
+    local Task = Task -- Tasking.Task#TASK
+    if Task:JoinUnit( PlayerUnit, PlayerGroup ) then
+      PlayerUnitAdded = true
+    end
+  end
+  
+  return PlayerUnitAdded
+end
+
+--- Aborts a PlayerUnit from the Mission.
+-- For each Task within the Mission, the PlayerUnit is removed from Task where it is assigned.
+-- If the Unit was not part of a Task in the Mission, false is returned.
+-- If the Unit is part of a Task in the Mission, true is returned.
+-- @param #MISSION self
+-- @param Wrapper.Unit#UNIT PlayerUnit The CLIENT or UNIT of the Player joining the Mission.
+-- @return #boolean true if Unit is part of a Task in the Mission.
+function MISSION:AbortUnit( PlayerUnit )
+  self:F( { PlayerUnit = PlayerUnit } )
+  
+  local PlayerUnitRemoved = false
+  
+  for TaskID, Task in pairs( self:GetTasks() ) do
+    if Task:AbortUnit( PlayerUnit ) then
+      PlayerUnitRemoved = true
+    end
+  end
+  
+  return PlayerUnitRemoved
+end
+
+--- Handles a crash of a PlayerUnit from the Mission.
+-- For each Task within the Mission, the PlayerUnit is removed from Task where it is assigned.
+-- If the Unit was not part of a Task in the Mission, false is returned.
+-- If the Unit is part of a Task in the Mission, true is returned.
+-- @param #MISSION self
+-- @param Wrapper.Unit#UNIT PlayerUnit The CLIENT or UNIT of the Player crashing.
+-- @return #boolean true if Unit is part of a Task in the Mission.
+function MISSION:CrashUnit( PlayerUnit )
+  self:F( { PlayerUnit = PlayerUnit } )
+  
+  local PlayerUnitRemoved = false
+  
+  for TaskID, Task in pairs( self:GetTasks() ) do
+    if Task:CrashUnit( PlayerUnit ) then
+      PlayerUnitRemoved = true
+    end
+  end
+  
+  return PlayerUnitRemoved
+end
+
+--- Add a scoring to the mission.
+-- @param #MISSION self
+-- @return #MISSION self
+function MISSION:AddScoring( Scoring )
+  self.Scoring = Scoring
+  return self
+end
+
+--- Get the scoring object of a mission.
+-- @param #MISSION self
+-- @return #SCORING Scoring
+function MISSION:GetScoring()
+  return self.Scoring
+end
+
+--- Get the groups for which TASKS are given in the mission
+-- @param #MISSION self
+-- @return Core.Set#SET_GROUP
+function MISSION:GetGroups()
+  
+  local SetGroup = SET_GROUP:New()
+  
+  for TaskID, Task in pairs( self:GetTasks() ) do
+    local Task = Task -- Tasking.Task#TASK
+    local GroupSet = Task:GetGroups()
+    GroupSet:ForEachGroup(
+      function( TaskGroup )
+        SetGroup:Add( TaskGroup, TaskGroup )
+      end
+    )
+  end
+  
+  return SetGroup
+  
+end
+
+
+--- Sets the Planned Task menu.
+-- @param #MISSION self
+-- @param #number MenuTime
+function MISSION:SetMenu( MenuTime )
+  self:F()
+  
+  for _, TaskData in pairs( self:GetTasks() ) do
+    local Task = TaskData -- Tasking.Task#TASK
+    Task:SetMenu( MenuTime )  
+  end
+end
+
+--- Removes the Planned Task menu.
+-- @param #MISSION self
+-- @param #number MenuTime
+function MISSION:RemoveMenu( MenuTime )
+  self:F()
+  
+  for _, Task in pairs( self:GetTasks() ) do
+    local Task = Task -- Tasking.Task#TASK
+    Task:RemoveMenu( MenuTime )
+  end
+end
+
+
+--- Gets the COMMANDCENTER.
+-- @param #MISSION self
+-- @return Tasking.CommandCenter#COMMANDCENTER
+function MISSION:GetCommandCenter()
+  return self.CommandCenter
+end
+
+
+--- Removes a Task menu.
+-- @param #MISSION self
+-- @param Tasking.Task#TASK Task
+-- @return #MISSION self
+function MISSION:RemoveTaskMenu( Task )
+    
+  Task:RemoveMenu()  
+end
+
+
+--- Gets the mission menu for the coalition.
+-- @param #MISSION self
+-- @param Wrapper.Group#GROUP TaskGroup
+-- @return Core.Menu#MENU_COALITION self
+function MISSION:GetMenu( TaskGroup )
+
+  local CommandCenter = self:GetCommandCenter()
+  local CommandCenterMenu = CommandCenter:GetMenu()
+
+  local MissionName = self:GetName()
+  local MissionMenu = CommandCenterMenu:GetMenu( MissionName )
+  
+  return MissionMenu
+end
+
+
+--- Get the TASK identified by the TaskNumber from the Mission. This function is useful in GoalFunctions.
+-- @param #string TaskName The Name of the @{Task} within the @{Mission}.
+-- @return Tasking.Task#TASK The Task
+-- @return #nil Returns nil if no task was found.
+function MISSION:GetTask( TaskName  )
+  self:F( { TaskName } )
+
+  return self.Tasks[TaskName]
+end
+
+
+--- Register a @{Task} to be completed within the @{Mission}. 
+-- Note that there can be multiple @{Task}s registered to be completed. 
+-- Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.
+-- @param #MISSION self
+-- @param Tasking.Task#TASK Task is the @{Task} object.
+-- @return Tasking.Task#TASK The task added.
+function MISSION:AddTask( Task )
+
+  local TaskName = Task:GetTaskName()
+  self:F( TaskName )
+
+  self.Tasks[TaskName] = self.Tasks[TaskName] or { n = 0 }
+
+  self.Tasks[TaskName] = Task
+  
+  self:GetCommandCenter():SetMenu()
+
+  return Task
+end
+
+--- Removes a @{Task} to be completed within the @{Mission}. 
+-- Note that there can be multiple @{Task}s registered to be completed. 
+-- Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.
+-- @param #MISSION self
+-- @param Tasking.Task#TASK Task is the @{Task} object.
+-- @return #nil The cleaned Task reference.
+function MISSION:RemoveTask( Task )
+
+  local TaskName = Task:GetTaskName()
+
+  self:F( TaskName )
+  self.Tasks[TaskName] = self.Tasks[TaskName] or { n = 0 }
+
+  -- Ensure everything gets garbarge collected.
+  self.Tasks[TaskName] = nil 
+  Task = nil
+  
+  collectgarbage()
+
+  self:GetCommandCenter():SetMenu()
+  
+  return nil
+end
+
+--- Return the next @{Task} ID to be completed within the @{Mission}. 
+-- @param #MISSION self
+-- @param Tasking.Task#TASK Task is the @{Task} object.
+-- @return Tasking.Task#TASK The task added.
+function MISSION:GetNextTaskID( Task )
+
+  local TaskName = Task:GetTaskName()
+  self:F( TaskName )
+  self.Tasks[TaskName] = self.Tasks[TaskName] or { n = 0 }
+  
+  self.Tasks[TaskName].n = self.Tasks[TaskName].n + 1
+
+  return self.Tasks[TaskName].n
+end
+
+--- Is the @{Mission} **Completed**.
+-- @param #MISSION self
+-- @return #boolean
+function MISSION:IsCompleted()
+  return self:Is( "Completed" )
+end
+
+--- Is the @{Mission} **Idle**.
+-- @param #MISSION self
+-- @return #boolean
+function MISSION:IsIdle()
+  return self:Is( "Idle" )
+end
+
+--- Is the @{Mission} **Ongoing**.
+-- @param #MISSION self
+-- @return #boolean
+function MISSION:IsOngoing()
+  return self:Is( "Ongoing" )
+end
+
+--- Is the @{Mission} **Failed**.
+-- @param #MISSION self
+-- @return #boolean
+function MISSION:IsFailed()
+  return self:Is( "Failed" )
+end
+
+--- Is the @{Mission} **Hold**.
+-- @param #MISSION self
+-- @return #boolean
+function MISSION:IsHold()
+  return self:Is( "Hold" )
+end
+
+--- Validates if the Mission has a Group
+-- @param #MISSION
+-- @return #boolean true if the Mission has a Group.
+function MISSION:HasGroup( TaskGroup )
+  local Has = false
+  
+  for TaskID, Task in pairs( self:GetTasks() ) do
+    local Task = Task -- Tasking.Task#TASK
+    if Task:HasGroup( TaskGroup ) then
+      Has = true
+      break
+    end
+  end
+  
+  return Has
+end
+
+--- Create a summary report of the Mission (one line).
+-- @param #MISSION self
+-- @return #string
+function MISSION:ReportSummary()
+
+  local Report = REPORT:New()
+
+  -- List the name of the mission.
+  local Name = self:GetName()
+  
+  -- Determine the status of the mission.
+  local Status = self:GetState()
+  
+  -- Determine how many tasks are remaining.
+  local TasksRemaining = 0
+  for TaskID, Task in pairs( self:GetTasks() ) do
+    local Task = Task -- Tasking.Task#TASK
+    if Task:IsStateSuccess() or Task:IsStateFailed() then
+    else
+      TasksRemaining = TasksRemaining + 1
+    end
+  end
+
+  Report:Add( "Mission " .. Name .. " - " .. Status .. " - " .. TasksRemaining .. " tasks remaining." )
+  
+  return Report:Text()
+end
+
+--- Create a overview report of the Mission (multiple lines).
+-- @param #MISSION self
+-- @return #string
+function MISSION:ReportOverview()
+
+  local Report = REPORT:New()
+
+  -- List the name of the mission.
+  local Name = self:GetName()
+  
+  -- Determine the status of the mission.
+  local Status = self:GetState()
+
+  Report:Add( "Mission " .. Name .. " - State '" .. Status .. "'" )
+  
+  -- Determine how many tasks are remaining.
+  local TasksRemaining = 0
+  for TaskID, Task in pairs( self:GetTasks() ) do
+    local Task = Task -- Tasking.Task#TASK
+    Report:Add( "- " .. Task:ReportSummary() )
+  end
+
+  return Report:Text()
+end
+
+--- Create a detailed report of the Mission, listing all the details of the Task.
+-- @param #MISSION self
+-- @return #string
+function MISSION:ReportDetails()
+
+  local Report = REPORT:New()
+  
+  -- List the name of the mission.
+  local Name = self:GetName()
+  
+  -- Determine the status of the mission.
+  local Status = self:GetState()
+  
+  Report:Add( "Mission " .. Name .. " - State '" .. Status .. "'" )
+  
+  -- Determine how many tasks are remaining.
+  local TasksRemaining = 0
+  for TaskID, Task in pairs( self:GetTasks() ) do
+    local Task = Task -- Tasking.Task#TASK
+    Report:Add( Task:ReportDetails() )
+  end
+
+  return Report:Text()
+end
+
+--- Get all the TASKs from the Mission. This function is useful in GoalFunctions.
+-- @return {TASK,...} Structure of TASKS with the @{TASK} number as the key.
+-- @usage
+-- -- Get Tasks from the Mission.
+-- Tasks = Mission:GetTasks()
+-- env.info( "Task 2 Completion = " .. Tasks[2]:GetGoalPercentage() .. "%" )
+function MISSION:GetTasks()
+	self:F()
+
+	return self.Tasks
+end
+ 
+

Moose Development/Moose/Tasking/Task_A2G.lua

@@ -0,0 +1,369 @@
+--- This module contains the TASK_A2G classes.
+-- 
+-- # 1) @{Task_A2G#TASK_A2G} class, extends @{Task#TASK}
+-- 
+-- The @{#TASK_A2G} class defines Air To Ground tasks for a @{Set} of Target Units, 
+-- based on the tasking capabilities defined in @{Task#TASK}.
+-- The TASK_A2G is implemented using a @{Statemachine#FSM_TASK}, and has the following statuses:
+-- 
+--   * **None**: Start of the process
+--   * **Planned**: The A2G task is planned.
+--   * **Assigned**: The A2G task is assigned to a @{Group#GROUP}.
+--   * **Success**: The A2G task is successfully completed.
+--   * **Failed**: The A2G task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.
+-- 
+-- # 1) @{Task_A2G#TASK_SEAD} class, extends @{Task_A2G#TASK_A2G}
+-- 
+-- The @{#TASK_SEAD} class defines a SEAD task for a @{Set} of Target Units.
+-- 
+-- ====
+--
+-- # **API CHANGE HISTORY**
+--
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+--
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+--
+-- Hereby the change log:
+--
+-- 2017-03-09: Revised version.
+--
+-- ===
+--
+-- # **AUTHORS and CONTRIBUTIONS**
+--
+-- ### Contributions:
+--
+--   * **[WingThor]**: Concept, Advice & Testing.
+--        
+-- ### Authors:
+--
+--   * **FlightControl**: Concept, Design & Programming.
+--   
+-- @module Task_A2G
+
+do -- TASK_A2G
+
+  --- The TASK_A2G class
+  -- @type TASK_A2G
+  -- @field Set#SET_UNIT TargetSetUnit
+  -- @extends Tasking.Task#TASK
+  TASK_A2G = {
+    ClassName = "TASK_A2G",
+  }
+  
+  --- Instantiates a new TASK_A2G.
+  -- @param #TASK_A2G self
+  -- @param Tasking.Mission#MISSION Mission
+  -- @param Set#SET_GROUP SetGroup The set of groups for which the Task can be assigned.
+  -- @param #string TaskName The name of the Task.
+  -- @param Set#SET_UNIT UnitSetTargets
+  -- @param #number TargetDistance The distance to Target when the Player is considered to have "arrived" at the engagement range.
+  -- @param Core.Zone#ZONE_BASE TargetZone The target zone, if known.
+  -- If the TargetZone parameter is specified, the player will be routed to the center of the zone where all the targets are assumed to be.
+  -- @return #TASK_A2G self
+  function TASK_A2G:New( Mission, SetGroup, TaskName, TargetSetUnit, TaskType )
+    local self = BASE:Inherit( self, TASK:New( Mission, SetGroup, TaskName, TaskType ) ) -- Tasking.Task#TASK_A2G
+    self:F()
+  
+    self.TargetSetUnit = TargetSetUnit
+    self.TaskType = TaskType
+
+    Mission:AddTask( self )
+    
+    local Fsm = self:GetUnitProcess()
+    
+
+    Fsm:AddProcess   ( "Planned", "Accept", ACT_ASSIGN_ACCEPT:New( self.TaskBriefing ), { Assigned = "RouteToRendezVous", Rejected = "Reject" }  )
+    
+    Fsm:AddTransition( "Assigned", "RouteToRendezVous", "RoutingToRendezVous" )
+    Fsm:AddProcess   ( "RoutingToRendezVous", "RouteToRendezVousPoint", ACT_ROUTE_POINT:New(), { Arrived = "ArriveAtRendezVous" } )
+    Fsm:AddProcess   ( "RoutingToRendezVous", "RouteToRendezVousZone", ACT_ROUTE_ZONE:New(), { Arrived = "ArriveAtRendezVous" } )
+    
+    Fsm:AddTransition( { "Arrived", "RoutingToRendezVous" }, "ArriveAtRendezVous", "ArrivedAtRendezVous" )
+    
+    Fsm:AddTransition( { "ArrivedAtRendezVous", "HoldingAtRendezVous" }, "Engage", "Engaging" )
+    Fsm:AddTransition( { "ArrivedAtRendezVous", "HoldingAtRendezVous" }, "HoldAtRendezVous", "HoldingAtRendezVous" )
+     
+    Fsm:AddProcess   ( "Engaging", "Account", ACT_ACCOUNT_DEADS:New( self.TargetSetUnit, self.TaskType ), { Accounted = "Success" } )
+    Fsm:AddTransition( "Engaging", "RouteToTarget", "Engaging" )
+    Fsm:AddProcess( "Engaging", "RouteToTargetZone", ACT_ROUTE_ZONE:New(), {} )
+    Fsm:AddProcess( "Engaging", "RouteToTargetPoint", ACT_ROUTE_POINT:New(), {} )
+    Fsm:AddTransition( "Engaging", "RouteToTargets", "Engaging" )
+    
+    Fsm:AddTransition( "Accounted", "DestroyedAll", "Accounted" )
+    Fsm:AddTransition( "Accounted", "Success", "Success" )
+    Fsm:AddTransition( "Rejected", "Reject", "Aborted" )
+    Fsm:AddTransition( "Failed", "Fail", "Failed" )
+    
+    
+    --- Test 
+    -- @param #FSM_PROCESS self
+    -- @param Wrapper.Unit#UNIT TaskUnit
+    -- @param Tasking.Task_A2G#TASK_A2G Task
+    function Fsm:onafterRouteToRendezVous( TaskUnit, Task )
+      self:E( { TaskUnit = TaskUnit, Task = Task and Task:GetClassNameAndID() } )
+      -- Determine the first Unit from the self.RendezVousSetUnit
+      
+      if Task:GetRendezVousZone( TaskUnit ) then
+        self:__RouteToRendezVousZone( 0.1 )
+      else
+        if Task:GetRendezVousPointVec2( TaskUnit ) then
+          self:__RouteToRendezVousPoint( 0.1 )
+        else
+          self:__ArriveAtRendezVous( 0.1 )
+        end
+      end
+    end
+
+    --- Test 
+    -- @param #FSM_PROCESS self
+    -- @param Wrapper.Unit#UNIT TaskUnit
+    -- @param Tasking.Task#TASK_A2G Task
+    function Fsm:OnAfterArriveAtRendezVous( TaskUnit, Task )
+      self:E( { TaskUnit = TaskUnit, Task = Task and Task:GetClassNameAndID() } )
+      -- Determine the first Unit from the self.TargetSetUnit
+      
+      self:__Engage( 0.1 )      
+    end
+    
+    --- Test 
+    -- @param #FSM_PROCESS self
+    -- @param Wrapper.Unit#UNIT TaskUnit
+    -- @param Tasking.Task#TASK_A2G Task
+    function Fsm:onafterEngage( TaskUnit, Task )
+      self:E( { self } )
+      self:__Account( 0.1 )
+      self:__RouteToTarget(0.1 )
+      self:__RouteToTargets( -10 )
+    end
+    
+    --- Test 
+    -- @param #FSM_PROCESS self
+    -- @param Wrapper.Unit#UNIT TaskUnit
+    -- @param Tasking.Task_A2G#TASK_A2G Task
+    function Fsm:onafterRouteToTarget( TaskUnit, Task )
+      self:E( { TaskUnit = TaskUnit, Task = Task and Task:GetClassNameAndID() } )
+      -- Determine the first Unit from the self.TargetSetUnit
+      
+      if Task:GetTargetZone( TaskUnit ) then
+        self:__RouteToTargetZone( 0.1 )
+      else
+        local TargetUnit = Task.TargetSetUnit:GetFirst() -- Wrapper.Unit#UNIT
+        if TargetUnit then
+          local PointVec2 = TargetUnit:GetPointVec2()
+          self:T( { TargetPointVec2 = PointVec2, PointVec2:GetX(), PointVec2:GetAlt(), PointVec2:GetZ() } )
+          Task:SetTargetPointVec2( TargetUnit:GetPointVec2(), TaskUnit )
+        end
+        self:__RouteToTargetPoint( 0.1 )
+      end
+    end
+    
+    --- Test 
+    -- @param #FSM_PROCESS self
+    -- @param Wrapper.Unit#UNIT TaskUnit
+    -- @param Tasking.Task_A2G#TASK_A2G Task
+    function Fsm:onafterRouteToTargets( TaskUnit, Task )
+      self:E( { TaskUnit = TaskUnit, Task = Task and Task:GetClassNameAndID() } )
+      local TargetUnit = Task.TargetSetUnit:GetFirst() -- Wrapper.Unit#UNIT
+      if TargetUnit then
+        Task:SetTargetPointVec2( TargetUnit:GetPointVec2(), TaskUnit )
+      end
+      self:__RouteToTargets( -10 )
+    end
+    
+    return self
+ 
+  end
+  
+  --- @param #TASK_A2G self
+  function TASK_A2G:GetPlannedMenuText()
+    return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.TargetSetUnit:GetUnitTypesText() .. " )"
+  end
+
+  --- @param #TASK_A2G self
+  -- @param Core.Point#POINT_VEC2 RendezVousPointVec2 The PointVec2 object referencing to the 2D point where the RendezVous point is located on the map.
+  -- @param #number RendezVousRange The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
+  -- @param Wrapper.Unit#UNIT TaskUnit
+  function TASK_A2G:SetRendezVousPointVec2( RendezVousPointVec2, RendezVousRange, TaskUnit  )
+  
+    local ProcessUnit = self:GetUnitProcess( TaskUnit )
+  
+    local ActRouteRendezVous = ProcessUnit:GetProcess( "RoutingToRendezVous", "RouteToRendezVousPoint" ) -- Actions.Act_Route#ACT_ROUTE_POINT
+    ActRouteRendezVous:SetPointVec2( RendezVousPointVec2 )
+    ActRouteRendezVous:SetRange( RendezVousRange )
+  end
+  
+  --- @param #TASK_A2G self
+  -- @param Wrapper.Unit#UNIT TaskUnit
+  -- @return Core.Point#POINT_VEC2 The PointVec2 object referencing to the 2D point where the RendezVous point is located on the map.
+  -- @return #number The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
+  function TASK_A2G:GetRendezVousPointVec2( TaskUnit )
+  
+    local ProcessUnit = self:GetUnitProcess( TaskUnit )
+
+    local ActRouteRendezVous = ProcessUnit:GetProcess( "RoutingToRendezVous", "RouteToRendezVousPoint" ) -- Actions.Act_Route#ACT_ROUTE_POINT
+    return ActRouteRendezVous:GetPointVec2(), ActRouteRendezVous:GetRange()
+  end
+  
+  
+  
+  --- @param #TASK_A2G self
+  -- @param Core.Zone#ZONE_BASE RendezVousZone The Zone object where the RendezVous is located on the map.
+  -- @param Wrapper.Unit#UNIT TaskUnit
+  function TASK_A2G:SetRendezVousZone( RendezVousZone, TaskUnit )
+  
+    local ProcessUnit = self:GetUnitProcess( TaskUnit )
+
+    local ActRouteRendezVous = ProcessUnit:GetProcess( "RoutingToRendezVous", "RouteToRendezVousZone" ) -- Actions.Act_Route#ACT_ROUTE_ZONE
+    ActRouteRendezVous:SetZone( RendezVousZone )
+  end
+
+  --- @param #TASK_A2G self
+  -- @param Wrapper.Unit#UNIT TaskUnit
+  -- @return Core.Zone#ZONE_BASE The Zone object where the RendezVous is located on the map.
+  function TASK_A2G:GetRendezVousZone( TaskUnit )
+
+    local ProcessUnit = self:GetUnitProcess( TaskUnit )
+
+    local ActRouteRendezVous = ProcessUnit:GetProcess( "RoutingToRendezVous", "RouteToRendezVousZone" ) -- Actions.Act_Route#ACT_ROUTE_ZONE
+    return ActRouteRendezVous:GetZone()
+  end
+  
+  --- @param #TASK_A2G self
+  -- @param Core.Point#POINT_VEC2 TargetPointVec2 The PointVec2 object where the Target is located on the map.
+  -- @param Wrapper.Unit#UNIT TaskUnit
+  function TASK_A2G:SetTargetPointVec2( TargetPointVec2, TaskUnit )
+  
+    local ProcessUnit = self:GetUnitProcess( TaskUnit )
+
+    local ActRouteTarget = ProcessUnit:GetProcess( "Engaging", "RouteToTargetPoint" ) -- Actions.Act_Route#ACT_ROUTE_POINT
+    ActRouteTarget:SetPointVec2( TargetPointVec2 )
+  end
+   
+
+  --- @param #TASK_A2G self
+  -- @param Wrapper.Unit#UNIT TaskUnit
+  -- @return Core.Point#POINT_VEC2 The PointVec2 object where the Target is located on the map.
+  function TASK_A2G:GetTargetPointVec2( TaskUnit )
+
+    local ProcessUnit = self:GetUnitProcess( TaskUnit )
+
+    local ActRouteTarget = ProcessUnit:GetProcess( "Engaging", "RouteToTargetPoint" ) -- Actions.Act_Route#ACT_ROUTE_POINT
+    return ActRouteTarget:GetPointVec2()
+  end
+
+
+  --- @param #TASK_A2G self
+  -- @param Core.Zone#ZONE_BASE TargetZone The Zone object where the Target is located on the map.
+  -- @param Wrapper.Unit#UNIT TaskUnit
+  function TASK_A2G:SetTargetZone( TargetZone, TaskUnit )
+  
+    local ProcessUnit = self:GetUnitProcess( TaskUnit )
+
+    local ActRouteTarget = ProcessUnit:GetProcess( "Engaging", "RouteToTargetZone" ) -- Actions.Act_Route#ACT_ROUTE_ZONE
+    ActRouteTarget:SetZone( TargetZone )
+  end
+   
+
+  --- @param #TASK_A2G self
+  -- @param Wrapper.Unit#UNIT TaskUnit
+  -- @return Core.Zone#ZONE_BASE The Zone object where the Target is located on the map.
+  function TASK_A2G:GetTargetZone( TaskUnit )
+
+    local ProcessUnit = self:GetUnitProcess( TaskUnit )
+
+    local ActRouteTarget = ProcessUnit:GetProcess( "Engaging", "RouteToTargetZone" ) -- Actions.Act_Route#ACT_ROUTE_ZONE
+    return ActRouteTarget:GetZone()
+  end
+  
+end 
+
+
+do -- TASK_SEAD
+
+  --- The TASK_SEAD class
+  -- @type TASK_SEAD
+  -- @field Set#SET_UNIT TargetSetUnit
+  -- @extends Tasking.Task#TASK
+  TASK_SEAD = {
+    ClassName = "TASK_SEAD",
+  }
+  
+  --- Instantiates a new TASK_SEAD.
+  -- @param #TASK_SEAD self
+  -- @param Tasking.Mission#MISSION Mission
+  -- @param Set#SET_GROUP SetGroup The set of groups for which the Task can be assigned.
+  -- @param #string TaskName The name of the Task.
+  -- @param Set#SET_UNIT UnitSetTargets
+  -- @param #number TargetDistance The distance to Target when the Player is considered to have "arrived" at the engagement range.
+  -- @param Core.Zone#ZONE_BASE TargetZone The target zone, if known.
+  -- If the TargetZone parameter is specified, the player will be routed to the center of the zone where all the targets are assumed to be.
+  -- @return #TASK_SEAD self
+  function TASK_SEAD:New( Mission, SetGroup, TaskName, TargetSetUnit )
+    local self = BASE:Inherit( self, TASK_A2G:New( Mission, SetGroup, TaskName, TargetSetUnit, "SEAD" ) ) -- #TASK_SEAD
+    self:F()
+    
+    return self
+  end 
+
+end
+
+do -- TASK_BAI
+
+  --- The TASK_BAI class
+  -- @type TASK_BAI
+  -- @field Set#SET_UNIT TargetSetUnit
+  -- @extends Tasking.Task#TASK
+  TASK_BAI = {
+    ClassName = "TASK_BAI",
+  }
+  
+  --- Instantiates a new TASK_BAI.
+  -- @param #TASK_BAI self
+  -- @param Tasking.Mission#MISSION Mission
+  -- @param Set#SET_GROUP SetGroup The set of groups for which the Task can be assigned.
+  -- @param #string TaskName The name of the Task.
+  -- @param Set#SET_UNIT UnitSetTargets
+  -- @param #number TargetDistance The distance to Target when the Player is considered to have "arrived" at the engagement range.
+  -- @param Core.Zone#ZONE_BASE TargetZone The target zone, if known.
+  -- If the TargetZone parameter is specified, the player will be routed to the center of the zone where all the targets are assumed to be.
+  -- @return #TASK_BAI self
+  function TASK_BAI:New( Mission, SetGroup, TaskName, TargetSetUnit )
+    local self = BASE:Inherit( self, TASK_A2G:New( Mission, SetGroup, TaskName, TargetSetUnit, "BAI" ) ) -- #TASK_BAI
+    self:F()
+    
+    return self
+  end 
+
+end
+
+do -- TASK_CAS
+
+  --- The TASK_CAS class
+  -- @type TASK_CAS
+  -- @field Set#SET_UNIT TargetSetUnit
+  -- @extends Tasking.Task#TASK
+  TASK_CAS = {
+    ClassName = "TASK_CAS",
+  }
+  
+  --- Instantiates a new TASK_CAS.
+  -- @param #TASK_CAS self
+  -- @param Tasking.Mission#MISSION Mission
+  -- @param Set#SET_GROUP SetGroup The set of groups for which the Task can be assigned.
+  -- @param #string TaskName The name of the Task.
+  -- @param Set#SET_UNIT UnitSetTargets
+  -- @param #number TargetDistance The distance to Target when the Player is considered to have "arrived" at the engagement range.
+  -- @param Core.Zone#ZONE_BASE TargetZone The target zone, if known.
+  -- If the TargetZone parameter is specified, the player will be routed to the center of the zone where all the targets are assumed to be.
+  -- @return #TASK_CAS self
+  function TASK_CAS:New( Mission, SetGroup, TaskName, TargetSetUnit )
+    local self = BASE:Inherit( self, TASK_A2G:New( Mission, SetGroup, TaskName, TargetSetUnit, "CAS" ) ) -- #TASK_CAS
+    self:F()
+    
+    return self
+  end 
+
+end

Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua

@@ -0,0 +1,286 @@
+--- **Tasking** - The TASK_A2G_DISPATCHER creates and manages player TASK_A2G tasks based on detected targets.
+-- 
+-- ===
+-- 
+-- # 1) @{#TASK_A2G_DISPATCHER} class, extends @{#DETECTION_MANAGER}
+-- 
+-- The @{#TASK_A2G_DISPATCHER} class implements the dynamic dispatching of tasks upon groups of detected units determined a @{Set} of FAC (groups).
+-- The FAC will detect units, will group them, and will dispatch @{Task}s to groups. Depending on the type of target detected, different tasks will be dispatched.
+-- Find a summary below describing for which situation a task type is created:
+-- 
+--   * **CAS Task**: Is created when there are enemy ground units within range of the FAC, while there are friendly units in the FAC perimeter.
+--   * **BAI Task**: Is created when there are enemy ground units within range of the FAC, while there are NO other friendly units within the FAC perimeter.
+--   * **SEAD Task**: Is created when there are enemy ground units wihtin range of the FAC, with air search radars.
+--   
+-- Other task types will follow...
+-- 
+-- 3.1) TASK_A2G_DISPATCHER constructor:
+-- --------------------------------------
+-- The @{#TASK_A2G_DISPATCHER.New}() method creates a new TASK_A2G_DISPATCHER instance.
+--    
+-- ===
+--
+-- # **API CHANGE HISTORY**
+--
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+--
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+--
+-- Hereby the change log:
+--
+-- 2017-03-09: Initial class and API.
+--
+-- ===
+--
+-- # **AUTHORS and CONTRIBUTIONS**
+--
+-- ### Contributions:
+--        
+-- ### Authors:
+--
+--   * **FlightControl**: Concept, Design & Programming.
+-- 
+-- @module Task_A2G_Dispatcher
+
+do -- TASK_A2G_DISPATCHER
+
+  --- TASK_A2G_DISPATCHER class.
+  -- @type TASK_A2G_DISPATCHER
+  -- @field Set#SET_GROUP SetGroup The groups to which the FAC will report to.
+  -- @field Functional.Detection#DETECTION_BASE Detection The DETECTION_BASE object that is used to report the detected objects.
+  -- @field Tasking.Mission#MISSION Mission
+  -- @extends Tasking.DetectionManager#DETECTION_MANAGER
+  TASK_A2G_DISPATCHER = {
+    ClassName = "TASK_A2G_DISPATCHER",
+    Mission = nil,
+    Detection = nil,
+  }
+  
+  
+  --- TASK_A2G_DISPATCHER constructor.
+  -- @param #TASK_A2G_DISPATCHER self
+  -- @param Tasking.Mission#MISSION The mission for which the task dispatching is done.
+  -- @param Set#SET_GROUP SetGroup The set of groups that can join the tasks within the mission.
+  -- @param Functional.Detection#DETECTION_BASE Detection The detection results that are used to dynamically assign new tasks to human players.
+  -- @return #TASK_A2G_DISPATCHER self
+  function TASK_A2G_DISPATCHER:New( Mission, SetGroup, Detection )
+  
+    -- Inherits from DETECTION_MANAGER
+    local self = BASE:Inherit( self, DETECTION_MANAGER:New( SetGroup, Detection ) ) -- #TASK_A2G_DISPATCHER
+    
+    self.Detection = Detection
+    self.Mission = Mission
+    
+    self:Schedule( 30 )
+    return self
+  end
+  
+  
+  --- Creates a SEAD task when there are targets for it.
+  -- @param #TASK_A2G_DISPATCHER self
+  -- @param Functional.Detection#DETECTION_AREAS.DetectedItem DetectedItem
+  -- @return Set#SET_UNIT TargetSetUnit: The target set of units.
+  -- @return #nil If there are no targets to be set.
+  function TASK_A2G_DISPATCHER:EvaluateSEAD( DetectedItem )
+    self:F( { DetectedItem.ItemID } )
+  
+    local DetectedSet = DetectedItem.Set
+    local DetectedZone = DetectedItem.Zone
+
+    -- Determine if the set has radar targets. If it does, construct a SEAD task.
+    local RadarCount = DetectedSet:HasSEAD()
+
+    if RadarCount > 0 then
+
+      -- Here we're doing something advanced... We're copying the DetectedSet, but making a new Set only with SEADable Radar units in it.
+      local TargetSetUnit = SET_UNIT:New()
+      TargetSetUnit:SetDatabase( DetectedSet )
+      TargetSetUnit:FilterHasSEAD()
+      TargetSetUnit:FilterOnce() -- Filter but don't do any events!!! Elements are added manually upon each detection.
+    
+      return TargetSetUnit
+    end
+    
+    return nil
+  end
+
+  --- Creates a CAS task when there are targets for it.
+  -- @param #TASK_A2G_DISPATCHER self
+  -- @param Functional.Detection#DETECTION_AREAS.DetectedItem DetectedItem
+  -- @return Tasking.Task#TASK
+  function TASK_A2G_DISPATCHER:EvaluateCAS( DetectedItem )
+    self:F( { DetectedItem.ItemID } )
+  
+    local DetectedSet = DetectedItem.Set
+    local DetectedZone = DetectedItem.Zone
+
+
+    -- Determine if the set has radar targets. If it does, construct a SEAD task.
+    local GroundUnitCount = DetectedSet:HasGroundUnits()
+    local FriendliesNearBy = self.Detection:IsFriendliesNearBy( DetectedItem )
+
+    if GroundUnitCount > 0 and FriendliesNearBy == true then
+
+      -- Copy the Set
+      local TargetSetUnit = SET_UNIT:New()
+      TargetSetUnit:SetDatabase( DetectedSet )
+      TargetSetUnit:FilterOnce() -- Filter but don't do any events!!! Elements are added manually upon each detection.
+      
+      return TargetSetUnit
+    end
+  
+    return nil
+  end
+  
+  --- Creates a BAI task when there are targets for it.
+  -- @param #TASK_A2G_DISPATCHER self
+  -- @param Functional.Detection#DETECTION_AREAS.DetectedItem DetectedItem
+  -- @return Tasking.Task#TASK
+  function TASK_A2G_DISPATCHER:EvaluateBAI( DetectedItem, FriendlyCoalition )
+    self:F( { DetectedItem.ItemID } )
+  
+    local DetectedSet = DetectedItem.Set
+    local DetectedZone = DetectedItem.Zone
+
+
+    -- Determine if the set has radar targets. If it does, construct a SEAD task.
+    local GroundUnitCount = DetectedSet:HasGroundUnits()
+    local FriendliesNearBy = self.Detection:IsFriendliesNearBy( DetectedItem )
+
+    if GroundUnitCount > 0 and FriendliesNearBy == false then
+
+      -- Copy the Set
+      local TargetSetUnit = SET_UNIT:New()
+      TargetSetUnit:SetDatabase( DetectedSet )
+      TargetSetUnit:FilterOnce() -- Filter but don't do any events!!! Elements are added manually upon each detection.
+      
+      return TargetSetUnit
+    end
+  
+    return nil
+  end
+  
+  --- Evaluates the removal of the Task from the Mission.
+  -- Can only occur when the DetectedItem is Changed AND the state of the Task is "Planned".
+  -- @param #TASK_A2G_DISPATCHER self
+  -- @param Tasking.Mission#MISSION Mission
+  -- @param Tasking.Task#TASK Task
+  -- @param Functional.Detection#DETECTION_AREAS.DetectedItem DetectedItem
+  -- @return Tasking.Task#TASK
+  function TASK_A2G_DISPATCHER:EvaluateRemoveTask( Mission, Task, DetectedItem )
+    
+    if Task then
+      if Task:IsStatePlanned() and DetectedItem.Changed == true then
+        self:E( "Removing Tasking: " .. Task:GetTaskName() )
+        Task = Mission:RemoveTask( Task )
+      end
+    end
+    
+    return Task
+  end
+  
+
+  --- Assigns tasks in relation to the detected items to the @{Set#SET_GROUP}.
+  -- @param #TASK_A2G_DISPATCHER self
+  -- @param Functional.Detection#DETECTION_BASE Detection The detection created by the @{Detection#DETECTION_BASE} derived object.
+  -- @return #boolean Return true if you want the task assigning to continue... false will cancel the loop.
+  function TASK_A2G_DISPATCHER:ProcessDetected( Detection )
+    self:F2()
+  
+    local AreaMsg = {}
+    local TaskMsg = {}
+    local ChangeMsg = {}
+    
+    local Mission = self.Mission
+    local ReportSEAD = REPORT:New( " - SEAD Tasks:")
+    local ReportCAS = REPORT:New( " - CAS Tasks:")
+    local ReportBAI = REPORT:New( " - BAI Tasks:")
+    local ReportChanges = REPORT:New( " - Changes:" )
+
+    --- First we need to  the detected targets.
+    for DetectedItemID, DetectedItem in pairs( Detection:GetDetectedItems() ) do
+    
+      local DetectedItem = DetectedItem -- Functional.Detection#DETECTION_BASE.DetectedItem
+      local DetectedSet = DetectedItem.Set -- Functional.Detection#DETECTION_BASE.DetectedSet
+      local DetectedZone = DetectedItem.Zone
+      self:E( { "Targets in DetectedItem", DetectedItem.ItemID, DetectedSet:Count(), tostring( DetectedItem ) } )
+      DetectedSet:Flush()
+      
+      local ItemID = DetectedItem.ItemID
+      
+      -- Evaluate SEAD Tasking
+      local SEADTask = Mission:GetTask( string.format( "SEAD.%03d", ItemID ) )
+      SEADTask = self:EvaluateRemoveTask( Mission, SEADTask, DetectedItem )
+      if not SEADTask then
+        local TargetSetUnit = self:EvaluateSEAD( DetectedItem ) -- Returns a SetUnit if there are targets to be SEADed...
+        if TargetSetUnit then
+          local Task = TASK_SEAD:New( Mission, self.SetGroup, string.format( "SEAD.%03d", ItemID ), TargetSetUnit )
+          Task:SetTargetZone( DetectedZone )
+          SEADTask = Mission:AddTask( Task )
+        end
+      end        
+      if SEADTask and SEADTask:IsStatePlanned() then
+        ReportSEAD:Add( string.format( " - %s.%02d - %s", "SEAD", ItemID, Detection:DetectedItemReportSummary(DetectedItemID) ) )
+      end
+
+      -- Evaluate CAS Tasking
+      local CASTask = Mission:GetTask( string.format( "CAS.%03d", ItemID ) )
+      CASTask = self:EvaluateRemoveTask( Mission, CASTask, DetectedItem )
+      if not CASTask then
+        local TargetSetUnit = self:EvaluateCAS( DetectedItem ) -- Returns a SetUnit if there are targets to be SEADed...
+        if TargetSetUnit then
+          local Task = TASK_CAS:New( Mission, self.SetGroup, string.format( "CAS.%03d", ItemID ), TargetSetUnit )
+          --Task:SetTargetZone( DetectedZone )
+          CASTask = Mission:AddTask( Task )
+        end
+      end        
+      if CASTask and CASTask:IsStatePlanned() then
+        ReportCAS:Add( string.format( " - %s.%02d - %s", "CAS", ItemID, Detection:DetectedItemReportSummary(DetectedItemID) ) )
+      end
+
+      -- Evaluate BAI Tasking
+      local BAITask = Mission:GetTask( string.format( "BAI.%03d", ItemID ) )
+      BAITask = self:EvaluateRemoveTask( Mission, BAITask, DetectedItem )
+      if not BAITask then
+        local TargetSetUnit = self:EvaluateBAI( DetectedItem, self.Mission:GetCommandCenter():GetPositionable():GetCoalition() ) -- Returns a SetUnit if there are targets to be SEADed...
+        if TargetSetUnit then
+          local Task = TASK_BAI:New( Mission, self.SetGroup, string.format( "BAI.%03d", ItemID ), TargetSetUnit )
+          Task:SetTargetZone( DetectedZone )
+          BAITask = Mission:AddTask( Task )
+        end
+      end        
+      if BAITask and BAITask:IsStatePlanned() then
+        ReportBAI:Add( string.format( " - %s.%02d - %s", "BAI", ItemID, Detection:DetectedItemReportSummary(DetectedItemID) ) )
+      end
+      
+
+      -- Loop through the changes ...
+      local ChangeText = Detection:GetChangeText( DetectedItem )
+      ReportChanges:Add( ChangeText )
+        
+      
+      -- OK, so the tasking has been done, now delete the changes reported for the area.
+      Detection:AcceptChanges( DetectedItem )
+      
+    end
+    
+    -- TODO set menus using the HQ coordinator
+    Mission:GetCommandCenter():SetMenu()
+    
+    for TaskGroupID, TaskGroup in pairs( self.SetGroup:GetSet() ) do
+      if not TaskGroup:GetState( TaskGroup, "Assigned" ) then
+        Mission:GetCommandCenter():MessageToGroup( 
+          string.format( "HQ Reporting - Planned tasks for mission '%s':\n%s\n", 
+                         self.Mission:GetName(),
+                         string.format( "%s\n%s\n%s\n%s", ReportSEAD:Text(), ReportCAS:Text(), ReportBAI:Text(), ReportChanges:Text()
+                       )
+          ), TaskGroup  
+        )
+      end
+    end
+    
+    return true
+  end
+
+end

Moose Development/Moose/Tasking/Task_Pickup.lua

@@ -0,0 +1,132 @@
+--- This module contains the TASK_PICKUP classes.
+-- 
+-- 1) @{#TASK_PICKUP} class, extends @{Task#TASK}
+-- ===================================================
+-- The @{#TASK_PICKUP} class defines a pickup task of a @{Set} of @{CARGO} objects defined within the mission. 
+-- based on the tasking capabilities defined in @{Task#TASK}.
+-- The TASK_PICKUP is implemented using a @{Statemachine#FSM_TASK}, and has the following statuses:
+-- 
+--   * **None**: Start of the process
+--   * **Planned**: The SEAD task is planned. Upon Planned, the sub-process @{Process_Fsm.Assign#ACT_ASSIGN_ACCEPT} is started to accept the task.
+--   * **Assigned**: The SEAD task is assigned to a @{Group#GROUP}. Upon Assigned, the sub-process @{Process_Fsm.Route#ACT_ROUTE} is started to route the active Units in the Group to the attack zone.
+--   * **Success**: The SEAD task is successfully completed. Upon Success, the sub-process @{Process_SEAD#PROCESS_SEAD} is started to follow-up successful SEADing of the targets assigned in the task.
+--   * **Failed**: The SEAD task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.
+-- 
+-- ===
+-- 
+-- ### Authors: FlightControl - Design and Programming
+-- 
+-- @module Task_PICKUP
+
+
+do -- TASK_PICKUP
+
+  --- The TASK_PICKUP class
+  -- @type TASK_PICKUP
+  -- @extends Tasking.Task#TASK
+  TASK_PICKUP = {
+    ClassName = "TASK_PICKUP",
+  }
+  
+  --- Instantiates a new TASK_PICKUP.
+  -- @param #TASK_PICKUP self
+  -- @param Tasking.Mission#MISSION Mission
+  -- @param Set#SET_GROUP AssignedSetGroup The set of groups for which the Task can be assigned.
+  -- @param #string TaskName The name of the Task.
+  -- @param #string TaskType BAI or CAS
+  -- @param Set#SET_UNIT UnitSetTargets
+  -- @param Core.Zone#ZONE_BASE TargetZone
+  -- @return #TASK_PICKUP self
+  function TASK_PICKUP:New( Mission, AssignedSetGroup, TaskName, TaskType )
+    local self = BASE:Inherit( self, TASK:New( Mission, AssignedSetGroup, TaskName, TaskType, "PICKUP" ) )
+    self:F()
+  
+    return self
+  end
+  
+  --- Removes a TASK_PICKUP.
+  -- @param #TASK_PICKUP self
+  -- @return #nil
+  function TASK_PICKUP:CleanUp()
+
+    self:GetParent( self ):CleanUp()
+    
+    return nil
+  end
+  
+  
+  --- Assign the @{Task} to a @{Unit}.
+  -- @param #TASK_PICKUP self
+  -- @param Wrapper.Unit#UNIT TaskUnit
+  -- @return #TASK_PICKUP self
+  function TASK_PICKUP:AssignToUnit( TaskUnit )
+    self:F( TaskUnit:GetName() )
+  
+    local ProcessAssign = self:AddProcess( TaskUnit, ACT_ASSIGN_ACCEPT:New( self, TaskUnit, self.TaskBriefing ) )
+    local ProcessPickup = self:AddProcess( TaskUnit, PROCESS_PICKUP:New( self, self.TaskType, TaskUnit ) )
+    
+    local Process = self:AddStateMachine( TaskUnit, FSM_TASK:New( self, TaskUnit, {
+        initial = 'None',
+        events = {
+          { name = 'Next',   from = 'None',           to = 'Planned' },
+          { name = 'Next',    from = 'Planned',       to = 'Assigned' },
+          { name = 'Next',    from = 'Assigned',      to = 'Success' },
+          { name = 'Fail',    from = 'Assigned',      to = 'Failed' }, 
+        },
+        callbacks = {
+          onNext = self.OnNext,
+        },
+        subs = {
+          Assign      = { onstateparent = 'Planned',          oneventparent = 'Next',         fsm = ProcessAssign.Fsm,        event = 'Start',      returnevents = { 'Next', 'Reject' } },
+          Pickup      = { onstateparent = 'Assigned',         oneventparent = 'Next',         fsm = ProcessDestroy.Fsm,       event = 'Start',      returnevents = { 'Next' } },
+        }
+      } ) )
+    
+    ProcessRoute:AddScore( "Failed", "failed to destroy a ground unit", -100 )
+    ProcessDestroy:AddScore( "Pickup", "Picked-Up a Cargo", 25 )
+    ProcessDestroy:AddScore( "Failed", "failed to destroy a ground unit", -100 )
+    
+    Process:Next()
+  
+    return self
+  end
+  
+  --- StateMachine callback function for a TASK
+  -- @param #TASK_PICKUP self
+  -- @param Core.Fsm#FSM_TASK Fsm
+  -- @param #string Event
+  -- @param #string From
+  -- @param #string To
+  -- @param Event#EVENTDATA Event
+  function TASK_PICKUP:OnNext( Fsm, From, Event, To, Event )
+  
+    self:SetState( self, "State", To )
+  
+  end
+  
+    --- @param #TASK_PICKUP self
+  function TASK_PICKUP:GetPlannedMenuText()
+    return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.TargetSetUnit:GetUnitTypesText() .. " )"
+  end
+  
+  
+  --- @param #TASK_PICKUP self
+  function TASK_PICKUP:_Schedule()
+    self:F2()
+  
+    self.TaskScheduler = SCHEDULER:New( self, _Scheduler, {}, 15, 15 )
+    return self
+  end
+  
+  
+  --- @param #TASK_PICKUP self
+  function TASK_PICKUP._Scheduler()
+    self:F2()
+  
+    return true
+  end
+  
+end
+
+
+

Moose Development/Moose/Unit.lua

@@ -1,775 +0,0 @@
---- UNIT Class
--- 
--- @{UNIT} class
--- ==============
--- The @{UNIT} class is a wrapper class to handle the DCS Unit objects:
--- 
---  * Support all DCS Unit APIs.
---  * Enhance with Unit specific APIs not in the DCS Unit API set.
---  * Handle local Unit Controller.
---  * Manage the "state" of the DCS Unit.
---  
---  
--- UNIT reference methods
--- ====================== 
--- For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the _@{DATABASE} object.
--- This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Unit objects are spawned (using the @{SPAWN} class).
---  
--- The UNIT class **does not contain a :New()** method, rather it provides **:Find()** methods to retrieve the object reference
--- using the DCS Unit or the DCS UnitName.
--- 
--- Another thing to know is that UNIT objects do not "contain" the DCS Unit object. 
--- The UNIT methods will reference the DCS Unit object by name when it is needed during API execution.
--- If the DCS Unit object does not exist or is nil, the UNIT methods will return nil and log an exception in the DCS.log file.
---  
--- The UNIT class provides the following functions to retrieve quickly the relevant UNIT instance:
--- 
---  * @{#UNIT.Find}(): Find a UNIT instance from the _DATABASE object using a DCS Unit object.
---  * @{#UNIT.FindByName}(): Find a UNIT instance from the _DATABASE object using a DCS Unit name.
---  
--- IMPORTANT: ONE SHOULD NEVER SANATIZE these UNIT OBJECT REFERENCES! (make the UNIT object references nil).
--- 
--- DCS UNIT APIs
--- =============
--- The DCS Unit APIs are used extensively within MOOSE. The UNIT class has for each DCS Unit API a corresponding method.
--- To be able to distinguish easily in your code the difference between a UNIT API call and a DCS Unit API call,
--- the first letter of the method is also capitalized. So, by example, the DCS Unit method @{DCSUnit#Unit.getName}()
--- is implemented in the UNIT class as @{#UNIT.GetName}().
--- 
--- Additional UNIT APIs
--- ====================
--- The UNIT class comes with additional methods. Find below a summary.
--- 
--- Smoke, Flare Units
--- ------------------
--- The UNIT class provides methods to smoke or flare units easily. 
--- The @{#UNIT.SmokeBlue}(), @{#UNIT.SmokeGreen}(),@{#UNIT.SmokeOrange}(), @{#UNIT.SmokeRed}(), @{#UNIT.SmokeRed}() methods
--- will smoke the unit in the corresponding color. Note that smoking a unit is done at the current position of the DCS Unit. 
--- When the DCS Unit moves for whatever reason, the smoking will still continue!
--- The @{#UNIT.FlareGreen}(), @{#UNIT.FlareRed}(), @{#UNIT.FlareWhite}(), @{#UNIT.FlareYellow}() 
--- methods will fire off a flare in the air with the corresponding color. Note that a flare is a one-off shot and its effect is of very short duration.
--- 
--- Position, Point
--- ---------------
--- The UNIT class provides methods to obtain the current point or position of the DCS Unit.
--- The @{#UNIT.GetPointVec2}(), @{#UNIT.GetPointVec3}() will obtain the current location of the DCS Unit in a Vec2 (2D) or a Vec3 (3D) vector respectively.
--- If you want to obtain the complete 3D position including oriëntation and direction vectors, consult the @{#UNIT.GetPositionVec3}() method respectively.
--- 
--- Alive
--- -----
--- The @{#UNIT.IsAlive}(), @{#UNIT.IsActive}() methods determines if the DCS Unit is alive, meaning, it is existing and active.
--- 
--- Test for other units in radius
--- ------------------------------
--- One can test if another DCS Unit is within a given radius of the current DCS Unit, by using the @{#UNIT.OtherUnitInRadius}() method.
--- 
--- More functions will be added
--- ----------------------------
--- During the MOOSE development, more functions will be added. A complete list of the current functions is below.
--- 
--- 
--- 
--- 
--- @module Unit
--- @author FlightControl
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Message" )
-
---- The UNIT class
--- @type UNIT
--- @extends Base#BASE
--- @field #UNIT.FlareColor FlareColor
--- @field #UNIT.SmokeColor SmokeColor
-UNIT = {
-	ClassName="UNIT",
-	CategoryName = { 
-    [Unit.Category.AIRPLANE]      = "Airplane",
-    [Unit.Category.HELICOPTER]    = "Helicoper",
-    [Unit.Category.GROUND_UNIT]   = "Ground Unit",
-    [Unit.Category.SHIP]          = "Ship",
-    [Unit.Category.STRUCTURE]     = "Structure",
-    },
-  FlareColor = {
-    Green = trigger.flareColor.Green,
-    Red = trigger.flareColor.Red,
-    White = trigger.flareColor.White,
-    Yellow = trigger.flareColor.Yellow
-    },
-  SmokeColor = {
-    Green = trigger.smokeColor.Green,
-    Red = trigger.smokeColor.Red,
-    White = trigger.smokeColor.White,
-    Orange = trigger.smokeColor.Orange,
-    Blue = trigger.smokeColor.Blue
-    },
-	}
-
---- FlareColor
--- @type UNIT.FlareColor
--- @field Green
--- @field Red
--- @field White
--- @field Yellow
-
---- SmokeColor
--- @type UNIT.SmokeColor
--- @field Green
--- @field Red
--- @field White
--- @field Orange
--- @field Blue
-
--- Registration.
-	
---- Create a new UNIT from DCSUnit.
--- @param #UNIT self
--- @param DCSUnit#Unit DCSUnit
--- @param Database#DATABASE Database
--- @return Unit#UNIT
-function UNIT:Register( UnitName )
-
-  local self = BASE:Inherit( self, BASE:New() )
-  self:F2( UnitName )
-  self.UnitName = UnitName
-  return self
-end
-
--- Reference methods.
-
---- Finds a UNIT from the _DATABASE using a DCSUnit object.
--- @param #UNIT self
--- @param DCSUnit#Unit DCSUnit An existing DCS Unit object reference.
--- @return Unit#UNIT self
-function UNIT:Find( DCSUnit )
-
-  local UnitName = DCSUnit:getName()
-  local UnitFound = _DATABASE:FindUnit( UnitName )
-  return UnitFound
-end
-
---- Find a UNIT in the _DATABASE using the name of an existing DCS Unit.
--- @param #UNIT self
--- @param #string UnitName The Unit Name.
--- @return Unit#UNIT self
-function UNIT:FindByName( UnitName )
-  
-  local UnitFound = _DATABASE:FindUnit( UnitName )
-  return UnitFound
-end
-
-function UNIT:GetDCSUnit()
-  local DCSUnit = Unit.getByName( self.UnitName )
-  
-  if DCSUnit then
-    return DCSUnit
-  end
-    
-  return nil
-end
-
---- Returns coalition of the Unit.
--- @param Unit#UNIT self
--- @return DCSCoalitionObject#coalition.side The side of the coalition.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetCoalition()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitCoalition = DCSUnit:getCoalition()
-    self:T3( UnitCoalition )
-    return UnitCoalition
-  end 
-  
-  return nil
-end
-
---- Returns country of the Unit.
--- @param Unit#UNIT self
--- @return DCScountry#country.id The country identifier.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetCountry()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitCountry = DCSUnit:getCountry()
-    self:T3( UnitCountry )
-    return UnitCountry
-  end 
-  
-  return nil
-end
- 
-
---- Returns DCS Unit object name. 
--- The function provides access to non-activated units too.
--- @param Unit#UNIT self
--- @return #string The name of the DCS Unit.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetName()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitName = self.UnitName
-    return UnitName
-  end 
-  
-  return nil
-end
-
-
---- Returns if the unit is alive.
--- @param Unit#UNIT self
--- @return #boolean true if Unit is alive.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:IsAlive()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitIsAlive = DCSUnit:isExist()
-    return UnitIsAlive
-  end	
-	
-	return false
-end
-
---- Returns if the unit is activated.
--- @param Unit#UNIT self
--- @return #boolean true if Unit is activated.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:IsActive()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-  
-    local UnitIsActive = DCSUnit:isActive()
-    return UnitIsActive 
-  end
-
-  return nil
-end
-
---- Returns name of the player that control the unit or nil if the unit is controlled by A.I.
--- @param Unit#UNIT self
--- @return #string Player Name
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetPlayerName()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-  
-    local PlayerName = DCSUnit:getPlayerName()
-    if PlayerName == nil then
-      PlayerName = ""
-    end
-    return PlayerName
-  end
-
-  return nil
-end
-
---- Returns the unit's unique identifier.
--- @param Unit#UNIT self
--- @return DCSUnit#Unit.ID Unit ID
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetID()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitID = DCSUnit:getID()
-    return UnitID
-  end	
-
-  return nil
-end
-
---- Returns the unit's number in the group. 
--- The number is the same number the unit has in ME. 
--- It may not be changed during the mission. 
--- If any unit in the group is destroyed, the numbers of another units will not be changed.
--- @param Unit#UNIT self
--- @return #number The Unit number. 
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetNumber()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitNumber = DCSUnit:getNumber()
-    return UnitNumber
-  end
-
-  return nil
-end
-
---- Returns the unit's group if it exist and nil otherwise.
--- @param Unit#UNIT self
--- @return Group#GROUP The Group of the Unit.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetGroup()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitGroup = DCSUnit:getGroup()
-    return UnitGroup
-  end
-
-  return nil
-end
-
-
---- Returns the unit's callsign - the localized string.
--- @param Unit#UNIT self
--- @return #string The Callsign of the Unit.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetCallSign()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitCallSign = DCSUnit:getCallsign()
-    return UnitCallSign
-  end
-  
-  return nil
-end
-
---- Returns the unit's health. Dead units has health <= 1.0.
--- @param Unit#UNIT self
--- @return #number The Unit's health value.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetLife()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitLife = DCSUnit:getLife()
-    return UnitLife
-  end
-  
-  return nil
-end
-
---- Returns the Unit's initial health.
--- @param Unit#UNIT self
--- @return #number The Unit's initial health value.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetLife0()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitLife0 = DCSUnit:getLife0()
-    return UnitLife0
-  end
-  
-  return nil
-end
-
---- Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks. If there are additional fuel tanks the value may be greater than 1.0.
--- @param Unit#UNIT self
--- @return #number The relative amount of fuel (from 0.0 to 1.0).
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetFuel()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitFuel = DCSUnit:getFuel()
-    return UnitFuel
-  end
-  
-  return nil
-end
-
---- Returns the Unit's ammunition.
--- @param Unit#UNIT self
--- @return DCSUnit#Unit.Ammo
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetAmmo()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitAmmo = DCSUnit:getAmmo()
-    return UnitAmmo
-  end
-  
-  return nil
-end
-
---- Returns the unit sensors.
--- @param Unit#UNIT self
--- @return DCSUnit#Unit.Sensors
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetSensors()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitSensors = DCSUnit:getSensors()
-    return UnitSensors
-  end
-  
-  return nil
-end
-
--- Need to add here a function per sensortype
---  unit:hasSensors(Unit.SensorType.RADAR, Unit.RadarType.AS)
-
---- Returns two values:
--- 
---  * First value indicates if at least one of the unit's radar(s) is on.
---  * 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.
--- @param Unit#UNIT self
--- @return #boolean  Indicates if at least one of the unit's radar(s) is on.
--- @return DCSObject#Object The object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetRadar()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitRadarOn, UnitRadarObject = DCSUnit:getRadar()
-    return UnitRadarOn, UnitRadarObject
-  end
-  
-  return nil, nil
-end
-
--- Need to add here functions to check if radar is on and which object etc.
-
---- Returns unit descriptor. Descriptor type depends on unit category.
--- @param Unit#UNIT self
--- @return DCSUnit#Unit.Desc The Unit descriptor.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetDesc()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitDesc = DCSUnit:getDesc()
-    return UnitDesc
-  end
-  
-  return nil
-end
-
-
---- Returns the type name of the DCS Unit.
--- @param Unit#UNIT self
--- @return #string The type name of the DCS Unit.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetTypeName()
-	self:F2( self.UnitName )
-	
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitTypeName = DCSUnit:getTypeName()
-    self:T3( UnitTypeName )
-    return UnitTypeName
-  end
-
-	return nil
-end
-
-
-
---- Returns the prefix name of the DCS Unit. A prefix name is a part of the name before a '#'-sign.
--- DCS Units spawned with the @{SPAWN} class contain a '#'-sign to indicate the end of the (base) DCS Unit name. 
--- The spawn sequence number and unit number are contained within the name after the '#' sign. 
--- @param Unit#UNIT self
--- @return #string The name of the DCS Unit.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetPrefix()
-	self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-	
-  if DCSUnit then
-  	local UnitPrefix = string.match( self.UnitName, ".*#" ):sub( 1, -2 )
-  	self:T3( UnitPrefix )
-  	return UnitPrefix
-  end
-  
-  return nil
-end
-
-
-
---- Returns the @{DCSTypes#Vec2} vector indicating the point in 2D of the DCS Unit within the mission.
--- @param Unit#UNIT self
--- @return DCSTypes#Vec2 The 2D point vector of the DCS Unit.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetPointVec2()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-	
-  if DCSUnit then
-  	local UnitPointVec3 = DCSUnit:getPosition().p
-  	
-  	local UnitPointVec2 = {}
-  	UnitPointVec2.x = UnitPointVec3.x
-  	UnitPointVec2.y = UnitPointVec3.z
-  
-  	self:T3( UnitPointVec2 )
-  	return UnitPointVec2
-  end
-  
-  return nil
-end
-
-
---- Returns the @{DCSTypes#Vec3} vector indicating the point in 3D of the DCS Unit within the mission.
--- @param Unit#UNIT self
--- @return DCSTypes#Vec3 The 3D point vector of the DCS Unit.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetPointVec3()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-  	local UnitPointVec3 = DCSUnit:getPosition().p
-  	self:T3( UnitPointVec3 )
-  	return UnitPointVec3
-  end
-	
-	return nil
-end
-
---- Returns the @{DCSTypes#Position3} position vectors indicating the point and direction vectors in 3D of the DCS Unit within the mission.
--- @param Unit#UNIT self
--- @return DCSTypes#Position The 3D position vectors of the DCS Unit.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetPositionVec3()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitPosition = DCSUnit:getPosition()
-    self:T3( UnitPosition )
-    return UnitPosition
-  end
-  
-  return nil
-end
-
---- Returns the DCS Unit velocity vector.
--- @param Unit#UNIT self
--- @return DCSTypes#Vec3 The velocity vector
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetVelocity()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitVelocityVec3 = DCSUnit:getVelocity()
-    self:T3( UnitVelocityVec3 )
-    return UnitVelocityVec3
-  end
-  
-  return nil
-end
- 
---- Returns true if the DCS Unit is in the air.
--- @param Unit#UNIT self
--- @return #boolean true if in the air.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:InAir()
-  self:F2( self.UnitName )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitInAir = DCSUnit:inAir()
-    self:T3( UnitInAir )
-    return UnitInAir
-  end
-  
-  return nil
-end
- 
---- Returns the altitude of the DCS Unit.
--- @param Unit#UNIT self
--- @return DCSTypes#Distance The altitude of the DCS Unit.
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:GetAltitude()
-  self:F2()
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitPointVec3 = DCSUnit:getPoint() --DCSTypes#Vec3
-    return UnitPointVec3.y
-  end
-  
-  return nil
-end 
-
---- Returns true if there is an **other** DCS Unit within a radius of the current 2D point of the DCS Unit.
--- @param Unit#UNIT self
--- @param Unit#UNIT AwaitUnit The other UNIT wrapper object.
--- @param Radius The radius in meters with the DCS Unit in the centre.
--- @return true If the other DCS Unit is within the radius of the 2D point of the DCS Unit. 
--- @return #nil The DCS Unit is not existing or alive.  
-function UNIT:OtherUnitInRadius( AwaitUnit, Radius )
-	self:F2( { self.UnitName, AwaitUnit.UnitName, Radius } )
-
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-  	local UnitPos = self:GetPointVec3()
-  	local AwaitUnitPos = AwaitUnit:GetPointVec3()
-  
-  	if  (((UnitPos.x - AwaitUnitPos.x)^2 + (UnitPos.z - AwaitUnitPos.z)^2)^0.5 <= Radius) then
-  		self:T3( "true" )
-  		return true
-  	else
-  		self:T3( "false" )
-  		return false
-  	end
-  end
-
-	return nil
-end
-
---- Returns the DCS Unit category name as defined within the DCS Unit Descriptor.
--- @param Unit#UNIT self
--- @return #string The DCS Unit Category Name
-function UNIT:GetCategoryName()
-  local DCSUnit = self:GetDCSUnit()
-  
-  if DCSUnit then
-    local UnitCategoryName = self.CategoryName[ self:GetDesc().category ]
-    return UnitCategoryName
-  end
-  
-  return nil
-end
-
---- Signal a flare at the position of the UNIT.
--- @param #UNIT self
-function UNIT:Flare( FlareColor )
-  self:F2()
-  trigger.action.signalFlare( self:GetPointVec3(), FlareColor , 0 )
-end
-
---- Signal a white flare at the position of the UNIT.
--- @param #UNIT self
-function UNIT:FlareWhite()
-  self:F2()
-  trigger.action.signalFlare( self:GetPointVec3(), trigger.flareColor.White , 0 )
-end
-
---- Signal a yellow flare at the position of the UNIT.
--- @param #UNIT self
-function UNIT:FlareYellow()
-  self:F2()
-  trigger.action.signalFlare( self:GetPointVec3(), trigger.flareColor.Yellow , 0 )
-end
-
---- Signal a green flare at the position of the UNIT.
--- @param #UNIT self
-function UNIT:FlareGreen()
-  self:F2()
-  trigger.action.signalFlare( self:GetPointVec3(), trigger.flareColor.Green , 0 )
-end
-
---- Signal a red flare at the position of the UNIT.
--- @param #UNIT self
-function UNIT:FlareRed()
-  self:F2()
-  trigger.action.signalFlare( self:GetPointVec3(), trigger.flareColor.Red, 0 )
-end
-
---- Smoke the UNIT.
--- @param #UNIT self
-function UNIT:Smoke( SmokeColor )
-  self:F2()
-  trigger.action.smoke( self:GetPointVec3(), SmokeColor )
-end
-
---- Smoke the UNIT Green.
--- @param #UNIT self
-function UNIT:SmokeGreen()
-  self:F2()
-  trigger.action.smoke( self:GetPointVec3(), trigger.smokeColor.Green )
-end
-
---- Smoke the UNIT Red.
--- @param #UNIT self
-function UNIT:SmokeRed()
-  self:F2()
-  trigger.action.smoke( self:GetPointVec3(), trigger.smokeColor.Red )
-end
-
---- Smoke the UNIT White.
--- @param #UNIT self
-function UNIT:SmokeWhite()
-  self:F2()
-  trigger.action.smoke( self:GetPointVec3(), trigger.smokeColor.White )
-end
-
---- Smoke the UNIT Orange.
--- @param #UNIT self
-function UNIT:SmokeOrange()
-  self:F2()
-  trigger.action.smoke( self:GetPointVec3(), trigger.smokeColor.Orange )
-end
-
---- Smoke the UNIT Blue.
--- @param #UNIT self
-function UNIT:SmokeBlue()
-  self:F2()
-  trigger.action.smoke( self:GetPointVec3(), trigger.smokeColor.Blue )
-end
-
--- Is methods
-
---- Returns if the unit is of an air category.
--- If the unit is a helicopter or a plane, then this method will return true, otherwise false.
--- @param #UNIT self
--- @return #boolean Air category evaluation result.
-function UNIT:IsAir()
-  self:F2()
-  
-  local UnitDescriptor = self.DCSUnit:getDesc()
-  self:T3( { UnitDescriptor.category, Unit.Category.AIRPLANE, Unit.Category.HELICOPTER } )
-  
-  local IsAirResult = ( UnitDescriptor.category == Unit.Category.AIRPLANE ) or ( UnitDescriptor.category == Unit.Category.HELICOPTER )
-
-  self:T3( IsAirResult )
-  return IsAirResult
-end
-

Moose Development/Moose/Utilities/Routines.lua

@@ -2,10 +2,6 @@
 -- @module routines
 -- @author Flightcontrol
 
---Include.File( "Trace" )
---Include.File( "Message" )
-
-
 env.setErrorMessageBoxEnabled(false)
 
 --- Extract of MIST functions.
@@ -249,22 +245,6 @@ end
 
 
 
--- From http://lua-users.org/wiki/SimpleRound
--- use negative idp for rounding ahead of decimal place, positive for rounding after decimal place
-routines.utils.round = function(num, idp)
-  local mult = 10^(idp or 0)
-  return math.floor(num * mult + 0.5) / mult
-end
-
--- porting in Slmod's dostring
-routines.utils.dostring = function(s)
-	local f, err = loadstring(s)
-	if f then
-		return true, f()
-	else
-		return false, err
-	end
-end
 
 
 --3D Vector manipulation
@@ -445,118 +425,6 @@ routines.getNorthCorrection = function(point)  --gets the correction needed for
 end
 
 
--- the main area
-do
-	-- THE MAIN FUNCTION --   Accessed 100 times/sec.
-	routines.main = function()
-		timer.scheduleFunction(routines.main, {}, timer.getTime() + 2)  --reschedule first in case of Lua error
-		----------------------------------------------------------------------------------------------------------
-		--area to add new stuff in
-
-		routines.do_scheduled_functions()
-	end -- end of routines.main
-
-	timer.scheduleFunction(routines.main, {}, timer.getTime() + 2)
-
-end
-
-
-do
-	local Tasks = {}
-	local task_id = 0
-	--[[ routines.scheduleFunction:
-	int id = routines.schedule_task(f function, vars table, t number, rep number, st number)
-	id - integer id of this function task
-	f - function to run
-	vars - table of vars for that function
-	t - time to run function
-	rep - time between repetitions of this function (OPTIONAL)
-	st - time when repetitions of this function will stop automatically (OPTIONAL)
-	]]
-	
-	--- Schedule a function
-	-- @param #function f
-	-- @param #table parameters
-	-- @param #Time t
-	-- @param #Time rep seconds
-	-- @param #Time st
-	routines.scheduleFunction = function(f, vars, t, rep, st)
-	--verify correct types
-		assert(type(f) == 'function', 'variable 1, expected function, got ' .. type(f))
-		assert(type(vars) == 'table' or vars == nil, 'variable 2, expected table or nil, got ' .. type(f))
-		assert(type(t) == 'number', 'variable 3, expected number, got ' .. type(t))
-		assert(type(rep) == 'number' or rep == nil, 'variable 4, expected number or nil, got ' .. type(rep))
-		assert(type(st) == 'number' or st == nil, 'variable 5, expected number or nil, got ' .. type(st))
-		if not vars then
-			vars = {}
-		end
-		task_id = task_id + 1
-		table.insert(Tasks, {f = f, vars = vars, t = t, rep = rep, st = st, id = task_id})
-		return task_id
-	end
-
-	-- removes a scheduled function based on the function's id.  returns true if successful, false if not successful.
-	routines.removeFunction = function(id)
-		local i = 1
-		while i <= #Tasks do
-			if Tasks[i].id == id then
-				table.remove(Tasks, i)
-			else
-				i = i + 1
-			end
-		end
-	end
-
-	routines.errhandler = function(errmsg)
-
-		env.info( "Error in scheduled function:" .. errmsg )
-		env.info( debug.traceback() )
-
-		return errmsg
-	end
-
-	--------------------------------------------------------------------------------------------------------------------
-	-- not intended for users to use this function.
-	routines.do_scheduled_functions = function()
-		local i = 1
-		while i <= #Tasks do
-			if not Tasks[i].rep then -- not a repeated process
-				if Tasks[i].t <= timer.getTime() then
-					local Task = Tasks[i] -- local reference
-					--env.info("do_scheduled_functions:call function " .. i )
-					table.remove(Tasks, i)
-					local err, errmsg = xpcall(function() Task.f( unpack(Task.vars, 1, table.maxn(Task.vars))) end, routines.errhandler )
-					if not err then
-						--env.info('routines.scheduleFunction, error in scheduled function: ' .. errmsg)
-					end
-					--Task.f(unpack(Task.vars, 1, table.maxn(Task.vars)))  -- do the task, do not increment i
-				else
-					i = i + 1
-				end
-			else
-				if Tasks[i].st and Tasks[i].st <= timer.getTime() then   --if a stoptime was specified, and the stop time exceeded
-					--env.info("do_scheduled_functions:remove repeated")
-					table.remove(Tasks, i) -- stop time exceeded, do not execute, do not increment i
-				elseif Tasks[i].t <= timer.getTime() then
-					local Task = Tasks[i] -- local reference
-					Task.t = timer.getTime() + Task.rep  --schedule next run
-					--env.info("do_scheduled_functions:call function " .. i )
-					local err, errmsg = xpcall(function() Task.f( unpack(Task.vars, 1, table.maxn(Task.vars))) end, routines.errhandler )
-					if not err then
-						--env.info('routines.scheduleFunction, error in scheduled function: ' .. errmsg)
-					end
-					--Tasks[i].f(unpack(Tasks[i].vars, 1, table.maxn(Tasks[i].vars)))  -- do the task
-					i = i + 1
-				else
-					i = i + 1
-				end
-			end
-		end
-
-	end
-
-end
-
 do
 	local idNum = 0
 
@@ -2406,19 +2274,19 @@ end
 function MessageToAll( MsgText, MsgTime, MsgName )
 --trace.f()
 
-	MESSAGE:New( MsgText, "Message", MsgTime, MsgName ):ToCoalition( coalition.side.RED ):ToCoalition( coalition.side.BLUE )
+	MESSAGE:New( MsgText, MsgTime, "Message" ):ToCoalition( coalition.side.RED ):ToCoalition( coalition.side.BLUE )
 end
 
 function MessageToRed( MsgText, MsgTime, MsgName )
 --trace.f()
 
-	MESSAGE:New( MsgText, "To Red Coalition", MsgTime, MsgName ):ToCoalition( coalition.side.RED )
+	MESSAGE:New( MsgText, MsgTime, "To Red Coalition" ):ToCoalition( coalition.side.RED )
 end
 
 function MessageToBlue( MsgText, MsgTime, MsgName )
 --trace.f()
 
-	MESSAGE:New( MsgText, "To Blue Coalition", MsgTime, MsgName ):ToCoalition( coalition.side.RED )
+	MESSAGE:New( MsgText, MsgTime, "To Blue Coalition" ):ToCoalition( coalition.side.RED )
 end
 
 function getCarrierHeight( CarrierGroup )

Moose Development/Moose/Utilities/StatHandler.lua

@@ -1,7 +1,7 @@
 --- Provides a logging of statistics in a running DCS Mission.
 -- @script eStatHandler
 
-Include.File( "Routines" )
+
 
 
 --Handler table

Moose Development/Moose/Utilities/Utils.lua

@@ -0,0 +1,295 @@
+--- This module contains derived utilities taken from the MIST framework, 
+-- which are excellent tools to be reused in an OO environment!.
+-- 
+-- ### Authors: 
+-- 
+--   * Grimes : Design & Programming of the MIST framework.
+--   
+-- ### Contributions:
+-- 
+--   * FlightControl : Rework to OO framework 
+-- 
+-- @module Utils
+
+
+--- @type SMOKECOLOR
+-- @field Green
+-- @field Red
+-- @field White
+-- @field Orange
+-- @field Blue
+ 
+SMOKECOLOR = trigger.smokeColor -- #SMOKECOLOR
+
+--- @type FLARECOLOR
+-- @field Green
+-- @field Red
+-- @field White
+-- @field Yellow
+
+FLARECOLOR = trigger.flareColor -- #FLARECOLOR
+
+--- Utilities static class.
+-- @type UTILS
+UTILS = {}
+
+
+--from http://lua-users.org/wiki/CopyTable
+UTILS.DeepCopy = function(object)
+  local lookup_table = {}
+  local function _copy(object)
+    if type(object) ~= "table" then
+      return object
+    elseif lookup_table[object] then
+      return lookup_table[object]
+    end
+    local new_table = {}
+    lookup_table[object] = new_table
+    for index, value in pairs(object) do
+      new_table[_copy(index)] = _copy(value)
+    end
+    return setmetatable(new_table, getmetatable(object))
+  end
+  local objectreturn = _copy(object)
+  return objectreturn
+end
+
+
+-- porting in Slmod's serialize_slmod2
+UTILS.OneLineSerialize = function( tbl )  -- serialization of a table all on a single line, no comments, made to replace old get_table_string function
+
+  lookup_table = {}
+  
+  local function _Serialize( tbl )
+
+    if type(tbl) == 'table' then --function only works for tables!
+    
+      if lookup_table[tbl] then
+        return lookup_table[object]
+      end
+
+      local tbl_str = {}
+      
+      lookup_table[tbl] = tbl_str
+      
+      tbl_str[#tbl_str + 1] = '{'
+
+      for ind,val in pairs(tbl) do -- serialize its fields
+        local ind_str = {}
+        if type(ind) == "number" then
+          ind_str[#ind_str + 1] = '['
+          ind_str[#ind_str + 1] = tostring(ind)
+          ind_str[#ind_str + 1] = ']='
+        else --must be a string
+          ind_str[#ind_str + 1] = '['
+          ind_str[#ind_str + 1] = routines.utils.basicSerialize(ind)
+          ind_str[#ind_str + 1] = ']='
+        end
+
+        local val_str = {}
+        if ((type(val) == 'number') or (type(val) == 'boolean')) then
+          val_str[#val_str + 1] = tostring(val)
+          val_str[#val_str + 1] = ','
+          tbl_str[#tbl_str + 1] = table.concat(ind_str)
+          tbl_str[#tbl_str + 1] = table.concat(val_str)
+      elseif type(val) == 'string' then
+          val_str[#val_str + 1] = routines.utils.basicSerialize(val)
+          val_str[#val_str + 1] = ','
+          tbl_str[#tbl_str + 1] = table.concat(ind_str)
+          tbl_str[#tbl_str + 1] = table.concat(val_str)
+        elseif type(val) == 'nil' then -- won't ever happen, right?
+          val_str[#val_str + 1] = 'nil,'
+          tbl_str[#tbl_str + 1] = table.concat(ind_str)
+          tbl_str[#tbl_str + 1] = table.concat(val_str)
+        elseif type(val) == 'table' then
+          if ind == "__index" then
+          --  tbl_str[#tbl_str + 1] = "__index"
+          --  tbl_str[#tbl_str + 1] = ','   --I think this is right, I just added it
+          else
+
+            val_str[#val_str + 1] = _Serialize(val)
+            val_str[#val_str + 1] = ','   --I think this is right, I just added it
+            tbl_str[#tbl_str + 1] = table.concat(ind_str)
+            tbl_str[#tbl_str + 1] = table.concat(val_str)
+          end
+        elseif type(val) == 'function' then
+          tbl_str[#tbl_str + 1] = "f() " .. tostring(ind)
+          tbl_str[#tbl_str + 1] = ','   --I think this is right, I just added it
+        else
+          env.info('unable to serialize value type ' .. routines.utils.basicSerialize(type(val)) .. ' at index ' .. tostring(ind))
+          env.info( debug.traceback() )
+        end
+  
+      end
+      tbl_str[#tbl_str + 1] = '}'
+      return table.concat(tbl_str)
+    else
+      return tostring(tbl)
+    end
+  end
+  
+  local objectreturn = _Serialize(tbl)
+  return objectreturn
+end
+
+--porting in Slmod's "safestring" basic serialize
+UTILS.BasicSerialize = function(s)
+  if s == nil then
+    return "\"\""
+  else
+    if ((type(s) == 'number') or (type(s) == 'boolean') or (type(s) == 'function') or (type(s) == 'table') or (type(s) == 'userdata') ) then
+      return tostring(s)
+    elseif type(s) == 'string' then
+      s = string.format('%q', s)
+      return s
+    end
+  end
+end
+
+
+UTILS.ToDegree = function(angle)
+  return angle*180/math.pi
+end
+
+UTILS.ToRadian = function(angle)
+  return angle*math.pi/180
+end
+
+UTILS.MetersToNM = function(meters)
+  return meters/1852
+end
+
+UTILS.MetersToFeet = function(meters)
+  return meters/0.3048
+end
+
+UTILS.NMToMeters = function(NM)
+  return NM*1852
+end
+
+UTILS.FeetToMeters = function(feet)
+  return feet*0.3048
+end
+
+UTILS.MpsToKnots = function(mps)
+  return mps*3600/1852
+end
+
+UTILS.MpsToKmph = function(mps)
+  return mps*3.6
+end
+
+UTILS.KnotsToMps = function(knots)
+  return knots*1852/3600
+end
+
+UTILS.KmphToMps = function(kmph)
+  return kmph/3.6
+end
+
+--[[acc:
+in DM: decimal point of minutes.
+In DMS: decimal point of seconds.
+position after the decimal of the least significant digit:
+So:
+42.32 - acc of 2.
+]]
+UTILS.tostringLL = function( lat, lon, acc, DMS)
+
+  local latHemi, lonHemi
+  if lat > 0 then
+    latHemi = 'N'
+  else
+    latHemi = 'S'
+  end
+
+  if lon > 0 then
+    lonHemi = 'E'
+  else
+    lonHemi = 'W'
+  end
+
+  lat = math.abs(lat)
+  lon = math.abs(lon)
+
+  local latDeg = math.floor(lat)
+  local latMin = (lat - latDeg)*60
+
+  local lonDeg = math.floor(lon)
+  local lonMin = (lon - lonDeg)*60
+
+  if DMS then  -- degrees, minutes, and seconds.
+    local oldLatMin = latMin
+    latMin = math.floor(latMin)
+    local latSec = UTILS.Round((oldLatMin - latMin)*60, acc)
+
+    local oldLonMin = lonMin
+    lonMin = math.floor(lonMin)
+    local lonSec = UTILS.Round((oldLonMin - lonMin)*60, acc)
+
+    if latSec == 60 then
+      latSec = 0
+      latMin = latMin + 1
+    end
+
+    if lonSec == 60 then
+      lonSec = 0
+      lonMin = lonMin + 1
+    end
+
+    local secFrmtStr -- create the formatting string for the seconds place
+    if acc <= 0 then  -- no decimal place.
+      secFrmtStr = '%02d'
+    else
+      local width = 3 + acc  -- 01.310 - that's a width of 6, for example.
+      secFrmtStr = '%0' .. width .. '.' .. acc .. 'f'
+    end
+
+    return string.format('%02d', latDeg) .. ' ' .. string.format('%02d', latMin) .. '\' ' .. string.format(secFrmtStr, latSec) .. '"' .. latHemi .. '   '
+           .. string.format('%02d', lonDeg) .. ' ' .. string.format('%02d', lonMin) .. '\' ' .. string.format(secFrmtStr, lonSec) .. '"' .. lonHemi
+
+  else  -- degrees, decimal minutes.
+    latMin = UTILS.Round(latMin, acc)
+    lonMin = UTILS.Round(lonMin, acc)
+
+    if latMin == 60 then
+      latMin = 0
+      latDeg = latDeg + 1
+    end
+
+    if lonMin == 60 then
+      lonMin = 0
+      lonDeg = lonDeg + 1
+    end
+
+    local minFrmtStr -- create the formatting string for the minutes place
+    if acc <= 0 then  -- no decimal place.
+      minFrmtStr = '%02d'
+    else
+      local width = 3 + acc  -- 01.310 - that's a width of 6, for example.
+      minFrmtStr = '%0' .. width .. '.' .. acc .. 'f'
+    end
+
+    return string.format('%02d', latDeg) .. ' ' .. string.format(minFrmtStr, latMin) .. '\'' .. latHemi .. '   '
+     .. string.format('%02d', lonDeg) .. ' ' .. string.format(minFrmtStr, lonMin) .. '\'' .. lonHemi
+
+  end
+end
+
+
+--- From http://lua-users.org/wiki/SimpleRound
+-- use negative idp for rounding ahead of decimal place, positive for rounding after decimal place
+function UTILS.Round( num, idp )
+  local mult = 10 ^ ( idp or 0 )
+  return math.floor( num * mult + 0.5 ) / mult
+end
+
+-- porting in Slmod's dostring
+function UTILS.DoString( s )
+  local f, err = loadstring( s )
+  if f then
+    return true, f()
+  else
+    return false, err
+  end
+end

Moose Development/Moose/Wrapper/Airbase.lua

@@ -0,0 +1,109 @@
+--- This module contains the AIRBASE classes.
+-- 
+-- ===
+-- 
+-- 1) @{Airbase#AIRBASE} class, extends @{Positionable#POSITIONABLE}
+-- =================================================================
+-- The @{AIRBASE} class is a wrapper class to handle the DCS Airbase objects:
+-- 
+--  * Support all DCS Airbase APIs.
+--  * Enhance with Airbase specific APIs not in the DCS Airbase API set.
+--  
+--  
+-- 1.1) AIRBASE reference methods
+-- ------------------------------ 
+-- For each DCS Airbase object alive within a running mission, a AIRBASE wrapper object (instance) will be created within the _@{DATABASE} object.
+-- This is done at the beginning of the mission (when the mission starts).
+--  
+-- The AIRBASE class **does not contain a :New()** method, rather it provides **:Find()** methods to retrieve the object reference
+-- using the DCS Airbase or the DCS AirbaseName.
+-- 
+-- Another thing to know is that AIRBASE objects do not "contain" the DCS Airbase object. 
+-- The AIRBASE methods will reference the DCS Airbase object by name when it is needed during API execution.
+-- If the DCS Airbase object does not exist or is nil, the AIRBASE methods will return nil and log an exception in the DCS.log file.
+--  
+-- The AIRBASE class provides the following functions to retrieve quickly the relevant AIRBASE instance:
+-- 
+--  * @{#AIRBASE.Find}(): Find a AIRBASE instance from the _DATABASE object using a DCS Airbase object.
+--  * @{#AIRBASE.FindByName}(): Find a AIRBASE instance from the _DATABASE object using a DCS Airbase name.
+--  
+-- IMPORTANT: ONE SHOULD NEVER SANATIZE these AIRBASE OBJECT REFERENCES! (make the AIRBASE object references nil).
+-- 
+-- 1.2) DCS AIRBASE APIs
+-- ---------------------
+-- The DCS Airbase APIs are used extensively within MOOSE. The AIRBASE class has for each DCS Airbase API a corresponding method.
+-- To be able to distinguish easily in your code the difference between a AIRBASE API call and a DCS Airbase API call,
+-- the first letter of the method is also capitalized. So, by example, the DCS Airbase method @{DCSWrapper.Airbase#Airbase.getName}()
+-- is implemented in the AIRBASE class as @{#AIRBASE.GetName}().
+-- 
+-- More functions will be added
+-- ----------------------------
+-- During the MOOSE development, more functions will be added. 
+-- 
+-- @module Airbase
+-- @author FlightControl
+
+
+
+
+
+--- The AIRBASE class
+-- @type AIRBASE
+-- @extends Wrapper.Positionable#POSITIONABLE
+AIRBASE = {
+  ClassName="AIRBASE",
+  CategoryName = { 
+    [Airbase.Category.AIRDROME]   = "Airdrome",
+    [Airbase.Category.HELIPAD]    = "Helipad",
+    [Airbase.Category.SHIP]       = "Ship",
+    },
+  }
+
+-- Registration.
+  
+--- Create a new AIRBASE from DCSAirbase.
+-- @param #AIRBASE self
+-- @param #string AirbaseName The name of the airbase.
+-- @return Wrapper.Airbase#AIRBASE
+function AIRBASE:Register( AirbaseName )
+
+  local self = BASE:Inherit( self, POSITIONABLE:New( AirbaseName ) )
+  self.AirbaseName = AirbaseName
+  return self
+end
+
+-- Reference methods.
+
+--- Finds a AIRBASE from the _DATABASE using a DCSAirbase object.
+-- @param #AIRBASE self
+-- @param Dcs.DCSWrapper.Airbase#Airbase DCSAirbase An existing DCS Airbase object reference.
+-- @return Wrapper.Airbase#AIRBASE self
+function AIRBASE:Find( DCSAirbase )
+
+  local AirbaseName = DCSAirbase:getName()
+  local AirbaseFound = _DATABASE:FindAirbase( AirbaseName )
+  return AirbaseFound
+end
+
+--- Find a AIRBASE in the _DATABASE using the name of an existing DCS Airbase.
+-- @param #AIRBASE self
+-- @param #string AirbaseName The Airbase Name.
+-- @return Wrapper.Airbase#AIRBASE self
+function AIRBASE:FindByName( AirbaseName )
+  
+  local AirbaseFound = _DATABASE:FindAirbase( AirbaseName )
+  return AirbaseFound
+end
+
+function AIRBASE:GetDCSObject()
+  local DCSAirbase = Airbase.getByName( self.AirbaseName )
+  
+  if DCSAirbase then
+    return DCSAirbase
+  end
+    
+  return nil
+end
+
+
+

Moose Development/Moose/Wrapper/Client.lua

@@ -1,10 +1,10 @@
---- The CLIENT models client units in multi player missions.
+--- This module contains the CLIENT class.
 -- 
--- @{#CLIENT} class
--- ================
+-- 1) @{Client#CLIENT} class, extends @{Unit#UNIT}
+-- ===============================================
 -- Clients are those **Units** defined within the Mission Editor that have the skillset defined as __Client__ or __Player__.
 -- Note that clients are NOT the same as Units, they are NOT necessarily alive.
--- The @{CLIENT} class is a wrapper class to handle the DCS Unit objects that have the skillset defined as __Client__ or __Player__:
+-- The @{Client#CLIENT} class is a wrapper class to handle the DCS Unit objects that have the skillset defined as __Client__ or __Player__:
 -- 
 --  * Wraps the DCS Unit objects with skill level set to Player or Client.
 --  * Support all DCS Unit APIs.
@@ -15,8 +15,8 @@
 -- 
 -- Clients are being used by the @{MISSION} class to follow players and register their successes.
 --  
--- CLIENT reference methods
--- ======================= 
+-- 1.1) CLIENT reference methods
+-- -----------------------------
 -- For each DCS Unit having skill level Player or Client, a CLIENT wrapper object (instance) will be created within the _@{DATABASE} object.
 -- This is done at the beginning of the mission (when the mission starts).
 --  
@@ -35,17 +35,10 @@
 -- IMPORTANT: ONE SHOULD NEVER SANATIZE these CLIENT OBJECT REFERENCES! (make the CLIENT object references nil).
 -- 
 -- @module Client
--- @author FlightControl
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Cargo" )
-Include.File( "Message" )
-
 
 --- The CLIENT class
 -- @type CLIENT
--- @extends Unit#UNIT
+-- @extends Wrapper.Unit#UNIT
 CLIENT = {
 	ONBOARDSIDE = {
 		NONE = 0,
@@ -98,6 +91,7 @@ end
 -- @param #CLIENT self
 -- @param #string ClientName Name of the DCS **Unit** as defined within the Mission Editor.
 -- @param #string ClientBriefing Text that describes the briefing of the mission when a Player logs into the Client.
+-- @param #boolean Error A flag that indicates whether an error should be raised if the CLIENT cannot be found. By default an error will be raised.
 -- @return #CLIENT
 -- @usage
 -- -- Create new Clients.
@@ -108,7 +102,7 @@ end
 --	Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 3' ):Transport() )
 --	Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*HOT-Deploy Troops 2' ):Transport() )
 --	Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 4' ):Transport() )
-function CLIENT:FindByName( ClientName, ClientBriefing )
+function CLIENT:FindByName( ClientName, ClientBriefing, Error )
   local ClientFound = _DATABASE:FindClient( ClientName )
 
   if ClientFound then
@@ -119,7 +113,9 @@ function CLIENT:FindByName( ClientName, ClientBriefing )
   	return ClientFound
   end
   
-  error( "CLIENT not found for: " .. ClientName )
+  if not Error then
+    error( "CLIENT not found for: " .. ClientName )
+  end
 end
 
 function CLIENT:Register( ClientName )
@@ -130,8 +126,10 @@ function CLIENT:Register( ClientName )
   self.MessageSwitch = true
   self.ClientAlive2 = false
   
-  self.AliveCheckScheduler = routines.scheduleFunction( self._AliveCheckScheduler, { self }, timer.getTime() + 1, 5 )
+  --self.AliveCheckScheduler = routines.scheduleFunction( self._AliveCheckScheduler, { self }, timer.getTime() + 1, 5 )
+  self.AliveCheckScheduler = SCHEDULER:New( self, self._AliveCheckScheduler, { "Client Alive " .. ClientName }, 1, 5 )
 
+  self:E( self )
   return self
 end
 
@@ -158,7 +156,7 @@ function CLIENT:AddBriefing( ClientBriefing )
   return self
 end
 
---- Show the briefing of the MISSION to the CLIENT.
+--- Show the briefing of a CLIENT.
 -- @param #CLIENT self
 -- @return #CLIENT self
 function CLIENT:ShowBriefing()
@@ -167,14 +165,25 @@ function CLIENT:ShowBriefing()
   if not self.ClientBriefingShown then
     self.ClientBriefingShown = true
     local Briefing = ""
-    if self.MissionBriefing then
-      Briefing = Briefing .. self.MissionBriefing 
-    end
     if self.ClientBriefing then
-      Briefing = Briefing .. "\n" .. self.ClientBriefing
+      Briefing = Briefing .. self.ClientBriefing
     end
-    Briefing = Briefing .. "\nPress [LEFT ALT]+[B] to view the complete mission briefing."
-    self:Message( Briefing, 30,  self.ClientName .. '/MissionBriefing', "Briefing" )
+    Briefing = Briefing .. " Press [LEFT ALT]+[B] to view the complete mission briefing."
+    self:Message( Briefing, 60, "Briefing" )
+  end
+
+  return self
+end
+
+--- Show the mission briefing of a MISSION to the CLIENT.
+-- @param #CLIENT self
+-- @param #string MissionBriefing
+-- @return #CLIENT self
+function CLIENT:ShowMissionBriefing( MissionBriefing )
+  self:F( { self.ClientName } )
+
+  if MissionBriefing then
+    self:Message( MissionBriefing, 60, "Mission Briefing" )
   end
 
   return self
@@ -216,22 +225,22 @@ end
 
 --- Checks for a client alive event and calls a function on a continuous basis.
 -- @param #CLIENT self
--- @param #function CallBack Function.
+-- @param #function CallBackFunction Create a function that will be called when a player joins the slot.
 -- @return #CLIENT
-function CLIENT:Alive( CallBack, ... )
+function CLIENT:Alive( CallBackFunction, ... )
   self:F()
   
-  self.ClientCallBack = CallBack
+  self.ClientCallBack = CallBackFunction
   self.ClientParameters = arg
 
   return self
 end
 
 --- @param #CLIENT self
-function CLIENT:_AliveCheckScheduler()
-  self:F( { self.ClientName, self.ClientAlive2, self.ClientBriefingShown } )
+function CLIENT:_AliveCheckScheduler( SchedulerName )
+  self:F3( { SchedulerName, self.ClientName, self.ClientAlive2, self.ClientBriefingShown, self.ClientCallBack } )
 
-  if self:IsAlive() then -- Polymorphic call of UNIT
+  if self:IsAlive() then 
     if self.ClientAlive2 == false then
       self:ShowBriefing()
       if self.ClientCallBack then
@@ -245,12 +254,14 @@ function CLIENT:_AliveCheckScheduler()
       self.ClientAlive2 = false
     end
   end
+  
+  return true
 end
 
 --- Return the DCSGroup of a Client.
 -- This function is modified to deal with a couple of bugs in DCS 1.5.3
 -- @param #CLIENT self
--- @return DCSGroup#Group
+-- @return Dcs.DCSWrapper.Group#Group
 function CLIENT:GetDCSGroup()
   self:F3()
 
@@ -324,10 +335,10 @@ function CLIENT:GetDCSGroup()
 end 
 
 
--- TODO: Check DCSTypes#Group.ID
+-- TODO: Check Dcs.DCSTypes#Group.ID
 --- Get the group ID of the client.
 -- @param #CLIENT self
--- @return DCSTypes#Group.ID
+-- @return Dcs.DCSTypes#Group.ID
 function CLIENT:GetClientGroupID()
 
   local ClientGroup = self:GetDCSGroup()
@@ -350,7 +361,7 @@ end
 
 --- Returns the UNIT of the CLIENT.
 -- @param #CLIENT self
--- @return Unit#UNIT
+-- @return Wrapper.Unit#UNIT
 function CLIENT:GetClientGroupUnit()
 	self:F2()
 
@@ -366,7 +377,7 @@ end
 
 --- Returns the DCSUnit of the CLIENT.
 -- @param #CLIENT self
--- @return DCSTypes#Unit
+-- @return Dcs.DCSTypes#Unit
 function CLIENT:GetClientGroupDCSUnit()
 	self:F2()
 
@@ -387,8 +398,8 @@ function CLIENT:IsTransport()
 	return self.ClientTransport
 end
 
---- Shows the @{Cargo#CARGO} contained within the CLIENT to the player as a message.
--- The @{Cargo#CARGO} is shown using the @{Message#MESSAGE} distribution system.
+--- Shows the @{AI_Cargo#CARGO} contained within the CLIENT to the player as a message.
+-- The @{AI_Cargo#CARGO} is shown using the @{Message#MESSAGE} distribution system.
 -- @param #CLIENT self
 function CLIENT:ShowCargo()
 	self:F()
@@ -405,7 +416,7 @@ function CLIENT:ShowCargo()
 		CargoMsg = "empty"
 	end
   
-	self:Message( CargoMsg, 15, self.ClientName .. "/Cargo", "Co-Pilot: Cargo Status", 30 )
+	self:Message( CargoMsg, 15, "Co-Pilot: Cargo Status", 30 )
 
 end
 
@@ -420,47 +431,43 @@ end
 -- @param #CLIENT self
 -- @param #string Message is the text describing the message.
 -- @param #number MessageDuration is the duration in seconds that the Message should be displayed.
--- @param #string MessageId is a text identifying the Message in the MessageQueue. The Message system overwrites Messages with the same MessageId
 -- @param #string MessageCategory is the category of the message (the title).
 -- @param #number MessageInterval is the interval in seconds between the display of the @{Message#MESSAGE} when the CLIENT is in the air.
-function CLIENT:Message( Message, MessageDuration, MessageId, MessageCategory, MessageInterval )
-	self:F( { Message, MessageDuration, MessageId, MessageCategory, MessageInterval } )
-
-	if not self.MenuMessages then
-		if self:GetClientGroupID() then
-			self.MenuMessages = MENU_CLIENT:New( self, 'Messages' )
-			self.MenuRouteMessageOn = MENU_CLIENT_COMMAND:New( self, 'Messages On', self.MenuMessages, CLIENT.SwitchMessages, { self, true } )
-			self.MenuRouteMessageOff = MENU_CLIENT_COMMAND:New( self,'Messages Off', self.MenuMessages, CLIENT.SwitchMessages, { self, false } )
-		end
-	end
+-- @param #string MessageID is the identifier of the message when displayed with intervals.
+function CLIENT:Message( Message, MessageDuration, MessageCategory, MessageInterval, MessageID )
+	self:F( { Message, MessageDuration, MessageCategory, MessageInterval } )
 
 	if self.MessageSwitch == true then
 		if MessageCategory == nil then
 			MessageCategory = "Messages"
 		end
-		if self.Messages[MessageId] == nil then
-			self.Messages[MessageId] = {}
-			self.Messages[MessageId].MessageId = MessageId
-			self.Messages[MessageId].MessageTime = timer.getTime()
-			self.Messages[MessageId].MessageDuration = MessageDuration
-			if MessageInterval == nil then
-				self.Messages[MessageId].MessageInterval = 600
-			else
-				self.Messages[MessageId].MessageInterval = MessageInterval
-			end
-			MESSAGE:New( Message, MessageCategory, MessageDuration, MessageId ):ToClient( self )
+		if MessageID ~= nil then
+  		if self.Messages[MessageID] == nil then
+  			self.Messages[MessageID] = {}
+  			self.Messages[MessageID].MessageId = MessageID
+  			self.Messages[MessageID].MessageTime = timer.getTime()
+  			self.Messages[MessageID].MessageDuration = MessageDuration
+  			if MessageInterval == nil then
+  				self.Messages[MessageID].MessageInterval = 600
+  			else
+  				self.Messages[MessageID].MessageInterval = MessageInterval
+  			end
+  			MESSAGE:New( Message, MessageDuration, MessageCategory ):ToClient( self )
+  		else
+  			if self:GetClientGroupDCSUnit() and not self:GetClientGroupDCSUnit():inAir() then
+  				if timer.getTime() - self.Messages[MessageID].MessageTime >= self.Messages[MessageID].MessageDuration + 10 then
+  					MESSAGE:New( Message, MessageDuration , MessageCategory):ToClient( self )
+  					self.Messages[MessageID].MessageTime = timer.getTime()
+  				end
+  			else
+  				if timer.getTime() - self.Messages[MessageID].MessageTime  >= self.Messages[MessageID].MessageDuration + self.Messages[MessageID].MessageInterval then
+  					MESSAGE:New( Message, MessageDuration, MessageCategory ):ToClient( self )
+  					self.Messages[MessageID].MessageTime = timer.getTime()
+  				end
+  			end
+  		end
 		else
-			if self:GetClientGroupDCSUnit() and not self:GetClientGroupDCSUnit():inAir() then
-				if timer.getTime() - self.Messages[MessageId].MessageTime >= self.Messages[MessageId].MessageDuration + 10 then
-					MESSAGE:New( Message, MessageCategory, MessageDuration, MessageId ):ToClient( self )
-					self.Messages[MessageId].MessageTime = timer.getTime()
-				end
-			else
-				if timer.getTime() - self.Messages[MessageId].MessageTime  >= self.Messages[MessageId].MessageDuration + self.Messages[MessageId].MessageInterval then
-					MESSAGE:New( Message, MessageCategory, MessageDuration, MessageId ):ToClient( self )
-					self.Messages[MessageId].MessageTime = timer.getTime()
-				end
-			end
-		end
+      MESSAGE:New( Message, MessageDuration, MessageCategory ):ToClient( self )
+    end
 	end
 end

Moose Development/Moose/Wrapper/Group.lua

@@ -0,0 +1,954 @@
+--- This module contains the GROUP class.
+-- 
+-- 1) @{Group#GROUP} class, extends @{Controllable#CONTROLLABLE}
+-- =============================================================
+-- The @{Group#GROUP} class is a wrapper class to handle the DCS Group objects:
+--
+--  * Support all DCS Group APIs.
+--  * Enhance with Group specific APIs not in the DCS Group API set.
+--  * Handle local Group Controller.
+--  * Manage the "state" of the DCS Group.
+--
+-- **IMPORTANT: ONE SHOULD NEVER SANATIZE these GROUP OBJECT REFERENCES! (make the GROUP object references nil).**
+--
+-- 1.1) GROUP reference methods
+-- -----------------------
+-- For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _@{DATABASE} object.
+-- This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Group objects are spawned (using the @{SPAWN} class).
+--
+-- The GROUP class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference
+-- using the DCS Group or the DCS GroupName.
+--
+-- Another thing to know is that GROUP objects do not "contain" the DCS Group object.
+-- The GROUP methods will reference the DCS Group object by name when it is needed during API execution.
+-- If the DCS Group object does not exist or is nil, the GROUP methods will return nil and log an exception in the DCS.log file.
+--
+-- The GROUP class provides the following functions to retrieve quickly the relevant GROUP instance:
+--
+--  * @{#GROUP.Find}(): Find a GROUP instance from the _DATABASE object using a DCS Group object.
+--  * @{#GROUP.FindByName}(): Find a GROUP instance from the _DATABASE object using a DCS Group name.
+--
+-- ## 1.2) GROUP task methods
+--
+-- A GROUP is a @{Controllable}. See the @{Controllable} task methods section for a description of the task methods.
+--
+-- ### 1.2.4) Obtain the mission from group templates
+-- 
+-- Group templates contain complete mission descriptions. Sometimes you want to copy a complete mission from a group and assign it to another:
+-- 
+--   * @{Controllable#CONTROLLABLE.TaskMission}: (AIR + GROUND) Return a mission task from a mission template.
+--
+-- ## 1.3) GROUP Command methods
+--
+-- A GROUP is a @{Controllable}. See the @{Controllable} command methods section for a description of the command methods.
+-- 
+-- ## 1.4) GROUP option methods
+--
+-- A GROUP is a @{Controllable}. See the @{Controllable} option methods section for a description of the option methods.
+-- 
+-- ## 1.5) GROUP Zone validation methods
+-- 
+-- The group can be validated whether it is completely, partly or not within a @{Zone}.
+-- Use the following Zone validation methods on the group:
+-- 
+--   * @{#GROUP.IsCompletelyInZone}: Returns true if all units of the group are within a @{Zone}.
+--   * @{#GROUP.IsPartlyInZone}: Returns true if some units of the group are within a @{Zone}.
+--   * @{#GROUP.IsNotInZone}: Returns true if none of the group units of the group are within a @{Zone}.
+--   
+-- The zone can be of any @{Zone} class derived from @{Zone#ZONE_BASE}. So, these methods are polymorphic to the zones tested on.
+-- 
+-- ## 1.6) GROUP AI methods
+-- 
+-- A GROUP has AI methods to control the AI activation.
+-- 
+--   * @{#GROUP.SetAIOnOff}(): Turns the GROUP AI On or Off.
+--   * @{#GROUP.SetAIOn}(): Turns the GROUP AI On.
+--   * @{#GROUP.SetAIOff}(): Turns the GROUP AI Off.
+--   
+-- ====
+-- 
+-- # **API CHANGE HISTORY**
+-- 
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+-- 
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+-- 
+-- Hereby the change log:
+-- 
+-- 2017-03-07: GROUP:**HandleEvent( Event, EventFunction )** added.  
+-- 2017-03-07: GROUP:**UnHandleEvent( Event )** added.
+-- 
+-- 2017-01-24: GROUP:**SetAIOnOff( AIOnOff )** added.  
+-- 
+-- 2017-01-24: GROUP:**SetAIOn()** added.  
+-- 
+-- 2017-01-24: GROUP:**SetAIOff()** added.  
+-- 
+-- ===
+-- 
+-- # **AUTHORS and CONTRIBUTIONS**
+-- 
+-- ### Contributions: 
+-- 
+--   * [**Entropy**](https://forums.eagle.ru/member.php?u=111471), **Afinegan**: Came up with the requirement for AIOnOff().
+-- 
+-- ### Authors: 
+-- 
+--   * **FlightControl**: Design & Programming
+-- 
+-- @module Group
+-- @author FlightControl
+
+--- The GROUP class
+-- @type GROUP
+-- @extends Wrapper.Controllable#CONTROLLABLE
+-- @field #string GroupName The name of the group.
+GROUP = {
+  ClassName = "GROUP",
+}
+
+--- Create a new GROUP from a DCSGroup
+-- @param #GROUP self
+-- @param Dcs.DCSWrapper.Group#Group GroupName The DCS Group name
+-- @return #GROUP self
+function GROUP:Register( GroupName )
+  self = BASE:Inherit( self, CONTROLLABLE:New( GroupName ) )
+  self:F2( GroupName )
+  self.GroupName = GroupName
+  
+  self:SetEventPriority( 4 )
+  return self
+end
+
+-- Reference methods.
+
+--- Find the GROUP wrapper class instance using the DCS Group.
+-- @param #GROUP self
+-- @param Dcs.DCSWrapper.Group#Group DCSGroup The DCS Group.
+-- @return #GROUP The GROUP.
+function GROUP:Find( DCSGroup )
+
+  local GroupName = DCSGroup:getName() -- Wrapper.Group#GROUP
+  local GroupFound = _DATABASE:FindGroup( GroupName )
+  return GroupFound
+end
+
+--- Find the created GROUP using the DCS Group Name.
+-- @param #GROUP self
+-- @param #string GroupName The DCS Group Name.
+-- @return #GROUP The GROUP.
+function GROUP:FindByName( GroupName )
+
+  local GroupFound = _DATABASE:FindGroup( GroupName )
+  return GroupFound
+end
+
+-- DCS Group methods support.
+
+--- Returns the DCS Group.
+-- @param #GROUP self
+-- @return Dcs.DCSWrapper.Group#Group The DCS Group.
+function GROUP:GetDCSObject()
+  local DCSGroup = Group.getByName( self.GroupName )
+
+  if DCSGroup then
+    return DCSGroup
+  end
+
+  return nil
+end
+
+--- Returns the @{DCSTypes#Position3} position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return Dcs.DCSTypes#Position The 3D position vectors of the POSITIONABLE.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function GROUP:GetPositionVec3() -- Overridden from POSITIONABLE:GetPositionVec3()
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local PositionablePosition = DCSPositionable:getUnits()[1]:getPosition().p
+    self:T3( PositionablePosition )
+    return PositionablePosition
+  end
+  
+  return nil
+end
+
+--- Returns if the DCS Group is alive.
+-- When the group exists at run-time, this method will return true, otherwise false.
+-- @param #GROUP self
+-- @return #boolean true if the DCS Group is alive.
+function GROUP:IsAlive()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupIsAlive = DCSGroup:isExist() and DCSGroup:getUnit(1) ~= nil
+    self:T3( GroupIsAlive )
+    return GroupIsAlive
+  end
+
+  return nil
+end
+
+--- Destroys the DCS Group and all of its DCS Units.
+-- Note that this destroy method also raises a destroy event at run-time.
+-- So all event listeners will catch the destroy event of this DCS Group.
+-- @param #GROUP self
+function GROUP:Destroy()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    for Index, UnitData in pairs( DCSGroup:getUnits() ) do
+      self:CreateEventCrash( timer.getTime(), UnitData )
+    end
+    DCSGroup:destroy()
+    DCSGroup = nil
+  end
+
+  return nil
+end
+
+--- Returns category of the DCS Group.
+-- @param #GROUP self
+-- @return Dcs.DCSWrapper.Group#Group.Category The category ID
+function GROUP:GetCategory()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+  if DCSGroup then
+    local GroupCategory = DCSGroup:getCategory()
+    self:T3( GroupCategory )
+    return GroupCategory
+  end
+
+  return nil
+end
+
+--- Returns the category name of the #GROUP.
+-- @param #GROUP self
+-- @return #string Category name = Helicopter, Airplane, Ground Unit, Ship
+function GROUP:GetCategoryName()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+  if DCSGroup then
+    local CategoryNames = {
+      [Group.Category.AIRPLANE] = "Airplane",
+      [Group.Category.HELICOPTER] = "Helicopter",
+      [Group.Category.GROUND] = "Ground Unit",
+      [Group.Category.SHIP] = "Ship",
+    }
+    local GroupCategory = DCSGroup:getCategory()
+    self:T3( GroupCategory )
+
+    return CategoryNames[GroupCategory]
+  end
+
+  return nil
+end
+
+
+--- Returns the coalition of the DCS Group.
+-- @param #GROUP self
+-- @return Dcs.DCSCoalitionWrapper.Object#coalition.side The coalition side of the DCS Group.
+function GROUP:GetCoalition()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+  if DCSGroup then
+    local GroupCoalition = DCSGroup:getCoalition()
+    self:T3( GroupCoalition )
+    return GroupCoalition
+  end
+
+  return nil
+end
+
+--- Returns the country of the DCS Group.
+-- @param #GROUP self
+-- @return Dcs.DCScountry#country.id The country identifier.
+-- @return #nil The DCS Group is not existing or alive.
+function GROUP:GetCountry()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+  if DCSGroup then
+    local GroupCountry = DCSGroup:getUnit(1):getCountry()
+    self:T3( GroupCountry )
+    return GroupCountry
+  end
+
+  return nil
+end
+
+--- Returns the UNIT wrapper class with number UnitNumber.
+-- If the underlying DCS Unit does not exist, the method will return nil. .
+-- @param #GROUP self
+-- @param #number UnitNumber The number of the UNIT wrapper class to be returned.
+-- @return Wrapper.Unit#UNIT The UNIT wrapper class.
+function GROUP:GetUnit( UnitNumber )
+  self:F2( { self.GroupName, UnitNumber } )
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local UnitFound = UNIT:Find( DCSGroup:getUnit( UnitNumber ) )
+    self:T2( UnitFound )
+    return UnitFound
+  end
+
+  return nil
+end
+
+--- Returns the DCS Unit with number UnitNumber.
+-- If the underlying DCS Unit does not exist, the method will return nil. .
+-- @param #GROUP self
+-- @param #number UnitNumber The number of the DCS Unit to be returned.
+-- @return Dcs.DCSWrapper.Unit#Unit The DCS Unit.
+function GROUP:GetDCSUnit( UnitNumber )
+  self:F2( { self.GroupName, UnitNumber } )
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local DCSUnitFound = DCSGroup:getUnit( UnitNumber )
+    self:T3( DCSUnitFound )
+    return DCSUnitFound
+  end
+
+  return nil
+end
+
+--- Returns current size of the DCS Group.
+-- If some of the DCS Units of the DCS Group are destroyed the size of the DCS Group is changed.
+-- @param #GROUP self
+-- @return #number The DCS Group size.
+function GROUP:GetSize()
+  self:F2( { self.GroupName } )
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupSize = DCSGroup:getSize()
+    self:T3( GroupSize )
+    return GroupSize
+  end
+
+  return nil
+end
+
+---
+--- Returns the initial size of the DCS Group.
+-- If some of the DCS Units of the DCS Group are destroyed, the initial size of the DCS Group is unchanged.
+-- @param #GROUP self
+-- @return #number The DCS Group initial size.
+function GROUP:GetInitialSize()
+  self:F2( { self.GroupName } )
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupInitialSize = DCSGroup:getInitialSize()
+    self:T3( GroupInitialSize )
+    return GroupInitialSize
+  end
+
+  return nil
+end
+
+
+--- Returns the DCS Units of the DCS Group.
+-- @param #GROUP self
+-- @return #table The DCS Units.
+function GROUP:GetDCSUnits()
+  self:F2( { self.GroupName } )
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local DCSUnits = DCSGroup:getUnits()
+    self:T3( DCSUnits )
+    return DCSUnits
+  end
+
+  return nil
+end
+
+
+--- Activates a GROUP.
+-- @param #GROUP self
+function GROUP:Activate()
+  self:F2( { self.GroupName } )
+  trigger.action.activateGroup( self:GetDCSObject() )
+  return self:GetDCSObject()
+end
+
+
+--- Gets the type name of the group.
+-- @param #GROUP self
+-- @return #string The type name of the group.
+function GROUP:GetTypeName()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupTypeName = DCSGroup:getUnit(1):getTypeName()
+    self:T3( GroupTypeName )
+    return( GroupTypeName )
+  end
+
+  return nil
+end
+
+--- Gets the CallSign of the first DCS Unit of the DCS Group.
+-- @param #GROUP self
+-- @return #string The CallSign of the first DCS Unit of the DCS Group.
+function GROUP:GetCallsign()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupCallSign = DCSGroup:getUnit(1):getCallsign()
+    self:T3( GroupCallSign )
+    return GroupCallSign
+  end
+
+  return nil
+end
+
+--- Returns the current point (Vec2 vector) of the first DCS Unit in the DCS Group.
+-- @param #GROUP self
+-- @return Dcs.DCSTypes#Vec2 Current Vec2 point of the first DCS Unit of the DCS Group.
+function GROUP:GetVec2()
+  self:F2( self.GroupName )
+
+  local UnitPoint = self:GetUnit(1)
+  UnitPoint:GetVec2()
+  local GroupPointVec2 = UnitPoint:GetVec2()
+  self:T3( GroupPointVec2 )
+  return GroupPointVec2
+end
+
+--- Returns the current Vec3 vector of the first DCS Unit in the GROUP.
+-- @return Dcs.DCSTypes#Vec3 Current Vec3 of the first DCS Unit of the GROUP.
+function GROUP:GetVec3()
+  self:F2( self.GroupName )
+
+  local GroupVec3 = self:GetUnit(1):GetVec3()
+  self:T3( GroupVec3 )
+  return GroupVec3
+end
+
+
+
+do -- Is Zone methods
+
+--- Returns true if all units of the group are within a @{Zone}.
+-- @param #GROUP self
+-- @param Core.Zone#ZONE_BASE Zone The zone to test.
+-- @return #boolean Returns true if the Group is completely within the @{Zone#ZONE_BASE}
+function GROUP:IsCompletelyInZone( Zone )
+  self:F2( { self.GroupName, Zone } )
+  
+  for UnitID, UnitData in pairs( self:GetUnits() ) do
+    local Unit = UnitData -- Wrapper.Unit#UNIT
+    if Zone:IsVec3InZone( Unit:GetVec3() ) then
+    else
+      return false
+    end
+  end
+  
+  return true
+end
+
+--- Returns true if some units of the group are within a @{Zone}.
+-- @param #GROUP self
+-- @param Core.Zone#ZONE_BASE Zone The zone to test.
+-- @return #boolean Returns true if the Group is completely within the @{Zone#ZONE_BASE}
+function GROUP:IsPartlyInZone( Zone )
+  self:F2( { self.GroupName, Zone } )
+  
+  for UnitID, UnitData in pairs( self:GetUnits() ) do
+    local Unit = UnitData -- Wrapper.Unit#UNIT
+    if Zone:IsVec3InZone( Unit:GetVec3() ) then
+      return true
+    end
+  end
+  
+  return false
+end
+
+--- Returns true if none of the group units of the group are within a @{Zone}.
+-- @param #GROUP self
+-- @param Core.Zone#ZONE_BASE Zone The zone to test.
+-- @return #boolean Returns true if the Group is completely within the @{Zone#ZONE_BASE}
+function GROUP:IsNotInZone( Zone )
+  self:F2( { self.GroupName, Zone } )
+  
+  for UnitID, UnitData in pairs( self:GetUnits() ) do
+    local Unit = UnitData -- Wrapper.Unit#UNIT
+    if Zone:IsVec3InZone( Unit:GetVec3() ) then
+      return false
+    end
+  end
+  
+  return true
+end
+
+--- Returns if the group is of an air category.
+-- If the group is a helicopter or a plane, then this method will return true, otherwise false.
+-- @param #GROUP self
+-- @return #boolean Air category evaluation result.
+function GROUP:IsAir()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local IsAirResult = DCSGroup:getCategory() == Group.Category.AIRPLANE or DCSGroup:getCategory() == Group.Category.HELICOPTER
+    self:T3( IsAirResult )
+    return IsAirResult
+  end
+
+  return nil
+end
+
+--- Returns if the DCS Group contains Helicopters.
+-- @param #GROUP self
+-- @return #boolean true if DCS Group contains Helicopters.
+function GROUP:IsHelicopter()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupCategory = DCSGroup:getCategory()
+    self:T2( GroupCategory )
+    return GroupCategory == Group.Category.HELICOPTER
+  end
+
+  return nil
+end
+
+--- Returns if the DCS Group contains AirPlanes.
+-- @param #GROUP self
+-- @return #boolean true if DCS Group contains AirPlanes.
+function GROUP:IsAirPlane()
+  self:F2()
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupCategory = DCSGroup:getCategory()
+    self:T2( GroupCategory )
+    return GroupCategory == Group.Category.AIRPLANE
+  end
+
+  return nil
+end
+
+--- Returns if the DCS Group contains Ground troops.
+-- @param #GROUP self
+-- @return #boolean true if DCS Group contains Ground troops.
+function GROUP:IsGround()
+  self:F2()
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupCategory = DCSGroup:getCategory()
+    self:T2( GroupCategory )
+    return GroupCategory == Group.Category.GROUND
+  end
+
+  return nil
+end
+
+--- Returns if the DCS Group contains Ships.
+-- @param #GROUP self
+-- @return #boolean true if DCS Group contains Ships.
+function GROUP:IsShip()
+  self:F2()
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupCategory = DCSGroup:getCategory()
+    self:T2( GroupCategory )
+    return GroupCategory == Group.Category.SHIP
+  end
+
+  return nil
+end
+
+--- Returns if all units of the group are on the ground or landed.
+-- If all units of this group are on the ground, this function will return true, otherwise false.
+-- @param #GROUP self
+-- @return #boolean All units on the ground result.
+function GROUP:AllOnGround()
+  self:F2()
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local AllOnGroundResult = true
+
+    for Index, UnitData in pairs( DCSGroup:getUnits() ) do
+      if UnitData:inAir() then
+        AllOnGroundResult = false
+      end
+    end
+
+    self:T3( AllOnGroundResult )
+    return AllOnGroundResult
+  end
+
+  return nil
+end
+
+end
+
+do -- AI methods
+
+  --- Turns the AI On or Off for the GROUP.
+  -- @param #GROUP self
+  -- @param #boolean AIOnOff The value true turns the AI On, the value false turns the AI Off.
+  -- @return #GROUP The GROUP.
+  function GROUP:SetAIOnOff( AIOnOff )
+  
+    local DCSGroup = self:GetDCSObject() -- Dcs.DCSGroup#Group
+    
+    if DCSGroup then
+      local DCSController = DCSGroup:getController() -- Dcs.DCSController#Controller
+      if DCSController then
+        DCSController:setOnOff( AIOnOff )
+        return self
+      end
+    end
+    
+    return nil
+  end
+
+  --- Turns the AI On for the GROUP.
+  -- @param #GROUP self
+  -- @return #GROUP The GROUP.
+  function GROUP:SetAIOn()
+
+    return self:SetAIOnOff( true )  
+  end
+  
+  --- Turns the AI Off for the GROUP.
+  -- @param #GROUP self
+  -- @return #GROUP The GROUP.
+  function GROUP:SetAIOff()
+
+    return self:SetAIOnOff( false )  
+  end
+
+end
+
+
+
+--- Returns the current maximum velocity of the group.
+-- Each unit within the group gets evaluated, and the maximum velocity (= the unit which is going the fastest) is returned.
+-- @param #GROUP self
+-- @return #number Maximum velocity found.
+function GROUP:GetMaxVelocity()
+  self:F2()
+
+  local DCSGroup = self:GetDCSObject()
+
+  if DCSGroup then
+    local GroupVelocityMax = 0
+
+    for Index, UnitData in pairs( DCSGroup:getUnits() ) do
+
+      local UnitVelocityVec3 = UnitData:getVelocity()
+      local UnitVelocity = math.abs( UnitVelocityVec3.x ) + math.abs( UnitVelocityVec3.y ) + math.abs( UnitVelocityVec3.z )
+
+      if UnitVelocity > GroupVelocityMax then
+        GroupVelocityMax = UnitVelocity
+      end
+    end
+
+    return GroupVelocityMax
+  end
+
+  return nil
+end
+
+--- Returns the current minimum height of the group.
+-- Each unit within the group gets evaluated, and the minimum height (= the unit which is the lowest elevated) is returned.
+-- @param #GROUP self
+-- @return #number Minimum height found.
+function GROUP:GetMinHeight()
+  self:F2()
+
+end
+
+--- Returns the current maximum height of the group.
+-- Each unit within the group gets evaluated, and the maximum height (= the unit which is the highest elevated) is returned.
+-- @param #GROUP self
+-- @return #number Maximum height found.
+function GROUP:GetMaxHeight()
+  self:F2()
+
+end
+
+-- SPAWNING
+
+--- Respawn the @{GROUP} using a (tweaked) template of the Group.
+-- The template must be retrieved with the @{Group#GROUP.GetTemplate}() function.
+-- The template contains all the definitions as declared within the mission file.
+-- To understand templates, do the following: 
+-- 
+--   * unpack your .miz file into a directory using 7-zip.
+--   * browse in the directory created to the file **mission**.
+--   * open the file and search for the country group definitions.
+--   
+-- Your group template will contain the fields as described within the mission file.
+-- 
+-- This function will:
+-- 
+--  * Get the current position and heading of the group.
+--  * When the group is alive, it will tweak the template x, y and heading coordinates of the group and the embedded units to the current units positions.
+--  * Then it will destroy the current alive group.
+--  * And it will respawn the group using your new template definition.
+-- @param Wrapper.Group#GROUP self
+-- @param #table Template The template of the Group retrieved with GROUP:GetTemplate()
+function GROUP:Respawn( Template )
+
+  local Vec3 = self:GetVec3()
+  Template.x = Vec3.x
+  Template.y = Vec3.z
+  --Template.x = nil
+  --Template.y = nil
+  
+  self:E( #Template.units )
+  for UnitID, UnitData in pairs( self:GetUnits() ) do
+    local GroupUnit = UnitData -- Wrapper.Unit#UNIT
+    self:E( GroupUnit:GetName() )
+    if GroupUnit:IsAlive() then
+      local GroupUnitVec3 = GroupUnit:GetVec3()
+      local GroupUnitHeading = GroupUnit:GetHeading()
+      Template.units[UnitID].alt = GroupUnitVec3.y
+      Template.units[UnitID].x = GroupUnitVec3.x
+      Template.units[UnitID].y = GroupUnitVec3.z
+      Template.units[UnitID].heading = GroupUnitHeading
+      self:E( { UnitID, Template.units[UnitID], Template.units[UnitID] } )
+    end
+  end
+  
+  self:Destroy()
+  _DATABASE:Spawn( Template )
+end
+
+--- Returns the group template from the @{DATABASE} (_DATABASE object).
+-- @param #GROUP self
+-- @return #table 
+function GROUP:GetTemplate()
+  local GroupName = self:GetName()
+  self:E( GroupName )
+  return _DATABASE:GetGroupTemplate( GroupName )
+end
+
+--- Sets the controlled status in a Template.
+-- @param #GROUP self
+-- @param #boolean Controlled true is controlled, false is uncontrolled.
+-- @return #table 
+function GROUP:SetTemplateControlled( Template, Controlled )
+  Template.uncontrolled = not Controlled
+  return Template
+end
+
+--- Sets the CountryID of the group in a Template.
+-- @param #GROUP self
+-- @param Dcs.DCScountry#country.id CountryID The country ID.
+-- @return #table 
+function GROUP:SetTemplateCountry( Template, CountryID )
+  Template.CountryID = CountryID
+  return Template
+end
+
+--- Sets the CoalitionID of the group in a Template.
+-- @param #GROUP self
+-- @param Dcs.DCSCoalitionWrapper.Object#coalition.side CoalitionID The coalition ID.
+-- @return #table 
+function GROUP:SetTemplateCoalition( Template, CoalitionID )
+  Template.CoalitionID = CoalitionID
+  return Template
+end
+
+
+
+
+--- Return the mission template of the group.
+-- @param #GROUP self
+-- @return #table The MissionTemplate
+function GROUP:GetTaskMission()
+  self:F2( self.GroupName )
+
+  return routines.utils.deepCopy( _DATABASE.Templates.Groups[self.GroupName].Template )
+end
+
+--- Return the mission route of the group.
+-- @param #GROUP self
+-- @return #table The mission route defined by points.
+function GROUP:GetTaskRoute()
+  self:F2( self.GroupName )
+
+  return routines.utils.deepCopy( _DATABASE.Templates.Groups[self.GroupName].Template.route.points )
+end
+
+--- Return the route of a group by using the @{Database#DATABASE} class.
+-- @param #GROUP self
+-- @param #number Begin The route point from where the copy will start. The base route point is 0.
+-- @param #number End The route point where the copy will end. The End point is the last point - the End point. The last point has base 0.
+-- @param #boolean Randomize Randomization of the route, when true.
+-- @param #number Radius When randomization is on, the randomization is within the radius.
+function GROUP:CopyRoute( Begin, End, Randomize, Radius )
+  self:F2( { Begin, End } )
+
+  local Points = {}
+
+  -- Could be a Spawned Group
+  local GroupName = string.match( self:GetName(), ".*#" )
+  if GroupName then
+    GroupName = GroupName:sub( 1, -2 )
+  else
+    GroupName = self:GetName()
+  end
+
+  self:T3( { GroupName } )
+
+  local Template = _DATABASE.Templates.Groups[GroupName].Template
+
+  if Template then
+    if not Begin then
+      Begin = 0
+    end
+    if not End then
+      End = 0
+    end
+
+    for TPointID = Begin + 1, #Template.route.points - End do
+      if Template.route.points[TPointID] then
+        Points[#Points+1] = routines.utils.deepCopy( Template.route.points[TPointID] )
+        if Randomize then
+          if not Radius then
+            Radius = 500
+          end
+          Points[#Points].x = Points[#Points].x + math.random( Radius * -1, Radius )
+          Points[#Points].y = Points[#Points].y + math.random( Radius * -1, Radius )
+        end
+      end
+    end
+    return Points
+  else
+    error( "Template not found for Group : " .. GroupName )
+  end
+
+  return nil
+end
+
+--- Calculate the maxium A2G threat level of the Group.
+-- @param #GROUP self
+function GROUP:CalculateThreatLevelA2G()
+  
+  local MaxThreatLevelA2G = 0
+  for UnitName, UnitData in pairs( self:GetUnits() ) do
+    local ThreatUnit = UnitData -- Wrapper.Unit#UNIT
+    local ThreatLevelA2G = ThreatUnit:GetThreatLevel()
+    if ThreatLevelA2G > MaxThreatLevelA2G then
+      MaxThreatLevelA2G = ThreatLevelA2G
+    end
+  end
+
+  self:T3( MaxThreatLevelA2G )
+  return MaxThreatLevelA2G
+end
+
+--- Returns true if the first unit of the GROUP is in the air.
+-- @param Wrapper.Group#GROUP self
+-- @return #boolean true if in the first unit of the group is in the air.
+-- @return #nil The GROUP is not existing or not alive.  
+function GROUP:InAir()
+  self:F2( self.GroupName )
+
+  local DCSGroup = self:GetDCSObject()
+  
+  if DCSGroup then
+    local DCSUnit = DCSGroup:getUnit(1)
+    if DCSUnit then
+      local GroupInAir = DCSGroup:getUnit(1):inAir()
+      self:T3( GroupInAir )
+      return GroupInAir
+    end
+  end
+  
+  return nil
+end
+
+function GROUP:OnReSpawn( ReSpawnFunction )
+
+  self.ReSpawnFunction = ReSpawnFunction
+end
+
+do -- Event Handling
+
+  --- Subscribe to a DCS Event.
+  -- @param #GROUP self
+  -- @param Core.Event#EVENTS Event
+  -- @param #function EventFunction (optional) The function to be called when the event occurs for the GROUP.
+  -- @return #GROUP
+  function GROUP:HandleEvent( Event, EventFunction )
+  
+    self:EventDispatcher():OnEventForGroup( self:GetName(), EventFunction, self, Event )
+    
+    return self
+  end
+  
+  --- UnSubscribe to a DCS event.
+  -- @param #GROUP self
+  -- @param Core.Event#EVENTS Event
+  -- @return #GROUP
+  function GROUP:UnHandleEvent( Event )
+  
+    self:EventDispatcher():RemoveForGroup( self:GetName(), self, Event )
+    
+    return self
+  end
+
+end
+
+do -- Players
+
+  --- Get player names
+  -- @param #GROUP self
+  -- @return #table The group has players, an array of player names is returned.
+  -- @return #nil The group has no players
+  function GROUP:GetPlayerNames()
+  
+    local PlayerNames = nil
+    
+    local Units = self:GetUnits()
+    for UnitID, UnitData in pairs( Units ) do
+      local Unit = UnitData -- Wrapper.Unit#UNIT
+      local PlayerName = Unit:GetPlayerName()
+      if PlayerName and PlayerName ~= "" then
+        PlayerNames = PlayerNames or {}
+        table.insert( PlayerNames, PlayerName )
+      end   
+    end
+    
+    self:F( PlayerNames )
+    return PlayerNames
+  end
+  
+end

Moose Development/Moose/Wrapper/Identifiable.lua

@@ -0,0 +1,223 @@
+--- This module contains the IDENTIFIABLE class.
+-- 
+-- 1) @{#IDENTIFIABLE} class, extends @{Object#OBJECT}
+-- ===============================================================
+-- The @{#IDENTIFIABLE} class is a wrapper class to handle the DCS Identifiable objects:
+--
+--  * Support all DCS Identifiable APIs.
+--  * Enhance with Identifiable specific APIs not in the DCS Identifiable API set.
+--  * Manage the "state" of the DCS Identifiable.
+--
+-- 1.1) IDENTIFIABLE constructor:
+-- ------------------------------
+-- The IDENTIFIABLE class provides the following functions to construct a IDENTIFIABLE instance:
+--
+--  * @{#IDENTIFIABLE.New}(): Create a IDENTIFIABLE instance.
+--
+-- 1.2) IDENTIFIABLE methods:
+-- --------------------------
+-- The following methods can be used to identify an identifiable object:
+-- 
+--    * @{#IDENTIFIABLE.GetName}(): Returns the name of the Identifiable.
+--    * @{#IDENTIFIABLE.IsAlive}(): Returns if the Identifiable is alive.
+--    * @{#IDENTIFIABLE.GetTypeName}(): Returns the type name of the Identifiable.
+--    * @{#IDENTIFIABLE.GetCoalition}(): Returns the coalition of the Identifiable.
+--    * @{#IDENTIFIABLE.GetCountry}(): Returns the country of the Identifiable.
+--    * @{#IDENTIFIABLE.GetDesc}(): Returns the descriptor structure of the Identifiable.
+--    
+-- 
+-- ===
+-- 
+-- @module Identifiable
+
+--- The IDENTIFIABLE class
+-- @type IDENTIFIABLE
+-- @extends Wrapper.Object#OBJECT
+-- @field #string IdentifiableName The name of the identifiable.
+IDENTIFIABLE = {
+  ClassName = "IDENTIFIABLE",
+  IdentifiableName = "",
+}
+
+local _CategoryName = { 
+  [Unit.Category.AIRPLANE]      = "Airplane",
+  [Unit.Category.HELICOPTER]    = "Helicoper",
+  [Unit.Category.GROUND_UNIT]   = "Ground Identifiable",
+  [Unit.Category.SHIP]          = "Ship",
+  [Unit.Category.STRUCTURE]     = "Structure",
+  }
+
+--- Create a new IDENTIFIABLE from a DCSIdentifiable
+-- @param #IDENTIFIABLE self
+-- @param Dcs.DCSWrapper.Identifiable#Identifiable IdentifiableName The DCS Identifiable name
+-- @return #IDENTIFIABLE self
+function IDENTIFIABLE:New( IdentifiableName )
+  local self = BASE:Inherit( self, OBJECT:New( IdentifiableName ) )
+  self:F2( IdentifiableName )
+  self.IdentifiableName = IdentifiableName
+  return self
+end
+
+--- Returns if the Identifiable is alive.
+-- @param #IDENTIFIABLE self
+-- @return #boolean true if Identifiable is alive.
+-- @return #nil The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:IsAlive()
+  self:F3( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableIsAlive = DCSIdentifiable:isExist()
+    return IdentifiableIsAlive
+  end 
+  
+  return false
+end
+
+
+
+
+--- Returns DCS Identifiable object name. 
+-- The function provides access to non-activated objects too.
+-- @param #IDENTIFIABLE self
+-- @return #string The name of the DCS Identifiable.
+-- @return #nil The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:GetName()
+  self:F2( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableName = self.IdentifiableName
+    return IdentifiableName
+  end 
+  
+  self:E( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+
+--- Returns the type name of the DCS Identifiable.
+-- @param #IDENTIFIABLE self
+-- @return #string The type name of the DCS Identifiable.
+-- @return #nil The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:GetTypeName()
+  self:F2( self.IdentifiableName )
+  
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableTypeName = DCSIdentifiable:getTypeName()
+    self:T3( IdentifiableTypeName )
+    return IdentifiableTypeName
+  end
+
+  self:E( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+
+--- Returns category of the DCS Identifiable.
+-- @param #IDENTIFIABLE self
+-- @return Dcs.DCSWrapper.Object#Object.Category The category ID
+function IDENTIFIABLE:GetCategory()
+  self:F2( self.ObjectName )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    local ObjectCategory = DCSObject:getCategory()
+    self:T3( ObjectCategory )
+    return ObjectCategory
+  end
+
+  return nil
+end
+
+
+--- Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.
+-- @param #IDENTIFIABLE self
+-- @return #string The DCS Identifiable Category Name
+function IDENTIFIABLE:GetCategoryName()
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableCategoryName = _CategoryName[ self:GetDesc().category ]
+    return IdentifiableCategoryName
+  end
+  
+  self:E( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+--- Returns coalition of the Identifiable.
+-- @param #IDENTIFIABLE self
+-- @return Dcs.DCSCoalitionWrapper.Object#coalition.side The side of the coalition.
+-- @return #nil The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:GetCoalition()
+  self:F2( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableCoalition = DCSIdentifiable:getCoalition()
+    self:T3( IdentifiableCoalition )
+    return IdentifiableCoalition
+  end 
+  
+  self:E( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+--- Returns country of the Identifiable.
+-- @param #IDENTIFIABLE self
+-- @return Dcs.DCScountry#country.id The country identifier.
+-- @return #nil The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:GetCountry()
+  self:F2( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableCountry = DCSIdentifiable:getCountry()
+    self:T3( IdentifiableCountry )
+    return IdentifiableCountry
+  end 
+  
+  self:E( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+ 
+
+
+--- Returns Identifiable descriptor. Descriptor type depends on Identifiable category.
+-- @param #IDENTIFIABLE self
+-- @return Dcs.DCSWrapper.Identifiable#Identifiable.Desc The Identifiable descriptor.
+-- @return #nil The DCS Identifiable is not existing or alive.  
+function IDENTIFIABLE:GetDesc()
+  self:F2( self.IdentifiableName )
+
+  local DCSIdentifiable = self:GetDCSObject()
+  
+  if DCSIdentifiable then
+    local IdentifiableDesc = DCSIdentifiable:getDesc()
+    self:T2( IdentifiableDesc )
+    return IdentifiableDesc
+  end
+  
+  self:E( self.ClassName .. " " .. self.IdentifiableName .. " not found!" )
+  return nil
+end
+
+--- Gets the CallSign of the IDENTIFIABLE, which is a blank by default.
+-- @param #IDENTIFIABLE self
+-- @return #string The CallSign of the IDENTIFIABLE.
+function IDENTIFIABLE:GetCallsign()
+  return ''
+end
+
+
+function IDENTIFIABLE:GetThreatLevel()
+
+  return 0, "Scenery"
+end

Moose Development/Moose/Wrapper/Object.lua

@@ -0,0 +1,88 @@
+--- This module contains the OBJECT class.
+-- 
+-- 1) @{Object#OBJECT} class, extends @{Base#BASE}
+-- ===========================================================
+-- The @{Object#OBJECT} class is a wrapper class to handle the DCS Object objects:
+--
+--  * Support all DCS Object APIs.
+--  * Enhance with Object specific APIs not in the DCS Object API set.
+--  * Manage the "state" of the DCS Object.
+--
+-- 1.1) OBJECT constructor:
+-- ------------------------------
+-- The OBJECT class provides the following functions to construct a OBJECT instance:
+--
+--  * @{Object#OBJECT.New}(): Create a OBJECT instance.
+--
+-- 1.2) OBJECT methods:
+-- --------------------------
+-- The following methods can be used to identify an Object object:
+-- 
+--    * @{Object#OBJECT.GetID}(): Returns the ID of the Object object.
+-- 
+-- ===
+-- 
+-- @module Object
+
+--- The OBJECT class
+-- @type OBJECT
+-- @extends Core.Base#BASE
+-- @field #string ObjectName The name of the Object.
+OBJECT = {
+  ClassName = "OBJECT",
+  ObjectName = "",
+}
+
+--- A DCSObject
+-- @type DCSObject
+-- @field id_ The ID of the controllable in DCS
+
+--- Create a new OBJECT from a DCSObject
+-- @param #OBJECT self
+-- @param Dcs.DCSWrapper.Object#Object ObjectName The Object name
+-- @return #OBJECT self
+function OBJECT:New( ObjectName, Test )
+  local self = BASE:Inherit( self, BASE:New() )
+  self:F2( ObjectName )
+  self.ObjectName = ObjectName
+
+  return self
+end
+
+
+--- Returns the unit's unique identifier.
+-- @param Wrapper.Object#OBJECT self
+-- @return Dcs.DCSWrapper.Object#Object.ID ObjectID
+-- @return #nil The DCS Object is not existing or alive.  
+function OBJECT:GetID()
+  self:F2( self.ObjectName )
+
+  local DCSObject = self:GetDCSObject()
+  
+  if DCSObject then
+    local ObjectID = DCSObject:getID()
+    return ObjectID
+  end 
+
+  return nil
+end
+
+--- Destroys the OBJECT.
+-- @param #OBJECT self
+-- @return #nil The DCS Unit is not existing or alive.  
+function OBJECT:Destroy()
+  self:F2( self.ObjectName )
+
+  local DCSObject = self:GetDCSObject()
+  
+  if DCSObject then
+  
+    DCSObject:destroy()
+  end
+
+  return nil
+end
+
+
+
+

Moose Development/Moose/Wrapper/Positionable.lua

@@ -0,0 +1,438 @@
+--- This module contains the POSITIONABLE class.
+-- 
+-- 1) @{Positionable#POSITIONABLE} class, extends @{Identifiable#IDENTIFIABLE}
+-- ===========================================================
+-- The @{Positionable#POSITIONABLE} class is a wrapper class to handle the POSITIONABLE objects:
+--
+--  * Support all DCS APIs.
+--  * Enhance with POSITIONABLE specific APIs not in the DCS API set.
+--  * Manage the "state" of the POSITIONABLE.
+--
+-- 1.1) POSITIONABLE constructor:
+-- ------------------------------
+-- The POSITIONABLE class provides the following functions to construct a POSITIONABLE instance:
+--
+--  * @{Positionable#POSITIONABLE.New}(): Create a POSITIONABLE instance.
+--
+-- 1.2) POSITIONABLE methods:
+-- --------------------------
+-- The following methods can be used to identify an measurable object:
+-- 
+--    * @{Positionable#POSITIONABLE.GetID}(): Returns the ID of the measurable object.
+--    * @{Positionable#POSITIONABLE.GetName}(): Returns the name of the measurable object.
+-- 
+-- ===
+-- 
+-- @module Positionable
+
+--- The POSITIONABLE class
+-- @type POSITIONABLE
+-- @extends Wrapper.Identifiable#IDENTIFIABLE
+-- @field #string PositionableName The name of the measurable.
+POSITIONABLE = {
+  ClassName = "POSITIONABLE",
+  PositionableName = "",
+}
+
+--- A DCSPositionable
+-- @type DCSPositionable
+-- @field id_ The ID of the controllable in DCS
+
+--- Create a new POSITIONABLE from a DCSPositionable
+-- @param #POSITIONABLE self
+-- @param Dcs.DCSWrapper.Positionable#Positionable PositionableName The POSITIONABLE name
+-- @return #POSITIONABLE self
+function POSITIONABLE:New( PositionableName )
+  local self = BASE:Inherit( self, IDENTIFIABLE:New( PositionableName ) )
+
+  self.PositionableName = PositionableName
+  return self
+end
+
+--- Returns the @{DCSTypes#Position3} position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return Dcs.DCSTypes#Position The 3D position vectors of the POSITIONABLE.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:GetPositionVec3()
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local PositionablePosition = DCSPositionable:getPosition().p
+    self:T3( PositionablePosition )
+    return PositionablePosition
+  end
+  
+  return nil
+end
+
+--- Returns the @{DCSTypes#Vec2} vector indicating the point in 2D of the POSITIONABLE within the mission.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return Dcs.DCSTypes#Vec2 The 2D point vector of the POSITIONABLE.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:GetVec2()
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local PositionableVec3 = DCSPositionable:getPosition().p
+    
+    local PositionableVec2 = {}
+    PositionableVec2.x = PositionableVec3.x
+    PositionableVec2.y = PositionableVec3.z
+  
+    self:T2( PositionableVec2 )
+    return PositionableVec2
+  end
+  
+  return nil
+end
+
+--- Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return Core.Point#POINT_VEC2 The 2D point vector of the POSITIONABLE.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:GetPointVec2()
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local PositionableVec3 = DCSPositionable:getPosition().p
+    
+    local PositionablePointVec2 = POINT_VEC2:NewFromVec3( PositionableVec3 )
+  
+    self:T2( PositionablePointVec2 )
+    return PositionablePointVec2
+  end
+  
+  return nil
+end
+
+--- Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return Core.Point#POINT_VEC3 The 3D point vector of the POSITIONABLE.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:GetPointVec3()
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local PositionableVec3 = self:GetPositionVec3()
+    
+    local PositionablePointVec3 = POINT_VEC3:NewFromVec3( PositionableVec3 )
+  
+    self:T2( PositionablePointVec3 )
+    return PositionablePointVec3
+  end
+  
+  return nil
+end
+
+
+--- Returns a random @{DCSTypes#Vec3} vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return Dcs.DCSTypes#Vec3 The 3D point vector of the POSITIONABLE.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:GetRandomVec3( Radius )
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local PositionablePointVec3 = DCSPositionable:getPosition().p
+    local PositionableRandomVec3 = {}
+    local angle = math.random() * math.pi*2;
+    PositionableRandomVec3.x = PositionablePointVec3.x + math.cos( angle ) * math.random() * Radius;
+    PositionableRandomVec3.y = PositionablePointVec3.y
+    PositionableRandomVec3.z = PositionablePointVec3.z + math.sin( angle ) * math.random() * Radius;
+    
+    self:T3( PositionableRandomVec3 )
+    return PositionableRandomVec3
+  end
+  
+  return nil
+end
+
+--- Returns the @{DCSTypes#Vec3} vector indicating the 3D vector of the POSITIONABLE within the mission.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return Dcs.DCSTypes#Vec3 The 3D point vector of the POSITIONABLE.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:GetVec3()
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local PositionableVec3 = DCSPositionable:getPosition().p
+    self:T3( PositionableVec3 )
+    return PositionableVec3
+  end
+  
+  return nil
+end
+
+--- Returns the altitude of the POSITIONABLE.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return Dcs.DCSTypes#Distance The altitude of the POSITIONABLE.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:GetAltitude()
+  self:F2()
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local PositionablePointVec3 = DCSPositionable:getPoint() --Dcs.DCSTypes#Vec3
+    return PositionablePointVec3.y
+  end
+  
+  return nil
+end 
+
+--- Returns if the Positionable is located above a runway.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return #boolean true if Positionable is above a runway.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:IsAboveRunway()
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+  
+    local Vec2 = self:GetVec2()
+    local SurfaceType = land.getSurfaceType( Vec2 )
+    local IsAboveRunway = SurfaceType == land.SurfaceType.RUNWAY
+  
+    self:T2( IsAboveRunway )
+    return IsAboveRunway
+  end
+
+  return nil
+end
+
+
+
+--- Returns the POSITIONABLE heading in degrees.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return #number The POSTIONABLE heading
+function POSITIONABLE:GetHeading()
+  local DCSPositionable = self:GetDCSObject()
+
+  if DCSPositionable then
+
+    local PositionablePosition = DCSPositionable:getPosition()
+    if PositionablePosition then
+      local PositionableHeading = math.atan2( PositionablePosition.x.z, PositionablePosition.x.x )
+      if PositionableHeading < 0 then
+        PositionableHeading = PositionableHeading + 2 * math.pi
+      end
+      PositionableHeading = PositionableHeading * 180 / math.pi
+      self:T2( PositionableHeading )
+      return PositionableHeading
+    end
+  end
+  
+  return nil
+end
+
+
+--- Returns true if the POSITIONABLE is in the air.
+-- Polymorphic, is overridden in GROUP and UNIT.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return #boolean true if in the air.
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:InAir()
+  self:F2( self.PositionableName )
+
+  return nil
+end
+
+ 
+--- Returns the POSITIONABLE velocity vector.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return Dcs.DCSTypes#Vec3 The velocity vector
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:GetVelocity()
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local PositionableVelocityVec3 = DCSPositionable:getVelocity()
+    self:T3( PositionableVelocityVec3 )
+    return PositionableVelocityVec3
+  end
+  
+  return nil
+end
+
+--- Returns the POSITIONABLE velocity in km/h.
+-- @param Wrapper.Positionable#POSITIONABLE self
+-- @return #number The velocity in km/h
+-- @return #nil The POSITIONABLE is not existing or alive.  
+function POSITIONABLE:GetVelocityKMH()
+  self:F2( self.PositionableName )
+
+  local DCSPositionable = self:GetDCSObject()
+  
+  if DCSPositionable then
+    local VelocityVec3 = self:GetVelocity()
+    local Velocity = ( VelocityVec3.x ^ 2 + VelocityVec3.y ^ 2 + VelocityVec3.z ^ 2 ) ^ 0.5 -- in meters / sec
+    local Velocity = Velocity * 3.6 -- now it is in km/h.
+    self:T3( Velocity )
+    return Velocity
+  end
+  
+  return nil
+end
+
+--- Returns a message with the callsign embedded (if there is one).
+-- @param #POSITIONABLE self
+-- @param #string Message The message text
+-- @param Dcs.DCSTypes#Duration Duration The duration of the message.
+-- @param #string Name (optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
+-- @return Core.Message#MESSAGE
+function POSITIONABLE:GetMessage( Message, Duration, Name )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    Name = Name or self:GetTypeName()
+    return MESSAGE:New( Message, Duration, self:GetCallsign() .. " (" .. Name .. ")" )
+  end
+
+  return nil
+end
+
+--- Send a message to all coalitions.
+-- The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.
+-- @param #POSITIONABLE self
+-- @param #string Message The message text
+-- @param Dcs.DCSTypes#Duration Duration The duration of the message.
+-- @param #string Name (optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
+function POSITIONABLE:MessageToAll( Message, Duration, Name )
+  self:F2( { Message, Duration } )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    self:GetMessage( Message, Duration, Name ):ToAll()
+  end
+
+  return nil
+end
+
+--- Send a message to a coalition.
+-- The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.
+-- @param #POSITIONABLE self
+-- @param #string Message The message text
+-- @param Dcs.DCSTYpes#Duration Duration The duration of the message.
+-- @param Dcs.DCScoalition#coalition MessageCoalition The Coalition receiving the message.
+-- @param #string Name (optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
+function POSITIONABLE:MessageToCoalition( Message, Duration, MessageCoalition, Name )
+  self:F2( { Message, Duration } )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    self:GetMessage( Message, Duration, Name ):ToCoalition( MessageCoalition )
+  end
+
+  return nil
+end
+
+
+--- Send a message to the red coalition.
+-- The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.
+-- @param #POSITIONABLE self
+-- @param #string Message The message text
+-- @param Dcs.DCSTYpes#Duration Duration The duration of the message.
+-- @param #string Name (optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
+function POSITIONABLE:MessageToRed( Message, Duration, Name )
+  self:F2( { Message, Duration } )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    self:GetMessage( Message, Duration, Name ):ToRed()
+  end
+
+  return nil
+end
+
+--- Send a message to the blue coalition.
+-- The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.
+-- @param #POSITIONABLE self
+-- @param #string Message The message text
+-- @param Dcs.DCSTypes#Duration Duration The duration of the message.
+-- @param #string Name (optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
+function POSITIONABLE:MessageToBlue( Message, Duration, Name )
+  self:F2( { Message, Duration } )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    self:GetMessage( Message, Duration, Name ):ToBlue()
+  end
+
+  return nil
+end
+
+--- Send a message to a client.
+-- The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.
+-- @param #POSITIONABLE self
+-- @param #string Message The message text
+-- @param Dcs.DCSTypes#Duration Duration The duration of the message.
+-- @param Wrapper.Client#CLIENT Client The client object receiving the message.
+-- @param #string Name (optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
+function POSITIONABLE:MessageToClient( Message, Duration, Client, Name )
+  self:F2( { Message, Duration } )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    self:GetMessage( Message, Duration, Name ):ToClient( Client )
+  end
+
+  return nil
+end
+
+--- Send a message to a @{Group}.
+-- The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.
+-- @param #POSITIONABLE self
+-- @param #string Message The message text
+-- @param Dcs.DCSTypes#Duration Duration The duration of the message.
+-- @param Wrapper.Group#GROUP MessageGroup The GROUP object receiving the message.
+-- @param #string Name (optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
+function POSITIONABLE:MessageToGroup( Message, Duration, MessageGroup, Name )
+  self:F2( { Message, Duration } )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    if DCSObject:isExist() then
+      self:GetMessage( Message, Duration, Name ):ToGroup( MessageGroup )
+    end
+  end
+
+  return nil
+end
+
+--- Send a message to the players in the @{Group}.
+-- The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.
+-- @param #POSITIONABLE self
+-- @param #string Message The message text
+-- @param Dcs.DCSTypes#Duration Duration The duration of the message.
+-- @param #string Name (optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
+function POSITIONABLE:Message( Message, Duration, Name )
+  self:F2( { Message, Duration } )
+
+  local DCSObject = self:GetDCSObject()
+  if DCSObject then
+    self:GetMessage( Message, Duration, Name ):ToGroup( self )
+  end
+
+  return nil
+end
+
+
+
+
+

Moose Development/Moose/Wrapper/Scenery.lua

@@ -0,0 +1,39 @@
+--- This module contains the SCENERY class.
+-- 
+-- 1) @{Scenery#SCENERY} class, extends @{Positionable#POSITIONABLE}
+-- ===============================================================
+-- Scenery objects are defined on the map.
+-- The @{Scenery#SCENERY} class is a wrapper class to handle the DCS Scenery objects:
+-- 
+--  * Wraps the DCS Scenery objects.
+--  * Support all DCS Scenery APIs.
+--  * Enhance with Scenery specific APIs not in the DCS API set.
+-- 
+-- @module Scenery
+-- @author FlightControl
+
+
+
+--- The SCENERY class
+-- @type SCENERY
+-- @extends Wrapper.Positionable#POSITIONABLE
+SCENERY = {
+	ClassName = "SCENERY",
+}
+
+
+function SCENERY:Register( SceneryName, SceneryObject )
+  local self = BASE:Inherit( self, POSITIONABLE:New( SceneryName ) )
+  self.SceneryName = SceneryName
+  self.SceneryObject = SceneryObject
+  return self
+end
+
+function SCENERY:GetDCSObject()
+  return self.SceneryObject
+end
+
+function SCENERY:GetThreatLevel()
+
+  return 0, "Scenery"
+end

Moose Development/Moose/Wrapper/Static.lua

@@ -0,0 +1,91 @@
+--- This module contains the STATIC class.
+-- 
+-- 1) @{Static#STATIC} class, extends @{Positionable#POSITIONABLE}
+-- ===============================================================
+-- Statics are **Static Units** defined within the Mission Editor.
+-- Note that Statics are almost the same as Units, but they don't have a controller.
+-- The @{Static#STATIC} class is a wrapper class to handle the DCS Static objects:
+-- 
+--  * Wraps the DCS Static objects.
+--  * Support all DCS Static APIs.
+--  * Enhance with Static specific APIs not in the DCS API set.
+-- 
+-- 1.1) STATIC reference methods
+-- -----------------------------
+-- For each DCS Static will have a STATIC wrapper object (instance) within the _@{DATABASE} object.
+-- This is done at the beginning of the mission (when the mission starts).
+--  
+-- The STATIC class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference
+-- using the Static Name.
+-- 
+-- Another thing to know is that STATIC objects do not "contain" the DCS Static object. 
+-- The STATIc methods will reference the DCS Static object by name when it is needed during API execution.
+-- If the DCS Static object does not exist or is nil, the STATIC methods will return nil and log an exception in the DCS.log file.
+--  
+-- The STATIc class provides the following functions to retrieve quickly the relevant STATIC instance:
+-- 
+--  * @{#STATIC.FindByName}(): Find a STATIC instance from the _DATABASE object using a DCS Static name.
+--  
+-- IMPORTANT: ONE SHOULD NEVER SANATIZE these STATIC OBJECT REFERENCES! (make the STATIC object references nil).
+-- 
+-- @module Static
+-- @author FlightControl
+
+
+
+
+
+
+--- The STATIC class
+-- @type STATIC
+-- @extends Wrapper.Positionable#POSITIONABLE
+STATIC = {
+	ClassName = "STATIC",
+}
+
+
+--- Finds a STATIC from the _DATABASE using the relevant Static Name.
+-- As an optional parameter, a briefing text can be given also.
+-- @param #STATIC self
+-- @param #string StaticName Name of the DCS **Static** as defined within the Mission Editor.
+-- @param #boolean RaiseError Raise an error if not found.
+-- @return #STATIC
+function STATIC:FindByName( StaticName, RaiseError )
+  local StaticFound = _DATABASE:FindStatic( StaticName )
+
+  self.StaticName = StaticName
+  
+  if StaticFound then
+    StaticFound:F3( { StaticName } )
+
+  	return StaticFound
+  end
+
+  if RaiseError == nil or RaiseError == true then
+    error( "STATIC not found for: " .. StaticName )
+  end
+
+  return nil
+end
+
+function STATIC:Register( StaticName )
+  local self = BASE:Inherit( self, POSITIONABLE:New( StaticName ) )
+  self.StaticName = StaticName
+  return self
+end
+
+
+function STATIC:GetDCSObject()
+  local DCSStatic = StaticObject.getByName( self.StaticName )
+  
+  if DCSStatic then
+    return DCSStatic
+  end
+    
+  return nil
+end
+
+function STATIC:GetThreatLevel()
+
+  return 1, "Static"
+end

Moose Development/Moose/Wrapper/Unit.lua

@@ -0,0 +1,975 @@
+--- This module contains the UNIT class.
+-- 
+-- 1) @{#UNIT} class, extends @{Controllable#CONTROLLABLE}
+-- ===========================================================
+-- The @{#UNIT} class is a wrapper class to handle the DCS Unit objects:
+-- 
+--  * Support all DCS Unit APIs.
+--  * Enhance with Unit specific APIs not in the DCS Unit API set.
+--  * Handle local Unit Controller.
+--  * Manage the "state" of the DCS Unit.
+--  
+--  
+-- 1.1) UNIT reference methods
+-- ----------------------
+-- For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the _@{DATABASE} object.
+-- This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Unit objects are spawned (using the @{SPAWN} class).
+--  
+-- The UNIT class **does not contain a :New()** method, rather it provides **:Find()** methods to retrieve the object reference
+-- using the DCS Unit or the DCS UnitName.
+-- 
+-- Another thing to know is that UNIT objects do not "contain" the DCS Unit object. 
+-- The UNIT methods will reference the DCS Unit object by name when it is needed during API execution.
+-- If the DCS Unit object does not exist or is nil, the UNIT methods will return nil and log an exception in the DCS.log file.
+--  
+-- The UNIT class provides the following functions to retrieve quickly the relevant UNIT instance:
+-- 
+--  * @{#UNIT.Find}(): Find a UNIT instance from the _DATABASE object using a DCS Unit object.
+--  * @{#UNIT.FindByName}(): Find a UNIT instance from the _DATABASE object using a DCS Unit name.
+--  
+-- IMPORTANT: ONE SHOULD NEVER SANATIZE these UNIT OBJECT REFERENCES! (make the UNIT object references nil).
+-- 
+-- 1.2) DCS UNIT APIs
+-- ------------------
+-- The DCS Unit APIs are used extensively within MOOSE. The UNIT class has for each DCS Unit API a corresponding method.
+-- To be able to distinguish easily in your code the difference between a UNIT API call and a DCS Unit API call,
+-- the first letter of the method is also capitalized. So, by example, the DCS Unit method @{DCSWrapper.Unit#Unit.getName}()
+-- is implemented in the UNIT class as @{#UNIT.GetName}().
+-- 
+-- 1.3) Smoke, Flare Units
+-- -----------------------
+-- The UNIT class provides methods to smoke or flare units easily. 
+-- The @{#UNIT.SmokeBlue}(), @{#UNIT.SmokeGreen}(),@{#UNIT.SmokeOrange}(), @{#UNIT.SmokeRed}(), @{#UNIT.SmokeRed}() methods
+-- will smoke the unit in the corresponding color. Note that smoking a unit is done at the current position of the DCS Unit. 
+-- When the DCS Unit moves for whatever reason, the smoking will still continue!
+-- The @{#UNIT.FlareGreen}(), @{#UNIT.FlareRed}(), @{#UNIT.FlareWhite}(), @{#UNIT.FlareYellow}() 
+-- methods will fire off a flare in the air with the corresponding color. Note that a flare is a one-off shot and its effect is of very short duration.
+-- 
+-- 1.4) Location Position, Point
+-- -----------------------------
+-- The UNIT class provides methods to obtain the current point or position of the DCS Unit.
+-- The @{#UNIT.GetPointVec2}(), @{#UNIT.GetVec3}() will obtain the current **location** of the DCS Unit in a Vec2 (2D) or a **point** in a Vec3 (3D) vector respectively.
+-- If you want to obtain the complete **3D position** including ori<72>ntation and direction vectors, consult the @{#UNIT.GetPositionVec3}() method respectively.
+-- 
+-- 1.5) Test if alive
+-- ------------------
+-- The @{#UNIT.IsAlive}(), @{#UNIT.IsActive}() methods determines if the DCS Unit is alive, meaning, it is existing and active.
+-- 
+-- 1.6) Test for proximity
+-- -----------------------
+-- The UNIT class contains methods to test the location or proximity against zones or other objects.
+-- 
+-- ### 1.6.1) Zones
+-- To test whether the Unit is within a **zone**, use the @{#UNIT.IsInZone}() or the @{#UNIT.IsNotInZone}() methods. Any zone can be tested on, but the zone must be derived from @{Zone#ZONE_BASE}. 
+-- 
+-- ### 1.6.2) Units
+-- Test if another DCS Unit is within a given radius of the current DCS Unit, use the @{#UNIT.OtherUnitInRadius}() method.
+-- 
+-- @module Unit
+-- @author FlightControl
+
+
+
+
+
+--- The UNIT class
+-- @type UNIT
+-- @extends Wrapper.Controllable#CONTROLLABLE
+UNIT = {
+	ClassName="UNIT",
+}
+
+
+--- Unit.SensorType
+-- @type Unit.SensorType
+-- @field OPTIC
+-- @field RADAR
+-- @field IRST
+-- @field RWR
+
+
+-- Registration.
+	
+--- Create a new UNIT from DCSUnit.
+-- @param #UNIT self
+-- @param #string UnitName The name of the DCS unit.
+-- @return #UNIT
+function UNIT:Register( UnitName )
+  local self = BASE:Inherit( self, CONTROLLABLE:New( UnitName ) )
+  self.UnitName = UnitName
+  
+  self:SetEventPriority( 3 )
+  return self
+end
+
+-- Reference methods.
+
+--- Finds a UNIT from the _DATABASE using a DCSUnit object.
+-- @param #UNIT self
+-- @param Dcs.DCSWrapper.Unit#Unit DCSUnit An existing DCS Unit object reference.
+-- @return #UNIT self
+function UNIT:Find( DCSUnit )
+
+  local UnitName = DCSUnit:getName()
+  local UnitFound = _DATABASE:FindUnit( UnitName )
+  return UnitFound
+end
+
+--- Find a UNIT in the _DATABASE using the name of an existing DCS Unit.
+-- @param #UNIT self
+-- @param #string UnitName The Unit Name.
+-- @return #UNIT self
+function UNIT:FindByName( UnitName )
+  
+  local UnitFound = _DATABASE:FindUnit( UnitName )
+  return UnitFound
+end
+
+--- Return the name of the UNIT.
+-- @param #UNIT self
+-- @return #string The UNIT name.
+function UNIT:Name()
+  
+  return self.UnitName
+end
+
+
+--- @param #UNIT self
+-- @return Dcs.DCSWrapper.Unit#Unit
+function UNIT:GetDCSObject()
+
+  local DCSUnit = Unit.getByName( self.UnitName )
+
+  if DCSUnit then
+    return DCSUnit
+  end
+
+  return nil
+end
+
+--- Respawn the @{Unit} using a (tweaked) template of the parent Group.
+-- 
+-- This function will:
+-- 
+--  * Get the current position and heading of the group.
+--  * When the unit is alive, it will tweak the template x, y and heading coordinates of the group and the embedded units to the current units positions.
+--  * Then it will respawn the re-modelled group.
+--  
+-- @param #UNIT self
+-- @param Dcs.DCSTypes#Vec3 SpawnVec3 The position where to Spawn the new Unit at.
+-- @param #number Heading The heading of the unit respawn.
+function UNIT:ReSpawn( SpawnVec3, Heading )
+
+  local SpawnGroupTemplate = UTILS.DeepCopy( _DATABASE:GetGroupTemplateFromUnitName( self:Name() ) )
+  self:T( SpawnGroupTemplate )
+
+  local SpawnGroup = self:GetGroup()
+  
+  if SpawnGroup then
+  
+    local Vec3 = SpawnGroup:GetVec3()
+    SpawnGroupTemplate.x = SpawnVec3.x
+    SpawnGroupTemplate.y = SpawnVec3.z
+    
+    self:E( #SpawnGroupTemplate.units )
+    for UnitID, UnitData in pairs( SpawnGroup:GetUnits() ) do
+      local GroupUnit = UnitData -- #UNIT
+      self:E( GroupUnit:GetName() )
+      if GroupUnit:IsAlive() then
+        local GroupUnitVec3 = GroupUnit:GetVec3()
+        local GroupUnitHeading = GroupUnit:GetHeading()
+        SpawnGroupTemplate.units[UnitID].alt = GroupUnitVec3.y
+        SpawnGroupTemplate.units[UnitID].x = GroupUnitVec3.x
+        SpawnGroupTemplate.units[UnitID].y = GroupUnitVec3.z
+        SpawnGroupTemplate.units[UnitID].heading = GroupUnitHeading
+        self:E( { UnitID, SpawnGroupTemplate.units[UnitID], SpawnGroupTemplate.units[UnitID] } )
+      end
+    end
+  end
+  
+  for UnitTemplateID, UnitTemplateData in pairs( SpawnGroupTemplate.units ) do
+    self:T( UnitTemplateData.name )
+    if UnitTemplateData.name == self:Name() then
+      self:T("Adjusting")
+      SpawnGroupTemplate.units[UnitTemplateID].alt = SpawnVec3.y
+      SpawnGroupTemplate.units[UnitTemplateID].x = SpawnVec3.x
+      SpawnGroupTemplate.units[UnitTemplateID].y = SpawnVec3.z
+      SpawnGroupTemplate.units[UnitTemplateID].heading = Heading
+      self:E( { UnitTemplateID, SpawnGroupTemplate.units[UnitTemplateID], SpawnGroupTemplate.units[UnitTemplateID] } )
+    else
+      self:E( SpawnGroupTemplate.units[UnitTemplateID].name )
+      local GroupUnit = UNIT:FindByName( SpawnGroupTemplate.units[UnitTemplateID].name ) -- #UNIT
+      if GroupUnit and GroupUnit:IsAlive() then
+        local GroupUnitVec3 = GroupUnit:GetVec3()
+        local GroupUnitHeading = GroupUnit:GetHeading()
+        UnitTemplateData.alt = GroupUnitVec3.y
+        UnitTemplateData.x = GroupUnitVec3.x
+        UnitTemplateData.y = GroupUnitVec3.z
+        UnitTemplateData.heading = GroupUnitHeading
+      else
+        if SpawnGroupTemplate.units[UnitTemplateID].name ~= self:Name() then
+          self:T("nilling")
+          SpawnGroupTemplate.units[UnitTemplateID].delete = true
+        end
+      end
+    end
+  end
+
+  -- Remove obscolete units from the group structure
+  i = 1
+  while i <= #SpawnGroupTemplate.units do
+
+    local UnitTemplateData = SpawnGroupTemplate.units[i]
+    self:T( UnitTemplateData.name )
+
+    if UnitTemplateData.delete then
+      table.remove( SpawnGroupTemplate.units, i )
+    else
+      i = i + 1
+    end
+  end
+
+  _DATABASE:Spawn( SpawnGroupTemplate )
+end
+
+
+
+--- Returns if the unit is activated.
+-- @param #UNIT self
+-- @return #boolean true if Unit is activated.
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:IsActive()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+  
+    local UnitIsActive = DCSUnit:isActive()
+    return UnitIsActive 
+  end
+
+  return nil
+end
+
+
+
+--- Returns the Unit's callsign - the localized string.
+-- @param #UNIT self
+-- @return #string The Callsign of the Unit.
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetCallsign()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitCallSign = DCSUnit:getCallsign()
+    return UnitCallSign
+  end
+  
+  self:E( self.ClassName .. " " .. self.UnitName .. " not found!" )
+  return nil
+end
+
+
+--- Returns name of the player that control the unit or nil if the unit is controlled by A.I.
+-- @param #UNIT self
+-- @return #string Player Name
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetPlayerName()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+  
+    local PlayerName = DCSUnit:getPlayerName()
+    if PlayerName == nil then
+      PlayerName = ""
+    end
+    return PlayerName
+  end
+
+  return nil
+end
+
+--- Returns the unit's number in the group. 
+-- The number is the same number the unit has in ME. 
+-- It may not be changed during the mission. 
+-- If any unit in the group is destroyed, the numbers of another units will not be changed.
+-- @param #UNIT self
+-- @return #number The Unit number. 
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetNumber()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitNumber = DCSUnit:getNumber()
+    return UnitNumber
+  end
+
+  return nil
+end
+
+--- Returns the unit's group if it exist and nil otherwise.
+-- @param Wrapper.Unit#UNIT self
+-- @return Wrapper.Group#GROUP The Group of the Unit.
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetGroup()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitGroup = GROUP:Find( DCSUnit:getGroup() )
+    return UnitGroup
+  end
+
+  return nil
+end
+
+
+-- Need to add here functions to check if radar is on and which object etc.
+
+--- Returns the prefix name of the DCS Unit. A prefix name is a part of the name before a '#'-sign.
+-- DCS Units spawned with the @{SPAWN} class contain a '#'-sign to indicate the end of the (base) DCS Unit name. 
+-- The spawn sequence number and unit number are contained within the name after the '#' sign. 
+-- @param #UNIT self
+-- @return #string The name of the DCS Unit.
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetPrefix()
+	self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+	
+  if DCSUnit then
+  	local UnitPrefix = string.match( self.UnitName, ".*#" ):sub( 1, -2 )
+  	self:T3( UnitPrefix )
+  	return UnitPrefix
+  end
+  
+  return nil
+end
+
+--- Returns the Unit's ammunition.
+-- @param #UNIT self
+-- @return Dcs.DCSWrapper.Unit#Unit.Ammo
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetAmmo()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitAmmo = DCSUnit:getAmmo()
+    return UnitAmmo
+  end
+  
+  return nil
+end
+
+--- Returns the unit sensors.
+-- @param #UNIT self
+-- @return Dcs.DCSWrapper.Unit#Unit.Sensors
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetSensors()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitSensors = DCSUnit:getSensors()
+    return UnitSensors
+  end
+  
+  return nil
+end
+
+-- Need to add here a function per sensortype
+--  unit:hasSensors(Unit.SensorType.RADAR, Unit.RadarType.AS)
+
+--- Returns if the unit has sensors of a certain type.
+-- @param #UNIT self
+-- @return #boolean returns true if the unit has specified types of sensors. This function is more preferable than Unit.getSensors() if you don't want to get information about all the unit's sensors, and just want to check if the unit has specified types of sensors. 
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:HasSensors( ... )
+  self:F2( arg )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local HasSensors = DCSUnit:hasSensors( unpack( arg ) )
+    return HasSensors
+  end
+  
+  return nil
+end
+
+--- Returns if the unit is SEADable.
+-- @param #UNIT self
+-- @return #boolean returns true if the unit is SEADable. 
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:HasSEAD()
+  self:F2()
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitSEADAttributes = DCSUnit:getDesc().attributes
+    
+    local HasSEAD = false
+    if UnitSEADAttributes["RADAR_BAND1_FOR_ARM"] and UnitSEADAttributes["RADAR_BAND1_FOR_ARM"] == true or
+       UnitSEADAttributes["RADAR_BAND2_FOR_ARM"] and UnitSEADAttributes["RADAR_BAND2_FOR_ARM"] == true then
+       HasSEAD = true
+    end
+    return HasSEAD
+  end
+  
+  return nil
+end
+
+--- Returns two values:
+-- 
+--  * First value indicates if at least one of the unit's radar(s) is on.
+--  * 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.
+-- @param #UNIT self
+-- @return #boolean  Indicates if at least one of the unit's radar(s) is on.
+-- @return Dcs.DCSWrapper.Object#Object The object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetRadar()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitRadarOn, UnitRadarObject = DCSUnit:getRadar()
+    return UnitRadarOn, UnitRadarObject
+  end
+  
+  return nil, nil
+end
+
+--- Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks. If there are additional fuel tanks the value may be greater than 1.0.
+-- @param #UNIT self
+-- @return #number The relative amount of fuel (from 0.0 to 1.0).
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetFuel()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitFuel = DCSUnit:getFuel()
+    return UnitFuel
+  end
+  
+  return nil
+end
+
+--- Returns the UNIT in a UNIT list of one element.
+-- @param #UNIT self
+-- @return #list<Wrapper.Unit#UNIT> The UNITs wrappers.
+function UNIT:GetUnits()
+  self:F2( { self.UnitName } )
+  local DCSUnit = self:GetDCSObject()
+
+  if DCSUnit then
+    local DCSUnits = DCSUnit:getUnits()
+    local Units = {}
+    Units[1] = UNIT:Find( DCSUnit )
+    self:T3( Units )
+    return Units
+  end
+
+  return nil
+end
+
+
+--- Returns the unit's health. Dead units has health <= 1.0.
+-- @param #UNIT self
+-- @return #number The Unit's health value.
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetLife()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitLife = DCSUnit:getLife()
+    return UnitLife
+  end
+  
+  return nil
+end
+
+--- Returns the Unit's initial health.
+-- @param #UNIT self
+-- @return #number The Unit's initial health value.
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:GetLife0()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitLife0 = DCSUnit:getLife0()
+    return UnitLife0
+  end
+  
+  return nil
+end
+
+--- Returns the category name of the #UNIT.
+-- @param #UNIT self
+-- @return #string Category name = Helicopter, Airplane, Ground Unit, Ship
+function UNIT:GetCategoryName()
+  self:F3( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  if DCSUnit then
+    local CategoryNames = {
+      [Unit.Category.AIRPLANE] = "Airplane",
+      [Unit.Category.HELICOPTER] = "Helicopter",
+      [Unit.Category.GROUND_UNIT] = "Ground Unit",
+      [Unit.Category.SHIP] = "Ship",
+      [Unit.Category.STRUCTURE] = "Structure",
+    }
+    local UnitCategory = DCSUnit:getDesc().category
+    self:T3( UnitCategory )
+
+    return CategoryNames[UnitCategory]
+  end
+
+  return nil
+end
+
+
+--- Returns the Unit's A2G threat level on a scale from 1 to 10 ...
+-- The following threat levels are foreseen:
+-- 
+--   * Threat level  0: Unit is unarmed.
+--   * Threat level  1: Unit is infantry.
+--   * Threat level  2: Unit is an infantry vehicle.
+--   * Threat level  3: Unit is ground artillery.
+--   * Threat level  4: Unit is a tank.
+--   * Threat level  5: Unit is a modern tank or ifv with ATGM.
+--   * Threat level  6: Unit is a AAA.
+--   * Threat level  7: Unit is a SAM or manpad, IR guided.
+--   * Threat level  8: Unit is a Short Range SAM, radar guided.
+--   * Threat level  9: Unit is a Medium Range SAM, radar guided.
+--   * Threat level 10: Unit is a Long Range SAM, radar guided.
+--   @param #UNIT self
+function UNIT:GetThreatLevel()
+
+  local Attributes = self:GetDesc().attributes
+  self:T( Attributes )
+
+  local ThreatLevel = 0
+  local ThreatText = ""
+
+  if self:IsGround() then
+  
+    self:T( "Ground" )
+  
+    local ThreatLevels = {
+      "Unarmed", 
+      "Infantry", 
+      "Old Tanks & APCs", 
+      "Tanks & IFVs without ATGM",   
+      "Tanks & IFV with ATGM",
+      "Modern Tanks",
+      "AAA",
+      "IR Guided SAMs",
+      "SR SAMs",
+      "MR SAMs",
+      "LR SAMs"
+    }
+    
+    
+    if     Attributes["LR SAM"]                                                     then ThreatLevel = 10
+    elseif Attributes["MR SAM"]                                                     then ThreatLevel = 9
+    elseif Attributes["SR SAM"] and
+           not Attributes["IR Guided SAM"]                                          then ThreatLevel = 8
+    elseif ( Attributes["SR SAM"] or Attributes["MANPADS"] ) and
+           Attributes["IR Guided SAM"]                                              then ThreatLevel = 7
+    elseif Attributes["AAA"]                                                        then ThreatLevel = 6
+    elseif Attributes["Modern Tanks"]                                               then ThreatLevel = 5
+    elseif ( Attributes["Tanks"] or Attributes["IFV"] ) and
+           Attributes["ATGM"]                                                       then ThreatLevel = 4
+    elseif ( Attributes["Tanks"] or Attributes["IFV"] ) and
+           not Attributes["ATGM"]                                                   then ThreatLevel = 3
+    elseif Attributes["Old Tanks"] or Attributes["APC"] or Attributes["Artillery"]  then ThreatLevel = 2
+    elseif Attributes["Infantry"]                                                   then ThreatLevel = 1
+    end
+    
+    ThreatText = ThreatLevels[ThreatLevel+1]
+  end
+  
+  if self:IsAir() then
+  
+    self:T( "Air" )
+
+    local ThreatLevels = {
+      "Unarmed", 
+      "Tanker", 
+      "AWACS", 
+      "Transport Helicpter",   
+      "UAV",
+      "Bomber",
+      "Strategic Bomber",
+      "Attack Helicopter",
+      "Interceptor",
+      "Multirole Fighter",
+      "Fighter"
+    }
+    
+    
+    if     Attributes["Fighters"]                                 then ThreatLevel = 10
+    elseif Attributes["Multirole fighters"]                       then ThreatLevel = 9
+    elseif Attributes["Battleplanes"]                             then ThreatLevel = 8
+    elseif Attributes["Attack helicopters"]                       then ThreatLevel = 7
+    elseif Attributes["Strategic bombers"]                        then ThreatLevel = 6
+    elseif Attributes["Bombers"]                                  then ThreatLevel = 5
+    elseif Attributes["UAVs"]                                     then ThreatLevel = 4
+    elseif Attributes["Transport helicopters"]                    then ThreatLevel = 3
+    elseif Attributes["AWACS"]                                    then ThreatLevel = 2
+    elseif Attributes["Tankers"]                                  then ThreatLevel = 1
+    end
+
+    ThreatText = ThreatLevels[ThreatLevel+1]
+  end
+  
+  if self:IsShip() then
+
+    self:T( "Ship" )
+
+--["Aircraft Carriers"] = {"Heavy armed ships",},
+--["Cruisers"] = {"Heavy armed ships",},
+--["Destroyers"] = {"Heavy armed ships",},
+--["Frigates"] = {"Heavy armed ships",},
+--["Corvettes"] = {"Heavy armed ships",},
+--["Heavy armed ships"] = {"Armed ships", "Armed Air Defence", "HeavyArmoredUnits",},
+--["Light armed ships"] = {"Armed ships","NonArmoredUnits"},
+--["Armed ships"] = {"Ships"},
+--["Unarmed ships"] = {"Ships","HeavyArmoredUnits",},
+  
+    local ThreatLevels = {
+      "Unarmed ship", 
+      "Light armed ships", 
+      "Corvettes",
+      "",
+      "Frigates",
+      "",
+      "Cruiser",
+      "",
+      "Destroyer",
+      "",
+      "Aircraft Carrier"
+    }
+    
+    
+    if     Attributes["Aircraft Carriers"]                        then ThreatLevel = 10
+    elseif Attributes["Destroyers"]                               then ThreatLevel = 8
+    elseif Attributes["Cruisers"]                                 then ThreatLevel = 6
+    elseif Attributes["Frigates"]                                 then ThreatLevel = 4
+    elseif Attributes["Corvettes"]                                then ThreatLevel = 2
+    elseif Attributes["Light armed ships"]                        then ThreatLevel = 1
+    end
+
+    ThreatText = ThreatLevels[ThreatLevel+1]
+  end
+
+  self:T2( ThreatLevel )
+  return ThreatLevel, ThreatText
+
+end
+
+
+-- Is functions
+
+--- Returns true if the unit is within a @{Zone}.
+-- @param #UNIT self
+-- @param Core.Zone#ZONE_BASE Zone The zone to test.
+-- @return #boolean Returns true if the unit is within the @{Zone#ZONE_BASE}
+function UNIT:IsInZone( Zone )
+  self:F2( { self.UnitName, Zone } )
+
+  if self:IsAlive() then
+    local IsInZone = Zone:IsVec3InZone( self:GetVec3() )
+  
+    self:T( { IsInZone } )
+    return IsInZone 
+  end
+  
+  return false
+end
+
+--- Returns true if the unit is not within a @{Zone}.
+-- @param #UNIT self
+-- @param Core.Zone#ZONE_BASE Zone The zone to test.
+-- @return #boolean Returns true if the unit is not within the @{Zone#ZONE_BASE}
+function UNIT:IsNotInZone( Zone )
+  self:F2( { self.UnitName, Zone } )
+
+  if self:IsAlive() then
+    local IsInZone = not Zone:IsVec3InZone( self:GetVec3() )
+    
+    self:T( { IsInZone } )
+    return IsInZone 
+  else
+    return false
+  end
+end
+
+
+--- Returns true if there is an **other** DCS Unit within a radius of the current 2D point of the DCS Unit.
+-- @param #UNIT self
+-- @param #UNIT AwaitUnit The other UNIT wrapper object.
+-- @param Radius The radius in meters with the DCS Unit in the centre.
+-- @return true If the other DCS Unit is within the radius of the 2D point of the DCS Unit. 
+-- @return #nil The DCS Unit is not existing or alive.  
+function UNIT:OtherUnitInRadius( AwaitUnit, Radius )
+	self:F2( { self.UnitName, AwaitUnit.UnitName, Radius } )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+  	local UnitVec3 = self:GetVec3()
+  	local AwaitUnitVec3 = AwaitUnit:GetVec3()
+  
+  	if  (((UnitVec3.x - AwaitUnitVec3.x)^2 + (UnitVec3.z - AwaitUnitVec3.z)^2)^0.5 <= Radius) then
+  		self:T3( "true" )
+  		return true
+  	else
+  		self:T3( "false" )
+  		return false
+  	end
+  end
+
+	return nil
+end
+
+
+
+--- Signal a flare at the position of the UNIT.
+-- @param #UNIT self
+-- @param Utilities.Utils#FLARECOLOR FlareColor
+function UNIT:Flare( FlareColor )
+  self:F2()
+  trigger.action.signalFlare( self:GetVec3(), FlareColor , 0 )
+end
+
+--- Signal a white flare at the position of the UNIT.
+-- @param #UNIT self
+function UNIT:FlareWhite()
+  self:F2()
+  trigger.action.signalFlare( self:GetVec3(), trigger.flareColor.White , 0 )
+end
+
+--- Signal a yellow flare at the position of the UNIT.
+-- @param #UNIT self
+function UNIT:FlareYellow()
+  self:F2()
+  trigger.action.signalFlare( self:GetVec3(), trigger.flareColor.Yellow , 0 )
+end
+
+--- Signal a green flare at the position of the UNIT.
+-- @param #UNIT self
+function UNIT:FlareGreen()
+  self:F2()
+  trigger.action.signalFlare( self:GetVec3(), trigger.flareColor.Green , 0 )
+end
+
+--- Signal a red flare at the position of the UNIT.
+-- @param #UNIT self
+function UNIT:FlareRed()
+  self:F2()
+  local Vec3 = self:GetVec3()
+  if Vec3 then
+    trigger.action.signalFlare( Vec3, trigger.flareColor.Red, 0 )
+  end
+end
+
+--- Smoke the UNIT.
+-- @param #UNIT self
+function UNIT:Smoke( SmokeColor, Range )
+  self:F2()
+  if Range then
+    trigger.action.smoke( self:GetRandomVec3( Range ), SmokeColor )
+  else
+    trigger.action.smoke( self:GetVec3(), SmokeColor )
+  end
+  
+end
+
+--- Smoke the UNIT Green.
+-- @param #UNIT self
+function UNIT:SmokeGreen()
+  self:F2()
+  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.Green )
+end
+
+--- Smoke the UNIT Red.
+-- @param #UNIT self
+function UNIT:SmokeRed()
+  self:F2()
+  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.Red )
+end
+
+--- Smoke the UNIT White.
+-- @param #UNIT self
+function UNIT:SmokeWhite()
+  self:F2()
+  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.White )
+end
+
+--- Smoke the UNIT Orange.
+-- @param #UNIT self
+function UNIT:SmokeOrange()
+  self:F2()
+  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.Orange )
+end
+
+--- Smoke the UNIT Blue.
+-- @param #UNIT self
+function UNIT:SmokeBlue()
+  self:F2()
+  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.Blue )
+end
+
+-- Is methods
+
+--- Returns if the unit is of an air category.
+-- If the unit is a helicopter or a plane, then this method will return true, otherwise false.
+-- @param #UNIT self
+-- @return #boolean Air category evaluation result.
+function UNIT:IsAir()
+  self:F2()
+  
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitDescriptor = DCSUnit:getDesc()
+    self:T3( { UnitDescriptor.category, Unit.Category.AIRPLANE, Unit.Category.HELICOPTER } )
+    
+    local IsAirResult = ( UnitDescriptor.category == Unit.Category.AIRPLANE ) or ( UnitDescriptor.category == Unit.Category.HELICOPTER )
+  
+    self:T3( IsAirResult )
+    return IsAirResult
+  end
+  
+  return nil
+end
+
+--- Returns if the unit is of an ground category.
+-- If the unit is a ground vehicle or infantry, this method will return true, otherwise false.
+-- @param #UNIT self
+-- @return #boolean Ground category evaluation result.
+function UNIT:IsGround()
+  self:F2()
+  
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitDescriptor = DCSUnit:getDesc()
+    self:T3( { UnitDescriptor.category, Unit.Category.GROUND_UNIT } )
+    
+    local IsGroundResult = ( UnitDescriptor.category == Unit.Category.GROUND_UNIT )
+  
+    self:T3( IsGroundResult )
+    return IsGroundResult
+  end
+  
+  return nil
+end
+
+--- Returns if the unit is a friendly unit.
+-- @param #UNIT self
+-- @return #boolean IsFriendly evaluation result.
+function UNIT:IsFriendly( FriendlyCoalition )
+  self:F2()
+  
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitCoalition = DCSUnit:getCoalition()
+    self:T3( { UnitCoalition, FriendlyCoalition } )
+    
+    local IsFriendlyResult = ( UnitCoalition == FriendlyCoalition )
+  
+    self:E( IsFriendlyResult )
+    return IsFriendlyResult
+  end
+  
+  return nil
+end
+
+--- Returns if the unit is of a ship category.
+-- If the unit is a ship, this method will return true, otherwise false.
+-- @param #UNIT self
+-- @return #boolean Ship category evaluation result.
+function UNIT:IsShip()
+  self:F2()
+  
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitDescriptor = DCSUnit:getDesc()
+    self:T3( { UnitDescriptor.category, Unit.Category.SHIP } )
+    
+    local IsShipResult = ( UnitDescriptor.category == Unit.Category.SHIP )
+  
+    self:T3( IsShipResult )
+    return IsShipResult
+  end
+  
+  return nil
+end
+
+--- Returns true if the UNIT is in the air.
+-- @param Wrapper.Positionable#UNIT self
+-- @return #boolean true if in the air.
+-- @return #nil The UNIT is not existing or alive.  
+function UNIT:InAir()
+  self:F2( self.UnitName )
+
+  local DCSUnit = self:GetDCSObject()
+  
+  if DCSUnit then
+    local UnitInAir = DCSUnit:inAir()
+    self:T3( UnitInAir )
+    return UnitInAir
+  end
+  
+  return nil
+end
+
+do -- Event Handling
+
+  --- Subscribe to a DCS Event.
+  -- @param #UNIT self
+  -- @param Core.Event#EVENTS Event
+  -- @param #function EventFunction (optional) The function to be called when the event occurs for the unit.
+  -- @return #UNIT
+  function UNIT:HandleEvent( Event, EventFunction )
+  
+    self:EventDispatcher():OnEventForUnit( self:GetName(), EventFunction, self, Event )
+    
+    return self
+  end
+  
+  --- UnSubscribe to a DCS event.
+  -- @param #UNIT self
+  -- @param Core.Event#EVENTS Event
+  -- @return #UNIT
+  function UNIT:UnHandleEvent( Event )
+  
+    self:EventDispatcher():RemoveForUnit( self:GetName(), self, Event )
+    
+    return self
+  end
+
+end

Moose Development/Moose/Zone.lua

@@ -1,79 +0,0 @@
---- ZONE Classes
--- @module Zone
-
-Include.File( "Routines" )
-Include.File( "Base" )
-Include.File( "Message" )
-
---- The ZONE class
--- @type ZONE
--- @Extends Base#BASE
-ZONE = {
-	ClassName="ZONE",
-	}
-	
-function ZONE:New( ZoneName )
-	local self = BASE:Inherit( self, BASE:New() )
-	self:F( ZoneName )
-
-	local Zone = trigger.misc.getZone( ZoneName )
-	
-	if not Zone then
-		error( "Zone " .. ZoneName .. " does not exist." )
-		return nil
-	end
-	
-	self.Zone = Zone
-	self.ZoneName = ZoneName
-	
-	return self
-end
-
-function ZONE:GetPointVec2()
-	self:F( self.ZoneName )
-
-	local Zone = trigger.misc.getZone( self.ZoneName )
-	local Point = { x = Zone.point.x, y = Zone.point.z }
-
-	self:T( { Zone, Point } )
-	
-	return Point	
-end
-
-function ZONE:GetPointVec3( Height )
-  self:F( self.ZoneName )
-
-  local Zone = trigger.misc.getZone( self.ZoneName )
-  local Point = { x = Zone.point.x, y = land.getHeight( self:GetPointVec2() ) + Height, z = Zone.point.z }
-
-  self:T( { Zone, Point } )
-  
-  return Point  
-end
-
-function ZONE:GetRandomPointVec2()
-	self:F( self.ZoneName )
-
-	local Point = {}
-
-	local Zone = trigger.misc.getZone( self.ZoneName )
-	
-	local angle = math.random() * math.pi*2;
-	Point.x = Zone.point.x + math.cos( angle ) * math.random() * Zone.radius;
-	Point.y = Zone.point.z + math.sin( angle ) * math.random() * Zone.radius;
-	
-	self:T( { Zone, Point } )
-	
-	return Point
-end
-
-function ZONE:GetRadius()
-	self:F( self.ZoneName )
-
-	local Zone = trigger.misc.getZone( self.ZoneName )
-
-	self:T( { Zone } )
-
-	return Zone.radius
-end
-

Moose Development/Old/DeployTask.lua

@@ -1,7 +1,7 @@
 --- A DEPLOYTASK orchestrates the deployment of CARGO within a specific landing zone.
 -- @module DEPLOYTASK
 
-Include.File( "Task" )
+
 
 --- A DeployTask
 -- @type DEPLOYTASK

Moose Development/Old/DestroyBaseTask.lua

@@ -4,7 +4,7 @@
 -- @see DESTROYUNITTYPESTASK
 -- @see DESTROY_RADARS_TASK
 
-Include.File("Task")
+
 
 --- The DESTROYBASETASK class
 -- @type DESTROYBASETASK
@@ -43,7 +43,7 @@ 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.
+-- @param Core.Event#EVENTDATA Event structure of MOOSE.
 function DESTROYBASETASK:EventDead( Event )
 	self:F( { Event } )
 	

Moose Development/Old/DestroyGroupsTask.lua

@@ -1,7 +1,7 @@
 --- DESTROYGROUPSTASK
 -- @module DESTROYGROUPSTASK
 
-Include.File("DestroyBaseTask")
+
 
 --- The DESTROYGROUPSTASK class
 -- @type
@@ -32,8 +32,8 @@ 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.
+-- @param Dcs.DCSWrapper.Group#Group DestroyGroup Group structure describing the group to be evaluated.
+-- @param Dcs.DCSWrapper.Unit#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 } )